Aim CLI
Aim CLI offers a simple interface to easily organize and record your experiments. Paired with the Python Library, Aim is a powerful utility to record, search and compare AI experiments. Here are the set of commands supported:
Command |
Description |
---|---|
|
Initialize the |
|
Displays the version of aim cli currently installed. |
|
Runs Aim web UI for the given repo. |
|
Upgrades legacy Aim repository from |
|
Process runs left in ‘in progress’ state and optimized finished runs. |
|
Run |
|
Manage run data for the given repo. |
|
Tool-set for converting 3rd party data into Aim readable format. |
init
**This step is optional.** Initialize the aim repo to record the experiments.
$ aim init
Creates .aim
directory to save the recorded experiments to. Running aim init
in an existing repository will prompt
the user for re-initialization.
Args |
Description |
---|---|
|
Path to parent directory of |
**Beware:** Re-initialization of the repo clears .aim
folder from previously saved data and initializes new repo.
**Note:** This command is not necessary to be able to get started with Aim as aim is automatically initializes with
the first aim function call.
version
Display the Aim version installed.
$ aim version
up
Start the Aim web UI locally.
$ aim up [ARGS]
Args |
Description |
---|---|
|
Specify host address. |
|
Specify port to listen to. |
|
Path to parent directory of |
|
Run UI in development mode. |
|
Enables API profiling which logs run trace inside |
|
Specifies log level for python logging package. ``WARNING`` by default, ``DEBUG`` when ``–dev`` option is provided. |
upgrade
Upgrade Aim repository containing data logged with older version of Aim.
$ aim upgrade [ARGS] SUBCOMMAND
Args |
Description |
---|---|
|
Path to parent directory of |
upgrade subcommands
Upgrade aim
repository from 2.x
to 3.0
.
$ aim ugrade 2to3 [ARGS]
Args |
Description |
---|---|
|
Use this flag to skip runs which are failed/have missing or incomplete data. |
|
Use this flag to skip new repository consistency checks. |
|
Use this flag to clear old |
reindex
Update index to include all runs in Aim repo which are left in progress.
$ aim reindex [ARGS]
Args |
Description |
---|---|
|
Path to parent directory of |
|
Only finalize runs left in ‘in progress’ state. Do not attempt runs optimization. |
server
Run a gRPC server to collect tracked data from remote clients.
$ aim server [ARGS]
Args |
Description |
---|---|
|
Path to parent directory of |
|
Specify host address. |
|
Specify port to listen to. Default is 53800. |
|
Specify number of gPRC workers. Default is 1 worker. |
|
Specify path to keyfile for secure connection. |
|
Specify path to cert. file for secure connection. |
|
Specifies log level for python logging package. ``WARNING`` by default. |
runs
Upgrade Aim repository runs data.
$ aim runs [ARGS] SUBCOMMAND
Args |
Description |
---|---|
|
Path to parent directory of |
runs subcommands
Sub-command |
Description |
---|---|
|
List runs in |
|
Remove run data for given runs hashes. At lease one run should be specified. |
|
Copy run data for given runs hashes. At lease one run should be specified. |
|
Move run data for given runs hashes. At lease one run should be specified. |
Global expression (*
) support is available for run hashes. If hash contains *
, it must be enclosed within
quotes (''
) as bash resolves the expression before passing it to aim runs
command.
$ aim runs ls
$ aim runs rm [HASH] ...
$ aim runs cp [ARGS] [HASH] ...
Args |
Description |
---|---|
|
Path to destination repo. Required. |
$ aim runs mv [ARGS] [HASH] ...
Args |
Description |
---|---|
|
Path to destination repo. Required. |
convert
Tool-set for converting 3rd party data into Aim readable format.
$ aim convert [ARGS] SUBCOMMAND
Args |
Description |
---|---|
|
Path to parent directory of |
convert subcommands
Sub-command |
Description |
---|---|
|
Convert from TensorFlow events. |
|
Convert from MLFlow logs. |
Sub-command: tf
Options |
Description |
---|---|
|
Disregard context directory and treat them as distinct run directories. Inactive by default. |
Sub-command: mlflow
Options |
Description |
---|---|
|
MLFlow logs URI. Can be either an HTTP/HTTPS URI for a remote server, a database connection string, or a local path. |
|
MLFlow Experiment name. If specified, only runs for |