From 39c384e66465c43de800268d351e54409b850963 Mon Sep 17 00:00:00 2001 From: Victor Morand Date: Tue, 2 Sep 2025 17:47:27 +0200 Subject: [PATCH] update CLI documentation --- docs/cli.md | 31 +++++++++++++++++++++++++------ docs/experiments.md | 4 +++- 2 files changed, 28 insertions(+), 7 deletions(-) diff --git a/docs/cli.md b/docs/cli.md index bfe874a0..04fe2f9a 100644 --- a/docs/cli.md +++ b/docs/cli.md @@ -1,18 +1,37 @@ # Command Line Interface +## Running Experiments + +here is the general command used to launch experiments: + +`experimaestro run-experiment --run-mode NORMAL --workspace workspace-id some_xp_params.yaml` + +Use `experimaestro jobs --help` for more details. + +Let's detail some important parts: + +### Run modes + +`experimaestro run-experiment --run-mode [DRY_RUN|NORMAL|GENERATE_ONLY] ` + +Several run modes are possible: +- `DRY_RUN` will not launch any Task, but display task hashes and dependencies +- `GENERATE_ONLY` will generate jobs folder without [launching](./launchers/index.md) tasks. +- `NORMAL` will both generate and launch the jobs, effectively running the experiment. + +Use `experimaestro run-experiment --help` for more details. + ## Job Control Besides the web interface, it is possible to use the command line to check the job status and control jobs: -- ``experimaestro jobs list` list jobs +- `experimaestro jobs list` list jobs - `experimaestro jobs clean` cleans jobs -- ``experimaestro jobs kill` allows to kill running jobs -- ``experimaestro jobs log` show the stdout/stderr of a given job -- ``experimaestro jobs path` returns the full path for a given job - +- `experimaestro jobs kill` allows to kill running jobs +- `experimaestro jobs log` show the stdout/stderr of a given job +- `experimaestro jobs path` returns the full path for a given job -Use `experimaestro jobs --help` for more details. ## Filters diff --git a/docs/experiments.md b/docs/experiments.md index d5b7ba71..35e99cff 100644 --- a/docs/experiments.md +++ b/docs/experiments.md @@ -59,9 +59,11 @@ With `full.yaml` located in the same folder as `experiment.py` The experiment can be started with ```sh - experimaestro run-experiment --run-mode normal full.yaml + experimaestro run-experiment --run-mode NORMAL full.yaml ``` +See the [CLI documentation](cli.md#running-experiments) for more details + ### Experiment code in a module The Python path can be set by the configuration file, and module be used instead