runs

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

Overview

Name	runs
Type	Resource
Id	google.aiplatform.runs

Fields

Name	Datatype	Description
name	string	Output only. Name of the TensorboardRun. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}
description	string	Description of this TensorboardRun.
createTime	string	Output only. Timestamp when this TensorboardRun was created.
displayName	string	Required. User provided name of this TensorboardRun. This value must be unique among all TensorboardRuns belonging to the same parent TensorboardExperiment.
etag	string	Used to perform a consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
labels	object	The 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.
updateTime	string	Output only. Timestamp when this TensorboardRun was last updated.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	experimentsId, locationsId, projectsId, runsId, tensorboardsId	Gets a TensorboardRun.
list	SELECT	experimentsId, locationsId, projectsId, tensorboardsId	Lists TensorboardRuns in a Location.
batch_create	INSERT	experimentsId, locationsId, projectsId, tensorboardsId	Batch create TensorboardRuns.
create	INSERT	experimentsId, locationsId, projectsId, tensorboardsId	Creates a TensorboardRun.
delete	DELETE	experimentsId, locationsId, projectsId, runsId, tensorboardsId	Deletes a TensorboardRun.
patch	UPDATE	experimentsId, locationsId, projectsId, runsId, tensorboardsId	Updates a TensorboardRun.
write	EXEC	experimentsId, locationsId, projectsId, runsId, tensorboardsId	Write time series data points into multiple TensorboardTimeSeries under a TensorboardRun. If any data fail to be ingested, an error is returned.

SELECT examples

Lists TensorboardRuns in a Location.

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

INSERT example

Use the following StackQL query and manifest file to create a new runs resource.

All Properties

/*+ create */
INSERT INTO google.aiplatform.runs (
experimentsId,
locationsId,
projectsId,
tensorboardsId,
requests
)
SELECT 
'{{ experimentsId }}',
'{{ locationsId }}',
'{{ projectsId }}',
'{{ tensorboardsId }}',
'{{ requests }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: requests
      value:
        - - name: tensorboardRunId
            value: string
          - name: parent
            value: string
          - name: tensorboardRun
            value:
              - name: createTime
                value: string
              - name: updateTime
                value: string
              - name: description
                value: string
              - name: labels
                value: object
              - name: name
                value: string
              - name: etag
                value: string
              - name: displayName
                value: string

UPDATE example

Updates a runs resource.

/*+ update */
UPDATE google.aiplatform.runs
SET 
description = '{{ description }}',
labels = '{{ labels }}',
etag = '{{ etag }}',
displayName = '{{ displayName }}'
WHERE 
experimentsId = '{{ experimentsId }}'
AND locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}'
AND runsId = '{{ runsId }}'
AND tensorboardsId = '{{ tensorboardsId }}';

DELETE example

Deletes the specified runs resource.

/*+ delete */
DELETE FROM google.aiplatform.runs
WHERE experimentsId = '{{ experimentsId }}'
AND locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}'
AND runsId = '{{ runsId }}'
AND tensorboardsId = '{{ tensorboardsId }}';