experiments

Creates, updates, deletes, gets or lists an experiments resource.

Overview

Name	experiments
Type	Resource
Id	google.aiplatform.experiments

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
name	string	Output only. Name of the TensorboardExperiment. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}
createTime	string (google-datetime)	Output only. Timestamp when this TensorboardExperiment was created.
description	string	Description of this TensorboardExperiment.
displayName	string	User provided name of this TensorboardExperiment.
etag	string	Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
labels	object	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 metadata_schema's title.
source	string	Immutable. Source of the TensorboardExperiment. Example: a custom training job.
updateTime	string (google-datetime)	Output only. Timestamp when this TensorboardExperiment was last updated.

list

Name	Datatype	Description
name	string	Output only. Name of the TensorboardExperiment. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}
createTime	string (google-datetime)	Output only. Timestamp when this TensorboardExperiment was created.
description	string	Description of this TensorboardExperiment.
displayName	string	User provided name of this TensorboardExperiment.
etag	string	Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
labels	object	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 metadata_schema's title.
source	string	Immutable. Source of the TensorboardExperiment. Example: a custom training job.
updateTime	string (google-datetime)	Output only. Timestamp when this TensorboardExperiment was last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, tensorboardsId, experimentsId		Gets a TensorboardExperiment.
list	select	projectsId, locationsId, tensorboardsId	filter, orderBy, pageSize, pageToken, readMask	Lists TensorboardExperiments in a Location.
batch_create	insert	projectsId, locationsId, tensorboardsId, experimentsId		Batch create TensorboardTimeSeries that belong to a TensorboardExperiment.
create	insert	projectsId, locationsId, tensorboardsId	tensorboardExperimentId	Creates a TensorboardExperiment.
patch	update	projectsId, locationsId, tensorboardsId, experimentsId	updateMask	Updates a TensorboardExperiment.
delete	delete	projectsId, locationsId, tensorboardsId, experimentsId		Deletes a TensorboardExperiment.
write	exec	projectsId, locationsId, tensorboardsId, experimentsId		Write time series data points of multiple TensorboardTimeSeries in multiple TensorboardRun's. If any data fail to be ingested, an error is returned.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
experimentsId	string
locationsId	string
projectsId	string
tensorboardsId	string
filter	string
orderBy	string
pageSize	integer (int32)
pageToken	string
readMask	string (google-fieldmask)
tensorboardExperimentId	string
updateMask	string (google-fieldmask)

SELECT examples

get

Gets a TensorboardExperiment.

SELECT
name,
createTime,
description,
displayName,
etag,
labels,
source,
updateTime
FROM google.aiplatform.experiments
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND tensorboardsId = '{{ tensorboardsId }}' -- required
AND experimentsId = '{{ experimentsId }}' -- required
;

list

Lists TensorboardExperiments in a Location.

SELECT
name,
createTime,
description,
displayName,
etag,
labels,
source,
updateTime
FROM google.aiplatform.experiments
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND tensorboardsId = '{{ tensorboardsId }}' -- required
AND filter = '{{ filter }}'
AND orderBy = '{{ orderBy }}'
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND readMask = '{{ readMask }}'
;

INSERT examples

batch_create

Batch create TensorboardTimeSeries that belong to a TensorboardExperiment.

INSERT INTO google.aiplatform.experiments (
data__requests,
projectsId,
locationsId,
tensorboardsId,
experimentsId
)
SELECT 
'{{ requests }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ tensorboardsId }}',
'{{ experimentsId }}'
RETURNING
tensorboardTimeSeries
;

create

Creates a TensorboardExperiment.

INSERT INTO google.aiplatform.experiments (
data__description,
data__displayName,
data__etag,
data__labels,
data__source,
projectsId,
locationsId,
tensorboardsId,
tensorboardExperimentId
)
SELECT 
'{{ description }}',
'{{ displayName }}',
'{{ etag }}',
'{{ labels }}',
'{{ source }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ tensorboardsId }}',
'{{ tensorboardExperimentId }}'
RETURNING
name,
createTime,
description,
displayName,
etag,
labels,
source,
updateTime
;

Manifest

# Description fields are for documentation purposes
- name: experiments
props:
  - name: projectsId
    value: "{{ projectsId }}"
    description: Required parameter for the experiments resource.
  - name: locationsId
    value: "{{ locationsId }}"
    description: Required parameter for the experiments resource.
  - name: tensorboardsId
    value: "{{ tensorboardsId }}"
    description: Required parameter for the experiments resource.
  - name: experimentsId
    value: "{{ experimentsId }}"
    description: Required parameter for the experiments resource.
  - name: requests
    description: |
      Required. The request message specifying the TensorboardTimeSeries to create. A maximum of 1000 TensorboardTimeSeries can be created in a batch.
    value:
      - parent: "{{ parent }}"
        tensorboardTimeSeries:
          createTime: "{{ createTime }}"
          description: "{{ description }}"
          displayName: "{{ displayName }}"
          etag: "{{ etag }}"
          metadata:
            maxBlobSequenceLength: "{{ maxBlobSequenceLength }}"
            maxStep: "{{ maxStep }}"
            maxWallTime: "{{ maxWallTime }}"
          name: "{{ name }}"
          pluginData: "{{ pluginData }}"
          pluginName: "{{ pluginName }}"
          updateTime: "{{ updateTime }}"
          valueType: "{{ valueType }}"
        tensorboardTimeSeriesId: "{{ tensorboardTimeSeriesId }}"
  - name: description
    value: "{{ description }}"
    description: |
      Description of this TensorboardExperiment.
  - name: displayName
    value: "{{ displayName }}"
    description: |
      User provided name of this TensorboardExperiment.
  - name: etag
    value: "{{ etag }}"
    description: |
      Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
  - name: labels
    value: "{{ labels }}"
    description: |
      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 metadata_schema's title.
  - name: source
    value: "{{ source }}"
    description: |
      Immutable. Source of the TensorboardExperiment. Example: a custom training job.
  - name: tensorboardExperimentId
    value: "{{ tensorboardExperimentId }}"

UPDATE examples

patch

Updates a TensorboardExperiment.

UPDATE google.aiplatform.experiments
SET 
data__description = '{{ description }}',
data__displayName = '{{ displayName }}',
data__etag = '{{ etag }}',
data__labels = '{{ labels }}',
data__source = '{{ source }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND tensorboardsId = '{{ tensorboardsId }}' --required
AND experimentsId = '{{ experimentsId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
createTime,
description,
displayName,
etag,
labels,
source,
updateTime;

DELETE examples

delete

Deletes a TensorboardExperiment.

DELETE FROM google.aiplatform.experiments
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND tensorboardsId = '{{ tensorboardsId }}' --required
AND experimentsId = '{{ experimentsId }}' --required
;

Lifecycle Methods

write

Write time series data points of multiple TensorboardTimeSeries in multiple TensorboardRun's. If any data fail to be ingested, an error is returned.

EXEC google.aiplatform.experiments.write 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@tensorboardsId='{{ tensorboardsId }}' --required, 
@experimentsId='{{ experimentsId }}' --required 
@@json=
'{
"writeRunDataRequests": "{{ writeRunDataRequests }}"
}'
;