Skip to main content

AIchor CLI user guide

AIchor CLI is a command-line interface for interacting with the AIchor service. This CLI allows users to log in, retrieve information about projects and experiments, set default projects, resubmit experiments, and trigger experiments from a local package.

Installation

Prerequisite:

Ensure you have Python3 installed on your system. You can download it from python.org.

  • Install virtualenv:
pip install virtualenv
  • Test your installation:
virtualenv --version

Create and activate a virtual environment:

On Windows:

python -m venv <virtual_environment>
<virtual_environment>\Scripts\activate

On Linux/MacOS:

python3 -m venv <virtual_environment>
source <virtual_environment>/bin/activate

Install

  • Install AIchor CLI:
pip install --extra-index-url https://europe-west4-python.pkg.dev/aichor-test-pof1/aichor-public-pypi/simple aichor-cli

Usage

To use AIchor CLI, run the following command:

aichor

An output similar to the following should be displayed:

Usage: aichor [OPTIONS] COMMAND [ARGS]...

  AIchor CLI for managing experiments.

Options:
  --version  Show the version and exit.
  --help     Show this message and exit.

Commands:
  configure  Configure Token
  generate   Generate Storage Credentials
  get        Display ressources
  login      Login to access Aichor
  resubmit   Resubmit an experiment
  set        Set Default Project
  submit     Submit an experiment manually triggered

Available Commands

Now you can perform actions on projects and experiments:

  • Login to AIchor with:
aichor login
  • If you are unable to login, you can manually configure your access token with:
aichor configure
  • Set a default project with:
aichor set project --project-id <project_id>

Note: It is necessary to set a default project to proceed with your actions. Alternatively, you can specify the project ID each time you execute a command.

  • Retrieve projects with:
aichor get projects [options]
  • Retrieve experiments with:
aichor get experiments [options]
  • Resubmit experiments with:
aichor resubmit experiments [options]

Replace [options] with appropriate options such as --project-id <project_id> or --experiment-id <experiment_id> as needed

  • Submit an experiment from a local package with:
aichor submit experiment --project-name <project_name> --repo-dir <repo_path> --message <commit_message>
  • Generate Storage Credentials for Buckets with:
aichor generate storage-credentials --project-id <project_id>