Using Notebooks
Create a Notebook
Choose your Base Container
Notebooks can be created by clicking Create Notebook button on the Notebooks tab. There are three types of base containers:
Recommended Containers (Basic)
These are the templates that are most popular on Gradient. They include the most common ML frameworks and libraries. Click here to discover which Notebook Base Container will best suit your use case, then choose it from the options below:
All Containers (Basic)
These are additional templates that are made available in Gradient as a 1-click option. Click here to discover which Notebook Base Container will best suit your use case, then choose it from the options below:
Custom Containers (Advanced)
If you need to import an existing container, visit the Custom Containers section. Learn more here.
Choose the instance type
This is instance type that your notebook will run on. Our hardware is configured to work with the tools and packages in each of the provided containers.
Optional Settings:
Name your Notebook
Provide a friendly name for your Notebook in the text field
Auto-shutdown
If you have a Gradient subscription, you will have the ability to set a custom auto-shutdown interval.
Workspace
Additionally, you have the option to select a remote Github repository to serve as the starting point for your Notebook. If the repository is private, you need to provide access credentials (username and a password/apiKey). Also, you can provide an optional Github ref that points to a specific version of the repository.
Click Create
That's it! Your Notebook will start once it has been created 🚀
Once created, your Notebook will automatically start. Just click Open and your Notebook will appear in a new browser tab.
Create a Notebook
Syntax
gradient notebooks create [options...]Notebook Parameters Basics
Machine Type: Such as
--P100or--C7or--TPUContainer: Such as
--tensorflow/tensorflow:1.5.1-gpu
Example Use
Usage: gradient notebooks create \
--name "my job" \
--container "http://dockerhub.com/mycontainer" \
--machineType "P5000" \
--command "/paperspace/run.sh"
--projectId "someProjectID"Notebook Parameters Complete List
Argument
Description
name
Notebook name
projectId
Project ID
machineType
An optional machine type to run the job on: either 'GPU+', 'P4000', 'P5000', 'P6000', 'V100', 'K80', 'P100', or 'TPU'. [Required]
container
A reference to a docker image in a public or private docker registry. Docker image repository references must be in lowercase and may include a tag and a hostname prefix followed by a slash; if committed the hostname defaults to that of the public Docker Hub registry. An example docker image reference: docker.io/mynamespace/myimage:mytag. A container name may be mixed case. [Required]
containerUser
Container user
command
Command (executed as /bin/sh -c 'YOUR COMMAND')
clusterId
ID of the cluster to run the notebook.
registryUsername
Registry username
registryPassword
Registry password
shutdownTimeout
Shutdown timeout in hours
isPreemptible
Use a preemptible instance type
tag
One or multiple tags that you want to add to the notebook
workspace
S3 url or git repository. Directory uploads
are not yet supportedapiKey
workspacePassword
Workspace password
workspaceRef
Git commit hash, branch name or tag
environment
Environment variables
shutdownTimeout
Shutdown timeout in hours
apiKey
API key to use this time only
Start a Notebook
Start a stopped notebook again. The notebook can be started on a different cluster or machine type.
Syntax
gradient notebooks start [options...]Options:
Option
Description
id
Notebook ID [required]
machineType
Virtual Machine type label e.g. P5000 [required]
clusterId
Cluster ID
name
Notebook name
shutdownTimeout
Shutdown timeout in hours
Rename a Notebook
You can rename any Notebook, whether it is running or stopped, in order to help organize your work. Simply click on the notebook name and it will become an editable text field; press enter to commit the change:
Last updated