Command: tensorboard

Usage

guild tensorboard [OPTIONS] [RUN...]

Visualize runs with TensorBoard.

This command will start a TensorBoard process and open a browser window for you. TensorBoard will show the views that are selected using the commands filters. This list corresponds to the the runs shown when running guild runs.

This command will not exit until you type Ctrl-c to stop it.

If you’d like to change the filters used to select runs, stop the command and re-run it with a different set of filters. You may alternatively start another instance of TensorBoard in a separate console.

TensorBoard will automatically refresh with the current run data.

If you’re prefer that Guild not open a browser window, run the command with the --no-open option.

By default, Guild will start the TensorBoard process on a randomly selected free port. If you’d like to specify the port that TensorBoard runs on, use the --port option.

Guild will not include batch runs by default. To include batch runs, use --include-batch.

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.

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.

Options

-h, --host HOST Name of host interface to listen on.
-p, --port PORT Port to listen on.
--include-batch Include batch runs.
--refresh-interval SECONDS Refresh interval (defaults to 5 seconds).
--run-name-flags FLAGS Comma or space delimited list of flags used for run names.
-n, --no-open Don’t open TensorBoard in a browser.
-O OPTION=VALUE An option that is passed through to TensorBoard as --OPTION=VALUE. May be used multiple times.
--skip-images Don’t include run images as TF summaries.
--skip-hparams Don’t generate HParam TF summaries.
--tab TAB Open with an initially selected tab.
-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.
--help Show this message and exit.

Guild AI version 0.7.0.post1