Command: label

Usage

guild label [OPTIONS] [RUN...]

Set run labels.

The label action may be specified using one of three mutually exclusive options: --label, --prepend, or --append. --label sets the entire run label. --prepend appends the specified value to the existing label, and --append appends the value.

Use --remove to remove the specified value from a label, if it exists. Use --clear to remove the entire label.

--tag and --untag are aliases for --prepend and --remove respectively.

Specify runs to modify using one or more RUN arguments. See SPECIFYING RUNS for more information.

If RUN is not specified, the most recent run is selected.

By default Guild will prompt you before making any changes. If you want to apply the changes without being prompted, use the --yes option.

Specify Runs

You may use one or more RUN arguments to indicate which runs apply to the command. 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, 0 is assumed (the most recent run).

Filter by Operation or 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.

Use --marked to only include marked runs.

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

Filter by Run Start Time

Use --started to limit runs to those that have started within a specified time range.

IMPORTANT: You must quote RANGE values that contain spaces. For example, to filter runs started within the last hour, use the option:

--selected 'last hour'

You can specify a time range using several different forms:


after DATETIME
before DATETIME
between DATETIME and DATETIME
last N minutes|hours|days
today|yesterday
this week|month|year
last week|month|year
N days|weeks|months|years ago

DATETIME may be specified as a date in the format YY-MM-DD (the leading YY- may be omitted) or as a time in the format HH:MM (24 hour clock). A date and time may be specified together as DATE TIME.

When using between DATETIME and DATETIME, values for DATETIME may be specified in either order.

When specifying values like minutes and hours the training s may be omitted to improve readability. You may also use min instead of minutes and hr instead of hours.

Examples:


after 7-1
after 9:00
between 1-1 and 4-30
between 10:00 and 15:00
last 30 min
last 6 hours
today
this week
last month
3 weeks ago

Filter by Source Code Digest

To show runs for a specific source code digest, use -g or --digest with a complete or partial digest value.

Label Remote Runs

To label remote runs, use --remote.

REMOTE is the name of a configured remote. Use guild remotes to list available remotes.

For information on configuring remotes, see guild remotes.

Options

-s, --set VAL Set VAL as label.
-p, -t, --prepend, --tag VAL Prepend VAL to existing label.
-a, --append VAL Append VAL to existing label.
-rm, -u, --remove, --untag VAL Remove VAL from existing label. May be used multiple times.
-c, --clear Clear the entire run label.
-o, --operation VAL Filter runs with operations matching VAL.
-l, --label VAL Filter runs with labels matching VAL.
-U, --unlabeled Filter only runs without labels.
-M, --marked Filter only marked runs.
-N, --unmarked Filter only unmarked runs.
-R, --running Filter only runs that are still running.
-C, --completed Filter only completed runs.
-E, --error Filter only runs that exited with an error.
-T, --terminated Filter only runs terminated by the user.
-P, --pending Filter only pending runs.
-G, --staged Filter only staged runs.
-S, --started RANGE Filter only runs started within RANGE. See above for valid time ranges.
-D, --digest VAL Filter only runs with a matching source code digest.
-r, --remote REMOTE Label remote runs.
-y, --yes Do not prompt before modifying labels.
--help Show this message and exit.

Guild AI version 0.7.0.post1