1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="ml_v1.html">AI Platform Training & Prediction API</a> . <a href="ml_v1.projects.html">projects</a> . <a href="ml_v1.projects.locations.html">locations</a> . <a href="ml_v1.projects.locations.studies.html">studies</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="ml_v1.projects.locations.studies.trials.html">trials()</a></code>
</p>
<p class="firstline">Returns the trials Resource.</p>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#create">create(parent, body=None, studyId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a study.</p>
<p class="toc_element">
<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a study.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets a study.</p>
<p class="toc_element">
<code><a href="#list">list(parent, x__xgafv=None)</a></code></p>
<p class="firstline">Lists all the studies in a region for an associated project.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="create">create(parent, body=None, studyId=None, x__xgafv=None)</code>
<pre>Creates a study.
Args:
parent: string, Required. The project and location that the study belongs to. Format: projects/{project}/locations/{location} (required)
body: object, The request body.
The object takes the form of:
{ # A message representing a Study.
"createTime": "A String", # Output only. Time at which the study was created.
"inactiveReason": "A String", # Output only. A human readable reason why the Study is inactive. This should be empty if a study is ACTIVE or COMPLETED.
"name": "A String", # Output only. The name of a study.
"state": "A String", # Output only. The detailed state of a study.
"studyConfig": { # Represents configuration of a study. # Required. Configuration of the study.
"algorithm": "A String", # The search algorithm specified for the study.
"automatedStoppingConfig": { # Configuration for Automated Early Stopping of Trials. If no implementation_config is set, automated early stopping will not be run. # Configuration for automated stopping of unpromising Trials.
"decayCurveStoppingConfig": {
"useElapsedTime": True or False, # If true, measurement.elapsed_time is used as the x-axis of each Trials Decay Curve. Otherwise, Measurement.steps will be used as the x-axis.
},
"medianAutomatedStoppingConfig": { # The median automated stopping rule stops a pending trial if the trial's best objective_value is strictly below the median 'performance' of all completed trials reported up to the trial's last measurement. Currently, 'performance' refers to the running average of the objective values reported by the trial in each measurement.
"useElapsedTime": True or False, # If true, the median automated stopping rule applies to measurement.use_elapsed_time, which means the elapsed_time field of the current trial's latest measurement is used to compute the median objective value for each completed trial.
},
},
"metrics": [ # Metric specs for the study.
{ # Represents a metric to optimize.
"goal": "A String", # Required. The optimization goal of the metric.
"metric": "A String", # Required. The name of the metric.
},
],
"parameters": [ # Required. The set of parameters to tune.
{ # Represents a single parameter to optimize.
"categoricalValueSpec": { # The value spec for a 'CATEGORICAL' parameter.
"values": [ # Must be specified if type is `CATEGORICAL`. The list of possible categories.
"A String",
],
},
"childParameterSpecs": [ # A child node is active if the parameter's value matches the child node's matching_parent_values. If two items in child_parameter_specs have the same name, they must have disjoint matching_parent_values.
# Object with schema name: GoogleCloudMlV1_StudyConfig_ParameterSpec
],
"discreteValueSpec": { # The value spec for a 'DISCRETE' parameter.
"values": [ # Must be specified if type is `DISCRETE`. A list of feasible points. The list should be in strictly increasing order. For instance, this parameter might have possible settings of 1.5, 2.5, and 4.0. This list should not contain more than 1,000 values.
3.14,
],
},
"doubleValueSpec": { # The value spec for a 'DOUBLE' parameter.
"maxValue": 3.14, # Must be specified if type is `DOUBLE`. Maximum value of the parameter.
"minValue": 3.14, # Must be specified if type is `DOUBLE`. Minimum value of the parameter.
},
"integerValueSpec": { # The value spec for an 'INTEGER' parameter.
"maxValue": "A String", # Must be specified if type is `INTEGER`. Maximum value of the parameter.
"minValue": "A String", # Must be specified if type is `INTEGER`. Minimum value of the parameter.
},
"parameter": "A String", # Required. The parameter name must be unique amongst all ParameterSpecs.
"parentCategoricalValues": { # Represents the spec to match categorical values from parent parameter.
"values": [ # Matches values of the parent parameter with type 'CATEGORICAL'. All values must exist in `categorical_value_spec` of parent parameter.
"A String",
],
},
"parentDiscreteValues": { # Represents the spec to match discrete values from parent parameter.
"values": [ # Matches values of the parent parameter with type 'DISCRETE'. All values must exist in `discrete_value_spec` of parent parameter.
3.14,
],
},
"parentIntValues": { # Represents the spec to match integer values from parent parameter.
"values": [ # Matches values of the parent parameter with type 'INTEGER'. All values must lie in `integer_value_spec` of parent parameter.
"A String",
],
},
"scaleType": "A String", # How the parameter should be scaled. Leave unset for categorical parameters.
"type": "A String", # Required. The type of the parameter.
},
],
},
}
studyId: string, Required. The ID to use for the study, which will become the final component of the study's resource name.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A message representing a Study.
"createTime": "A String", # Output only. Time at which the study was created.
"inactiveReason": "A String", # Output only. A human readable reason why the Study is inactive. This should be empty if a study is ACTIVE or COMPLETED.
"name": "A String", # Output only. The name of a study.
"state": "A String", # Output only. The detailed state of a study.
"studyConfig": { # Represents configuration of a study. # Required. Configuration of the study.
"algorithm": "A String", # The search algorithm specified for the study.
"automatedStoppingConfig": { # Configuration for Automated Early Stopping of Trials. If no implementation_config is set, automated early stopping will not be run. # Configuration for automated stopping of unpromising Trials.
"decayCurveStoppingConfig": {
"useElapsedTime": True or False, # If true, measurement.elapsed_time is used as the x-axis of each Trials Decay Curve. Otherwise, Measurement.steps will be used as the x-axis.
},
"medianAutomatedStoppingConfig": { # The median automated stopping rule stops a pending trial if the trial's best objective_value is strictly below the median 'performance' of all completed trials reported up to the trial's last measurement. Currently, 'performance' refers to the running average of the objective values reported by the trial in each measurement.
"useElapsedTime": True or False, # If true, the median automated stopping rule applies to measurement.use_elapsed_time, which means the elapsed_time field of the current trial's latest measurement is used to compute the median objective value for each completed trial.
},
},
"metrics": [ # Metric specs for the study.
{ # Represents a metric to optimize.
"goal": "A String", # Required. The optimization goal of the metric.
"metric": "A String", # Required. The name of the metric.
},
],
"parameters": [ # Required. The set of parameters to tune.
{ # Represents a single parameter to optimize.
"categoricalValueSpec": { # The value spec for a 'CATEGORICAL' parameter.
"values": [ # Must be specified if type is `CATEGORICAL`. The list of possible categories.
"A String",
],
},
"childParameterSpecs": [ # A child node is active if the parameter's value matches the child node's matching_parent_values. If two items in child_parameter_specs have the same name, they must have disjoint matching_parent_values.
# Object with schema name: GoogleCloudMlV1_StudyConfig_ParameterSpec
],
"discreteValueSpec": { # The value spec for a 'DISCRETE' parameter.
"values": [ # Must be specified if type is `DISCRETE`. A list of feasible points. The list should be in strictly increasing order. For instance, this parameter might have possible settings of 1.5, 2.5, and 4.0. This list should not contain more than 1,000 values.
3.14,
],
},
"doubleValueSpec": { # The value spec for a 'DOUBLE' parameter.
"maxValue": 3.14, # Must be specified if type is `DOUBLE`. Maximum value of the parameter.
"minValue": 3.14, # Must be specified if type is `DOUBLE`. Minimum value of the parameter.
},
"integerValueSpec": { # The value spec for an 'INTEGER' parameter.
"maxValue": "A String", # Must be specified if type is `INTEGER`. Maximum value of the parameter.
"minValue": "A String", # Must be specified if type is `INTEGER`. Minimum value of the parameter.
},
"parameter": "A String", # Required. The parameter name must be unique amongst all ParameterSpecs.
"parentCategoricalValues": { # Represents the spec to match categorical values from parent parameter.
"values": [ # Matches values of the parent parameter with type 'CATEGORICAL'. All values must exist in `categorical_value_spec` of parent parameter.
"A String",
],
},
"parentDiscreteValues": { # Represents the spec to match discrete values from parent parameter.
"values": [ # Matches values of the parent parameter with type 'DISCRETE'. All values must exist in `discrete_value_spec` of parent parameter.
3.14,
],
},
"parentIntValues": { # Represents the spec to match integer values from parent parameter.
"values": [ # Matches values of the parent parameter with type 'INTEGER'. All values must lie in `integer_value_spec` of parent parameter.
"A String",
],
},
"scaleType": "A String", # How the parameter should be scaled. Leave unset for categorical parameters.
"type": "A String", # Required. The type of the parameter.
},
],
},
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(name, x__xgafv=None)</code>
<pre>Deletes a study.
Args:
name: string, Required. The study name. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>Gets a study.
Args:
name: string, Required. The study name. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A message representing a Study.
"createTime": "A String", # Output only. Time at which the study was created.
"inactiveReason": "A String", # Output only. A human readable reason why the Study is inactive. This should be empty if a study is ACTIVE or COMPLETED.
"name": "A String", # Output only. The name of a study.
"state": "A String", # Output only. The detailed state of a study.
"studyConfig": { # Represents configuration of a study. # Required. Configuration of the study.
"algorithm": "A String", # The search algorithm specified for the study.
"automatedStoppingConfig": { # Configuration for Automated Early Stopping of Trials. If no implementation_config is set, automated early stopping will not be run. # Configuration for automated stopping of unpromising Trials.
"decayCurveStoppingConfig": {
"useElapsedTime": True or False, # If true, measurement.elapsed_time is used as the x-axis of each Trials Decay Curve. Otherwise, Measurement.steps will be used as the x-axis.
},
"medianAutomatedStoppingConfig": { # The median automated stopping rule stops a pending trial if the trial's best objective_value is strictly below the median 'performance' of all completed trials reported up to the trial's last measurement. Currently, 'performance' refers to the running average of the objective values reported by the trial in each measurement.
"useElapsedTime": True or False, # If true, the median automated stopping rule applies to measurement.use_elapsed_time, which means the elapsed_time field of the current trial's latest measurement is used to compute the median objective value for each completed trial.
},
},
"metrics": [ # Metric specs for the study.
{ # Represents a metric to optimize.
"goal": "A String", # Required. The optimization goal of the metric.
"metric": "A String", # Required. The name of the metric.
},
],
"parameters": [ # Required. The set of parameters to tune.
{ # Represents a single parameter to optimize.
"categoricalValueSpec": { # The value spec for a 'CATEGORICAL' parameter.
"values": [ # Must be specified if type is `CATEGORICAL`. The list of possible categories.
"A String",
],
},
"childParameterSpecs": [ # A child node is active if the parameter's value matches the child node's matching_parent_values. If two items in child_parameter_specs have the same name, they must have disjoint matching_parent_values.
# Object with schema name: GoogleCloudMlV1_StudyConfig_ParameterSpec
],
"discreteValueSpec": { # The value spec for a 'DISCRETE' parameter.
"values": [ # Must be specified if type is `DISCRETE`. A list of feasible points. The list should be in strictly increasing order. For instance, this parameter might have possible settings of 1.5, 2.5, and 4.0. This list should not contain more than 1,000 values.
3.14,
],
},
"doubleValueSpec": { # The value spec for a 'DOUBLE' parameter.
"maxValue": 3.14, # Must be specified if type is `DOUBLE`. Maximum value of the parameter.
"minValue": 3.14, # Must be specified if type is `DOUBLE`. Minimum value of the parameter.
},
"integerValueSpec": { # The value spec for an 'INTEGER' parameter.
"maxValue": "A String", # Must be specified if type is `INTEGER`. Maximum value of the parameter.
"minValue": "A String", # Must be specified if type is `INTEGER`. Minimum value of the parameter.
},
"parameter": "A String", # Required. The parameter name must be unique amongst all ParameterSpecs.
"parentCategoricalValues": { # Represents the spec to match categorical values from parent parameter.
"values": [ # Matches values of the parent parameter with type 'CATEGORICAL'. All values must exist in `categorical_value_spec` of parent parameter.
"A String",
],
},
"parentDiscreteValues": { # Represents the spec to match discrete values from parent parameter.
"values": [ # Matches values of the parent parameter with type 'DISCRETE'. All values must exist in `discrete_value_spec` of parent parameter.
3.14,
],
},
"parentIntValues": { # Represents the spec to match integer values from parent parameter.
"values": [ # Matches values of the parent parameter with type 'INTEGER'. All values must lie in `integer_value_spec` of parent parameter.
"A String",
],
},
"scaleType": "A String", # How the parameter should be scaled. Leave unset for categorical parameters.
"type": "A String", # Required. The type of the parameter.
},
],
},
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, x__xgafv=None)</code>
<pre>Lists all the studies in a region for an associated project.
Args:
parent: string, Required. The project and location that the study belongs to. Format: projects/{project}/locations/{location} (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"studies": [ # The studies associated with the project.
{ # A message representing a Study.
"createTime": "A String", # Output only. Time at which the study was created.
"inactiveReason": "A String", # Output only. A human readable reason why the Study is inactive. This should be empty if a study is ACTIVE or COMPLETED.
"name": "A String", # Output only. The name of a study.
"state": "A String", # Output only. The detailed state of a study.
"studyConfig": { # Represents configuration of a study. # Required. Configuration of the study.
"algorithm": "A String", # The search algorithm specified for the study.
"automatedStoppingConfig": { # Configuration for Automated Early Stopping of Trials. If no implementation_config is set, automated early stopping will not be run. # Configuration for automated stopping of unpromising Trials.
"decayCurveStoppingConfig": {
"useElapsedTime": True or False, # If true, measurement.elapsed_time is used as the x-axis of each Trials Decay Curve. Otherwise, Measurement.steps will be used as the x-axis.
},
"medianAutomatedStoppingConfig": { # The median automated stopping rule stops a pending trial if the trial's best objective_value is strictly below the median 'performance' of all completed trials reported up to the trial's last measurement. Currently, 'performance' refers to the running average of the objective values reported by the trial in each measurement.
"useElapsedTime": True or False, # If true, the median automated stopping rule applies to measurement.use_elapsed_time, which means the elapsed_time field of the current trial's latest measurement is used to compute the median objective value for each completed trial.
},
},
"metrics": [ # Metric specs for the study.
{ # Represents a metric to optimize.
"goal": "A String", # Required. The optimization goal of the metric.
"metric": "A String", # Required. The name of the metric.
},
],
"parameters": [ # Required. The set of parameters to tune.
{ # Represents a single parameter to optimize.
"categoricalValueSpec": { # The value spec for a 'CATEGORICAL' parameter.
"values": [ # Must be specified if type is `CATEGORICAL`. The list of possible categories.
"A String",
],
},
"childParameterSpecs": [ # A child node is active if the parameter's value matches the child node's matching_parent_values. If two items in child_parameter_specs have the same name, they must have disjoint matching_parent_values.
# Object with schema name: GoogleCloudMlV1_StudyConfig_ParameterSpec
],
"discreteValueSpec": { # The value spec for a 'DISCRETE' parameter.
"values": [ # Must be specified if type is `DISCRETE`. A list of feasible points. The list should be in strictly increasing order. For instance, this parameter might have possible settings of 1.5, 2.5, and 4.0. This list should not contain more than 1,000 values.
3.14,
],
},
"doubleValueSpec": { # The value spec for a 'DOUBLE' parameter.
"maxValue": 3.14, # Must be specified if type is `DOUBLE`. Maximum value of the parameter.
"minValue": 3.14, # Must be specified if type is `DOUBLE`. Minimum value of the parameter.
},
"integerValueSpec": { # The value spec for an 'INTEGER' parameter.
"maxValue": "A String", # Must be specified if type is `INTEGER`. Maximum value of the parameter.
"minValue": "A String", # Must be specified if type is `INTEGER`. Minimum value of the parameter.
},
"parameter": "A String", # Required. The parameter name must be unique amongst all ParameterSpecs.
"parentCategoricalValues": { # Represents the spec to match categorical values from parent parameter.
"values": [ # Matches values of the parent parameter with type 'CATEGORICAL'. All values must exist in `categorical_value_spec` of parent parameter.
"A String",
],
},
"parentDiscreteValues": { # Represents the spec to match discrete values from parent parameter.
"values": [ # Matches values of the parent parameter with type 'DISCRETE'. All values must exist in `discrete_value_spec` of parent parameter.
3.14,
],
},
"parentIntValues": { # Represents the spec to match integer values from parent parameter.
"values": [ # Matches values of the parent parameter with type 'INTEGER'. All values must lie in `integer_value_spec` of parent parameter.
"A String",
],
},
"scaleType": "A String", # How the parameter should be scaled. Leave unset for categorical parameters.
"type": "A String", # Required. The type of the parameter.
},
],
},
},
],
}</pre>
</div>
</body></html>
|
