Skip to main content

experiments

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

Overview​

Nameexperiments
TypeResource
Idgoogle.aiplatform.experiments

Fields​

The following fields are returned by SELECT queries:

Successful response

NameDatatypeDescription
namestringOutput only. Name of the TensorboardExperiment. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}
createTimestring (google-datetime)Output only. Timestamp when this TensorboardExperiment was created.
descriptionstringDescription of this TensorboardExperiment.
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.
updateTimestring (google-datetime)Output only. Timestamp when this TensorboardExperiment was last updated.

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectprojectsId, locationsId, tensorboardsId, experimentsIdGets a TensorboardExperiment.
listselectprojectsId, locationsId, tensorboardsIdfilter, pageSize, pageToken, orderBy, readMaskLists TensorboardExperiments in a Location.
batch_createinsertprojectsId, locationsId, tensorboardsId, experimentsIdBatch create TensorboardTimeSeries that belong to a TensorboardExperiment.
createinsertprojectsId, locationsId, tensorboardsIdtensorboardExperimentIdCreates a TensorboardExperiment.
patchupdateprojectsId, locationsId, tensorboardsId, experimentsIdupdateMaskUpdates a TensorboardExperiment.
deletedeleteprojectsId, locationsId, tensorboardsId, experimentsIdDeletes a TensorboardExperiment.
writeexecprojectsId, locationsId, tensorboardsId, experimentsIdWrite 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.

NameDatatypeDescription
experimentsIdstring
locationsIdstring
projectsIdstring
tensorboardsIdstring
filterstring
orderBystring
pageSizeinteger (int32)
pageTokenstring
readMaskstring (google-fieldmask)
tensorboardExperimentIdstring
updateMaskstring (google-fieldmask)

SELECT examples​

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;

INSERT examples​

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
;

UPDATE examples​

Updates a TensorboardExperiment.

UPDATE google.aiplatform.experiments
SET 
data__displayName = '{{ displayName }}',
data__description = '{{ description }}',
data__labels = '{{ labels }}',
data__etag = '{{ etag }}',
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​

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 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 }}"
}';