adpt

A command line tool for interacting with the Adaptive Platform.

Installation

MacOS

On ARM-based macs brew can be used:

brew install adaptive-ml/homebrew-tap/adpt

Windows

On x86-based Windows winget can be used:

winget install --source winget AdaptiveML.adpt

Everything else

cargo install adpt

Once installed an API key must be specified for use. This can be done using the ADAPTIVE_API_KEY environment variable, or alternatively stored in your operating system's keyring using the below command:

adpt set-api-key

Additionally your adaptive instance may be specified either via the ADAPTIVE_BASE_URL environment variable or via a configuration file as described in the configuration section below.

Completions

To set up completions for zsh run the following:

echo -e "\nsource <(COMPLETE=zsh adpt)" >> ~/.zshrc

Note that completions for things like recipe keys will only work when a default project is configured.

Usage

Specifying the project

Most commands require a --project option to specify the project:

adpt recipes --project my-project

However to avoid specifying this every time, the DEFAULT_USE_CASE environment variable or the default_project configuration file option.:

Setting API Key

Store your API key in the system keyring:

adpt set-api-key <your-api-key>

Running Recipes

Run a recipe by its ID or key:

adpt run <recipe-key-or-id>

Run a recipe with parameters from a JSON file:

adpt run my-recipe --parameters params.json

Run a recipe with custom settings:

adpt run my-recipe --name "My Custom Run" --compute-pool gpu-pool --num-gpus 4

Publishing Recipes

Publish a recipe from a file or a directory containing a main.py:

adpt publish /path/to/recipe-directory

Publish a recipe with a custom name and key:

adpt publish /path/to/recipe --name "My Recipe" --key my-recipe-key

Listing Recipes

List all available recipes:

adpt recipes

Uploading datasets

Upload a dataset:

adpt upload /path/to/dataset

Monitoring Jobs

Get the status of a specific job:

adpt job <job-id>

Follow a job's progress until completion:

adpt job <job-id> --follow

Configuration

Env file

Envionrment variables may be specified using a .env file in a parent folder.

Configuration File Locations

Configuration files are stored in platform-specific locations:

Configuration File Format

The configuration file uses TOML format and supports the following options:

# Default project for operations
default_project = "my-project"

# Base URL for the Adaptive platform
adaptive_base_url = "https://your-adaptive-instance.com"

API Key Storage

The API key can be provided in two ways (in order of priority):

1. Environment Variable: Set ADAPTIVE_API_KEY environment variable
2. System Keyring: Store securely using adpt set-api-key <your-key>