Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 25 additions & 6 deletions docs/cli.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
4 changes: 3 additions & 1 deletion docs/experiments.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading