Sign in

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-132661,4471.5 MB
projects

Creates a HyperparameterTuningJob

post/v1/{+parent}/hyperparameterTuningJobs

Path parameters

parentstring required

Required. The resource name of the Location to create the HyperparameterTuningJob in. Format: projects/{project}/locations/{location}

Request body

startTimestring google-datetime

Output only. Time when the HyperparameterTuningJob for the first time entered the JOB_STATE_RUNNING state.

maxFailedTrialCountinteger

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.

endTimestring google-datetime

Output only. Time when the HyperparameterTuningJob entered any of the following states: JOB_STATE_SUCCEEDED, JOB_STATE_FAILED, JOB_STATE_CANCELLED.

parallelTrialCountinteger

Required. The desired number of Trials to run in parallel.

satisfiesPzsboolean

Output only. Reserved for future use.

displayNamestring

Required. The display name of the HyperparameterTuningJob. The name can be up to 128 characters long and can consist of any UTF-8 characters.

satisfiesPziboolean

Output only. Reserved for future use.

namestring

Output only. Resource name of the HyperparameterTuningJob.

maxTrialCountinteger

Required. The desired total number of Trials.

updateTimestring google-datetime

Output only. Time when the HyperparameterTuningJob was most recently updated.

labelsobject

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.

createTimestring google-datetime

Output only. Time when the HyperparameterTuningJob was created.

state'JOB_STATE_UNSPECIFIED' | 'JOB_STATE_QUEUED' | 'JOB_STATE_PENDING' | 'JOB_STATE_RUNNING' | 'JOB_STATE_SUCCEEDED' | 'JOB_STATE_FAILED' | 'JOB_STATE_CANCELLING' | 'JOB_STATE_CANCELLED' | 'JOB_STATE_PAUSED' | 'JOB_STATE_EXPIRED' | 'JOB_STATE_UPDATING' | 'JOB_STATE_PARTIALLY_SUCCEEDED'

Output only. The detailed state of the job.

Response

Successful response