You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
title: About the google_vertex_ai_hyperparameter_tuning_job resource
3
+
platform: gcp
4
+
---
5
+
6
+
## Syntax
7
+
A `google_vertex_ai_hyperparameter_tuning_job` is used to test a Google HyperparameterTuningJob resource
8
+
9
+
## Examples
10
+
```
11
+
describe google_vertex_ai_hyperparameter_tuning_job(name: "projects/#{gcp_project_id}/locations/#{hyperparameter_tuning_job['region']}/hyperparameterTuningJobs/#{hyperparameter_tuning_job['name']}", region: ' value_region') do
12
+
it { should exist }
13
+
its('state') { should cmp 'value_state' }
14
+
its('end_time') { should cmp 'value_endtime' }
15
+
its('update_time') { should cmp 'value_updatetime' }
16
+
its('start_time') { should cmp 'value_starttime' }
17
+
its('create_time') { should cmp 'value_createtime' }
18
+
its('display_name') { should cmp 'value_displayname' }
19
+
its('name') { should cmp 'value_name' }
20
+
21
+
end
22
+
23
+
describe google_vertex_ai_hyperparameter_tuning_job(name: "does_not_exit", region: ' value_region') do
24
+
it { should_not exist }
25
+
end
26
+
```
27
+
28
+
## Properties
29
+
Properties that can be accessed from the `google_vertex_ai_hyperparameter_tuning_job` resource:
30
+
31
+
32
+
*`study_spec`: Required. Study configuration of the HyperparameterTuningJob.
33
+
34
+
*`trials`: Output only. Trials of the HyperparameterTuningJob.
35
+
36
+
*`state`: Output only. The detailed state of the job.
37
+
Possible values:
38
+
* JOB_STATE_UNSPECIFIED
39
+
* JOB_STATE_QUEUED
40
+
* JOB_STATE_PENDING
41
+
* JOB_STATE_RUNNING
42
+
* JOB_STATE_SUCCEEDED
43
+
* JOB_STATE_FAILED
44
+
* JOB_STATE_CANCELLING
45
+
* JOB_STATE_CANCELLED
46
+
* JOB_STATE_PAUSED
47
+
* JOB_STATE_EXPIRED
48
+
* JOB_STATE_UPDATING
49
+
* JOB_STATE_PARTIALLY_SUCCEEDED
50
+
51
+
*`max_failed_trial_count`: 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.
52
+
53
+
*`encryption_spec`: 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.
54
+
55
+
*`error`: Output only. Only populated when job's state is JOB_STATE_FAILED or JOB_STATE_CANCELLED.
56
+
57
+
*`end_time`: Output only. Time when the HyperparameterTuningJob entered any of the following states: `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`, `JOB_STATE_CANCELLED`.
58
+
59
+
*`update_time`: Output only. Time when the HyperparameterTuningJob was most recently updated.
60
+
61
+
*`start_time`: Output only. Time when the HyperparameterTuningJob for the first time entered the `JOB_STATE_RUNNING` state.
62
+
63
+
*`labels`: 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.
64
+
65
+
*`additional_properties`:
66
+
67
+
*`create_time`: Output only. Time when the HyperparameterTuningJob was created.
68
+
69
+
*`parallel_trial_count`: Required. The desired number of Trials to run in parallel.
70
+
71
+
*`trial_job_spec`: Required. The spec of a trial job. The same spec applies to the CustomJobs created in all the trials.
72
+
73
+
*`max_trial_count`: Required. The desired total number of Trials.
74
+
75
+
*`display_name`: Required. The display name of the HyperparameterTuningJob. The name can be up to 128 characters long and can consist of any UTF-8 characters.
76
+
77
+
*`name`: Output only. Resource name of the HyperparameterTuningJob.
0 commit comments