REST Resource: projects.locations.hyperparameterTuningJobs

Stay organized with collections Save and categorize content based on your preferences.

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 (StudySpec)
  },
  "maxTrialCount": integer,
  "parallelTrialCount": integer,
  "maxFailedTrialCount": integer,
  "trialJobSpec": {
    object (CustomJobSpec)
  },
  "trials": [
    {
      object (Trial)
    }
  ],
  "state": enum (JobState),
  "createTime": string,
  "startTime": string,
  "endTime": string,
  "updateTime": string,
  "error": {
    object (Status)
  },
  "labels": {
    string: string,
    ...
  },
  "encryptionSpec": {
    object (EncryptionSpec)
  }
}
Fields
name

string

Output only. Resource name of the HyperparameterTuningJob.

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.

studySpec

object (StudySpec)

Required. Study configuration of the HyperparameterTuningJob.

maxTrialCount

integer

Required. The desired total number of Trials.

parallelTrialCount

integer

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

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.

trialJobSpec

object (CustomJobSpec)

Required. The spec of a trial job. The same spec applies to the CustomJobs created in all the trials.

trials[]

object (Trial)

Output only. Trials of the HyperparameterTuningJob.

state

enum (