3. Usage

3.1. Run Noodles

noodles <command_type> <path_to_spec>

Noodles only uses one command type and one spec file at a time. The command type is simply a key in the spec file to serve for different purposes.

3.2. Choose Only Some Experiments

Noodles can run only some experiments when a filter string is specified as follows:

noodles <command_type> <path_to_spec>:<filter_experiments>

<filter_experiments> is a comma-separated string composed of experiment names. For example, the command would be like this when we only want to run experiments exp1 and exp3:

noodles run spec.yaml:exp1,exp3

3.3. Command Types

We may need different command types for the same experiment, for example, we may need to run and stop the same experiment. We should write different commands under two keys run and stop in the spec file.

Then we can run the experiments like this:

noodles run spec.yml
...
noodles stop spec.yml

3.4. Spec File

The spec file should be written in YAML. We’ll introduce the how write a minimalist spec file in the next topic Write a Minimalist Spec File.

3.5. Debug

If something didn’t go as expected, Noodles provides extra arguments to provide verbose and debugging messages, including how the commands are executed and what environment variables are given.

Add two extra arguments like this:

noodles run spec.yml --verbose --debug