Skip to main content

runs

Creates, updates, deletes, gets or lists a runs resource.

Overview​

Nameruns
TypeResource
Idgoogle.aiplatform.runs

Fields​

The following fields are returned by SELECT queries:

Successful response

NameDatatypeDescription
namestringOutput only. Name of the TensorboardRun. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}
createTimestring (google-datetime)Output only. Timestamp when this TensorboardRun was created.
descriptionstringDescription of this TensorboardRun.
displayNamestringRequired. User provided name of this TensorboardRun. This value must be unique among all TensorboardRuns belonging to the same parent TensorboardExperiment.
etagstringUsed to perform a consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
labelsobjectThe labels with user-defined metadata to organize your TensorboardRuns. This field will be used to filter and visualize Runs in the Tensorboard UI. For example, a Vertex AI training job can set a label aiplatform.googleapis.com/training_job_id=xxxxx to all the runs created within that job. An end user can set a label experiment_id=xxxxx for all the runs produced in a Jupyter notebook. These runs can be grouped by a label value and visualized together in the Tensorboard UI. Label keys and values can be no 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 TensorboardRun (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.
updateTimestring (google-datetime)Output only. Timestamp when this TensorboardRun was last updated.

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectprojectsId, locationsId, tensorboardsId, experimentsId, runsIdGets a TensorboardRun.
listselectprojectsId, locationsId, tensorboardsId, experimentsIdfilter, pageSize, pageToken, orderBy, readMaskLists TensorboardRuns in a Location.
createinsertprojectsId, locationsId, tensorboardsId, experimentsIdtensorboardRunIdCreates a TensorboardRun.
batch_createinsertprojectsId, locationsId, tensorboardsId, experimentsIdBatch create TensorboardRuns.
patchupdateprojectsId, locationsId, tensorboardsId, experimentsId, runsIdupdateMaskUpdates a TensorboardRun.
deletedeleteprojectsId, locationsId, tensorboardsId, experimentsId, runsIdDeletes a TensorboardRun.
writeexecprojectsId, locationsId, tensorboardsId, experimentsId, runsIdWrite time series data points into multiple TensorboardTimeSeries under a TensorboardRun. 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
runsIdstring
tensorboardsIdstring
filterstring
orderBystring
pageSizeinteger (int32)
pageTokenstring
readMaskstring (google-fieldmask)
tensorboardRunIdstring
updateMaskstring (google-fieldmask)

SELECT examples​

Gets a TensorboardRun.

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

INSERT examples​

Creates a TensorboardRun.

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

UPDATE examples​

Updates a TensorboardRun.

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

DELETE examples​

Deletes a TensorboardRun.

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

Lifecycle Methods​

Write time series data points into multiple TensorboardTimeSeries under a TensorboardRun. If any data fail to be ingested, an error is returned.

EXEC google.aiplatform.runs.write 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@tensorboardsId='{{ tensorboardsId }}' --required, 
@experimentsId='{{ experimentsId }}' --required, 
@runsId='{{ runsId }}' --required 
@@json=
'{
"tensorboardRun": "{{ tensorboardRun }}", 
"timeSeriesData": "{{ timeSeriesData }}"
}';