Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / e4e4b403f89a92d0f2d0661bf47d5ccd490d7bbd / . / docs / dyn / ml_v1.projects.locations.studies.trials.html
blob: faf15e01e250699cb64e2766d175829b3eafbed2 [file] [log] [blame]
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1<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>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]79<p class="firstline">Adds a measurement of the objective metrics to a trial. This measurement is assumed to have been taken before the trial is complete.</p>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]80<p class="toc_element">
81 <code><a href="#checkEarlyStoppingState">checkEarlyStoppingState(name, body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]82<p class="firstline">Checks whether a trial should stop or not. Returns a long-running operation. When the operation is successful, it will contain a CheckTrialEarlyStoppingStateResponse.</p>
83<p class="toc_element">
84 <code><a href="#close">close()</a></code></p>
85<p class="firstline">Close httplib2 connections.</p>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]86<p class="toc_element">
87 <code><a href="#complete">complete(name, body=None, x__xgafv=None)</a></code></p>
88<p class="firstline">Marks a trial as complete.</p>
89<p class="toc_element">
90 <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
91<p class="firstline">Adds a user provided trial to a study.</p>
92<p class="toc_element">
93 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
94<p class="firstline">Deletes a trial.</p>
95<p class="toc_element">
96 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
97<p class="firstline">Gets a trial.</p>
98<p class="toc_element">
99 <code><a href="#list">list(parent, x__xgafv=None)</a></code></p>
100<p class="firstline">Lists the trials associated with a study.</p>
101<p class="toc_element">
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]102 <code><a href="#listOptimalTrials">listOptimalTrials(parent, body=None, x__xgafv=None)</a></code></p>
103<p class="firstline">Lists the pareto-optimal trials for multi-objective study or the optimal trials for single-objective study. The definition of pareto-optimal can be checked in wiki page. https://en.wikipedia.org/wiki/Pareto_efficiency</p>
104<p class="toc_element">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]105 <code><a href="#stop">stop(name, body=None, x__xgafv=None)</a></code></p>
106<p class="firstline">Stops a trial.</p>
107<p class="toc_element">
108 <code><a href="#suggest">suggest(parent, body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]109<p class="firstline">Adds one or more trials to a study, with parameter values suggested by AI Platform Vizier. Returns a long-running operation associated with the generation of trial suggestions. When this long-running operation succeeds, it will contain a SuggestTrialsResponse.</p>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]110<h3>Method Details</h3>
111<div class="method">
112 <code class="details" id="addMeasurement">addMeasurement(name, body=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]113 <pre>Adds a measurement of the objective metrics to a trial. This measurement is assumed to have been taken before the trial is complete.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]114
115Args:
116 name: string, Required. The trial name. (required)
117 body: object, The request body.
118 The object takes the form of:
119
120{ # The request message for the AddTrialMeasurement service method.
121 &quot;measurement&quot;: { # A message representing a measurement. # Required. The measurement to be added to a trial.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]122 &quot;metrics&quot;: [ # Provides a list of metrics that act as inputs into the objective function.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]123 { # A message representing a metric in the measurement.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]124 &quot;value&quot;: 3.14, # Required. The value for this metric.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]125 &quot;metric&quot;: &quot;A String&quot;, # Required. Metric name.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]126 },
127 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]128 &quot;stepCount&quot;: &quot;A String&quot;, # The number of steps a machine learning model has been trained for. Must be non-negative.
129 &quot;elapsedTime&quot;: &quot;A String&quot;, # Output only. Time that the trial has been running at the point of this measurement.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]130 },
131 }
132
133 x__xgafv: string, V1 error format.
134 Allowed values
135 1 - v1 error format
136 2 - v2 error format
137
138Returns:
139 An object of the form:
140
141 { # A message representing a trial.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]142 &quot;endTime&quot;: &quot;A String&quot;, # Output only. Time at which the trial&#x27;s status changed to COMPLETED.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]143 &quot;measurements&quot;: [ # A list of measurements that are strictly lexicographically ordered by their induced tuples (steps, elapsed_time). These are used for early stopping computations.
144 { # A message representing a measurement.
145 &quot;metrics&quot;: [ # Provides a list of metrics that act as inputs into the objective function.
146 { # A message representing a metric in the measurement.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]147 &quot;value&quot;: 3.14, # Required. The value for this metric.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]148 &quot;metric&quot;: &quot;A String&quot;, # Required. Metric name.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]149 },
150 ],
151 &quot;stepCount&quot;: &quot;A String&quot;, # The number of steps a machine learning model has been trained for. Must be non-negative.
152 &quot;elapsedTime&quot;: &quot;A String&quot;, # Output only. Time that the trial has been running at the point of this measurement.
153 },
154 ],
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]155 &quot;infeasibleReason&quot;: &quot;A String&quot;, # Output only. A human readable string describing why the trial is infeasible. This should only be set if trial_infeasible is true.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]156 &quot;parameters&quot;: [ # The parameters of the trial.
157 { # A message representing a parameter to be tuned. Contains the name of the parameter and the suggested value to use for this trial.
158 &quot;parameter&quot;: &quot;A String&quot;, # The name of the parameter.
159 &quot;intValue&quot;: &quot;A String&quot;, # Must be set if ParameterType is INTEGER
160 &quot;stringValue&quot;: &quot;A String&quot;, # Must be set if ParameterTypeis CATEGORICAL
161 &quot;floatValue&quot;: 3.14, # Must be set if ParameterType is DOUBLE or DISCRETE.
162 },
163 ],
164 &quot;name&quot;: &quot;A String&quot;, # Output only. Name of the trial assigned by the service.
165 &quot;finalMeasurement&quot;: { # A message representing a measurement. # The final measurement containing the objective value.
166 &quot;metrics&quot;: [ # Provides a list of metrics that act as inputs into the objective function.
167 { # A message representing a metric in the measurement.
168 &quot;value&quot;: 3.14, # Required. The value for this metric.
169 &quot;metric&quot;: &quot;A String&quot;, # Required. Metric name.
170 },
171 ],
172 &quot;stepCount&quot;: &quot;A String&quot;, # The number of steps a machine learning model has been trained for. Must be non-negative.
173 &quot;elapsedTime&quot;: &quot;A String&quot;, # Output only. Time that the trial has been running at the point of this measurement.
174 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]175 &quot;trialInfeasible&quot;: True or False, # Output only. If true, the parameters in this trial are not attempted again.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]176 &quot;clientId&quot;: &quot;A String&quot;, # Output only. The identifier of the client that originally requested this trial.
177 &quot;state&quot;: &quot;A String&quot;, # The detailed state of a trial.
178 &quot;startTime&quot;: &quot;A String&quot;, # Output only. Time at which the trial was started.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]179 }</pre>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]180</div>
181
182<div class="method">
183 <code class="details" id="checkEarlyStoppingState">checkEarlyStoppingState(name, body=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]184 <pre>Checks whether a trial should stop or not. Returns a long-running operation. When the operation is successful, it will contain a CheckTrialEarlyStoppingStateResponse.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]185
186Args:
187 name: string, Required. The trial name. (required)
188 body: object, The request body.
189 The object takes the form of:
190
191{ # The request message for the CheckTrialEarlyStoppingState service method.
192 }
193
194 x__xgafv: string, V1 error format.
195 Allowed values
196 1 - v1 error format
197 2 - v2 error format
198
199Returns:
200 An object of the form:
201
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]202 { # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]203 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
204 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]205 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
206 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]207 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]208 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]209 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]210 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]211 {
212 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
213 },
214 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]215 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]216 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
217 &quot;response&quot;: { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]218 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
219 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]220 }</pre>
221</div>
222
223<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]224 <code class="details" id="close">close()</code>
225 <pre>Close httplib2 connections.</pre>
226</div>
227
228<div class="method">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]229 <code class="details" id="complete">complete(name, body=None, x__xgafv=None)</code>
230 <pre>Marks a trial as complete.
231
232Args:
233 name: string, Required. The trial name.metat (required)
234 body: object, The request body.
235 The object takes the form of:
236
237{ # The request message for the CompleteTrial service method.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]238 &quot;finalMeasurement&quot;: { # A message representing a measurement. # Optional. If provided, it will be used as the completed trial&#x27;s final_measurement; Otherwise, the service will auto-select a previously reported measurement as the final-measurement
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]239 &quot;metrics&quot;: [ # Provides a list of metrics that act as inputs into the objective function.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]240 { # A message representing a metric in the measurement.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]241 &quot;value&quot;: 3.14, # Required. The value for this metric.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]242 &quot;metric&quot;: &quot;A String&quot;, # Required. Metric name.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]243 },
244 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]245 &quot;stepCount&quot;: &quot;A String&quot;, # The number of steps a machine learning model has been trained for. Must be non-negative.
246 &quot;elapsedTime&quot;: &quot;A String&quot;, # Output only. Time that the trial has been running at the point of this measurement.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]247 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]248 &quot;trialInfeasible&quot;: True or False, # Optional. True if the trial cannot be run with the given Parameter, and final_measurement will be ignored.
249 &quot;infeasibleReason&quot;: &quot;A String&quot;, # Optional. A human readable reason why the trial was infeasible. This should only be provided if `trial_infeasible` is true.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]250 }
251
252 x__xgafv: string, V1 error format.
253 Allowed values
254 1 - v1 error format
255 2 - v2 error format
256
257Returns:
258 An object of the form:
259
260 { # A message representing a trial.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]261 &quot;endTime&quot;: &quot;A String&quot;, # Output only. Time at which the trial&#x27;s status changed to COMPLETED.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]262 &quot;measurements&quot;: [ # A list of measurements that are strictly lexicographically ordered by their induced tuples (steps, elapsed_time). These are used for early stopping computations.
263 { # A message representing a measurement.
264 &quot;metrics&quot;: [ # Provides a list of metrics that act as inputs into the objective function.
265 { # A message representing a metric in the measurement.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]266 &quot;value&quot;: 3.14, # Required. The value for this metric.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]267 &quot;metric&quot;: &quot;A String&quot;, # Required. Metric name.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]268 },
269 ],
270 &quot;stepCount&quot;: &quot;A String&quot;, # The number of steps a machine learning model has been trained for. Must be non-negative.
271 &quot;elapsedTime&quot;: &quot;A String&quot;, # Output only. Time that the trial has been running at the point of this measurement.
272 },
273 ],
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]274 &quot;infeasibleReason&quot;: &quot;A String&quot;, # Output only. A human readable string describing why the trial is infeasible. This should only be set if trial_infeasible is true.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]275 &quot;parameters&quot;: [ # The parameters of the trial.
276 { # A message representing a parameter to be tuned. Contains the name of the parameter and the suggested value to use for this trial.
277 &quot;parameter&quot;: &quot;A String&quot;, # The name of the parameter.
278 &quot;intValue&quot;: &quot;A String&quot;, # Must be set if ParameterType is INTEGER
279 &quot;stringValue&quot;: &quot;A String&quot;, # Must be set if ParameterTypeis CATEGORICAL
280 &quot;floatValue&quot;: 3.14, # Must be set if ParameterType is DOUBLE or DISCRETE.
281 },
282 ],
283 &quot;name&quot;: &quot;A String&quot;, # Output only. Name of the trial assigned by the service.
284 &quot;finalMeasurement&quot;: { # A message representing a measurement. # The final measurement containing the objective value.
285 &quot;metrics&quot;: [ # Provides a list of metrics that act as inputs into the objective function.
286 { # A message representing a metric in the measurement.
287 &quot;value&quot;: 3.14, # Required. The value for this metric.
288 &quot;metric&quot;: &quot;A String&quot;, # Required. Metric name.
289 },
290 ],
291 &quot;stepCount&quot;: &quot;A String&quot;, # The number of steps a machine learning model has been trained for. Must be non-negative.
292 &quot;elapsedTime&quot;: &quot;A String&quot;, # Output only. Time that the trial has been running at the point of this measurement.
293 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]294 &quot;trialInfeasible&quot;: True or False, # Output only. If true, the parameters in this trial are not attempted again.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]295 &quot;clientId&quot;: &quot;A String&quot;, # Output only. The identifier of the client that originally requested this trial.
296 &quot;state&quot;: &quot;A String&quot;, # The detailed state of a trial.
297 &quot;startTime&quot;: &quot;A String&quot;, # Output only. Time at which the trial was started.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]298 }</pre>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]299</div>
300
301<div class="method">
302 <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
303 <pre>Adds a user provided trial to a study.
304
305Args:
306 parent: string, Required. The name of the study that the trial belongs to. (required)
307 body: object, The request body.
308 The object takes the form of:
309
310{ # A message representing a trial.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]311 &quot;endTime&quot;: &quot;A String&quot;, # Output only. Time at which the trial&#x27;s status changed to COMPLETED.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]312 &quot;measurements&quot;: [ # A list of measurements that are strictly lexicographically ordered by their induced tuples (steps, elapsed_time). These are used for early stopping computations.
313 { # A message representing a measurement.
314 &quot;metrics&quot;: [ # Provides a list of metrics that act as inputs into the objective function.
315 { # A message representing a metric in the measurement.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]316 &quot;value&quot;: 3.14, # Required. The value for this metric.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]317 &quot;metric&quot;: &quot;A String&quot;, # Required. Metric name.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]318 },
319 ],
320 &quot;stepCount&quot;: &quot;A String&quot;, # The number of steps a machine learning model has been trained for. Must be non-negative.
321 &quot;elapsedTime&quot;: &quot;A String&quot;, # Output only. Time that the trial has been running at the point of this measurement.
322 },
323 ],
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]324 &quot;infeasibleReason&quot;: &quot;A String&quot;, # Output only. A human readable string describing why the trial is infeasible. This should only be set if trial_infeasible is true.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]325 &quot;parameters&quot;: [ # The parameters of the trial.
326 { # A message representing a parameter to be tuned. Contains the name of the parameter and the suggested value to use for this trial.
327 &quot;parameter&quot;: &quot;A String&quot;, # The name of the parameter.
328 &quot;intValue&quot;: &quot;A String&quot;, # Must be set if ParameterType is INTEGER
329 &quot;stringValue&quot;: &quot;A String&quot;, # Must be set if ParameterTypeis CATEGORICAL
330 &quot;floatValue&quot;: 3.14, # Must be set if ParameterType is DOUBLE or DISCRETE.
331 },
332 ],
333 &quot;name&quot;: &quot;A String&quot;, # Output only. Name of the trial assigned by the service.
334 &quot;finalMeasurement&quot;: { # A message representing a measurement. # The final measurement containing the objective value.
335 &quot;metrics&quot;: [ # Provides a list of metrics that act as inputs into the objective 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.
339 },
340 ],
341 &quot;stepCount&quot;: &quot;A String&quot;, # The number of steps a machine learning model has been trained for. Must be non-negative.
342 &quot;elapsedTime&quot;: &quot;A String&quot;, # Output only. Time that the trial has been running at the point of this measurement.
343 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]344 &quot;trialInfeasible&quot;: True or False, # Output only. If true, the parameters in this trial are not attempted again.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]345 &quot;clientId&quot;: &quot;A String&quot;, # Output only. The identifier of the client that originally requested this trial.
346 &quot;state&quot;: &quot;A String&quot;, # The detailed state of a trial.
347 &quot;startTime&quot;: &quot;A String&quot;, # Output only. Time at which the trial was started.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]348}
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]349
350 x__xgafv: string, V1 error format.
351 Allowed values
352 1 - v1 error format
353 2 - v2 error format
354
355Returns:
356 An object of the form:
357
358 { # A message representing a trial.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]359 &quot;endTime&quot;: &quot;A String&quot;, # Output only. Time at which the trial&#x27;s status changed to COMPLETED.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]360 &quot;measurements&quot;: [ # A list of measurements that are strictly lexicographically ordered by their induced tuples (steps, elapsed_time). These are used for early stopping computations.
361 { # A message representing a measurement.
362 &quot;metrics&quot;: [ # Provides a list of metrics that act as inputs into the objective function.
363 { # A message representing a metric in the measurement.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]364 &quot;value&quot;: 3.14, # Required. The value for this metric.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]365 &quot;metric&quot;: &quot;A String&quot;, # Required. Metric name.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]366 },
367 ],
368 &quot;stepCount&quot;: &quot;A String&quot;, # The number of steps a machine learning model has been trained for. Must be non-negative.
369 &quot;elapsedTime&quot;: &quot;A String&quot;, # Output only. Time that the trial has been running at the point of this measurement.
370 },
371 ],
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]372 &quot;infeasibleReason&quot;: &quot;A String&quot;, # Output only. A human readable string describing why the trial is infeasible. This should only be set if trial_infeasible is true.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]373 &quot;parameters&quot;: [ # The parameters of the trial.
374 { # A message representing a parameter to be tuned. Contains the name of the parameter and the suggested value to use for this trial.
375 &quot;parameter&quot;: &quot;A String&quot;, # The name of the parameter.
376 &quot;intValue&quot;: &quot;A String&quot;, # Must be set if ParameterType is INTEGER
377 &quot;stringValue&quot;: &quot;A String&quot;, # Must be set if ParameterTypeis CATEGORICAL
378 &quot;floatValue&quot;: 3.14, # Must be set if ParameterType is DOUBLE or DISCRETE.
379 },
380 ],
381 &quot;name&quot;: &quot;A String&quot;, # Output only. Name of the trial assigned by the service.
382 &quot;finalMeasurement&quot;: { # A message representing a measurement. # The final measurement containing the objective value.
383 &quot;metrics&quot;: [ # Provides a list of metrics that act as inputs into the objective function.
384 { # A message representing a metric in the measurement.
385 &quot;value&quot;: 3.14, # Required. The value for this metric.
386 &quot;metric&quot;: &quot;A String&quot;, # Required. Metric name.
387 },
388 ],
389 &quot;stepCount&quot;: &quot;A String&quot;, # The number of steps a machine learning model has been trained for. Must be non-negative.
390 &quot;elapsedTime&quot;: &quot;A String&quot;, # Output only. Time that the trial has been running at the point of this measurement.
391 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]392 &quot;trialInfeasible&quot;: True or False, # Output only. If true, the parameters in this trial are not attempted again.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]393 &quot;clientId&quot;: &quot;A String&quot;, # Output only. The identifier of the client that originally requested this trial.
394 &quot;state&quot;: &quot;A String&quot;, # The detailed state of a trial.
395 &quot;startTime&quot;: &quot;A String&quot;, # Output only. Time at which the trial was started.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]396 }</pre>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]397</div>
398
399<div class="method">
400 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
401 <pre>Deletes a trial.
402
403Args:
404 name: string, Required. The trial name. (required)
405 x__xgafv: string, V1 error format.
406 Allowed values
407 1 - v1 error format
408 2 - v2 error format
409
410Returns:
411 An object of the form:
412
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]413 { # 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); } The JSON representation for `Empty` is empty JSON object `{}`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]414 }</pre>
415</div>
416
417<div class="method">
418 <code class="details" id="get">get(name, x__xgafv=None)</code>
419 <pre>Gets a trial.
420
421Args:
422 name: string, Required. The trial name. (required)
423 x__xgafv: string, V1 error format.
424 Allowed values
425 1 - v1 error format
426 2 - v2 error format
427
428Returns:
429 An object of the form:
430
431 { # A message representing a trial.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]432 &quot;endTime&quot;: &quot;A String&quot;, # Output only. Time at which the trial&#x27;s status changed to COMPLETED.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]433 &quot;measurements&quot;: [ # A list of measurements that are strictly lexicographically ordered by their induced tuples (steps, elapsed_time). These are used for early stopping computations.
434 { # A message representing a measurement.
435 &quot;metrics&quot;: [ # Provides a list of metrics that act as inputs into the objective function.
436 { # A message representing a metric in the measurement.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]437 &quot;value&quot;: 3.14, # Required. The value for this metric.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]438 &quot;metric&quot;: &quot;A String&quot;, # Required. Metric name.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]439 },
440 ],
441 &quot;stepCount&quot;: &quot;A String&quot;, # The number of steps a machine learning model has been trained for. Must be non-negative.
442 &quot;elapsedTime&quot;: &quot;A String&quot;, # Output only. Time that the trial has been running at the point of this measurement.
443 },
444 ],
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]445 &quot;infeasibleReason&quot;: &quot;A String&quot;, # Output only. A human readable string describing why the trial is infeasible. This should only be set if trial_infeasible is true.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]446 &quot;parameters&quot;: [ # The parameters of the trial.
447 { # A message representing a parameter to be tuned. Contains the name of the parameter and the suggested value to use for this trial.
448 &quot;parameter&quot;: &quot;A String&quot;, # The name of the parameter.
449 &quot;intValue&quot;: &quot;A String&quot;, # Must be set if ParameterType is INTEGER
450 &quot;stringValue&quot;: &quot;A String&quot;, # Must be set if ParameterTypeis CATEGORICAL
451 &quot;floatValue&quot;: 3.14, # Must be set if ParameterType is DOUBLE or DISCRETE.
452 },
453 ],
454 &quot;name&quot;: &quot;A String&quot;, # Output only. Name of the trial assigned by the service.
455 &quot;finalMeasurement&quot;: { # A message representing a measurement. # The final measurement containing the objective value.
456 &quot;metrics&quot;: [ # Provides a list of metrics that act as inputs into the objective function.
457 { # A message representing a metric in the measurement.
458 &quot;value&quot;: 3.14, # Required. The value for this metric.
459 &quot;metric&quot;: &quot;A String&quot;, # Required. Metric name.
460 },
461 ],
462 &quot;stepCount&quot;: &quot;A String&quot;, # The number of steps a machine learning model has been trained for. Must be non-negative.
463 &quot;elapsedTime&quot;: &quot;A String&quot;, # Output only. Time that the trial has been running at the point of this measurement.
464 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]465 &quot;trialInfeasible&quot;: True or False, # Output only. If true, the parameters in this trial are not attempted again.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]466 &quot;clientId&quot;: &quot;A String&quot;, # Output only. The identifier of the client that originally requested this trial.
467 &quot;state&quot;: &quot;A String&quot;, # The detailed state of a trial.
468 &quot;startTime&quot;: &quot;A String&quot;, # Output only. Time at which the trial was started.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]469 }</pre>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]470</div>
471
472<div class="method">
473 <code class="details" id="list">list(parent, x__xgafv=None)</code>
474 <pre>Lists the trials associated with a study.
475
476Args:
477 parent: string, Required. The name of the study that the trial belongs to. (required)
478 x__xgafv: string, V1 error format.
479 Allowed values
480 1 - v1 error format
481 2 - v2 error format
482
483Returns:
484 An object of the form:
485
486 { # The response message for the ListTrials method.
487 &quot;trials&quot;: [ # The trials associated with the study.
488 { # A message representing a trial.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]489 &quot;endTime&quot;: &quot;A String&quot;, # Output only. Time at which the trial&#x27;s status changed to COMPLETED.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]490 &quot;measurements&quot;: [ # A list of measurements that are strictly lexicographically ordered by their induced tuples (steps, elapsed_time). These are used for early stopping computations.
491 { # A message representing a measurement.
492 &quot;metrics&quot;: [ # Provides a list of metrics that act as inputs into the objective function.
493 { # A message representing a metric in the measurement.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]494 &quot;value&quot;: 3.14, # Required. The value for this metric.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]495 &quot;metric&quot;: &quot;A String&quot;, # Required. Metric name.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]496 },
497 ],
498 &quot;stepCount&quot;: &quot;A String&quot;, # The number of steps a machine learning model has been trained for. Must be non-negative.
499 &quot;elapsedTime&quot;: &quot;A String&quot;, # Output only. Time that the trial has been running at the point of this measurement.
500 },
501 ],
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]502 &quot;infeasibleReason&quot;: &quot;A String&quot;, # Output only. A human readable string describing why the trial is infeasible. This should only be set if trial_infeasible is true.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]503 &quot;parameters&quot;: [ # The parameters of the trial.
504 { # A message representing a parameter to be tuned. Contains the name of the parameter and the suggested value to use for this trial.
505 &quot;parameter&quot;: &quot;A String&quot;, # The name of the parameter.
506 &quot;intValue&quot;: &quot;A String&quot;, # Must be set if ParameterType is INTEGER
507 &quot;stringValue&quot;: &quot;A String&quot;, # Must be set if ParameterTypeis CATEGORICAL
508 &quot;floatValue&quot;: 3.14, # Must be set if ParameterType is DOUBLE or DISCRETE.
509 },
510 ],
511 &quot;name&quot;: &quot;A String&quot;, # Output only. Name of the trial assigned by the service.
512 &quot;finalMeasurement&quot;: { # A message representing a measurement. # The final measurement containing the objective value.
513 &quot;metrics&quot;: [ # Provides a list of metrics that act as inputs into the objective function.
514 { # A message representing a metric in the measurement.
515 &quot;value&quot;: 3.14, # Required. The value for this metric.
516 &quot;metric&quot;: &quot;A String&quot;, # Required. Metric name.
517 },
518 ],
519 &quot;stepCount&quot;: &quot;A String&quot;, # The number of steps a machine learning model has been trained for. Must be non-negative.
520 &quot;elapsedTime&quot;: &quot;A String&quot;, # Output only. Time that the trial has been running at the point of this measurement.
521 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]522 &quot;trialInfeasible&quot;: True or False, # Output only. If true, the parameters in this trial are not attempted again.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]523 &quot;clientId&quot;: &quot;A String&quot;, # Output only. The identifier of the client that originally requested this trial.
524 &quot;state&quot;: &quot;A String&quot;, # The detailed state of a trial.
525 &quot;startTime&quot;: &quot;A String&quot;, # Output only. Time at which the trial was started.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]526 },
527 ],
528 }</pre>
529</div>
530
531<div class="method">
532 <code class="details" id="listOptimalTrials">listOptimalTrials(parent, body=None, x__xgafv=None)</code>
533 <pre>Lists the pareto-optimal trials for multi-objective study or the optimal trials for single-objective study. The definition of pareto-optimal can be checked in wiki page. https://en.wikipedia.org/wiki/Pareto_efficiency
534
535Args:
536 parent: string, Required. The name of the study that the pareto-optimal trial belongs to. (required)
537 body: object, The request body.
538 The object takes the form of:
539
540{ # The request message for the ListTrials service method.
541 }
542
543 x__xgafv: string, V1 error format.
544 Allowed values
545 1 - v1 error format
546 2 - v2 error format
547
548Returns:
549 An object of the form:
550
551 { # The response message for the ListOptimalTrials method.
552 &quot;trials&quot;: [ # The pareto-optimal trials for multiple objective study or the optimal trial for single objective study. The definition of pareto-optimal can be checked in wiki page. https://en.wikipedia.org/wiki/Pareto_efficiency
553 { # A message representing a trial.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]554 &quot;endTime&quot;: &quot;A String&quot;, # Output only. Time at which the trial&#x27;s status changed to COMPLETED.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]555 &quot;measurements&quot;: [ # A list of measurements that are strictly lexicographically ordered by their induced tuples (steps, elapsed_time). These are used for early stopping computations.
556 { # A message representing a measurement.
557 &quot;metrics&quot;: [ # Provides a list of metrics that act as inputs into the objective function.
558 { # A message representing a metric in the measurement.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]559 &quot;value&quot;: 3.14, # Required. The value for this metric.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]560 &quot;metric&quot;: &quot;A String&quot;, # Required. Metric name.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]561 },
562 ],
563 &quot;stepCount&quot;: &quot;A String&quot;, # The number of steps a machine learning model has been trained for. Must be non-negative.
564 &quot;elapsedTime&quot;: &quot;A String&quot;, # Output only. Time that the trial has been running at the point of this measurement.
565 },
566 ],
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]567 &quot;infeasibleReason&quot;: &quot;A String&quot;, # Output only. A human readable string describing why the trial is infeasible. This should only be set if trial_infeasible is true.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]568 &quot;parameters&quot;: [ # The parameters of the trial.
569 { # A message representing a parameter to be tuned. Contains the name of the parameter and the suggested value to use for this trial.
570 &quot;parameter&quot;: &quot;A String&quot;, # The name of the parameter.
571 &quot;intValue&quot;: &quot;A String&quot;, # Must be set if ParameterType is INTEGER
572 &quot;stringValue&quot;: &quot;A String&quot;, # Must be set if ParameterTypeis CATEGORICAL
573 &quot;floatValue&quot;: 3.14, # Must be set if ParameterType is DOUBLE or DISCRETE.
574 },
575 ],
576 &quot;name&quot;: &quot;A String&quot;, # Output only. Name of the trial assigned by the service.
577 &quot;finalMeasurement&quot;: { # A message representing a measurement. # The final measurement containing the objective value.
578 &quot;metrics&quot;: [ # Provides a list of metrics that act as inputs into the objective function.
579 { # A message representing a metric in the measurement.
580 &quot;value&quot;: 3.14, # Required. The value for this metric.
581 &quot;metric&quot;: &quot;A String&quot;, # Required. Metric name.
582 },
583 ],
584 &quot;stepCount&quot;: &quot;A String&quot;, # The number of steps a machine learning model has been trained for. Must be non-negative.
585 &quot;elapsedTime&quot;: &quot;A String&quot;, # Output only. Time that the trial has been running at the point of this measurement.
586 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]587 &quot;trialInfeasible&quot;: True or False, # Output only. If true, the parameters in this trial are not attempted again.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]588 &quot;clientId&quot;: &quot;A String&quot;, # Output only. The identifier of the client that originally requested this trial.
589 &quot;state&quot;: &quot;A String&quot;, # The detailed state of a trial.
590 &quot;startTime&quot;: &quot;A String&quot;, # Output only. Time at which the trial was started.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]591 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]592 ],
593 }</pre>
594</div>
595
596<div class="method">
597 <code class="details" id="stop">stop(name, body=None, x__xgafv=None)</code>
598 <pre>Stops a trial.
599
600Args:
601 name: string, Required. The trial name. (required)
602 body: object, The request body.
603 The object takes the form of:
604
605{
606 }
607
608 x__xgafv: string, V1 error format.
609 Allowed values
610 1 - v1 error format
611 2 - v2 error format
612
613Returns:
614 An object of the form:
615
616 { # A message representing a trial.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]617 &quot;endTime&quot;: &quot;A String&quot;, # Output only. Time at which the trial&#x27;s status changed to COMPLETED.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]618 &quot;measurements&quot;: [ # A list of measurements that are strictly lexicographically ordered by their induced tuples (steps, elapsed_time). These are used for early stopping computations.
619 { # A message representing a measurement.
620 &quot;metrics&quot;: [ # Provides a list of metrics that act as inputs into the objective function.
621 { # A message representing a metric in the measurement.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]622 &quot;value&quot;: 3.14, # Required. The value for this metric.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]623 &quot;metric&quot;: &quot;A String&quot;, # Required. Metric name.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]624 },
625 ],
626 &quot;stepCount&quot;: &quot;A String&quot;, # The number of steps a machine learning model has been trained for. Must be non-negative.
627 &quot;elapsedTime&quot;: &quot;A String&quot;, # Output only. Time that the trial has been running at the point of this measurement.
628 },
629 ],
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]630 &quot;infeasibleReason&quot;: &quot;A String&quot;, # Output only. A human readable string describing why the trial is infeasible. This should only be set if trial_infeasible is true.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]631 &quot;parameters&quot;: [ # The parameters of the trial.
632 { # A message representing a parameter to be tuned. Contains the name of the parameter and the suggested value to use for this trial.
633 &quot;parameter&quot;: &quot;A String&quot;, # The name of the parameter.
634 &quot;intValue&quot;: &quot;A String&quot;, # Must be set if ParameterType is INTEGER
635 &quot;stringValue&quot;: &quot;A String&quot;, # Must be set if ParameterTypeis CATEGORICAL
636 &quot;floatValue&quot;: 3.14, # Must be set if ParameterType is DOUBLE or DISCRETE.
637 },
638 ],
639 &quot;name&quot;: &quot;A String&quot;, # Output only. Name of the trial assigned by the service.
640 &quot;finalMeasurement&quot;: { # A message representing a measurement. # The final measurement containing the objective value.
641 &quot;metrics&quot;: [ # Provides a list of metrics that act as inputs into the objective function.
642 { # A message representing a metric in the measurement.
643 &quot;value&quot;: 3.14, # Required. The value for this metric.
644 &quot;metric&quot;: &quot;A String&quot;, # Required. Metric name.
645 },
646 ],
647 &quot;stepCount&quot;: &quot;A String&quot;, # The number of steps a machine learning model has been trained for. Must be non-negative.
648 &quot;elapsedTime&quot;: &quot;A String&quot;, # Output only. Time that the trial has been running at the point of this measurement.
649 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]650 &quot;trialInfeasible&quot;: True or False, # Output only. If true, the parameters in this trial are not attempted again.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]651 &quot;clientId&quot;: &quot;A String&quot;, # Output only. The identifier of the client that originally requested this trial.
652 &quot;state&quot;: &quot;A String&quot;, # The detailed state of a trial.
653 &quot;startTime&quot;: &quot;A String&quot;, # Output only. Time at which the trial was started.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]654 }</pre>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]655</div>
656
657<div class="method">
658 <code class="details" id="suggest">suggest(parent, body=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]659 <pre>Adds one or more trials to a study, with parameter values suggested by AI Platform Vizier. Returns a long-running operation associated with the generation of trial suggestions. When this long-running operation succeeds, it will contain a SuggestTrialsResponse.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]660
661Args:
662 parent: string, Required. The name of the study that the trial belongs to. (required)
663 body: object, The request body.
664 The object takes the form of:
665
666{ # The request message for the SuggestTrial service method.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]667 &quot;suggestionCount&quot;: 42, # Required. The number of suggestions requested.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]668 &quot;clientId&quot;: &quot;A String&quot;, # Required. The identifier of the client that is requesting the suggestion. If multiple SuggestTrialsRequests have the same `client_id`, the service will return the identical suggested trial if the trial is pending, and provide a new trial if the last suggested trial was completed.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]669 }
670
671 x__xgafv: string, V1 error format.
672 Allowed values
673 1 - v1 error format
674 2 - v2 error format
675
676Returns:
677 An object of the form:
678
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]679 { # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]680 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
681 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]682 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
683 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]684 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]685 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]686 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]687 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]688 {
689 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
690 },
691 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]692 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]693 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
694 &quot;response&quot;: { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]695 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
696 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]697 }</pre>
698</div>
699
700</body></html>