Comment on page

Install the Sync-CLI

Install the Sync-CLI on your local machine to help setup the rest of the Gradient installation process. The Sync-CLI also enables other advanced functions with Gradient.
Network restrictions: If your company restricts non whitelisted external IP addresses from your Databricks clusters, be sure to request permission to access:

Step 1: Setting up your Environment

Start by making sure your environment meets all the prerequisites. The Gradient CLI is actually part of the Sync Library, which requires Python v3.7 or above and which only runs on Linux/Unix based systems.
python --version

Step 2: Create a virtual environment

This is a good practice for whenever you install any new Python tool, as it allows you to avoid conflicts between projects and makes environment management simpler.
Here, we will create a virtual environment called gradient-cli that will reside under the ~/VirtualEnvironments path.
python -m venv ~/VirtualEnvironments/gradient-cli

Step 3: Install the Sync Library

Activating your new virtual environment.
source ~/VirtualEnvironments/gradient-cli/bin/activate
Next use the pip package installer to install the latest version of the Sync Library.
pip install -I
You can confirm that the installation was successful by viewing the CLI executable’s version by using the –version or –help options.
sync-cli --help

Step 4. Configure the Sync Library

Configuring the CLI with your credentials and preferences is the final step for the installation and setup for the Sync CLI. To do this, run the configure command:
sync-cli configure
You will be prompted for the following values:
Sync API key ID:
Sync API key secret:
Default prediction preference (performance, balanced, economy) [economy]:
Would you like to configure a Databricks workspace? [y/n]:
Databricks host (prefix with https://):
Databricks token:
Databricks AWS region name: