gcloud beta ai tensorboard-experiments update

NAME
gcloud beta ai tensorboard-experiments update - update an existing Vertex AI Tensorboard experiment
SYNOPSIS
gcloud beta 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
(BETA) Update an existing Vertex AI Tensorboard experiment.
EXAMPLES
To update a Tensorboard Experiment my-tensorboard-experiment in Tensorboard 12345, region us-central1, and project my-project, with the display name updated display name: 
gcloud beta ai tensorboard-experiments update projects/my-project/locations/us-central1/tensorboards/12345/experiments/my-tensorboard-experiment --display-name="updated display name"

Or with flags: 

gcloud beta ai tensorboard-experiments update my-tensorboard-experiment --tensorboard-id=12345 --display-name="updated display name"
POSITIONAL ARGUMENTS
Tensorboard experiment resource - The Tensorboard experiment 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 project attribute:

  • provide the argument tensorboard_experiment on the command line with a fully specified name;
  • provide the argument --project on the command line;
  • set the property core/project.

This must be specified.

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

To set the name attribute:

  • provide the argument tensorboard_experiment on the command line.

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

--region=REGION
Cloud region for the tensorboard_experiment.

To set the region attribute:

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

To set the tensorboard-id attribute:

  • provide the argument tensorboard_experiment on the command line with 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 is modified. Otherwise, a new label is created.

Keys must start with a lowercase character and contain only hyphens (-), underscores (_), lowercase characters, and numbers. 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: 

gcloud beta ai tensorboard-experiments update --clear-labels

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

gcloud beta ai tensorboard-experiments update --clear-labels --update-labels foo=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 beta and might change without notice. This variant is also available: 
gcloud alpha ai tensorboard-experiments update