push command
Usage
Copy one or more runs to a remote location.
REMOTE must be define in ~/.guild/config.yml. See REMOTES
below for more information.
By default Guild will prompt you before copying. If you want to
apply the changes without being prompted, use the ‑‑yes
option.
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.
Remotes
Remotes are non-local systems that Guild can interact with. They
are defined in ~/.guild/config.yml under the remotes
section.
For a list of supported remotes, see https://guild.ai/docs/remotes/
Options
| -o, --operation VAL | Include runs with operations matching |
|---|---|
| -l, --label VAL | Include runs with labels matching |
| -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. |
| -n, --delete | Delete remote files missing locally. |
| -y, --yes | Do not prompt before copying. |
| --help | Show command help and exit. |