Resource: HyperparameterTuningJob
Represents a HyperparameterTuningJob. A HyperparameterTuningJob has a Study specification and multiple CustomJobs with identical CustomJob specification.
JSON representation |
---|
{ "name": string, "displayName": string, "studySpec": { object ( |
Fields | |
---|---|
name |
Output only. Resource name of the HyperparameterTuningJob. |
displayName |
Required. The display name of the HyperparameterTuningJob. The name can be up to 128 characters long and can consist of any UTF-8 characters. |
studySpec |
Required. Study configuration of the HyperparameterTuningJob. |
maxTrialCount |
Required. The desired total number of Trials. |
parallelTrialCount |
Required. The desired number of Trials to run in parallel. |
maxFailedTrialCount |
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. |
trialJobSpec |
Required. The spec of a trial job. The same spec applies to the CustomJobs created in all the trials. |
trials[] |
Output only. Trials of the HyperparameterTuningJob. |
state |
Output only. The detailed state of the job. |
createTime |
Output only. time when the HyperparameterTuningJob was created. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
startTime |
Output only. time when the HyperparameterTuningJob for the first time entered the A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
endTime |
Output only. time when the HyperparameterTuningJob entered any of the following states: A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
updateTime |
Output only. time when the HyperparameterTuningJob was most recently updated. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
error |
Output only. Only populated when job's state is JOB_STATE_FAILED or JOB_STATE_CANCELLED. |
labels |
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. |
encryptionSpec |
Customer-managed encryption key options for a HyperparameterTuningJob. If this is set, then all resources created by the HyperparameterTuningJob will be encrypted with the provided encryption key. |
Methods |
|
---|---|
|
Cancels a HyperparameterTuningJob. |
|
Creates a HyperparameterTuningJob |
|
Deletes a HyperparameterTuningJob. |
|
Gets a HyperparameterTuningJob |
|
Lists HyperparameterTuningJobs in a Location. |