nbox
provides first class CLI python package support for all NimbleBox infrastructure and services. You can
# on macos find the correct wheel file based on python version: https://github.com/pietrodn/grpcio-mac-arm-build/releases/tag/1.51.1
pip install <wheel_url>
pip install nbox
Next you need to authenticate yourself with the CLI:
nbx login
Status: The library is currently undergoing heavy development.
nbx projects
:nbx projects - artifacts --help
stable βnbx projects - run --help
stable β
nbx jobs --help
: mostly stable π‘nbx serve --help
: mostly stable π‘
- Write and execute code in Python
- Document your code that supports mathematical equations
- Create/Upload/Share notebooks
- Import notebooks from your local machine
- Import/Publish notebooks from/to GitHub
- Import external datasets (e.g. from Kaggle)
- Integrate PyTorch, TensorFlow, Keras, OpenCV
- Share your projects
- Collaborate with your team
If you're a new startup with(<$1M raised,<3 years since founded) then you're in luck to be the part of our startup program!
Install the package from pypi:
When loading nbox for the first time, it will prompt you the username and password and create a secrets file at ~/.nbx/secrets.json.
This file then contains all the information that you donβt have to fetch manually again.
Our APIs are deep, user functions are kept to minimum and most relavant. This documentation contains the full spec of everything, but hereβs all the APIs you need to know:
nbox
βββ Model # Framework agnostic Model
β βββ __call__
β βββ deploy
β βββ train_on_instance (WIP)
β βββ train_on_jobs (WIP)
βββ Operators # How jobs are combinations of operators
β βββ __call__
β βββ deploy
βββ Jobs # For controlling all your jobs
β βββ logs # stream logs right on your terminal
β βββ trigger # manually trigger a job
βββ Instance
βββ __call__ # Run any command on the instance
βββ mv (WIP) # Move files to and from NBX-Build
Let's take this script as an example
from nbox import operator, Operator
from nbox.lib.shell import ShellCommand
# define your function and wrap it as an operator
@operator()
def foo(x: Dict):
return "bar"
# or use OO to deploy an API
@operator()
class Baz():
def __init__(self, power: int = 2):
# load any model that you want
self.model = load_tf_pt_model()
self.power = power
def forward(self, x: float = 1.0):
return {"pred": x ** self.power}
Through your CLI:
# to deploy a job
nbx jobs upload file:foo 'my_first_job'
# to deploy an API
nbx serve upload file:Baz 'my_first_api'
Join our discord and someone from our community or engineering team will respond!
πRead our Blog.
The code in thist repo is licensed as Apache License 2.0. Please check for individual repositories for licenses.