compare command

  1. Usage
    1. Selecting runs
    2. Filtering by operation and label
    3. Filtering by run status
  2. Options

Usage

guild compare [OPTIONS] [RUN...]

Compare run results.

Guild Compare is a console based application that displays a table of runs with their current accuracy and loss. The application will continue to run until you exit it by pressing q (for quit).

Guild Compare supports a number of commands. Commands are activated by pressing a letter. To view the list of commands, press ?.

Guild Compare does not automatically update to display the latest available data. If you want to update the list of runs and their status, press r (for refresh).

You may alternative use this command to generate CSV output for run. Use the ‑‑csv option to print data to standard output instead of running as an application. You can redirect this output to a file using:

guild compare ‑‑csv > RUNS.csv

Selecting runs

You may use one or more RUN arguments to limit the runs that are selected. RUN may be a run ID, a run ID prefix, or a one-based index corresponding to a run returned by the list command.

Indexes may also be specified in ranges in the form START:END where START is the start index and END is the end index. Either START or END may be omitted. If START is omitted, all runs up to END are selected. If END id omitted, all runs from START on are selected. If both START and END are omitted (i.e. the : char is used by itself) all runs are selected.

If a RUN argument is not specified, : is assumed (all runs are selected).

Filtering by operation and label

Runs may be filtered by operation using ‑‑operation. A run is only included if any part of its full operation name, including the package and model name, matches the value.

Use ‑‑label to only include runs with labels matching a specified value.

‑‑operation and ‑‑label may be used multiple times to expand the runs that are included.

Use ‑‑unlabeled to only include runs without labels. This option may not be used with ‑‑label.

Filtering by run status

Runs may also be filtered by specifying one or more status filters: ‑‑running, ‑‑completed, ‑‑error, and ‑‑terminated. These may be used together to include runs that match any of the filters. For example to only include runs that were either terminated or exited with an error, use ‑‑terminated ‑‑error, or the short form ‑ET.

Status filters are applied before RUN indexes are resolved. For example, a run index of 1 is the latest run that matches the status filters.

Options

-o, --operation VAL

Include runs with operations matching VAL.

-l, --label VAL

Include runs with labels matching VAL.

-u, --unlabeled

Include only runs without labels.

-R, --running

Include only runs that are still running.

-C, --completed

Include only completed runs.

-E, --error

Include only runs that exited with an error.

-T, --terminated

Include only runs terminated by the user.

-t, --table

Generate comparison data as a table.

-c, --csv

Generate comparison data as a CSV file.

--help Show command help and exit.
Guild AI version 0.5.1