REST Resource: projects.locations.tensorboards.experiments

Resource: TensorboardExperiment

A TensorboardExperiment is a group of TensorboardRuns, that are typically the results of a training job run, in a Tensorboard.

Fields
name string

Output only. name of the TensorboardExperiment. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}

displayName string

user provided name of this TensorboardExperiment.

description string

description of this TensorboardExperiment.

createTime string (Timestamp format)

Output only. timestamp when this TensorboardExperiment was created.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

updateTime string (Timestamp format)

Output only. timestamp when this TensorboardExperiment was last updated.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

labels map (key: string, value: string)

The 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 metadataSchema's title.
etag string

Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.

source string

Immutable. Source of the TensorboardExperiment. Example: a custom training job.

JSON representation 
{
  "name": string,
  "displayName": string,
  "description": string,
  "createTime": string,
  "updateTime": string,
  "labels": {
    string: string,
    ...
  },
  "etag": string,
  "source": string
}

Methods

batchCreate

 Batch create TensorboardTimeSeries that belong to a TensorboardExperiment.

create

 Creates a TensorboardExperiment.

delete

 Deletes a TensorboardExperiment.

get

 Gets a TensorboardExperiment.

list

 Lists TensorboardExperiments in a Location.

patch

 Updates a TensorboardExperiment.

write

 Write time series data points of multiple TensorboardTimeSeries in multiple TensorboardRun's.