.TH "GCLOUD_ALPHA_AI_TENSORBOARD\-RUNS_UPDATE" 1



.SH "NAME"
.HP
gcloud alpha ai tensorboard\-runs update \- update an existing Vertex AI Tensorboard run



.SH "SYNOPSIS"
.HP
\f5gcloud alpha ai tensorboard\-runs update\fR (\fITENSORBOARD_RUN\fR\ :\ \fB\-\-region\fR=\fIREGION\fR\ \fB\-\-tensorboard\-experiment\-id\fR=\fITENSORBOARD_EXPERIMENT_ID\fR\ \fB\-\-tensorboard\-id\fR=\fITENSORBOARD_ID\fR) [\fB\-\-description\fR=\fIDESCRIPTION\fR] [\fB\-\-display\-name\fR=\fIDISPLAY_NAME\fR] [\fB\-\-update\-labels\fR=[\fIKEY\fR=\fIVALUE\fR,...]] [\fB\-\-clear\-labels\fR\ |\ \fB\-\-remove\-labels\fR=[\fIKEY\fR,...]] [\fIGCLOUD_WIDE_FLAG\ ...\fR]



.SH "DESCRIPTION"

\fB(ALPHA)\fR Update an existing Vertex AI Tensorboard run.



.SH "EXAMPLES"

To update Tensorboard Time Run \f5my\-tensorboard\-run\fR in Tensorboard
\f512345\fR, Tensorboard Experiment \f5my\-tensorboard\-experiment\fR, with the
display name \f5updated display name\fR:

.RS 2m
$ gcloud alpha ai tensorboard\-runs update \e
  projects/my\-project/locations/us\-central1/tensorboards/12345/\e
experiments/my\-tensorboard\-experiment/runs/my\-tensorboard\-run \e
    \-\-display\-name="updated display name"
.RE

Or with flags:

.RS 2m
$ gcloud alpha ai tensorboard\-runs update my\-tensorboard\-run \e
  \-\-tensorboard\-id=12345 \e
  \-\-tensorboard\-experiment\-id=my\-tensorboard\-experiment \e
  \-\-display\-name="updated display name"
.RE



.SH "POSITIONAL ARGUMENTS"

.RS 2m
.TP 2m

Tensorboard run resource \- The Tensorboard run to update. The arguments in this
group can be used to specify the attributes of this resource. (NOTE) Some
attributes are not given arguments in this group but can be set in other ways.

To set the \f5project\fR attribute:
.RS 2m
.IP "\(em" 2m
provide the argument \f5tensorboard_run\fR on the command line with a fully
specified name;
.IP "\(em" 2m
provide the argument \f5\-\-project\fR on the command line;
.IP "\(em" 2m
set the property \f5core/project\fR.
.RE
.sp

This must be specified.


.RS 2m
.TP 2m
\fITENSORBOARD_RUN\fR

ID of the tensorboard_run or fully qualified identifier for the tensorboard_run.

To set the \f5name\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5tensorboard_run\fR on the command line.
.RE
.sp

This positional argument must be specified if any of the other arguments in this
group are specified.

.TP 2m
\fB\-\-region\fR=\fIREGION\fR

Cloud region for the tensorboard_run.

To set the \f5region\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5tensorboard_run\fR on the command line with a fully
specified name;
.IP "\(bu" 2m
provide the argument \f5\-\-region\fR on the command line;
.IP "\(bu" 2m
set the property \f5ai/region\fR;
.IP "\(bu" 2m
choose one from the prompted list of available regions.
.RE
.sp

.TP 2m
\fB\-\-tensorboard\-experiment\-id\fR=\fITENSORBOARD_EXPERIMENT_ID\fR

ID of the tensorboard experiment for the tensorboard_run.

To set the \f5tensorboard\-experiment\-id\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5tensorboard_run\fR on the command line with a fully
specified name;
.IP "\(bu" 2m
provide the argument \f5\-\-tensorboard\-experiment\-id\fR on the command line.
.RE
.sp

.TP 2m
\fB\-\-tensorboard\-id\fR=\fITENSORBOARD_ID\fR

ID of the tensorboard for the tensorboard_run.

To set the \f5tensorboard\-id\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5tensorboard_run\fR on the command line with a fully
specified name;
.IP "\(bu" 2m
provide the argument \f5\-\-tensorboard\-id\fR on the command line.
.RE
.sp


.RE
.RE
.sp

.SH "FLAGS"

.RS 2m
.TP 2m
\fB\-\-description\fR=\fIDESCRIPTION\fR

Description of the tensorboard run.

.TP 2m
\fB\-\-display\-name\fR=\fIDISPLAY_NAME\fR

Display name of the tensorboard run.

.TP 2m
\fB\-\-update\-labels\fR=[\fIKEY\fR=\fIVALUE\fR,...]

List of label KEY=VALUE pairs to update. If a label exists, its value is
modified. Otherwise, a new label is created.

Keys must start with a lowercase character and contain only hyphens (\f5\-\fR),
underscores (\f5_\fR), lowercase characters, and numbers. Values must contain
only hyphens (\f5\-\fR), underscores (\f5_\fR), lowercase characters, and
numbers.

.TP 2m

At most one of these can be specified:


.RS 2m
.TP 2m
\fB\-\-clear\-labels\fR

Remove all labels. If \f5\-\-update\-labels\fR is also specified then
\f5\-\-clear\-labels\fR is applied first.

For example, to remove all labels:

.RS 2m
$ gcloud alpha ai tensorboard\-runs update \-\-clear\-labels
.RE

To remove all existing labels and create two new labels, \f5\fIfoo\fR\fR and
\f5\fIbaz\fR\fR:

.RS 2m
$ gcloud alpha ai tensorboard\-runs update \-\-clear\-labels \e
  \-\-update\-labels foo=bar,baz=qux
.RE

.TP 2m
\fB\-\-remove\-labels\fR=[\fIKEY\fR,...]

List of label keys to remove. If a label does not exist it is silently ignored.
If \f5\-\-update\-labels\fR is also specified then \f5\-\-update\-labels\fR is
applied first.


.RE
.RE
.sp

.SH "GCLOUD WIDE FLAGS"

These flags are available to all commands: \-\-access\-token\-file, \-\-account,
\-\-billing\-project, \-\-configuration, \-\-flags\-file, \-\-flatten,
\-\-format, \-\-help, \-\-impersonate\-service\-account, \-\-log\-http,
\-\-project, \-\-quiet, \-\-trace\-token, \-\-user\-output\-enabled,
\-\-verbosity.

Run \fB$ gcloud help\fR for details.



.SH "NOTES"

This command is currently in alpha and might change without notice. If this
command fails with API permission errors despite specifying the correct project,
you might be trying to access an API with an invitation\-only early access
allowlist. This variant is also available:

.RS 2m
$ gcloud beta ai tensorboard\-runs update
.RE