Skip to content

Commit 3f0e268

Browse files
authored
docs: update cli tool docs (#104)
1 parent 4aa58a8 commit 3f0e268

File tree

1 file changed

+12
-5
lines changed

1 file changed

+12
-5
lines changed

docs/source/tutorials/cli/index.rst

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -49,13 +49,20 @@ and has the following command line options:
4949
* `-b / --benchmarks`: *Optional* setting to specify which benchmarks to run. Accepts a
5050
list of benchmark names (e.g., `dihedral_scan`, `ring_planarity`) or `all` to
5151
run every available benchmark. Default: `all`. If the flag is omitted, all benchmarks
52-
run.
53-
* `--run-mode`: *Optional* setting that allows to run faster versions of the
52+
run. This is mutually exclusive with `-e`.
53+
* `-e / --exclude`: *Optional* setting to specify which benchmarks to exclude. Works
54+
in an analogous way to `-b` and is mutually exclusive with it.
55+
* `-rm / --run-mode`: *Optional* setting that allows to run faster versions of the
5456
benchmark suite. The default option `standard` which runs the entire suite.
5557
The option `fast` runs a slightly faster version. It runs less test cases for most
56-
benchmarks and it reduces the number of steps for benchmarks requiring long molecular dynamics simulations. The
57-
option `dev` runs a very minimal version of each benchmark for development and testing
58-
purposes. Benchmarks requiring molecular dynamics simulations are run with minimal steps.
58+
benchmarks and it reduces the number of steps for benchmarks requiring long molecular
59+
dynamics simulations. The option `dev` runs a very minimal version of each benchmark
60+
for development and testing purposes. Benchmarks requiring molecular dynamics
61+
simulations are run with minimal steps.
62+
* `-v / --verbose`: *Optional* flag to enable verbose logging
63+
from the `mlip <https://github.com/instadeepai/mlip>`_ library code.
64+
* `-lt / --log-timing`: *Optional* flag to enable logging of the run time for each
65+
benchmark.
5966

6067
For example, if you want to run the entire benchmark suite for two models, say
6168
`visnet_1` and `mace_2`, use this command:

0 commit comments

Comments
 (0)