Paperspace has a GUI to more easily build Jobs on Gradient. If you prefer to use a CLI environment to submit your Jobs, follow these steps:
Before you can use this tool, you'll need a Paperspace account. You'll use this account to obtain Paperspace API keys.
Prerequisite: Your system will need Node.js v8+ installed. Check that you have a recent enough version by running
node -v in your terminal. Node.js comes bundled with
npm, the Node.js package management tool, which you'll use to install this package.
Option 1: Using pre-built binaries
Pre-built binaries are available for Windows, Mac, and Linux. These binaries enable you to run the paperspace-node command line tool without having to install Nodejs or any additional node modules. Be sure to add the directory where the binary is installed to your path.
Option 2: Install the package from npm
$ npm install -g paperspace-node
We recommend installing this globally is so the
paperspace command will be available on your command line everywhere on your system. If you only want to make it available within an individual Node.js project, you can install it locally by omitting the
-g flag. Be sure to also add this directory to your path.
2. Obtaining an API key
First, sign in to your Paperspace account. On the left of your home console, you should find an 'API' section. There, you'll find a form where you can create API keys. You'll use the API keys you generate here to authenticate your requests.
3. Initialize a project directory
You can create a job by going in to any directory and typing
paperspace project init which will initialize a namespace with the current directory's name.
4. Submit a job
You are now ready to run a job (even without any code!). You can run:
paperspace jobs create --container Test-Container --command "nvidia-smi"
Your job will get uploaded to our cluster of machines. Behind the scenes, we are zipping the current working directory, creating a Docker container, and running the command you provided.
Note: the zipped upload of your working directory is limited to 100MB
5. Check your progress
Jobs can output in two ways: First, they can produce log output. For example, you should see the output of `nvidia-smi` by running paperspace jobs logs --tail. You can also check the console GUI to view the log output.
The second way your job can create output is by adding any file to the `/artifacts` directory within the container. After your job has completed (during the "teardown" process) we upload these files to a secure location. You can see these files in the web console or download them directly through the CLI.