guild publish [OPTIONS] [RUN...]
Publish one or more runs.
By default, runs are published to ‘published-runs’ subdirectory. To specify a different location, use
A published run is a subdirectory of destination
DIR that contains run-specific files:
run.yml- run information (e.g. run ID, operation, status,
flags.yml- run flags
output.txt- run output written to stdout/stderr
scalars.csv- summary of run scalar values
files.csv- list of files associated with the run
code/- subdirectory containing project source code at the
time run was started
runfiles/- files associated with the run
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 is the start index and
END is the end index. Either
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
END are omitted (i.e. the
: char is used by itself) all runs are selected.
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.
--operation multiple times to include more runs.
--label to only include runs with labels containing a specified value. To select runs that do not contain a label, specify a dash ‘-’ for
--label multiple times to include more runs.
--tag to only include runs with a specified tag. Tags must match completely and are case sensitive.
--tag multiple times to include more runs.
--marked to only include marked runs.
--unmarked to only include unmarked runs. This option may not be used with
--filter to limit runs that match a filter expressions. Filter expressions compare run attributes, flag values, or scalars to target values. They may include multiple expressions with logical operators.
For example, to match runs with flag
batch-size equal to 100 that have
loss less than 0.8, use:
--filter 'batch-size = 10 and loss < 0.8'
IMPORTANT: You must quote EXPR if it contains spaces or characters that the shell uses (e.g. ‘<’ or ‘>’).
Target values may be numbers, strings or lists containing numbers and strings. Strings that contain spaces must be quoted, otherwise a target string values does not require quotes. Lists are defined using square braces where each item is separated by a comma.
Comparisons may use the following operators: ‘=’, ‘!=’ (or ‘<>’), ‘<’, ‘<=’, ‘>’, ‘>=’. Text comparisons may use ‘contains’ to test for case-insensitive string membership. A value may be tested for membership or not in a list using ‘in’ or ‘not in’ respectively. An value may be tested for undefined using ‘is undefined’ or defined using ‘is not undefined’.
Logical operators include ‘or’ and ‘and’. An expression may be negated by preceding it with ‘not’. Parentheses may be used to control the order of precedence when expressions are evaluated.
If a value reference matches more than one type of run information (e.g. a flag is named ‘label’, which is also a run attribute), the value is read in order of run attribute, then flag value, then scalar. To disambiguate the reference, use a prefix
scalar: as needed. For example, to filter using a flag value named ‘label’, use ‘flag:label’.
operation = train and acc > 0.9
operation = train and (acc > 0.9 or loss < 0.3)
batch-size = 100 or batch-size = 200
batch-size in [100,200]
batch-size not in [400,800]
batch-size is undefined
batch-size is not undefined
label contains best and operation not in [test,deploy]
status in [error,terminated]
NOTE: Comments and tags are not supported in filter expressions at this time. Use
--tag options along with filter expressions to further refine a selection.
--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:
--started 'last hour'
You can specify a time range using several different forms:
between DATETIME and DATETIME
last N minutes|hours|days
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
between DATETIME and DATETIME, values for
DATETIME may be specified in either order.
When specifying values like
hours the trailing
s may be omitted to improve readability. You may also use
min instead of
hr instead of
between 1-1 and 4-30
between 10:00 and 15:00
last 30 min
last 6 hours
3 weeks ago
To show runs for a specific source code digest, use
--digest with a complete or partial digest value.
Runs may also be filtered by specifying one or more status filters:
--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
You may combine more than one status character with
-S to expand the filter. For example,
-Set shows only runs with terminated or error status.
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.
||Destination to publish runs.|
||Run template used to publish runs.|
||Index template used to publish runs.|
||Publish default run files.|
||Publish all run files.|
||Include links when publishing files. Implies --files.|
||Do not calculate MD5 digests for run files.|
||Include batch runs.|
||Refresh runs index without publishing anything.|
||Filter runs using a filter expression. See Filter by Expression above for details…|
||Filter runs with operations matching
||Filter runs with labels matching VAL. To show unlabeled runs, use --unlabeled.|
||Filter only runs without labels.|
||Filter runs with TAG.|
||Filter runs with comments matching VAL.|
||Filter only marked runs.|
||Filter only unmarked runs.|
||Filter only runs started within RANGE. See above for valid time ranges.|
||Filter only runs with a matching source code digest.|
||Filter only runs that are still running.|
||Filter only completed runs.|
||Filter only runs that exited with an error.|
||Filter only runs terminated by the user.|
||Filter only pending runs.|
||Filter only staged runs.|
||Do not prompt before publishing.|
||Show this message and exit.|
Guild AI version 0.8.2