studies

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

Overview

Name	studies
Type	Resource
Id	google.ml.studies

Fields

Name	Datatype	Description
name	string	Output only. The name of a study.
createTime	string	Output only. Time at which the study was created.
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.
studyConfig	object	Represents configuration of a study.

Methods

Name	Accessible by	Required Params	Description
projects_locations_studies_get	SELECT	locationsId, projectsId, studiesId	Gets a study.
projects_locations_studies_list	SELECT	locationsId, projectsId	Lists all the studies in a region for an associated project.
projects_locations_studies_create	INSERT	locationsId, projectsId	Creates a study.
projects_locations_studies_delete	DELETE	locationsId, projectsId, studiesId	Deletes a study.

SELECT examples

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

SELECT
name,
createTime,
inactiveReason,
state,
studyConfig
FROM google.ml.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.ml.studies (
locationsId,
projectsId,
studyConfig
)
SELECT 
'{{ locationsId }}',
'{{ projectsId }}',
'{{ studyConfig }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: name
      value: string
    - name: studyConfig
      value:
        - name: metrics
          value:
            - - name: goal
                value: string
              - name: metric
                value: string
        - name: parameters
          value:
            - - name: parameter
                value: string
              - name: type
                value: string
              - name: doubleValueSpec
                value:
                  - name: minValue
                    value: number
                  - name: maxValue
                    value: number
              - name: integerValueSpec
                value:
                  - name: minValue
                    value: string
                  - name: maxValue
                    value: string
              - name: categoricalValueSpec
                value:
                  - name: values
                    value:
                      - string
              - name: discreteValueSpec
                value:
                  - name: values
                    value:
                      - number
              - name: scaleType
                value: string
              - name: parentDiscreteValues
                value:
                  - name: values
                    value:
                      - number
              - name: parentIntValues
                value:
                  - name: values
                    value:
                      - string
              - name: parentCategoricalValues
                value:
                  - name: values
                    value:
                      - string
              - name: childParameterSpecs
                value:
                  - - name: parameter
                      value: string
                    - name: type
                      value: string
                    - name: scaleType
                      value: string
                    - name: childParameterSpecs
                      value:
                        - - name: parameter
                            value: string
                          - name: type
                            value: string
                          - name: scaleType
                            value: string
                          - name: childParameterSpecs
                            value:
                              - - name: parameter
                                  value: string
                                - name: type
                                  value: string
                                - name: scaleType
                                  value: string
                                - name: childParameterSpecs
                                  value:
                                    - - name: parameter
                                        value: string
                                      - name: type
                                        value: string
                                      - name: scaleType
                                        value: string
                                      - name: childParameterSpecs
                                        value:
                                          - - name: parameter
                                              value: string
                                            - name: type
                                              value: string
                                            - name: scaleType
                                              value: string
                                            - name: childParameterSpecs
                                              value:
                                                - - name: parameter
                                                    value: string
                                                  - name: type
                                                    value: string
                                                  - name: scaleType
                                                    value: string
                                                  - name: childParameterSpecs
                                                    value:
                                                      - - name: parameter
                                                          value: string
                                                        - name: type
                                                          value: string
                                                        - name: scaleType
                                                          value: string
                                                        - name: childParameterSpecs
                                                          value:
                                                            - - name: parameter
                                                                value: string
                                                              - name: type
                                                                value: string
                                                              - name: scaleType
                                                                value: string
                                                              - name: childParameterSpecs
                                                                value:
                                                                  - []
        - name: algorithm
          value: string
        - name: automatedStoppingConfig
          value:
            - name: decayCurveStoppingConfig
              value:
                - name: useElapsedTime
                  value: boolean
            - name: medianAutomatedStoppingConfig
              value:
                - name: useElapsedTime
                  value: boolean
    - name: state
      value: string
    - name: createTime
      value: string
    - name: inactiveReason
      value: string

DELETE example

Deletes the specified studies resource.

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