REST Resource: projects.locations.hyperparameterTuningJobs

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 be 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 (JobState)

Output only. The detailed state of the job.

createTime

string (Timestamp format)

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: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

startTime

string (Timestamp format)

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

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

endTime

string (Timestamp format)

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

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

updateTime

string (Timestamp format)

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: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

error

object (Status)

Output only. Only populated when job's state is JOB_STATE_FAILED or JOB_STATE_CANCELLED.

labels

map (key: string, value: string)

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

object (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

cancel

Cancels a HyperparameterTuningJob.

create

Creates a HyperparameterTuningJob

delete

Deletes a HyperparameterTuningJob.

get

Gets a HyperparameterTuningJob

list

Lists HyperparameterTuningJobs in a Location.