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
Using pip to install the latest prerelease
pip install -U --pre 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 include your API key with each command:
gradient experiments run ... --apiKey XXXXXXXXXXXXXXXXXXX
Note: You can reveal your current API key with
First, sign in to your Paperspace account. On the left of your home console, you will 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.
Add 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