Skip to main content

experiments

Overview

Nameexperiments
TypeResource
Idgoogle.aiplatform.experiments

Fields

NameDatatypeDescription
namestringOutput only. Name of the TensorboardExperiment. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}
descriptionstringDescription of this TensorboardExperiment.
createTimestringOutput only. Timestamp when this TensorboardExperiment was created.
displayNamestringUser provided name of this TensorboardExperiment.
etagstringUsed to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
labelsobjectThe labels with user-defined metadata to organize your TensorboardExperiment. Label keys and values cannot be longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Dataset (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with aiplatform.googleapis.com/ and are immutable. The following system labels exist for each Dataset: * aiplatform.googleapis.com/dataset_metadata_schema: output only. Its value is the metadata_schema's title.
sourcestringImmutable. Source of the TensorboardExperiment. Example: a custom training job.
updateTimestringOutput only. Timestamp when this TensorboardExperiment was last updated.

Methods

NameAccessible byRequired ParamsDescription
getSELECTexperimentsId, locationsId, projectsId, tensorboardsIdGets a TensorboardExperiment.
listSELECTlocationsId, projectsId, tensorboardsIdLists TensorboardExperiments in a Location.
createINSERTlocationsId, projectsId, tensorboardsIdCreates a TensorboardExperiment.
deleteDELETEexperimentsId, locationsId, projectsId, tensorboardsIdDeletes a TensorboardExperiment.
_listEXEClocationsId, projectsId, tensorboardsIdLists TensorboardExperiments in a Location.
patchEXECexperimentsId, locationsId, projectsId, tensorboardsIdUpdates a TensorboardExperiment.
writeEXECexperimentsId, locationsId, projectsId, tensorboardsIdWrite time series data points of multiple TensorboardTimeSeries in multiple TensorboardRun's. If any data fail to be ingested, an error is returned.