Aiplatform Hyperparameter Tuning Job

This table represents the aiplatform_hyperparameter_tuning_job resource from Google Cloud Platform.

gcp.aiplatform_hyperparameter_tuning_job

Fields

TitleIDTypeData TypeDescription
_keycorestring
ancestorscorearray<string>
create_timecoretimestampOutput only. Time when the HyperparameterTuningJob was created.
datadog_display_namecorestring
encryption_speccorejsonCustomer-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.
end_timecoretimestampOutput only. Time when the HyperparameterTuningJob entered any of the following states: `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`, `JOB_STATE_CANCELLED`.
errorcorejsonOutput only. Only populated when job's state is JOB_STATE_FAILED or JOB_STATE_CANCELLED.
gcp_display_namecorestringRequired. The display name of the HyperparameterTuningJob. The name can be up to 128 characters long and can consist of any UTF-8 characters.
labelscorearray<string>
max_failed_trial_countcoreint64The 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.
max_trial_countcoreint64Required. The desired total number of Trials.
namecorestringOutput only. Resource name of the HyperparameterTuningJob.
organization_idcorestring
parallel_trial_countcoreint64Required. The desired number of Trials to run in parallel.
parentcorestring
project_idcorestring
project_numbercorestring
resource_namecorestring
satisfies_pzicoreboolOutput only. Reserved for future use.
satisfies_pzscoreboolOutput only. Reserved for future use.
start_timecoretimestampOutput only. Time when the HyperparameterTuningJob for the first time entered the `JOB_STATE_RUNNING` state.
statecorestringOutput only. The detailed state of the job. Possible values: ['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']. Values descriptions: ['The job state is unspecified.', 'The job has been just created or resumed and processing has not yet begun.', 'The service is preparing to run the job.', 'The job is in progress.', 'The job completed successfully.', 'The job failed.', 'The job is being cancelled. From this state the job may only go to either `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED` or `JOB_STATE_CANCELLED`.', 'The job has been cancelled.', 'The job has been stopped, and can be resumed.', 'The job has expired.', 'The job is being updated. Only jobs in the `RUNNING` state can be updated. After updating, the job goes back to the `RUNNING` state.', 'The job is partially succeeded, some results may be missing due to errors.']
study_speccorejsonRequired. Study configuration of the HyperparameterTuningJob.
tagscorehstore
trial_job_speccorejsonRequired. The spec of a trial job. The same spec applies to the CustomJobs created in all the trials.
trialscorejsonOutput only. Trials of the HyperparameterTuningJob.
update_timecoretimestampOutput only. Time when the HyperparameterTuningJob was most recently updated.