blob: f6c69d95adb47baf2dc08d67859ab0db6072d4a3 [file] [log] [blame]
Bu Sun Kim65020912020-05-20 12:08:20 -07001<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<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> . <a href="ml_v1.projects.locations.studies.trials.html">trials</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#addMeasurement">addMeasurement(name, body=None, x__xgafv=None)</a></code></p>
79<p class="firstline">Adds a measurement of the objective metrics to a trial. This measurement</p>
80<p class="toc_element">
81 <code><a href="#checkEarlyStoppingState">checkEarlyStoppingState(name, body=None, x__xgafv=None)</a></code></p>
82<p class="firstline">Checks whether a trial should stop or not. Returns a</p>
83<p class="toc_element">
84 <code><a href="#complete">complete(name, body=None, x__xgafv=None)</a></code></p>
85<p class="firstline">Marks a trial as complete.</p>
86<p class="toc_element">
87 <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
88<p class="firstline">Adds a user provided trial to a study.</p>
89<p class="toc_element">
90 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
91<p class="firstline">Deletes a trial.</p>
92<p class="toc_element">
93 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
94<p class="firstline">Gets a trial.</p>
95<p class="toc_element">
96 <code><a href="#list">list(parent, x__xgafv=None)</a></code></p>
97<p class="firstline">Lists the trials associated with a study.</p>
98<p class="toc_element">
99 <code><a href="#stop">stop(name, body=None, x__xgafv=None)</a></code></p>
100<p class="firstline">Stops a trial.</p>
101<p class="toc_element">
102 <code><a href="#suggest">suggest(parent, body=None, x__xgafv=None)</a></code></p>
103<p class="firstline">Adds one or more trials to a study, with parameter values</p>
104<h3>Method Details</h3>
105<div class="method">
106 <code class="details" id="addMeasurement">addMeasurement(name, body=None, x__xgafv=None)</code>
107 <pre>Adds a measurement of the objective metrics to a trial. This measurement
108is assumed to have been taken before the trial is complete.
109
110Args:
111 name: string, Required. The trial name. (required)
112 body: object, The request body.
113 The object takes the form of:
114
115{ # The request message for the AddTrialMeasurement service method.
116 &quot;measurement&quot;: { # A message representing a measurement. # Required. The measurement to be added to a trial.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700117 &quot;elapsedTime&quot;: &quot;A String&quot;, # Output only. Time that the trial has been running at the point of
118 # this measurement.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700119 &quot;stepCount&quot;: &quot;A String&quot;, # The number of steps a machine learning model has been trained for.
120 # Must be non-negative.
Bu Sun Kim65020912020-05-20 12:08:20 -0700121 &quot;metrics&quot;: [ # Provides a list of metrics that act as inputs into the objective
122 # function.
123 { # A message representing a metric in the measurement.
124 &quot;value&quot;: 3.14, # Required. The value for this metric.
125 &quot;metric&quot;: &quot;A String&quot;, # Required. Metric name.
126 },
127 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700128 },
129 }
130
131 x__xgafv: string, V1 error format.
132 Allowed values
133 1 - v1 error format
134 2 - v2 error format
135
136Returns:
137 An object of the form:
138
139 { # A message representing a trial.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700140 &quot;infeasibleReason&quot;: &quot;A String&quot;, # Output only. A human readable string describing why the trial is
141 # infeasible. This should only be set if trial_infeasible is true.
142 &quot;endTime&quot;: &quot;A String&quot;, # Output only. Time at which the trial&#x27;s status changed to COMPLETED.
143 &quot;measurements&quot;: [ # A list of measurements that are strictly lexicographically
144 # ordered by their induced tuples (steps, elapsed_time).
145 # These are used for early stopping computations.
146 { # A message representing a measurement.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700147 &quot;elapsedTime&quot;: &quot;A String&quot;, # Output only. Time that the trial has been running at the point of
148 # this measurement.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700149 &quot;stepCount&quot;: &quot;A String&quot;, # The number of steps a machine learning model has been trained for.
150 # Must be non-negative.
Bu Sun Kim65020912020-05-20 12:08:20 -0700151 &quot;metrics&quot;: [ # Provides a list of metrics that act as inputs into the objective
152 # function.
153 { # A message representing a metric in the measurement.
154 &quot;value&quot;: 3.14, # Required. The value for this metric.
155 &quot;metric&quot;: &quot;A String&quot;, # Required. Metric name.
156 },
157 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700158 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700159 ],
160 &quot;clientId&quot;: &quot;A String&quot;, # Output only. The identifier of the client that originally requested this trial.
161 &quot;parameters&quot;: [ # The parameters of the trial.
162 { # A message representing a parameter to be tuned. Contains the name of
163 # the parameter and the suggested value to use for this trial.
164 &quot;intValue&quot;: &quot;A String&quot;, # Must be set if ParameterType is INTEGER
165 &quot;stringValue&quot;: &quot;A String&quot;, # Must be set if ParameterTypeis CATEGORICAL
166 &quot;parameter&quot;: &quot;A String&quot;, # The name of the parameter.
167 &quot;floatValue&quot;: 3.14, # Must be set if ParameterType is DOUBLE or DISCRETE.
168 },
169 ],
170 &quot;state&quot;: &quot;A String&quot;, # The detailed state of a trial.
171 &quot;finalMeasurement&quot;: { # A message representing a measurement. # The final measurement containing the objective value.
172 &quot;elapsedTime&quot;: &quot;A String&quot;, # Output only. Time that the trial has been running at the point of
173 # this measurement.
174 &quot;stepCount&quot;: &quot;A String&quot;, # The number of steps a machine learning model has been trained for.
175 # Must be non-negative.
176 &quot;metrics&quot;: [ # Provides a list of metrics that act as inputs into the objective
177 # function.
178 { # A message representing a metric in the measurement.
179 &quot;value&quot;: 3.14, # Required. The value for this metric.
180 &quot;metric&quot;: &quot;A String&quot;, # Required. Metric name.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700181 },
182 ],
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700183 },
184 &quot;trialInfeasible&quot;: True or False, # Output only. If true, the parameters in this trial are not attempted again.
185 &quot;startTime&quot;: &quot;A String&quot;, # Output only. Time at which the trial was started.
186 &quot;name&quot;: &quot;A String&quot;, # Output only. Name of the trial assigned by the service.
187 }</pre>
Bu Sun Kim65020912020-05-20 12:08:20 -0700188</div>
189
190<div class="method">
191 <code class="details" id="checkEarlyStoppingState">checkEarlyStoppingState(name, body=None, x__xgafv=None)</code>
192 <pre>Checks whether a trial should stop or not. Returns a
193long-running operation. When the operation is successful,
194it will contain a
195CheckTrialEarlyStoppingStateResponse.
196
197Args:
198 name: string, Required. The trial name. (required)
199 body: object, The request body.
200 The object takes the form of:
201
202{ # The request message for the CheckTrialEarlyStoppingState service method.
203 }
204
205 x__xgafv: string, V1 error format.
206 Allowed values
207 1 - v1 error format
208 2 - v2 error format
209
210Returns:
211 An object of the form:
212
213 { # This resource represents a long-running operation that is the result of a
214 # network API call.
Bu Sun Kim65020912020-05-20 12:08:20 -0700215 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
216 # different programming environments, including REST APIs and RPC APIs. It is
217 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
218 # three pieces of data: error code, error message, and error details.
219 #
220 # You can find out more about this error model and how to work with it in the
221 # [API Design Guide](https://cloud.google.com/apis/design/errors).
222 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
223 # message types for APIs to use.
224 {
225 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
226 },
227 ],
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700228 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
229 # user-facing error message should be localized and sent in the
230 # google.rpc.Status.details field, or localized by the client.
231 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
Bu Sun Kim65020912020-05-20 12:08:20 -0700232 },
233 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress.
234 # If `true`, the operation is completed, and either `error` or `response` is
235 # available.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700236 &quot;response&quot;: { # The normal response of the operation in case of success. If the original
237 # method returns no data on success, such as `Delete`, the response is
238 # `google.protobuf.Empty`. If the original method is standard
239 # `Get`/`Create`/`Update`, the response should be the resource. For other
240 # methods, the response should have the type `XxxResponse`, where `Xxx`
241 # is the original method name. For example, if the original method name
242 # is `TakeSnapshot()`, the inferred response type is
243 # `TakeSnapshotResponse`.
244 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
245 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700246 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically
247 # contains progress information and common metadata such as create time.
248 # Some services might not provide such metadata. Any method that returns a
249 # long-running operation should document the metadata type, if any.
250 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
251 },
252 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that
253 # originally returns it. If you use the default HTTP mapping, the
254 # `name` should be a resource name ending with `operations/{unique_id}`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700255 }</pre>
256</div>
257
258<div class="method">
259 <code class="details" id="complete">complete(name, body=None, x__xgafv=None)</code>
260 <pre>Marks a trial as complete.
261
262Args:
263 name: string, Required. The trial name.metat (required)
264 body: object, The request body.
265 The object takes the form of:
266
267{ # The request message for the CompleteTrial service method.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700268 &quot;infeasibleReason&quot;: &quot;A String&quot;, # Optional. A human readable reason why the trial was infeasible. This should
269 # only be provided if `trial_infeasible` is true.
270 &quot;trialInfeasible&quot;: True or False, # Optional. True if the trial cannot be run with the given Parameter, and
271 # final_measurement will be ignored.
Bu Sun Kim65020912020-05-20 12:08:20 -0700272 &quot;finalMeasurement&quot;: { # A message representing a measurement. # Optional. If provided, it will be used as the completed trial&#x27;s
273 # final_measurement; Otherwise, the service will auto-select a
274 # previously reported measurement as the final-measurement
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700275 &quot;elapsedTime&quot;: &quot;A String&quot;, # Output only. Time that the trial has been running at the point of
276 # this measurement.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700277 &quot;stepCount&quot;: &quot;A String&quot;, # The number of steps a machine learning model has been trained for.
278 # Must be non-negative.
Bu Sun Kim65020912020-05-20 12:08:20 -0700279 &quot;metrics&quot;: [ # Provides a list of metrics that act as inputs into the objective
280 # function.
281 { # A message representing a metric in the measurement.
282 &quot;value&quot;: 3.14, # Required. The value for this metric.
283 &quot;metric&quot;: &quot;A String&quot;, # Required. Metric name.
284 },
285 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700286 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700287 }
288
289 x__xgafv: string, V1 error format.
290 Allowed values
291 1 - v1 error format
292 2 - v2 error format
293
294Returns:
295 An object of the form:
296
297 { # A message representing a trial.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700298 &quot;infeasibleReason&quot;: &quot;A String&quot;, # Output only. A human readable string describing why the trial is
299 # infeasible. This should only be set if trial_infeasible is true.
300 &quot;endTime&quot;: &quot;A String&quot;, # Output only. Time at which the trial&#x27;s status changed to COMPLETED.
301 &quot;measurements&quot;: [ # A list of measurements that are strictly lexicographically
302 # ordered by their induced tuples (steps, elapsed_time).
303 # These are used for early stopping computations.
304 { # A message representing a measurement.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700305 &quot;elapsedTime&quot;: &quot;A String&quot;, # Output only. Time that the trial has been running at the point of
306 # this measurement.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700307 &quot;stepCount&quot;: &quot;A String&quot;, # The number of steps a machine learning model has been trained for.
308 # Must be non-negative.
Bu Sun Kim65020912020-05-20 12:08:20 -0700309 &quot;metrics&quot;: [ # Provides a list of metrics that act as inputs into the objective
310 # function.
311 { # A message representing a metric in the measurement.
312 &quot;value&quot;: 3.14, # Required. The value for this metric.
313 &quot;metric&quot;: &quot;A String&quot;, # Required. Metric name.
314 },
315 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700316 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700317 ],
318 &quot;clientId&quot;: &quot;A String&quot;, # Output only. The identifier of the client that originally requested this trial.
319 &quot;parameters&quot;: [ # The parameters of the trial.
320 { # A message representing a parameter to be tuned. Contains the name of
321 # the parameter and the suggested value to use for this trial.
322 &quot;intValue&quot;: &quot;A String&quot;, # Must be set if ParameterType is INTEGER
323 &quot;stringValue&quot;: &quot;A String&quot;, # Must be set if ParameterTypeis CATEGORICAL
324 &quot;parameter&quot;: &quot;A String&quot;, # The name of the parameter.
325 &quot;floatValue&quot;: 3.14, # Must be set if ParameterType is DOUBLE or DISCRETE.
326 },
327 ],
328 &quot;state&quot;: &quot;A String&quot;, # The detailed state of a trial.
329 &quot;finalMeasurement&quot;: { # A message representing a measurement. # The final measurement containing the objective value.
330 &quot;elapsedTime&quot;: &quot;A String&quot;, # Output only. Time that the trial has been running at the point of
331 # this measurement.
332 &quot;stepCount&quot;: &quot;A String&quot;, # The number of steps a machine learning model has been trained for.
333 # Must be non-negative.
334 &quot;metrics&quot;: [ # Provides a list of metrics that act as inputs into the objective
335 # function.
336 { # A message representing a metric in the measurement.
337 &quot;value&quot;: 3.14, # Required. The value for this metric.
338 &quot;metric&quot;: &quot;A String&quot;, # Required. Metric name.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700339 },
340 ],
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700341 },
342 &quot;trialInfeasible&quot;: True or False, # Output only. If true, the parameters in this trial are not attempted again.
343 &quot;startTime&quot;: &quot;A String&quot;, # Output only. Time at which the trial was started.
344 &quot;name&quot;: &quot;A String&quot;, # Output only. Name of the trial assigned by the service.
345 }</pre>
Bu Sun Kim65020912020-05-20 12:08:20 -0700346</div>
347
348<div class="method">
349 <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
350 <pre>Adds a user provided trial to a study.
351
352Args:
353 parent: string, Required. The name of the study that the trial belongs to. (required)
354 body: object, The request body.
355 The object takes the form of:
356
357{ # A message representing a trial.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700358 &quot;infeasibleReason&quot;: &quot;A String&quot;, # Output only. A human readable string describing why the trial is
359 # infeasible. This should only be set if trial_infeasible is true.
360 &quot;endTime&quot;: &quot;A String&quot;, # Output only. Time at which the trial&#x27;s status changed to COMPLETED.
361 &quot;measurements&quot;: [ # A list of measurements that are strictly lexicographically
362 # ordered by their induced tuples (steps, elapsed_time).
363 # These are used for early stopping computations.
364 { # A message representing a measurement.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700365 &quot;elapsedTime&quot;: &quot;A String&quot;, # Output only. Time that the trial has been running at the point of
366 # this measurement.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700367 &quot;stepCount&quot;: &quot;A String&quot;, # The number of steps a machine learning model has been trained for.
368 # Must be non-negative.
Bu Sun Kim65020912020-05-20 12:08:20 -0700369 &quot;metrics&quot;: [ # Provides a list of metrics that act as inputs into the objective
370 # function.
371 { # A message representing a metric in the measurement.
372 &quot;value&quot;: 3.14, # Required. The value for this metric.
373 &quot;metric&quot;: &quot;A String&quot;, # Required. Metric name.
374 },
375 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700376 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700377 ],
378 &quot;clientId&quot;: &quot;A String&quot;, # Output only. The identifier of the client that originally requested this trial.
379 &quot;parameters&quot;: [ # The parameters of the trial.
380 { # A message representing a parameter to be tuned. Contains the name of
381 # the parameter and the suggested value to use for this trial.
382 &quot;intValue&quot;: &quot;A String&quot;, # Must be set if ParameterType is INTEGER
383 &quot;stringValue&quot;: &quot;A String&quot;, # Must be set if ParameterTypeis CATEGORICAL
384 &quot;parameter&quot;: &quot;A String&quot;, # The name of the parameter.
385 &quot;floatValue&quot;: 3.14, # Must be set if ParameterType is DOUBLE or DISCRETE.
386 },
387 ],
388 &quot;state&quot;: &quot;A String&quot;, # The detailed state of a trial.
389 &quot;finalMeasurement&quot;: { # A message representing a measurement. # The final measurement containing the objective value.
390 &quot;elapsedTime&quot;: &quot;A String&quot;, # Output only. Time that the trial has been running at the point of
391 # this measurement.
392 &quot;stepCount&quot;: &quot;A String&quot;, # The number of steps a machine learning model has been trained for.
393 # Must be non-negative.
394 &quot;metrics&quot;: [ # Provides a list of metrics that act as inputs into the objective
395 # function.
396 { # A message representing a metric in the measurement.
397 &quot;value&quot;: 3.14, # Required. The value for this metric.
398 &quot;metric&quot;: &quot;A String&quot;, # Required. Metric name.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700399 },
400 ],
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700401 },
402 &quot;trialInfeasible&quot;: True or False, # Output only. If true, the parameters in this trial are not attempted again.
403 &quot;startTime&quot;: &quot;A String&quot;, # Output only. Time at which the trial was started.
404 &quot;name&quot;: &quot;A String&quot;, # Output only. Name of the trial assigned by the service.
405}
Bu Sun Kim65020912020-05-20 12:08:20 -0700406
407 x__xgafv: string, V1 error format.
408 Allowed values
409 1 - v1 error format
410 2 - v2 error format
411
412Returns:
413 An object of the form:
414
415 { # A message representing a trial.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700416 &quot;infeasibleReason&quot;: &quot;A String&quot;, # Output only. A human readable string describing why the trial is
417 # infeasible. This should only be set if trial_infeasible is true.
418 &quot;endTime&quot;: &quot;A String&quot;, # Output only. Time at which the trial&#x27;s status changed to COMPLETED.
419 &quot;measurements&quot;: [ # A list of measurements that are strictly lexicographically
420 # ordered by their induced tuples (steps, elapsed_time).
421 # These are used for early stopping computations.
422 { # A message representing a measurement.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700423 &quot;elapsedTime&quot;: &quot;A String&quot;, # Output only. Time that the trial has been running at the point of
424 # this measurement.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700425 &quot;stepCount&quot;: &quot;A String&quot;, # The number of steps a machine learning model has been trained for.
426 # Must be non-negative.
Bu Sun Kim65020912020-05-20 12:08:20 -0700427 &quot;metrics&quot;: [ # Provides a list of metrics that act as inputs into the objective
428 # function.
429 { # A message representing a metric in the measurement.
430 &quot;value&quot;: 3.14, # Required. The value for this metric.
431 &quot;metric&quot;: &quot;A String&quot;, # Required. Metric name.
432 },
433 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700434 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700435 ],
436 &quot;clientId&quot;: &quot;A String&quot;, # Output only. The identifier of the client that originally requested this trial.
437 &quot;parameters&quot;: [ # The parameters of the trial.
438 { # A message representing a parameter to be tuned. Contains the name of
439 # the parameter and the suggested value to use for this trial.
440 &quot;intValue&quot;: &quot;A String&quot;, # Must be set if ParameterType is INTEGER
441 &quot;stringValue&quot;: &quot;A String&quot;, # Must be set if ParameterTypeis CATEGORICAL
442 &quot;parameter&quot;: &quot;A String&quot;, # The name of the parameter.
443 &quot;floatValue&quot;: 3.14, # Must be set if ParameterType is DOUBLE or DISCRETE.
444 },
445 ],
446 &quot;state&quot;: &quot;A String&quot;, # The detailed state of a trial.
447 &quot;finalMeasurement&quot;: { # A message representing a measurement. # The final measurement containing the objective value.
448 &quot;elapsedTime&quot;: &quot;A String&quot;, # Output only. Time that the trial has been running at the point of
449 # this measurement.
450 &quot;stepCount&quot;: &quot;A String&quot;, # The number of steps a machine learning model has been trained for.
451 # Must be non-negative.
452 &quot;metrics&quot;: [ # Provides a list of metrics that act as inputs into the objective
453 # function.
454 { # A message representing a metric in the measurement.
455 &quot;value&quot;: 3.14, # Required. The value for this metric.
456 &quot;metric&quot;: &quot;A String&quot;, # Required. Metric name.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700457 },
458 ],
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700459 },
460 &quot;trialInfeasible&quot;: True or False, # Output only. If true, the parameters in this trial are not attempted again.
461 &quot;startTime&quot;: &quot;A String&quot;, # Output only. Time at which the trial was started.
462 &quot;name&quot;: &quot;A String&quot;, # Output only. Name of the trial assigned by the service.
463 }</pre>
Bu Sun Kim65020912020-05-20 12:08:20 -0700464</div>
465
466<div class="method">
467 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
468 <pre>Deletes a trial.
469
470Args:
471 name: string, Required. The trial name. (required)
472 x__xgafv: string, V1 error format.
473 Allowed values
474 1 - v1 error format
475 2 - v2 error format
476
477Returns:
478 An object of the form:
479
480 { # A generic empty message that you can re-use to avoid defining duplicated
481 # empty messages in your APIs. A typical example is to use it as the request
482 # or the response type of an API method. For instance:
483 #
484 # service Foo {
485 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
486 # }
487 #
488 # The JSON representation for `Empty` is empty JSON object `{}`.
489 }</pre>
490</div>
491
492<div class="method">
493 <code class="details" id="get">get(name, x__xgafv=None)</code>
494 <pre>Gets a trial.
495
496Args:
497 name: string, Required. The trial name. (required)
498 x__xgafv: string, V1 error format.
499 Allowed values
500 1 - v1 error format
501 2 - v2 error format
502
503Returns:
504 An object of the form:
505
506 { # A message representing a trial.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700507 &quot;infeasibleReason&quot;: &quot;A String&quot;, # Output only. A human readable string describing why the trial is
508 # infeasible. This should only be set if trial_infeasible is true.
509 &quot;endTime&quot;: &quot;A String&quot;, # Output only. Time at which the trial&#x27;s status changed to COMPLETED.
510 &quot;measurements&quot;: [ # A list of measurements that are strictly lexicographically
511 # ordered by their induced tuples (steps, elapsed_time).
512 # These are used for early stopping computations.
513 { # A message representing a measurement.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700514 &quot;elapsedTime&quot;: &quot;A String&quot;, # Output only. Time that the trial has been running at the point of
515 # this measurement.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700516 &quot;stepCount&quot;: &quot;A String&quot;, # The number of steps a machine learning model has been trained for.
517 # Must be non-negative.
Bu Sun Kim65020912020-05-20 12:08:20 -0700518 &quot;metrics&quot;: [ # Provides a list of metrics that act as inputs into the objective
519 # function.
520 { # A message representing a metric in the measurement.
521 &quot;value&quot;: 3.14, # Required. The value for this metric.
522 &quot;metric&quot;: &quot;A String&quot;, # Required. Metric name.
523 },
524 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700525 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700526 ],
527 &quot;clientId&quot;: &quot;A String&quot;, # Output only. The identifier of the client that originally requested this trial.
528 &quot;parameters&quot;: [ # The parameters of the trial.
529 { # A message representing a parameter to be tuned. Contains the name of
530 # the parameter and the suggested value to use for this trial.
531 &quot;intValue&quot;: &quot;A String&quot;, # Must be set if ParameterType is INTEGER
532 &quot;stringValue&quot;: &quot;A String&quot;, # Must be set if ParameterTypeis CATEGORICAL
533 &quot;parameter&quot;: &quot;A String&quot;, # The name of the parameter.
534 &quot;floatValue&quot;: 3.14, # Must be set if ParameterType is DOUBLE or DISCRETE.
535 },
536 ],
537 &quot;state&quot;: &quot;A String&quot;, # The detailed state of a trial.
538 &quot;finalMeasurement&quot;: { # A message representing a measurement. # The final measurement containing the objective value.
539 &quot;elapsedTime&quot;: &quot;A String&quot;, # Output only. Time that the trial has been running at the point of
540 # this measurement.
541 &quot;stepCount&quot;: &quot;A String&quot;, # The number of steps a machine learning model has been trained for.
542 # Must be non-negative.
543 &quot;metrics&quot;: [ # Provides a list of metrics that act as inputs into the objective
544 # function.
545 { # A message representing a metric in the measurement.
546 &quot;value&quot;: 3.14, # Required. The value for this metric.
547 &quot;metric&quot;: &quot;A String&quot;, # Required. Metric name.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700548 },
549 ],
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700550 },
551 &quot;trialInfeasible&quot;: True or False, # Output only. If true, the parameters in this trial are not attempted again.
552 &quot;startTime&quot;: &quot;A String&quot;, # Output only. Time at which the trial was started.
553 &quot;name&quot;: &quot;A String&quot;, # Output only. Name of the trial assigned by the service.
554 }</pre>
Bu Sun Kim65020912020-05-20 12:08:20 -0700555</div>
556
557<div class="method">
558 <code class="details" id="list">list(parent, x__xgafv=None)</code>
559 <pre>Lists the trials associated with a study.
560
561Args:
562 parent: string, Required. The name of the study that the trial belongs to. (required)
563 x__xgafv: string, V1 error format.
564 Allowed values
565 1 - v1 error format
566 2 - v2 error format
567
568Returns:
569 An object of the form:
570
571 { # The response message for the ListTrials method.
572 &quot;trials&quot;: [ # The trials associated with the study.
573 { # A message representing a trial.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700574 &quot;infeasibleReason&quot;: &quot;A String&quot;, # Output only. A human readable string describing why the trial is
575 # infeasible. This should only be set if trial_infeasible is true.
576 &quot;endTime&quot;: &quot;A String&quot;, # Output only. Time at which the trial&#x27;s status changed to COMPLETED.
577 &quot;measurements&quot;: [ # A list of measurements that are strictly lexicographically
578 # ordered by their induced tuples (steps, elapsed_time).
579 # These are used for early stopping computations.
580 { # A message representing a measurement.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700581 &quot;elapsedTime&quot;: &quot;A String&quot;, # Output only. Time that the trial has been running at the point of
582 # this measurement.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700583 &quot;stepCount&quot;: &quot;A String&quot;, # The number of steps a machine learning model has been trained for.
584 # Must be non-negative.
Bu Sun Kim65020912020-05-20 12:08:20 -0700585 &quot;metrics&quot;: [ # Provides a list of metrics that act as inputs into the objective
586 # function.
587 { # A message representing a metric in the measurement.
588 &quot;value&quot;: 3.14, # Required. The value for this metric.
589 &quot;metric&quot;: &quot;A String&quot;, # Required. Metric name.
590 },
591 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700592 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700593 ],
594 &quot;clientId&quot;: &quot;A String&quot;, # Output only. The identifier of the client that originally requested this trial.
595 &quot;parameters&quot;: [ # The parameters of the trial.
596 { # A message representing a parameter to be tuned. Contains the name of
597 # the parameter and the suggested value to use for this trial.
598 &quot;intValue&quot;: &quot;A String&quot;, # Must be set if ParameterType is INTEGER
599 &quot;stringValue&quot;: &quot;A String&quot;, # Must be set if ParameterTypeis CATEGORICAL
600 &quot;parameter&quot;: &quot;A String&quot;, # The name of the parameter.
601 &quot;floatValue&quot;: 3.14, # Must be set if ParameterType is DOUBLE or DISCRETE.
602 },
603 ],
604 &quot;state&quot;: &quot;A String&quot;, # The detailed state of a trial.
605 &quot;finalMeasurement&quot;: { # A message representing a measurement. # The final measurement containing the objective value.
606 &quot;elapsedTime&quot;: &quot;A String&quot;, # Output only. Time that the trial has been running at the point of
607 # this measurement.
608 &quot;stepCount&quot;: &quot;A String&quot;, # The number of steps a machine learning model has been trained for.
609 # Must be non-negative.
610 &quot;metrics&quot;: [ # Provides a list of metrics that act as inputs into the objective
611 # function.
612 { # A message representing a metric in the measurement.
613 &quot;value&quot;: 3.14, # Required. The value for this metric.
614 &quot;metric&quot;: &quot;A String&quot;, # Required. Metric name.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700615 },
616 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700617 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700618 &quot;trialInfeasible&quot;: True or False, # Output only. If true, the parameters in this trial are not attempted again.
619 &quot;startTime&quot;: &quot;A String&quot;, # Output only. Time at which the trial was started.
620 &quot;name&quot;: &quot;A String&quot;, # Output only. Name of the trial assigned by the service.
621 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700622 ],
623 }</pre>
624</div>
625
626<div class="method">
627 <code class="details" id="stop">stop(name, body=None, x__xgafv=None)</code>
628 <pre>Stops a trial.
629
630Args:
631 name: string, Required. The trial name. (required)
632 body: object, The request body.
633 The object takes the form of:
634
635{
636 }
637
638 x__xgafv: string, V1 error format.
639 Allowed values
640 1 - v1 error format
641 2 - v2 error format
642
643Returns:
644 An object of the form:
645
646 { # A message representing a trial.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700647 &quot;infeasibleReason&quot;: &quot;A String&quot;, # Output only. A human readable string describing why the trial is
648 # infeasible. This should only be set if trial_infeasible is true.
649 &quot;endTime&quot;: &quot;A String&quot;, # Output only. Time at which the trial&#x27;s status changed to COMPLETED.
650 &quot;measurements&quot;: [ # A list of measurements that are strictly lexicographically
651 # ordered by their induced tuples (steps, elapsed_time).
652 # These are used for early stopping computations.
653 { # A message representing a measurement.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700654 &quot;elapsedTime&quot;: &quot;A String&quot;, # Output only. Time that the trial has been running at the point of
655 # this measurement.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700656 &quot;stepCount&quot;: &quot;A String&quot;, # The number of steps a machine learning model has been trained for.
657 # Must be non-negative.
Bu Sun Kim65020912020-05-20 12:08:20 -0700658 &quot;metrics&quot;: [ # Provides a list of metrics that act as inputs into the objective
659 # function.
660 { # A message representing a metric in the measurement.
661 &quot;value&quot;: 3.14, # Required. The value for this metric.
662 &quot;metric&quot;: &quot;A String&quot;, # Required. Metric name.
663 },
664 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700665 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700666 ],
667 &quot;clientId&quot;: &quot;A String&quot;, # Output only. The identifier of the client that originally requested this trial.
668 &quot;parameters&quot;: [ # The parameters of the trial.
669 { # A message representing a parameter to be tuned. Contains the name of
670 # the parameter and the suggested value to use for this trial.
671 &quot;intValue&quot;: &quot;A String&quot;, # Must be set if ParameterType is INTEGER
672 &quot;stringValue&quot;: &quot;A String&quot;, # Must be set if ParameterTypeis CATEGORICAL
673 &quot;parameter&quot;: &quot;A String&quot;, # The name of the parameter.
674 &quot;floatValue&quot;: 3.14, # Must be set if ParameterType is DOUBLE or DISCRETE.
675 },
676 ],
677 &quot;state&quot;: &quot;A String&quot;, # The detailed state of a trial.
678 &quot;finalMeasurement&quot;: { # A message representing a measurement. # The final measurement containing the objective value.
679 &quot;elapsedTime&quot;: &quot;A String&quot;, # Output only. Time that the trial has been running at the point of
680 # this measurement.
681 &quot;stepCount&quot;: &quot;A String&quot;, # The number of steps a machine learning model has been trained for.
682 # Must be non-negative.
683 &quot;metrics&quot;: [ # Provides a list of metrics that act as inputs into the objective
684 # function.
685 { # A message representing a metric in the measurement.
686 &quot;value&quot;: 3.14, # Required. The value for this metric.
687 &quot;metric&quot;: &quot;A String&quot;, # Required. Metric name.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700688 },
689 ],
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700690 },
691 &quot;trialInfeasible&quot;: True or False, # Output only. If true, the parameters in this trial are not attempted again.
692 &quot;startTime&quot;: &quot;A String&quot;, # Output only. Time at which the trial was started.
693 &quot;name&quot;: &quot;A String&quot;, # Output only. Name of the trial assigned by the service.
694 }</pre>
Bu Sun Kim65020912020-05-20 12:08:20 -0700695</div>
696
697<div class="method">
698 <code class="details" id="suggest">suggest(parent, body=None, x__xgafv=None)</code>
699 <pre>Adds one or more trials to a study, with parameter values
700suggested by AI Platform Optimizer. Returns a long-running
701operation associated with the generation of trial suggestions.
702When this long-running operation succeeds, it will contain
703a SuggestTrialsResponse.
704
705Args:
706 parent: string, Required. The name of the study that the trial belongs to. (required)
707 body: object, The request body.
708 The object takes the form of:
709
710{ # The request message for the SuggestTrial service method.
711 &quot;clientId&quot;: &quot;A String&quot;, # Required. The identifier of the client that is requesting the suggestion.
712 #
713 # If multiple SuggestTrialsRequests have the same `client_id`,
714 # the service will return the identical suggested trial if the trial is
715 # pending, and provide a new trial if the last suggested trial was completed.
716 &quot;suggestionCount&quot;: 42, # Required. The number of suggestions requested.
717 }
718
719 x__xgafv: string, V1 error format.
720 Allowed values
721 1 - v1 error format
722 2 - v2 error format
723
724Returns:
725 An object of the form:
726
727 { # This resource represents a long-running operation that is the result of a
728 # network API call.
Bu Sun Kim65020912020-05-20 12:08:20 -0700729 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
730 # different programming environments, including REST APIs and RPC APIs. It is
731 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
732 # three pieces of data: error code, error message, and error details.
733 #
734 # You can find out more about this error model and how to work with it in the
735 # [API Design Guide](https://cloud.google.com/apis/design/errors).
736 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
737 # message types for APIs to use.
738 {
739 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
740 },
741 ],
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700742 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
743 # user-facing error message should be localized and sent in the
744 # google.rpc.Status.details field, or localized by the client.
745 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
Bu Sun Kim65020912020-05-20 12:08:20 -0700746 },
747 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress.
748 # If `true`, the operation is completed, and either `error` or `response` is
749 # available.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700750 &quot;response&quot;: { # The normal response of the operation in case of success. If the original
751 # method returns no data on success, such as `Delete`, the response is
752 # `google.protobuf.Empty`. If the original method is standard
753 # `Get`/`Create`/`Update`, the response should be the resource. For other
754 # methods, the response should have the type `XxxResponse`, where `Xxx`
755 # is the original method name. For example, if the original method name
756 # is `TakeSnapshot()`, the inferred response type is
757 # `TakeSnapshotResponse`.
758 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
759 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700760 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically
761 # contains progress information and common metadata such as create time.
762 # Some services might not provide such metadata. Any method that returns a
763 # long-running operation should document the metadata type, if any.
764 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
765 },
766 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that
767 # originally returns it. If you use the default HTTP mapping, the
768 # `name` should be a resource name ending with `operations/{unique_id}`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700769 }</pre>
770</div>
771
772</body></html>