sync command

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

Usage

guild sync [OPTIONS] [RUN...]

Synchronize remote runs.

A remote run is an operation that runs on another system. Guild keeps track of where each remote run is located and can synchronize with it. This includes downloading files generated by the run as well as updating run status.

By default, Guild synchronizes once with the remote run and exits. If you want to automatically synchronize with the run while watching its output, use the ‑‑watch option.

You can only watch one running operation at a time. If you don't specify a RUN with the ‑‑watch option, Guild will watch the most recently started running operation.

When a remote status stops (it finished successfully, is terminated, or exits with an error), Guild will no longer synchronize with it.

You can synchronize specific runs by selecting them using RUN arguments. For more information, see SELECTING RUNS and FILTERING topics below.

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.

Options

-w, --watch

Watch a remote run and synchronize in the background.

-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.

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