GOgoogle
projects

GET /v1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}

Gets a HyperparameterTuningJob

Request

Path parameters

projectsIdstring required
locationsIdstring required
hyperparameterTuningJobsIdstring required

Response

Successful response

createTimestring google-datetime

Output only. Time when the HyperparameterTuningJob was created.

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.

endTimestring google-datetime

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

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.

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.

maxTrialCountinteger

Required. The desired total number of Trials.

namestring

Output only. Resource name of the HyperparameterTuningJob.

parallelTrialCountinteger

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

satisfiesPziboolean

Output only. Reserved for future use.

satisfiesPzsboolean

Output only. Reserved for future use.

startTimestring google-datetime

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

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.

updateTimestring google-datetime

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

Changes

No recorded changes to this operation across all 8 revisions of this API.