The Gradient CLI is available on pypi and works on Windows, MacOS, and Linux.
The CLI requires Python 3.4+ (or Python 2.7). Be sure to use a compatible version of pip (or pip3) depending on your Python version.
pip install -U gradient
You can either stash your API key on your computer or include your API key on each command.
First, obtain an API Key, and then:
gradient apiKey XXXXXXXXXXXXXXXXXXX
Alternatively, you can set the environment variable
PAPERSPACE_API_KEY temporarily to override your configured api key.
export PAPERSPACE_API_KEY=XXXXgradient experiments run ...
Note: You can reveal your current API key with
Sign in to your Paperspace account and create a new API key. You'll use the API keys you generate here to authenticate your requests.
For Python 3.4+
pip install virtualenv
Create a new virtual environment:
python3 -m virtualenv <virtual_env_dir_path>
Activate the virtual environment:
Add the following to your
.zshrc) to enable autocomplete anytime you activate your shell. If gradient was installed in a virtual environment, the following has to be added to the
eval "$(_GRADIENT_COMPLETE=source gradient)"
Alternatively, you can create activation script by:
(_GRADIENT_COMPLETE=source gradient) > ~/paperspace_complete.sh
and then add
. ~/paperspace_complete.sh to your
pip install -U --pre gradient