Commands#

The Tango CLI is the recommended tool to run experiments with. It also comes with several other useful commands.

You can see the the list of all available commands by running:

$ tango --help
Usage: tango [OPTIONS] COMMAND [ARGS]...

Options:
  --version                       Show the version and exit.
  --settings FILE                 Path to a global tango.yml settings file.
  --log-level [debug|info|warning|error]
                                  Set the global log level.
  --file-friendly-logging         Outputs progress bar status on separate lines and slows refresh rate.
  --start-method [fork|spawn|forkserver]
                                  Set the multiprocessing start method.
  --help                          Show this message and exit.

Commands:
  info      Get info about the current tango installation.
  run       Run a tango experiment.
  server    Run a local webserver that watches a workspace.
  settings  Commands for initializing and updating global settings.

To see all of the available arguments and options for a particular command, run

$ tango [COMMAND] --help

For example,

$ tango run --help

tango run#

The run command is used to execute a tango experiment from an experiment configuration file. See the Configuration files section in the overview for a quick introduction to the format.

tango info#

The info command just prints out some useful information about the current tango installation, such as which integrations are available.

tango server#

The server command spins up a web server that watches a workspace. You can use this to track the progress of your runs while they are happening.

tango settings#

The settings group of commands can be used to initialize a TangoGlobalSettings file or update fields in it.