hyperparameter_tuning_jobs

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

Overview

Name	hyperparameter_tuning_jobs
Type	Resource
Id	google.aiplatform.hyperparameter_tuning_jobs

Fields

Name	Datatype	Description
name	string	Output only. Resource name of the HyperparameterTuningJob.
createTime	string	Output only. Time when the HyperparameterTuningJob was created.
displayName	string	Required. The display name of the HyperparameterTuningJob. The name can be up to 128 characters long and can consist of any UTF-8 characters.
encryptionSpec	object	Represents a customer-managed encryption key spec that can be applied to a top-level resource.
endTime	string	Output only. Time when the HyperparameterTuningJob entered any of the following states: JOB_STATE_SUCCEEDED, JOB_STATE_FAILED, JOB_STATE_CANCELLED.
error	object	The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.
labels	object	The labels with user-defined metadata to organize HyperparameterTuningJobs. 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. See https://goo.gl/xmQnxf for more information and examples of labels.
maxFailedTrialCount	integer	The number of failed Trials that need to be seen before failing the HyperparameterTuningJob. If set to 0, Vertex AI decides how many Trials must fail before the whole job fails.
maxTrialCount	integer	Required. The desired total number of Trials.
parallelTrialCount	integer	Required. The desired number of Trials to run in parallel.
satisfiesPzi	boolean	Output only. Reserved for future use.
satisfiesPzs	boolean	Output only. Reserved for future use.
startTime	string	Output only. Time when the HyperparameterTuningJob for the first time entered the JOB_STATE_RUNNING state.
state	string	Output only. The detailed state of the job.
studySpec	object	Represents specification of a Study.
trialJobSpec	object	Represents the spec of a CustomJob.
trials	array	Output only. Trials of the HyperparameterTuningJob.
updateTime	string	Output only. Time when the HyperparameterTuningJob was most recently updated.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	hyperparameterTuningJobsId, locationsId, projectsId	Gets a HyperparameterTuningJob
list	SELECT	locationsId, projectsId	Lists HyperparameterTuningJobs in a Location.
create	INSERT	locationsId, projectsId	Creates a HyperparameterTuningJob
delete	DELETE	hyperparameterTuningJobsId, locationsId, projectsId	Deletes a HyperparameterTuningJob.
cancel	EXEC	hyperparameterTuningJobsId, locationsId, projectsId	Cancels a HyperparameterTuningJob. Starts asynchronous cancellation on the HyperparameterTuningJob. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use JobService.GetHyperparameterTuningJob or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the HyperparameterTuningJob is not deleted; instead it becomes a job with a HyperparameterTuningJob.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED, and HyperparameterTuningJob.state is set to CANCELLED.

SELECT examples

Lists HyperparameterTuningJobs in a Location.

SELECT
name,
createTime,
displayName,
encryptionSpec,
endTime,
error,
labels,
maxFailedTrialCount,
maxTrialCount,
parallelTrialCount,
satisfiesPzi,
satisfiesPzs,
startTime,
state,
studySpec,
trialJobSpec,
trials,
updateTime
FROM google.aiplatform.hyperparameter_tuning_jobs
WHERE locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}';

INSERT example

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

All Properties

/*+ create */
INSERT INTO google.aiplatform.hyperparameter_tuning_jobs (
locationsId,
projectsId,
displayName,
studySpec,
maxFailedTrialCount,
trialJobSpec,
maxTrialCount,
encryptionSpec,
parallelTrialCount,
labels
)
SELECT 
'{{ locationsId }}',
'{{ projectsId }}',
'{{ displayName }}',
'{{ studySpec }}',
'{{ maxFailedTrialCount }}',
'{{ trialJobSpec }}',
'{{ maxTrialCount }}',
'{{ encryptionSpec }}',
'{{ parallelTrialCount }}',
'{{ labels }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: displayName
      value: string
    - name: createTime
      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: maxFailedTrialCount
      value: integer
    - name: state
      value: string
    - name: trialJobSpec
      value:
        - name: scheduling
          value:
            - name: restartJobOnWorkerRestart
              value: boolean
            - name: timeout
              value: string
            - name: strategy
              value: string
            - name: disableRetries
              value: boolean
            - name: maxWaitDuration
              value: string
        - name: persistentResourceId
          value: string
        - name: baseOutputDirectory
          value:
            - name: outputUriPrefix
              value: string
        - name: experimentRun
          value: string
        - name: protectedArtifactLocationId
          value: string
        - name: serviceAccount
          value: string
        - name: workerPoolSpecs
          value:
            - - name: pythonPackageSpec
                value:
                  - name: args
                    value:
                      - string
                  - name: env
                    value:
                      - - name: value
                          value: string
                        - name: name
                          value: string
                  - name: pythonModule
                    value: string
                  - name: executorImageUri
                    value: string
                  - name: packageUris
                    value:
                      - string
              - name: diskSpec
                value:
                  - name: bootDiskType
                    value: string
                  - name: bootDiskSizeGb
                    value: integer
              - name: machineSpec
                value:
                  - name: acceleratorCount
                    value: integer
                  - name: tpuTopology
                    value: string
                  - name: machineType
                    value: string
                  - name: acceleratorType
                    value: string
                  - name: reservationAffinity
                    value:
                      - name: reservationAffinityType
                        value: string
                      - name: values
                        value:
                          - string
                      - name: key
                        value: string
              - name: containerSpec
                value:
                  - name: command
                    value:
                      - string
                  - name: args
                    value:
                      - string
                  - name: imageUri
                    value: string
                  - name: env
                    value:
                      - - name: value
                          value: string
                        - name: name
                          value: string
              - name: nfsMounts
                value:
                  - - name: mountPoint
                      value: string
                    - name: path
                      value: string
                    - name: server
                      value: string
              - name: replicaCount
                value: string
        - name: enableDashboardAccess
          value: boolean
        - name: network
          value: string
        - name: enableWebAccess
          value: boolean
        - name: experiment
          value: string
        - name: reservedIpRanges
          value:
            - string
        - name: tensorboard
          value: string
        - name: models
          value:
            - string
    - name: maxTrialCount
      value: integer
    - name: endTime
      value: string
    - name: name
      value: string
    - name: satisfiesPzi
      value: boolean
    - name: encryptionSpec
      value:
        - name: kmsKeyName
          value: string
    - name: error
      value:
        - name: code
          value: integer
        - name: message
          value: string
        - name: details
          value:
            - object
    - name: parallelTrialCount
      value: integer
    - name: startTime
      value: string
    - name: trials
      value:
        - - name: id
            value: string
          - name: clientId
            value: string
          - name: name
            value: string
          - name: customJob
            value: string
          - name: finalMeasurement
            value:
              - name: stepCount
                value: string
              - name: elapsedDuration
                value: string
              - name: metrics
                value:
                  - - name: value
                      value: number
                    - name: metricId
                      value: string
          - name: startTime
            value: string
          - name: measurements
            value:
              - - name: stepCount
                  value: string
                - name: elapsedDuration
                  value: string
                - name: metrics
                  value:
                    - - name: value
                        value: number
                      - name: metricId
                        value: string
          - name: state
            value: string
          - name: endTime
            value: string
          - name: webAccessUris
            value: object
          - name: parameters
            value:
              - - name: value
                  value: any
                - name: parameterId
                  value: string
          - name: infeasibleReason
            value: string
    - name: updateTime
      value: string
    - name: labels
      value: object
    - name: satisfiesPzs
      value: boolean

DELETE example

Deletes the specified hyperparameter_tuning_jobs resource.

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