experiments

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

Overview

Name	experiments
Type	Resource
Id	google.aiplatform.experiments

Fields

Name	Datatype	Description
name	string	Output only. Name of the TensorboardExperiment. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}
description	string	Description of this TensorboardExperiment.
createTime	string	Output only. Timestamp when this TensorboardExperiment was created.
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	Output only. Timestamp when this TensorboardExperiment was last updated.

Methods

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

SELECT examples

Lists TensorboardExperiments in a Location.

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

INSERT example

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

All Properties

/*+ create */
INSERT INTO google.aiplatform.experiments (
locationsId,
projectsId,
tensorboardsId,
labels,
source,
description,
displayName,
etag
)
SELECT 
'{{ locationsId }}',
'{{ projectsId }}',
'{{ tensorboardsId }}',
'{{ labels }}',
'{{ source }}',
'{{ description }}',
'{{ displayName }}',
'{{ etag }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: createTime
      value: string
    - name: labels
      value: object
    - name: source
      value: string
    - name: updateTime
      value: string
    - name: description
      value: string
    - name: displayName
      value: string
    - name: etag
      value: string
    - name: name
      value: string

UPDATE example

Updates a experiments resource.

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

DELETE example

Deletes the specified experiments resource.

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