The CLI

python -m gatle_ignite <cmd> is equivalent to gatle-ignite <cmd>. Use that form under SLURM.

usage: gatle-ignite [-h] [--version] {init,train,config,eval} ...

The gatle-ignite command line.

    gatle-ignite init   my_project                      # write a new project, then cd into it
    gatle-ignite train  --config=path/to/config.py [--override k=v ...]
    gatle-ignite eval   --config=path/to/config.py [--ckpt best|latest]
    gatle-ignite config --config=path/to/config.py     # resolve + validate, print, exit

`python -m gatle_ignite <cmd>` is equivalent, which is the form to use under SLURM.

positional arguments:
  {init,train,config,eval}
    init                Write a new project skeleton.
    train               Train a config.
    config              Resolve and validate a config, then print it.
    eval                Load a checkpoint and evaluate.

options:
  -h, --help            show this help message and exit
  --version             show program's version number and exit

gatle-ignite init

usage: gatle-ignite init [-h] [--dir DIRECTORY] [--force] name

positional arguments:
  name             Project name. Must be a valid Python identifier: it becomes
                   a directory that gets imported, and the prefix is dropped
                   from your config's dotted paths.

options:
  -h, --help       show this help message and exit
  --dir DIRECTORY  Where to create it. Default: the current directory.
  --force          Overwrite existing files. Never deletes anything.

gatle-ignite train

usage: gatle-ignite train [-h] --config CONFIG [--override KEY=VALUE]

options:
  -h, --help            show this help message and exit
  --config CONFIG       Path to a .py defining get_config(). Comma-separated
                        paths run in parallel.
  --override KEY=VALUE  Override an existing config field. Repeatable.

gatle-ignite config

usage: gatle-ignite config [-h] --config CONFIG [--override KEY=VALUE]

options:
  -h, --help            show this help message and exit
  --config CONFIG       Path to a .py defining get_config(). Comma-separated
                        paths run in parallel.
  --override KEY=VALUE  Override an existing config field. Repeatable.

gatle-ignite eval

usage: gatle-ignite eval [-h] --config CONFIG [--override KEY=VALUE]
                         [--ckpt {best,latest}]

options:
  -h, --help            show this help message and exit
  --config CONFIG       Path to a .py defining get_config(). Comma-separated
                        paths run in parallel.
  --override KEY=VALUE  Override an existing config field. Repeatable.
  --ckpt {best,latest}  Which checkpoint to load: the highest-scoring
                        valid_best_result* (best), or the newest latest_epoch*
                        (latest).