Class HyperparameterTuningJob (0.4.0)

HyperparameterTuningJob(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Represents a HyperparameterTuningJob. A HyperparameterTuningJob has a Study specification and multiple CustomJobs with identical CustomJob specification.


name str
Output only. Resource name of the HyperparameterTuningJob.
display_name str
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.
study_spec `.study.StudySpec`
Required. Study configuration of the HyperparameterTuningJob.
max_trial_count int
Required. The desired total number of Trials.
parallel_trial_count int
Required. The desired number of Trials to run in parallel.
max_failed_trial_count int
The number of failed Trials that need to be seen before failing the HyperparameterTuningJob. If set to 0, AI Platform decides how many Trials must fail before the whole job fails.
trial_job_spec `.custom_job.CustomJobSpec`
Required. The spec of a trial job. The same spec applies to the CustomJobs created in all the trials.
trials Sequence[`.study.Trial`]
Output only. Trials of the HyperparameterTuningJob.
state `.job_state.JobState`
Output only. The detailed state of the job.
create_time `.timestamp.Timestamp`
Output only. Time when the HyperparameterTuningJob was created.
start_time `.timestamp.Timestamp`
Output only. Time when the HyperparameterTuningJob for the first time entered the ``JOB_STATE_RUNNING`` state.
end_time `.timestamp.Timestamp`
Output only. Time when the HyperparameterTuningJob entered any of the following states: ``JOB_STATE_SUCCEEDED``, ``JOB_STATE_FAILED``, ``JOB_STATE_CANCELLED``.
update_time `.timestamp.Timestamp`
Output only. Time when the HyperparameterTuningJob was most recently updated.
error `.status.Status`
Output only. Only populated when job's state is JOB_STATE_FAILED or JOB_STATE_CANCELLED.
labels Sequence[`.hyperparameter_tuning_job.HyperparameterTuningJob.LabelsEntry`]
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 for more information and examples of labels.


builtins.object > proto.message.Message > HyperparameterTuningJob



LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The abstract base class for a message.

kwargs dict

Keys and values corresponding to the fields of the message.

mapping Union[dict, `.Message`]

A dictionary or message to be used to determine the values for this message.

ignore_unknown_fields Optional(bool)

If True, do not raise errors for unknown fields. Only applied if mapping is a mapping type or there are keyword parameters.