studies

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

Overview

Name	studies
Type	Resource
Id	google.aiplatform.studies

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
name	string	Output only. The name of a study. The study's globally unique identifier. Format: projects/{project}/locations/{location}/studies/{study}
createTime	string (google-datetime)	Output only. Time at which the study was created.
displayName	string	Required. Describes the Study, default value is empty string.
inactiveReason	string	Output only. A human readable reason why the Study is inactive. This should be empty if a study is ACTIVE or COMPLETED.
state	string	Output only. The detailed state of a Study. (STATE_UNSPECIFIED, ACTIVE, INACTIVE, COMPLETED)
studySpec	object	Required. Configuration of the Study. (id: GoogleCloudAiplatformV1StudySpec)

list

Name	Datatype	Description
name	string	Output only. The name of a study. The study's globally unique identifier. Format: projects/{project}/locations/{location}/studies/{study}
createTime	string (google-datetime)	Output only. Time at which the study was created.
displayName	string	Required. Describes the Study, default value is empty string.
inactiveReason	string	Output only. A human readable reason why the Study is inactive. This should be empty if a study is ACTIVE or COMPLETED.
state	string	Output only. The detailed state of a Study. (STATE_UNSPECIFIED, ACTIVE, INACTIVE, COMPLETED)
studySpec	object	Required. Configuration of the Study. (id: GoogleCloudAiplatformV1StudySpec)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, studiesId		Gets a Study by name.
list	select	projectsId, locationsId	pageToken, pageSize	Lists all the studies in a region for an associated project.
create	insert	projectsId, locationsId		Creates a Study. A resource name will be generated after creation of the Study.
delete	delete	projectsId, locationsId, studiesId		Deletes a Study.
lookup	exec	projectsId, locationsId		Looks a study up using the user-defined display_name field instead of the fully qualified resource name.

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
locationsId	string
projectsId	string
studiesId	string
pageSize	integer (int32)
pageToken	string

SELECT examples

get

Gets a Study by name.

SELECT
name,
createTime,
displayName,
inactiveReason,
state,
studySpec
FROM google.aiplatform.studies
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND studiesId = '{{ studiesId }}' -- required
;

list

Lists all the studies in a region for an associated project.

SELECT
name,
createTime,
displayName,
inactiveReason,
state,
studySpec
FROM google.aiplatform.studies
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pageToken = '{{ pageToken }}'
AND pageSize = '{{ pageSize }}'
;

INSERT examples

create

Creates a Study. A resource name will be generated after creation of the Study.

INSERT INTO google.aiplatform.studies (
data__studySpec,
data__displayName,
projectsId,
locationsId
)
SELECT 
'{{ studySpec }}',
'{{ displayName }}',
'{{ projectsId }}',
'{{ locationsId }}'
RETURNING
name,
createTime,
displayName,
inactiveReason,
state,
studySpec
;

Manifest

# Description fields are for documentation purposes
- name: studies
props:
  - name: projectsId
    value: "{{ projectsId }}"
    description: Required parameter for the studies resource.
  - name: locationsId
    value: "{{ locationsId }}"
    description: Required parameter for the studies resource.
  - name: studySpec
    description: |
      Required. Configuration of the Study.
    value:
      convexAutomatedStoppingSpec:
        minStepCount: "{{ minStepCount }}"
        updateAllStoppedTrials: {{ updateAllStoppedTrials }}
        useElapsedDuration: {{ useElapsedDuration }}
        minMeasurementCount: "{{ minMeasurementCount }}"
        learningRateParameterName: "{{ learningRateParameterName }}"
        maxStepCount: "{{ maxStepCount }}"
      medianAutomatedStoppingSpec:
        useElapsedDuration: {{ useElapsedDuration }}
      measurementSelectionType: "{{ measurementSelectionType }}"
      algorithm: "{{ algorithm }}"
      metrics:
        - safetyConfig:
            safetyThreshold: {{ safetyThreshold }}
            desiredMinSafeTrialsFraction: {{ desiredMinSafeTrialsFraction }}
          goal: "{{ goal }}"
          metricId: "{{ metricId }}"
      studyStoppingConfig:
        minNumTrials: {{ minNumTrials }}
        shouldStopAsap: {{ shouldStopAsap }}
        maxNumTrialsNoProgress: {{ maxNumTrialsNoProgress }}
        minimumRuntimeConstraint:
          maxDuration: "{{ maxDuration }}"
          endTime: "{{ endTime }}"
        maxNumTrials: {{ maxNumTrials }}
        maxDurationNoProgress: "{{ maxDurationNoProgress }}"
        maximumRuntimeConstraint:
          maxDuration: "{{ maxDuration }}"
          endTime: "{{ endTime }}"
      decayCurveStoppingSpec:
        useElapsedDuration: {{ useElapsedDuration }}
      observationNoise: "{{ observationNoise }}"
      parameters:
        - doubleValueSpec:
            defaultValue: {{ defaultValue }}
            minValue: {{ minValue }}
            maxValue: {{ maxValue }}
          categoricalValueSpec:
            values:
              - "{{ values }}"
            defaultValue: "{{ defaultValue }}"
          scaleType: "{{ scaleType }}"
          discreteValueSpec:
            values:
              - {{ values }}
            defaultValue: {{ defaultValue }}
          parameterId: "{{ parameterId }}"
          integerValueSpec:
            defaultValue: "{{ defaultValue }}"
            minValue: "{{ minValue }}"
            maxValue: "{{ maxValue }}"
          conditionalParameterSpecs: "{{ conditionalParameterSpecs }}"
  - name: displayName
    value: "{{ displayName }}"
    description: |
      Required. Describes the Study, default value is empty string.

DELETE examples

delete

Deletes a Study.

DELETE FROM google.aiplatform.studies
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND studiesId = '{{ studiesId }}' --required
;

Lifecycle Methods

lookup

Looks a study up using the user-defined display_name field instead of the fully qualified resource name.

EXEC google.aiplatform.studies.lookup 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required 
@@json=
'{
"displayName": "{{ displayName }}"
}'
;