Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class HyperparameterTuningJob.
Represents a HyperparameterTuningJob. A HyperparameterTuningJob has a Study specification and multiple CustomJobs with identical CustomJob specification.
Generated from protobuf message google.cloud.aiplatform.v1.HyperparameterTuningJob
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Output only. Resource name of the HyperparameterTuningJob. |
↳ display_name |
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. |
↳ study_spec |
Google\Cloud\AIPlatform\V1\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, Vertex AI decides how many Trials must fail before the whole job fails. |
↳ trial_job_spec |
Google\Cloud\AIPlatform\V1\CustomJobSpec
Required. The spec of a trial job. The same spec applies to the CustomJobs created in all the trials. |
↳ trials |
array<Google\Cloud\AIPlatform\V1\Trial>
Output only. Trials of the HyperparameterTuningJob. |
↳ state |
int
Output only. The detailed state of the job. |
↳ create_time |
Google\Protobuf\Timestamp
Output only. Time when the HyperparameterTuningJob was created. |
↳ start_time |
Google\Protobuf\Timestamp
Output only. Time when the HyperparameterTuningJob for the first time entered the |
↳ end_time |
Google\Protobuf\Timestamp
Output only. Time when the HyperparameterTuningJob entered any of the following states: |
↳ update_time |
Google\Protobuf\Timestamp
Output only. Time when the HyperparameterTuningJob was most recently updated. |
↳ error |
Google\Rpc\Status
Output only. Only populated when job's state is JOB_STATE_FAILED or JOB_STATE_CANCELLED. |
↳ labels |
array|Google\Protobuf\Internal\MapField
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. |
↳ encryption_spec |
Google\Cloud\AIPlatform\V1\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. |
getName
Output only. Resource name of the HyperparameterTuningJob.
Generated from protobuf field string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
string | |
setName
Output only. Resource name of the HyperparameterTuningJob.
Generated from protobuf field string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDisplayName
Required. The display name of the HyperparameterTuningJob.
The name can be up to 128 characters long and can consist of any UTF-8 characters.
Generated from protobuf field string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
string | |
setDisplayName
Required. The display name of the HyperparameterTuningJob.
The name can be up to 128 characters long and can consist of any UTF-8 characters.
Generated from protobuf field string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getStudySpec
Required. Study configuration of the HyperparameterTuningJob.
Generated from protobuf field .google.cloud.aiplatform.v1.StudySpec study_spec = 4 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\AIPlatform\V1\StudySpec|null | |
hasStudySpec
clearStudySpec
setStudySpec
Required. Study configuration of the HyperparameterTuningJob.
Generated from protobuf field .google.cloud.aiplatform.v1.StudySpec study_spec = 4 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\AIPlatform\V1\StudySpec
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getMaxTrialCount
Required. The desired total number of Trials.
Generated from protobuf field int32 max_trial_count = 5 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
int | |
setMaxTrialCount
Required. The desired total number of Trials.
Generated from protobuf field int32 max_trial_count = 5 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getParallelTrialCount
Required. The desired number of Trials to run in parallel.
Generated from protobuf field int32 parallel_trial_count = 6 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
int | |
setParallelTrialCount
Required. The desired number of Trials to run in parallel.
Generated from protobuf field int32 parallel_trial_count = 6 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getMaxFailedTrialCount
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.
Generated from protobuf field int32 max_failed_trial_count = 7;
| Returns | |
|---|---|
| Type | Description |
int | |
setMaxFailedTrialCount
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.
Generated from protobuf field int32 max_failed_trial_count = 7;
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getTrialJobSpec
Required. The spec of a trial job. The same spec applies to the CustomJobs created in all the trials.
Generated from protobuf field .google.cloud.aiplatform.v1.CustomJobSpec trial_job_spec = 8 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\AIPlatform\V1\CustomJobSpec|null | |
hasTrialJobSpec
clearTrialJobSpec
setTrialJobSpec
Required. The spec of a trial job. The same spec applies to the CustomJobs created in all the trials.
Generated from protobuf field .google.cloud.aiplatform.v1.CustomJobSpec trial_job_spec = 8 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\AIPlatform\V1\CustomJobSpec
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getTrials
Output only. Trials of the HyperparameterTuningJob.
Generated from protobuf field repeated .google.cloud.aiplatform.v1.Trial trials = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setTrials
Output only. Trials of the HyperparameterTuningJob.
Generated from protobuf field repeated .google.cloud.aiplatform.v1.Trial trials = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\AIPlatform\V1\Trial>
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getState
Output only. The detailed state of the job.
Generated from protobuf field .google.cloud.aiplatform.v1.JobState state = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
int | |
setState
Output only. The detailed state of the job.
Generated from protobuf field .google.cloud.aiplatform.v1.JobState state = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getCreateTime
Output only. Time when the HyperparameterTuningJob was created.
Generated from protobuf field .google.protobuf.Timestamp create_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasCreateTime
clearCreateTime
setCreateTime
Output only. Time when the HyperparameterTuningJob was created.
Generated from protobuf field .google.protobuf.Timestamp create_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getStartTime
Output only. Time when the HyperparameterTuningJob for the first time entered the
JOB_STATE_RUNNING state.
Generated from protobuf field .google.protobuf.Timestamp start_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasStartTime
clearStartTime
setStartTime
Output only. Time when the HyperparameterTuningJob for the first time entered the
JOB_STATE_RUNNING state.
Generated from protobuf field .google.protobuf.Timestamp start_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getEndTime
Output only. Time when the HyperparameterTuningJob entered any of the following states:
JOB_STATE_SUCCEEDED, JOB_STATE_FAILED, JOB_STATE_CANCELLED.
Generated from protobuf field .google.protobuf.Timestamp end_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasEndTime
clearEndTime
setEndTime
Output only. Time when the HyperparameterTuningJob entered any of the following states:
JOB_STATE_SUCCEEDED, JOB_STATE_FAILED, JOB_STATE_CANCELLED.
Generated from protobuf field .google.protobuf.Timestamp end_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getUpdateTime
Output only. Time when the HyperparameterTuningJob was most recently updated.
Generated from protobuf field .google.protobuf.Timestamp update_time = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. Time when the HyperparameterTuningJob was most recently updated.
Generated from protobuf field .google.protobuf.Timestamp update_time = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getError
Output only. Only populated when job's state is JOB_STATE_FAILED or JOB_STATE_CANCELLED.
Generated from protobuf field .google.rpc.Status error = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Google\Rpc\Status|null | |
hasError
clearError
setError
Output only. Only populated when job's state is JOB_STATE_FAILED or JOB_STATE_CANCELLED.
Generated from protobuf field .google.rpc.Status error = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Rpc\Status
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getLabels
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.
Generated from protobuf field map<string, string> labels = 16;
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField | |
setLabels
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.
Generated from protobuf field map<string, string> labels = 16;
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getEncryptionSpec
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.
Generated from protobuf field .google.cloud.aiplatform.v1.EncryptionSpec encryption_spec = 17;
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\AIPlatform\V1\EncryptionSpec|null | |
hasEncryptionSpec
clearEncryptionSpec
setEncryptionSpec
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.
Generated from protobuf field .google.cloud.aiplatform.v1.EncryptionSpec encryption_spec = 17;
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\AIPlatform\V1\EncryptionSpec
|
| Returns | |
|---|---|
| Type | Description |
$this | |