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. |
|
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. |
|
Maintain/update Aim repository internal data formats. |
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. |
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 run hashes. At least one run should be specified. |
|
Copy run data for given run hashes. At least one run should be specified. |
|
Move run data for given run hashes. At least one run should be specified. |
|
Create a snapshot of |
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. |
$ aim runs upload [ARGS] ...
Args |
Description |
---|---|
|
Name of the cloud storage bucket. 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 Tensorboard logs. |
|
Convert from MLFlow logs. |
Sub-command: tensorboard
Options |
Description |
---|---|
|
Disregard context directory and treat them as distinct run directories. Inactive by default. |
|
Ignore previously cached results and process the logs entirely. Disabled 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 |
storage
Perform various maintenance operations on Aim repository.
$ aim storage [ARGS] SUBCOMMAND
Args |
Description |
---|---|
|
Path to parent directory of |
storage subcommands
Sub-command |
Description |
---|---|
|
Upgrades legacy Aim repository from |
|
Update metric sequence data format for given runs. At least one run should be specified. |
|
Rollback |
|
Update index to include all runs in Aim repo which are left in progress. |
|
Remove dangling params/sequences with no referring runs. |
Sub-command: update 2to3
$ aim storage 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 |
Sub-command: update 3.11+
$ aim storage upgrade 3.11+ [HASH] ...
Sub-command: restore
$ aim storage restore [HASH] ...
Sub-command: reindex
| Args | Description |
| ——————— | ———————————————————————————|
| --finalize-only
| Only finalize runs left in ‘in progress’ state. Do not attempt runs optimization.|
Sub-command: prune
$ aim storage prune
Aim status watcher CLI
Aim status CLI offers an interface to start training runs status monitoring and configure
how the notifications should be received. The entry point to this CLI is aim-watcher
:
$ aim-watcher [ARGS] SUBCOMMAND
Args |
Description |
---|---|
|
Path to parent directory of |
Sub-Commands |
Description |
---|---|
|
Start watcher service to monitor and report stuck/failed Runs. |
|
Configure how notifications should be received. |
start
Start watcher service for the given aim Repo
.
aim-watcher --repo . start
notifiers
Manipulate notifiers configuration.
notifiers subcommands
$ aim-watcher notifiers add
$ aim-watcher notifiers list
$ aim-watcher notifiers remove [NOTIFIER_ID]
$ aim-watcher notifiers disable [NOTIFIER_ID]
$ aim-watcher notifiers enable [NOTIFIER_ID]