Learn how to install the Gradient Python CLI.
Learn how to install the Gradient Python CLI and run your first remote workloads from your local computer.
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.
Pro Tip! We highly recommend installing and using the CLI within a Python virtual environment. This will minimize conflicts with existing libraries on your computer. We recommend virtualenv. See below for more instructions.
Using pip to install the latest stable release
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 include your API key with each command:
gradient experiments run ... --apiKey XXXXXXXXXXXXXXXXXXX
Note: You can reveal your current API key with cat ~/.paperspace/config.json
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+
First, install virtualenv:
pip install virtualenv
Create a new virtual environment:
python3 -m virtualenv <virtual_env_dir_path>
Activate the virtual environment:
pip install -U --pre gradient