qanat experiment

Command information

qanat experiment

Experiment-level utility

Usage

qanat experiment [OPTIONS] COMMAND [ARGS]...

action

Run an action on a run of an experiment. Additional option args can be passed to the action after experiment and action name.

Usage

qanat experiment action [OPTIONS] EXPERIMENT_NAME ACTION_NAME RUN_ID

Options

--group_no <group_no>

Group number to run action on when several groups are present in the run.

Arguments

EXPERIMENT_NAME

Required argument

ACTION_NAME

Required argument

RUN_ID

Required argument

delete

Delete experiment.

Usage

qanat experiment delete [OPTIONS] NAME

Arguments

NAME

Required argument

list

Show list of experiments in this repertory.

Usage

qanat experiment list [OPTIONS]

new

Create new experiment.

Usage

qanat experiment new [OPTIONS]

Options

-p, --prompt

Prompt for adding experiment.

-f, --file <file>

Path to a YAML filecontaining the experiment definition.

rerun

Rerun a single run with exact same environment and paraeters.

Usage

qanat experiment rerun [OPTIONS] NAME RUN_ID

Arguments

NAME

Required argument

RUN_ID

Required argument

run

Run an experiment with additional positional and option args.

WARNING: The following options are not available for your executable command:

  • –runner to specify runner

  • –container to specify container

  • –n_threads for local runner, number of threads to use when several groups of parameters.

  • –submit_template for htcondor runner, path to the submit template to use or name of the submit template in the config file.

  • –wait for htcondor runner, wait for the experiment to finish.

  • –param_file to specify a file containing parameters to run as a single run.

  • –group_param to specify group of parameters to run as the same run.

  • –range_param to specify to create groups of parameters as a range. Syntax is: -r ‘–param start end step’.

  • –storage_path to override storage path for the run of the experiment.

  • –tag to add tag to the run of the experiment.

  • –description to add description to the run of the experiment.

  • –commit_sha to run at a specific commit.

  • –dry_run to show parameters without running the experiment.

Usage

qanat experiment run [OPTIONS] NAME

Options

-r, --runner <runner>

Runner to use for experiment.

Default:

'local'

Options:

local | htcondor | slurm

--container <container>

Container to use for experiment.

-f, --param_file <param_file>

File containing params to run experiment (one per line).

-g, --group_param <group_param>

Group of parameters to run.

-R, --range_param <range_param>

Range for a single parameter.

--storage_path <storage_path>

Path to store results.

-t, --tag <tag>

Tag to assing this run

--description <description>

Description of this run.

--commit_sha <commit_sha>

Commit sha to use for this run.

--dry_run

Dry run, do not run experiment but show parameters.

Arguments

NAME

Required argument

run_comment

Comment run of an experiment.

Usage

qanat experiment run_comment [OPTIONS] EXPERIMENT_NAME RUN_ID

Arguments

EXPERIMENT_NAME

Required argument

RUN_ID

Required argument

run_delete

Delete run of experiment.

Usage

qanat experiment run_delete [OPTIONS] EXPERIMENT_NAME RUN_ID

Arguments

EXPERIMENT_NAME

Required argument

RUN_ID

Required argument

run_explore

Explore run of an experiment.

Usage

qanat experiment run_explore [OPTIONS] EXPERIMENT_NAME [RUN_ID]

Arguments

EXPERIMENT_NAME

Required argument

RUN_ID

Optional argument

status

Show status of all runs.

Usage

qanat experiment status [OPTIONS] NAME

Options

--live

Show live status of runs.

Arguments

NAME

Required argument

update

Update experiment.

Usage

qanat experiment update [OPTIONS] NAME

Arguments

NAME

Required argument

Command description

This command is used to create, manage (update, delete), run experiments.