studies

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

Overview

Name	studies
Type	Resource
Id	google.aiplatform.studies

Fields

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	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.
studySpec	object	Represents specification of a Study.

Methods

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

SELECT examples

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

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

INSERT example

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

All Properties

/*+ create */
INSERT INTO google.aiplatform.studies (
locationsId,
projectsId,
studySpec,
displayName
)
SELECT 
'{{ locationsId }}',
'{{ projectsId }}',
'{{ studySpec }}',
'{{ displayName }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: name
      value: string
    - name: inactiveReason
      value: string
    - name: state
      value: string
    - name: studySpec
      value:
        - name: parameters
          value:
            - - name: discreteValueSpec
                value:
                  - name: values
                    value:
                      - number
                  - name: defaultValue
                    value: number
              - name: categoricalValueSpec
                value:
                  - name: defaultValue
                    value: string
                  - name: values
                    value:
                      - string
              - name: conditionalParameterSpecs
                value:
                  - - name: parentCategoricalValues
                      value:
                        - name: values
                          value:
                            - string
                    - name: parentDiscreteValues
                      value:
                        - name: values
                          value:
                            - number
                    - name: parameterSpec
                      value:
                        - name: conditionalParameterSpecs
                          value:
                            - - name: parentIntValues
                                value:
                                  - name: values
                                    value:
                                      - string
                        - name: scaleType
                          value: string
                        - name: integerValueSpec
                          value:
                            - name: maxValue
                              value: string
                            - name: defaultValue
                              value: string
                            - name: minValue
                              value: string
                        - name: parameterId
                          value: string
                        - name: doubleValueSpec
                          value:
                            - name: defaultValue
                              value: number
                            - name: maxValue
                              value: number
                            - name: minValue
                              value: number
              - name: scaleType
                value: string
              - name: parameterId
                value: string
        - name: decayCurveStoppingSpec
          value:
            - name: useElapsedDuration
              value: boolean
        - name: observationNoise
          value: string
        - name: measurementSelectionType
          value: string
        - name: medianAutomatedStoppingSpec
          value:
            - name: useElapsedDuration
              value: boolean
        - name: convexAutomatedStoppingSpec
          value:
            - name: maxStepCount
              value: string
            - name: updateAllStoppedTrials
              value: boolean
            - name: minStepCount
              value: string
            - name: learningRateParameterName
              value: string
            - name: useElapsedDuration
              value: boolean
            - name: minMeasurementCount
              value: string
        - name: metrics
          value:
            - - name: goal
                value: string
              - name: metricId
                value: string
              - name: safetyConfig
                value:
                  - name: desiredMinSafeTrialsFraction
                    value: number
                  - name: safetyThreshold
                    value: number
        - name: studyStoppingConfig
          value:
            - name: maxNumTrials
              value: integer
            - name: maxNumTrialsNoProgress
              value: integer
            - name: shouldStopAsap
              value: boolean
            - name: maximumRuntimeConstraint
              value:
                - name: maxDuration
                  value: string
                - name: endTime
                  value: string
            - name: minNumTrials
              value: integer
            - name: maxDurationNoProgress
              value: string
        - name: algorithm
          value: string
    - name: displayName
      value: string
    - name: createTime
      value: string

DELETE example

Deletes the specified studies resource.

/*+ delete */
DELETE FROM google.aiplatform.studies
WHERE locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}'
AND studiesId = '{{ studiesId }}';