gcloud alpha ai tensorboard-experiments update

NAME
gcloud alpha ai tensorboard-experiments update - update an existing Vertex AI Tensorboard experiment
SYNOPSIS
gcloud alpha ai tensorboard-experiments update(TENSORBOARD_EXPERIMENT :--region=REGION--tensorboard-id=TENSORBOARD_ID)[--description=DESCRIPTION][--display-name=DISPLAY_NAME][--update-labels=[KEY=VALUE,…]][--clear-labels    |--remove-labels=[KEY,…]][GCLOUD_WIDE_FLAG]
DESCRIPTION
(ALPHA) Update an existing Vertex AI Tensorboard experiment.
EXAMPLES
To update a Tensorboard Experimentmy-tensorboard-experiment inTensorboard12345, regionus-central1, and projectmy-project, with the display nameupdated displayname:
gcloudalphaaitensorboard-experimentsupdateprojects/my-project/locations/us-central1/tensorboards/12345/experiments/my-tensorboard-experiment--display-name="updated display name"

Or with flags:

gcloudalphaaitensorboard-experimentsupdatemy-tensorboard-experiment--tensorboard-id=12345--display-name="updated display name"
POSITIONAL ARGUMENTS
Tensorboard experiment resource - The Tensorboard experiment to update. Thearguments 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 inother ways.

To set theproject attribute:

  • provide the argumenttensorboard_experiment on the command linewith a fully specified name;
  • provide the argument--project on the command line;
  • set the propertycore/project.

This must be specified.

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

To set thename attribute:

  • provide the argumenttensorboard_experiment on the command line.

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

--region=REGION
Cloud region for the tensorboard_experiment.

To set theregion attribute:

  • provide the argumenttensorboard_experiment on the command linewith a fully specified name;
  • provide the argument--region on the command line;
  • set the propertyai/region;
  • choose one from the prompted list of available regions.
--tensorboard-id=TENSORBOARD_ID
ID of the tensorboard for the tensorboard_experiment.

To set thetensorboard-id attribute:

  • provide the argumenttensorboard_experiment on the command linewith a fully specified name;
  • provide the argument--tensorboard-id on the command line.
FLAGS
--description=DESCRIPTION
Description of the tensorboard experiment.
--display-name=DISPLAY_NAME
Display name of the tensorboard experiment.
--update-labels=[KEY=VALUE,…]
List of label KEY=VALUE pairs to update. If a label exists, its value ismodified. Otherwise, a new label is created.

Keys must start with a lowercase character and contain only hyphens(-), underscores (_), lowercase characters, andnumbers. Values must contain only hyphens (-), underscores(_), lowercase characters, and numbers.

At most one of these can be specified:
--clear-labels
Remove all labels. If--update-labels is also specified then--clear-labels is applied first.

For example, to remove all labels:

gcloudalphaaitensorboard-experimentsupdate--clear-labels

To remove all existing labels and create two new labels,foo andbaz:

gcloudalphaaitensorboard-experimentsupdate--clear-labels--update-labelsfoo=bar,baz=qux
--remove-labels=[KEY,…]
List of label keys to remove. If a label does not exist it is silently ignored.If--update-labels is also specified then--update-labels is applied first.
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$gcloud help for details.

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

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-09-16 UTC.