Creates a HyperparameterTuningJob
This method waits—the workflow execution is paused—until the operation is
complete, fails, or times out. The default timeout value is 1800 seconds (30
minutes) and can be changed to a maximum value of 31536000 seconds (one year)
for long-running operations using the connector_params field. See the
Connectors reference.
The connector uses polling to monitor the long-running operation, which might generate additional billable steps. For more information about retries and long-running operations, refer to Understand connectors.
The polling policy for the long-running operation can be configured. To set the
connector-specific parameters (connector_params), refer to
Invoke a connector call.
Arguments
| Parameters | |
|---|---|
parent |
Required. The resource name of the Location to create the HyperparameterTuningJob in. Format: |
region |
Required. Region of the HTTP endpoint. For example, if region is set to |
body |
Required. |
Raised exceptions
| Exceptions | |
|---|---|
ConnectionError |
In case of a network problem (such as DNS failure or refused connection). |
HttpError |
If the response status is >= 400 (excluding 429 and 503). |
TimeoutError |
If a long-running operation takes longer to finish than the specified timeout limit. |
TypeError |
If an operation or function receives an argument of the wrong type. |
ValueError |
If an operation or function receives an argument of the right type but an inappropriate value. For example, a negative timeout. |
OperationError |
If the long-running operation finished unsuccessfully. |
ResponseTypeError |
If the long-running operation returned a response of the wrong type. |
Response
If successful, the response contains an instance of GoogleCloudAiplatformV1HyperparameterTuningJob.
Subworkflow snippet
Some fields might be optional or required. To identify required fields, refer to the API documentation.
YAML
- create: call: googleapis.aiplatform.v1.projects.locations.hyperparameterTuningJobs.create args: parent: ... region: ... body: displayName: ... encryptionSpec: kmsKeyName: ... labels: ... maxFailedTrialCount: ... maxTrialCount: ... parallelTrialCount: ... studySpec: algorithm: ... convexAutomatedStoppingSpec: learningRateParameterName: ... maxStepCount: ... minMeasurementCount: ... minStepCount: ... updateAllStoppedTrials: ... useElapsedDuration: ... decayCurveStoppingSpec: useElapsedDuration: ... measurementSelectionType: ... medianAutomatedStoppingSpec: useElapsedDuration: ... metrics: ... observationNoise: ... parameters: ... studyStoppingConfig: maxDurationNoProgress: ... maxNumTrials: ... maxNumTrialsNoProgress: ... maximumRuntimeConstraint: endTime: ... maxDuration: ... minNumTrials: ... minimumRuntimeConstraint: ... shouldStopAsap: ... trialJobSpec: baseOutputDirectory: outputUriPrefix: ... enableDashboardAccess: ... enableWebAccess: ... experiment: ... experimentRun: ... models: ... network: ... persistentResourceId: ... protectedArtifactLocationId: ... reservedIpRanges: ... scheduling: disableRetries: ... restartJobOnWorkerRestart: ... timeout: ... serviceAccount: ... tensorboard: ... workerPoolSpecs: ... result: createResult
JSON
[ { "create": { "call": "googleapis.aiplatform.v1.projects.locations.hyperparameterTuningJobs.create", "args": { "parent": "...", "region": "...", "body": { "displayName": "...", "encryptionSpec": { "kmsKeyName": "..." }, "labels": "...", "maxFailedTrialCount": "...", "maxTrialCount": "...", "parallelTrialCount": "...", "studySpec": { "algorithm": "...", "convexAutomatedStoppingSpec": { "learningRateParameterName": "...", "maxStepCount": "...", "minMeasurementCount": "...", "minStepCount": "...", "updateAllStoppedTrials": "...", "useElapsedDuration": "..." }, "decayCurveStoppingSpec": { "useElapsedDuration": "..." }, "measurementSelectionType": "...", "medianAutomatedStoppingSpec": { "useElapsedDuration": "..." }, "metrics": "...", "observationNoise": "...", "parameters": "...", "studyStoppingConfig": { "maxDurationNoProgress": "...", "maxNumTrials": "...", "maxNumTrialsNoProgress": "...", "maximumRuntimeConstraint": { "endTime": "...", "maxDuration": "..." }, "minNumTrials": "...", "minimumRuntimeConstraint": "...", "shouldStopAsap": "..." } }, "trialJobSpec": { "baseOutputDirectory": { "outputUriPrefix": "..." }, "enableDashboardAccess": "...", "enableWebAccess": "...", "experiment": "...", "experimentRun": "...", "models": "...", "network": "...", "persistentResourceId": "...", "protectedArtifactLocationId": "...", "reservedIpRanges": "...", "scheduling": { "disableRetries": "...", "restartJobOnWorkerRestart": "...", "timeout": "..." }, "serviceAccount": "...", "tensorboard": "...", "workerPoolSpecs": "..." } } }, "result": "createResult" } } ]