.TH "GCLOUD_ALPHA_AI_TENSORBOARD\-RUNS_CREATE" 1



.SH "NAME"
.HP
gcloud alpha ai tensorboard\-runs create \- create a new Vertex AI Tensorboard run



.SH "SYNOPSIS"
.HP
\f5gcloud alpha ai tensorboard\-runs create\fR (\fITENSORBOARD_EXPERIMENT\fR\ :\ \fB\-\-region\fR=\fIREGION\fR\ \fB\-\-tensorboard\-id\fR=\fITENSORBOARD_ID\fR) \fB\-\-display\-name\fR=\fIDISPLAY_NAME\fR \fB\-\-tensorboard\-run\-id\fR=\fITENSORBOARD_RUN_ID\fR [\fB\-\-description\fR=\fIDESCRIPTION\fR] [\fB\-\-labels\fR=[\fIKEY\fR=\fIVALUE\fR,...]] [\fIGCLOUD_WIDE_FLAG\ ...\fR]



.SH "DESCRIPTION"

\fB(ALPHA)\fR Create a new Vertex AI Tensorboard run.



.SH "EXAMPLES"

To create a Tensorboard Run \f5my\-tensorboard\-run\fR in Tensorboard
\f512345\fR and Tensorboard Experiment \f5my\-tensorboard\-experiment, with the
display name \fRmy tensorboard run\f5:

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

You may also provide a description and/or labels:

.RS 2m
$ gcloud alpha ai tensorboard\-runs create \e
  my\-tensorboard\-experiment \e
  \-\-tensorboard\-run\-id=my\-tensorboard\-run \-\-tensorboard\-id=12345 \e
  \-\-description="my description" \-\-labels="label1=value1" \e
  \-\-labels="label2=value2"
.RE

To create a Tensorboard Run \fRmy\-tensorboard\-run\f5 in Tensorboard
\fR12345\f5, Tensorboard Experiment \fRmy\-tensorboard\-experiment, region
\f5us\-central1\fR, and project \f5my\-project\fR:

.RS 2m
$ gcloud alpha ai tensorboard\-runs create \e
  projects/my\-project/locations/us\-central1/tensorboards/12345/\e
experiments/my\-tensorboard\-experiment \e
    \-\-tensorboard\-run\-id=my\-tensorboard\-run
.RE



.SH "POSITIONAL ARGUMENTS"

.RS 2m
.TP 2m

Tensorboard experiment resource \- The Tensorboard experiment to create a
Tensorboard run. 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_experiment\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_EXPERIMENT\fR

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

To set the \f5name\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5tensorboard_experiment\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_experiment.

To set the \f5region\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5tensorboard_experiment\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\-id\fR=\fITENSORBOARD_ID\fR

ID of the tensorboard for the tensorboard_experiment.

To set the \f5tensorboard\-id\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5tensorboard_experiment\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 "REQUIRED FLAGS"

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

Display name of the tensorboard\-run.

.TP 2m
\fB\-\-tensorboard\-run\-id\fR=\fITENSORBOARD_RUN_ID\fR

ID of the Tensorboard run.


.RE
.sp

.SH "OPTIONAL FLAGS"

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

Description of the tensorboard\-run.

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

List of label KEY=VALUE pairs to add.

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.


.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 create
.RE