blob: 2beda6224464833b5093a1b4e753d8a013cf9f30 [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></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="ml_v1.projects.locations.studies.trials.html">trials()</a></code>
79</p>
80<p class="firstline">Returns the trials Resource.</p>
81
82<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070083 <code><a href="#close">close()</a></code></p>
84<p class="firstline">Close httplib2 connections.</p>
85<p class="toc_element">
Bu Sun Kim65020912020-05-20 12:08:20 -070086 <code><a href="#create">create(parent, body=None, studyId=None, x__xgafv=None)</a></code></p>
87<p class="firstline">Creates a study.</p>
88<p class="toc_element">
89 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
90<p class="firstline">Deletes a study.</p>
91<p class="toc_element">
92 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
93<p class="firstline">Gets a study.</p>
94<p class="toc_element">
95 <code><a href="#list">list(parent, x__xgafv=None)</a></code></p>
96<p class="firstline">Lists all the studies in a region for an associated project.</p>
97<h3>Method Details</h3>
98<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070099 <code class="details" id="close">close()</code>
100 <pre>Close httplib2 connections.</pre>
101</div>
102
103<div class="method">
Bu Sun Kim65020912020-05-20 12:08:20 -0700104 <code class="details" id="create">create(parent, body=None, studyId=None, x__xgafv=None)</code>
105 <pre>Creates a study.
106
107Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700108 parent: string, Required. The project and location that the study belongs to. Format: projects/{project}/locations/{location} (required)
Bu Sun Kim65020912020-05-20 12:08:20 -0700109 body: object, The request body.
110 The object takes the form of:
111
112{ # A message representing a Study.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800113 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Time at which the study was created.
114 &quot;studyConfig&quot;: { # Represents configuration of a study. # Required. Configuration of the study.
115 &quot;automatedStoppingConfig&quot;: { # Configuration for Automated Early Stopping of Trials. If no implementation_config is set, automated early stopping will not be run. # Configuration for automated stopping of unpromising Trials.
116 &quot;decayCurveStoppingConfig&quot;: {
117 &quot;useElapsedTime&quot;: True or False, # If true, measurement.elapsed_time is used as the x-axis of each Trials Decay Curve. Otherwise, Measurement.steps will be used as the x-axis.
118 },
119 &quot;medianAutomatedStoppingConfig&quot;: { # The median automated stopping rule stops a pending trial if the trial&#x27;s best objective_value is strictly below the median &#x27;performance&#x27; of all completed trials reported up to the trial&#x27;s last measurement. Currently, &#x27;performance&#x27; refers to the running average of the objective values reported by the trial in each measurement.
120 &quot;useElapsedTime&quot;: True or False, # If true, the median automated stopping rule applies to measurement.use_elapsed_time, which means the elapsed_time field of the current trial&#x27;s latest measurement is used to compute the median objective value for each completed trial.
121 },
122 },
123 &quot;algorithm&quot;: &quot;A String&quot;, # The search algorithm specified for the study.
124 &quot;parameters&quot;: [ # Required. The set of parameters to tune.
125 { # Represents a single parameter to optimize.
126 &quot;parentCategoricalValues&quot;: { # Represents the spec to match categorical values from parent parameter.
127 &quot;values&quot;: [ # Matches values of the parent parameter with type &#x27;CATEGORICAL&#x27;. All values must exist in `categorical_value_spec` of parent parameter.
128 &quot;A String&quot;,
129 ],
130 },
131 &quot;categoricalValueSpec&quot;: { # The value spec for a &#x27;CATEGORICAL&#x27; parameter.
132 &quot;values&quot;: [ # Must be specified if type is `CATEGORICAL`. The list of possible categories.
133 &quot;A String&quot;,
134 ],
135 },
136 &quot;parentDiscreteValues&quot;: { # Represents the spec to match discrete values from parent parameter.
137 &quot;values&quot;: [ # Matches values of the parent parameter with type &#x27;DISCRETE&#x27;. All values must exist in `discrete_value_spec` of parent parameter.
138 3.14,
139 ],
140 },
141 &quot;scaleType&quot;: &quot;A String&quot;, # How the parameter should be scaled. Leave unset for categorical parameters.
142 &quot;discreteValueSpec&quot;: { # The value spec for a &#x27;DISCRETE&#x27; parameter.
143 &quot;values&quot;: [ # Must be specified if type is `DISCRETE`. A list of feasible points. The list should be in strictly increasing order. For instance, this parameter might have possible settings of 1.5, 2.5, and 4.0. This list should not contain more than 1,000 values.
144 3.14,
145 ],
146 },
147 &quot;integerValueSpec&quot;: { # The value spec for an &#x27;INTEGER&#x27; parameter.
148 &quot;maxValue&quot;: &quot;A String&quot;, # Must be specified if type is `INTEGER`. Maximum value of the parameter.
149 &quot;minValue&quot;: &quot;A String&quot;, # Must be specified if type is `INTEGER`. Minimum value of the parameter.
150 },
151 &quot;doubleValueSpec&quot;: { # The value spec for a &#x27;DOUBLE&#x27; parameter.
152 &quot;maxValue&quot;: 3.14, # Must be specified if type is `DOUBLE`. Maximum value of the parameter.
153 &quot;minValue&quot;: 3.14, # Must be specified if type is `DOUBLE`. Minimum value of the parameter.
154 },
155 &quot;type&quot;: &quot;A String&quot;, # Required. The type of the parameter.
156 &quot;childParameterSpecs&quot;: [ # A child node is active if the parameter&#x27;s value matches the child node&#x27;s matching_parent_values. If two items in child_parameter_specs have the same name, they must have disjoint matching_parent_values.
157 # Object with schema name: GoogleCloudMlV1_StudyConfig_ParameterSpec
158 ],
159 &quot;parameter&quot;: &quot;A String&quot;, # Required. The parameter name must be unique amongst all ParameterSpecs.
160 &quot;parentIntValues&quot;: { # Represents the spec to match integer values from parent parameter.
161 &quot;values&quot;: [ # Matches values of the parent parameter with type &#x27;INTEGER&#x27;. All values must lie in `integer_value_spec` of parent parameter.
162 &quot;A String&quot;,
163 ],
164 },
165 },
166 ],
167 &quot;metrics&quot;: [ # Metric specs for the study.
168 { # Represents a metric to optimize.
169 &quot;goal&quot;: &quot;A String&quot;, # Required. The optimization goal of the metric.
170 &quot;metric&quot;: &quot;A String&quot;, # Required. The name of the metric.
171 },
172 ],
173 },
174 &quot;state&quot;: &quot;A String&quot;, # Output only. The detailed state of a study.
175 &quot;name&quot;: &quot;A String&quot;, # Output only. The name of a study.
176 &quot;inactiveReason&quot;: &quot;A String&quot;, # Output only. A human readable reason why the Study is inactive. This should be empty if a study is ACTIVE or COMPLETED.
177}
178
179 studyId: string, Required. The ID to use for the study, which will become the final component of the study&#x27;s resource name.
180 x__xgafv: string, V1 error format.
181 Allowed values
182 1 - v1 error format
183 2 - v2 error format
184
185Returns:
186 An object of the form:
187
188 { # A message representing a Study.
189 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Time at which the study was created.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700190 &quot;studyConfig&quot;: { # Represents configuration of a study. # Required. Configuration of the study.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700191 &quot;automatedStoppingConfig&quot;: { # Configuration for Automated Early Stopping of Trials. If no implementation_config is set, automated early stopping will not be run. # Configuration for automated stopping of unpromising Trials.
192 &quot;decayCurveStoppingConfig&quot;: {
193 &quot;useElapsedTime&quot;: True or False, # If true, measurement.elapsed_time is used as the x-axis of each Trials Decay Curve. Otherwise, Measurement.steps will be used as the x-axis.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700194 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700195 &quot;medianAutomatedStoppingConfig&quot;: { # The median automated stopping rule stops a pending trial if the trial&#x27;s best objective_value is strictly below the median &#x27;performance&#x27; of all completed trials reported up to the trial&#x27;s last measurement. Currently, &#x27;performance&#x27; refers to the running average of the objective values reported by the trial in each measurement.
196 &quot;useElapsedTime&quot;: True or False, # If true, the median automated stopping rule applies to measurement.use_elapsed_time, which means the elapsed_time field of the current trial&#x27;s latest measurement is used to compute the median objective value for each completed trial.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700197 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700198 },
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800199 &quot;algorithm&quot;: &quot;A String&quot;, # The search algorithm specified for the study.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700200 &quot;parameters&quot;: [ # Required. The set of parameters to tune.
201 { # Represents a single parameter to optimize.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800202 &quot;parentCategoricalValues&quot;: { # Represents the spec to match categorical values from parent parameter.
203 &quot;values&quot;: [ # Matches values of the parent parameter with type &#x27;CATEGORICAL&#x27;. All values must exist in `categorical_value_spec` of parent parameter.
204 &quot;A String&quot;,
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700205 ],
206 },
207 &quot;categoricalValueSpec&quot;: { # The value spec for a &#x27;CATEGORICAL&#x27; parameter.
208 &quot;values&quot;: [ # Must be specified if type is `CATEGORICAL`. The list of possible categories.
209 &quot;A String&quot;,
210 ],
211 },
212 &quot;parentDiscreteValues&quot;: { # Represents the spec to match discrete values from parent parameter.
213 &quot;values&quot;: [ # Matches values of the parent parameter with type &#x27;DISCRETE&#x27;. All values must exist in `discrete_value_spec` of parent parameter.
214 3.14,
215 ],
216 },
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800217 &quot;scaleType&quot;: &quot;A String&quot;, # How the parameter should be scaled. Leave unset for categorical parameters.
218 &quot;discreteValueSpec&quot;: { # The value spec for a &#x27;DISCRETE&#x27; parameter.
219 &quot;values&quot;: [ # Must be specified if type is `DISCRETE`. A list of feasible points. The list should be in strictly increasing order. For instance, this parameter might have possible settings of 1.5, 2.5, and 4.0. This list should not contain more than 1,000 values.
220 3.14,
221 ],
222 },
223 &quot;integerValueSpec&quot;: { # The value spec for an &#x27;INTEGER&#x27; parameter.
224 &quot;maxValue&quot;: &quot;A String&quot;, # Must be specified if type is `INTEGER`. Maximum value of the parameter.
225 &quot;minValue&quot;: &quot;A String&quot;, # Must be specified if type is `INTEGER`. Minimum value of the parameter.
226 },
227 &quot;doubleValueSpec&quot;: { # The value spec for a &#x27;DOUBLE&#x27; parameter.
228 &quot;maxValue&quot;: 3.14, # Must be specified if type is `DOUBLE`. Maximum value of the parameter.
229 &quot;minValue&quot;: 3.14, # Must be specified if type is `DOUBLE`. Minimum value of the parameter.
230 },
231 &quot;type&quot;: &quot;A String&quot;, # Required. The type of the parameter.
232 &quot;childParameterSpecs&quot;: [ # A child node is active if the parameter&#x27;s value matches the child node&#x27;s matching_parent_values. If two items in child_parameter_specs have the same name, they must have disjoint matching_parent_values.
233 # Object with schema name: GoogleCloudMlV1_StudyConfig_ParameterSpec
234 ],
235 &quot;parameter&quot;: &quot;A String&quot;, # Required. The parameter name must be unique amongst all ParameterSpecs.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700236 &quot;parentIntValues&quot;: { # Represents the spec to match integer values from parent parameter.
237 &quot;values&quot;: [ # Matches values of the parent parameter with type &#x27;INTEGER&#x27;. All values must lie in `integer_value_spec` of parent parameter.
238 &quot;A String&quot;,
239 ],
240 },
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800241 },
242 ],
243 &quot;metrics&quot;: [ # Metric specs for the study.
244 { # Represents a metric to optimize.
245 &quot;goal&quot;: &quot;A String&quot;, # Required. The optimization goal of the metric.
246 &quot;metric&quot;: &quot;A String&quot;, # Required. The name of the metric.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700247 },
248 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700249 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700250 &quot;state&quot;: &quot;A String&quot;, # Output only. The detailed state of a study.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800251 &quot;name&quot;: &quot;A String&quot;, # Output only. The name of a study.
252 &quot;inactiveReason&quot;: &quot;A String&quot;, # Output only. A human readable reason why the Study is inactive. This should be empty if a study is ACTIVE or COMPLETED.
253 }</pre>
Bu Sun Kim65020912020-05-20 12:08:20 -0700254</div>
255
256<div class="method">
257 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
258 <pre>Deletes a study.
259
260Args:
261 name: string, Required. The study name. (required)
262 x__xgafv: string, V1 error format.
263 Allowed values
264 1 - v1 error format
265 2 - v2 error format
266
267Returns:
268 An object of the form:
269
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700270 { # 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 -0700271 }</pre>
272</div>
273
274<div class="method">
275 <code class="details" id="get">get(name, x__xgafv=None)</code>
276 <pre>Gets a study.
277
278Args:
279 name: string, Required. The study name. (required)
280 x__xgafv: string, V1 error format.
281 Allowed values
282 1 - v1 error format
283 2 - v2 error format
284
285Returns:
286 An object of the form:
287
288 { # A message representing a Study.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800289 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Time at which the study was created.
290 &quot;studyConfig&quot;: { # Represents configuration of a study. # Required. Configuration of the study.
291 &quot;automatedStoppingConfig&quot;: { # Configuration for Automated Early Stopping of Trials. If no implementation_config is set, automated early stopping will not be run. # Configuration for automated stopping of unpromising Trials.
292 &quot;decayCurveStoppingConfig&quot;: {
293 &quot;useElapsedTime&quot;: True or False, # If true, measurement.elapsed_time is used as the x-axis of each Trials Decay Curve. Otherwise, Measurement.steps will be used as the x-axis.
294 },
295 &quot;medianAutomatedStoppingConfig&quot;: { # The median automated stopping rule stops a pending trial if the trial&#x27;s best objective_value is strictly below the median &#x27;performance&#x27; of all completed trials reported up to the trial&#x27;s last measurement. Currently, &#x27;performance&#x27; refers to the running average of the objective values reported by the trial in each measurement.
296 &quot;useElapsedTime&quot;: True or False, # If true, the median automated stopping rule applies to measurement.use_elapsed_time, which means the elapsed_time field of the current trial&#x27;s latest measurement is used to compute the median objective value for each completed trial.
297 },
298 },
299 &quot;algorithm&quot;: &quot;A String&quot;, # The search algorithm specified for the study.
300 &quot;parameters&quot;: [ # Required. The set of parameters to tune.
301 { # Represents a single parameter to optimize.
302 &quot;parentCategoricalValues&quot;: { # Represents the spec to match categorical values from parent parameter.
303 &quot;values&quot;: [ # Matches values of the parent parameter with type &#x27;CATEGORICAL&#x27;. All values must exist in `categorical_value_spec` of parent parameter.
304 &quot;A String&quot;,
305 ],
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700306 },
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800307 &quot;categoricalValueSpec&quot;: { # The value spec for a &#x27;CATEGORICAL&#x27; parameter.
308 &quot;values&quot;: [ # Must be specified if type is `CATEGORICAL`. The list of possible categories.
309 &quot;A String&quot;,
310 ],
311 },
312 &quot;parentDiscreteValues&quot;: { # Represents the spec to match discrete values from parent parameter.
313 &quot;values&quot;: [ # Matches values of the parent parameter with type &#x27;DISCRETE&#x27;. All values must exist in `discrete_value_spec` of parent parameter.
314 3.14,
315 ],
316 },
317 &quot;scaleType&quot;: &quot;A String&quot;, # How the parameter should be scaled. Leave unset for categorical parameters.
318 &quot;discreteValueSpec&quot;: { # The value spec for a &#x27;DISCRETE&#x27; parameter.
319 &quot;values&quot;: [ # Must be specified if type is `DISCRETE`. A list of feasible points. The list should be in strictly increasing order. For instance, this parameter might have possible settings of 1.5, 2.5, and 4.0. This list should not contain more than 1,000 values.
320 3.14,
321 ],
322 },
323 &quot;integerValueSpec&quot;: { # The value spec for an &#x27;INTEGER&#x27; parameter.
324 &quot;maxValue&quot;: &quot;A String&quot;, # Must be specified if type is `INTEGER`. Maximum value of the parameter.
325 &quot;minValue&quot;: &quot;A String&quot;, # Must be specified if type is `INTEGER`. Minimum value of the parameter.
326 },
327 &quot;doubleValueSpec&quot;: { # The value spec for a &#x27;DOUBLE&#x27; parameter.
328 &quot;maxValue&quot;: 3.14, # Must be specified if type is `DOUBLE`. Maximum value of the parameter.
329 &quot;minValue&quot;: 3.14, # Must be specified if type is `DOUBLE`. Minimum value of the parameter.
330 },
331 &quot;type&quot;: &quot;A String&quot;, # Required. The type of the parameter.
332 &quot;childParameterSpecs&quot;: [ # A child node is active if the parameter&#x27;s value matches the child node&#x27;s matching_parent_values. If two items in child_parameter_specs have the same name, they must have disjoint matching_parent_values.
333 # Object with schema name: GoogleCloudMlV1_StudyConfig_ParameterSpec
334 ],
335 &quot;parameter&quot;: &quot;A String&quot;, # Required. The parameter name must be unique amongst all ParameterSpecs.
336 &quot;parentIntValues&quot;: { # Represents the spec to match integer values from parent parameter.
337 &quot;values&quot;: [ # Matches values of the parent parameter with type &#x27;INTEGER&#x27;. All values must lie in `integer_value_spec` of parent parameter.
338 &quot;A String&quot;,
339 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700340 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700341 },
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800342 ],
343 &quot;metrics&quot;: [ # Metric specs for the study.
344 { # Represents a metric to optimize.
345 &quot;goal&quot;: &quot;A String&quot;, # Required. The optimization goal of the metric.
346 &quot;metric&quot;: &quot;A String&quot;, # Required. The name of the metric.
347 },
348 ],
349 },
350 &quot;state&quot;: &quot;A String&quot;, # Output only. The detailed state of a study.
351 &quot;name&quot;: &quot;A String&quot;, # Output only. The name of a study.
352 &quot;inactiveReason&quot;: &quot;A String&quot;, # Output only. A human readable reason why the Study is inactive. This should be empty if a study is ACTIVE or COMPLETED.
353 }</pre>
Bu Sun Kim65020912020-05-20 12:08:20 -0700354</div>
355
356<div class="method">
357 <code class="details" id="list">list(parent, x__xgafv=None)</code>
358 <pre>Lists all the studies in a region for an associated project.
359
360Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700361 parent: string, Required. The project and location that the study belongs to. Format: projects/{project}/locations/{location} (required)
Bu Sun Kim65020912020-05-20 12:08:20 -0700362 x__xgafv: string, V1 error format.
363 Allowed values
364 1 - v1 error format
365 2 - v2 error format
366
367Returns:
368 An object of the form:
369
370 {
371 &quot;studies&quot;: [ # The studies associated with the project.
372 { # A message representing a Study.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800373 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Time at which the study was created.
374 &quot;studyConfig&quot;: { # Represents configuration of a study. # Required. Configuration of the study.
375 &quot;automatedStoppingConfig&quot;: { # Configuration for Automated Early Stopping of Trials. If no implementation_config is set, automated early stopping will not be run. # Configuration for automated stopping of unpromising Trials.
376 &quot;decayCurveStoppingConfig&quot;: {
377 &quot;useElapsedTime&quot;: True or False, # If true, measurement.elapsed_time is used as the x-axis of each Trials Decay Curve. Otherwise, Measurement.steps will be used as the x-axis.
378 },
379 &quot;medianAutomatedStoppingConfig&quot;: { # The median automated stopping rule stops a pending trial if the trial&#x27;s best objective_value is strictly below the median &#x27;performance&#x27; of all completed trials reported up to the trial&#x27;s last measurement. Currently, &#x27;performance&#x27; refers to the running average of the objective values reported by the trial in each measurement.
380 &quot;useElapsedTime&quot;: True or False, # If true, the median automated stopping rule applies to measurement.use_elapsed_time, which means the elapsed_time field of the current trial&#x27;s latest measurement is used to compute the median objective value for each completed trial.
381 },
382 },
383 &quot;algorithm&quot;: &quot;A String&quot;, # The search algorithm specified for the study.
384 &quot;parameters&quot;: [ # Required. The set of parameters to tune.
385 { # Represents a single parameter to optimize.
386 &quot;parentCategoricalValues&quot;: { # Represents the spec to match categorical values from parent parameter.
387 &quot;values&quot;: [ # Matches values of the parent parameter with type &#x27;CATEGORICAL&#x27;. All values must exist in `categorical_value_spec` of parent parameter.
388 &quot;A String&quot;,
389 ],
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700390 },
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800391 &quot;categoricalValueSpec&quot;: { # The value spec for a &#x27;CATEGORICAL&#x27; parameter.
392 &quot;values&quot;: [ # Must be specified if type is `CATEGORICAL`. The list of possible categories.
393 &quot;A String&quot;,
394 ],
395 },
396 &quot;parentDiscreteValues&quot;: { # Represents the spec to match discrete values from parent parameter.
397 &quot;values&quot;: [ # Matches values of the parent parameter with type &#x27;DISCRETE&#x27;. All values must exist in `discrete_value_spec` of parent parameter.
398 3.14,
399 ],
400 },
401 &quot;scaleType&quot;: &quot;A String&quot;, # How the parameter should be scaled. Leave unset for categorical parameters.
402 &quot;discreteValueSpec&quot;: { # The value spec for a &#x27;DISCRETE&#x27; parameter.
403 &quot;values&quot;: [ # Must be specified if type is `DISCRETE`. A list of feasible points. The list should be in strictly increasing order. For instance, this parameter might have possible settings of 1.5, 2.5, and 4.0. This list should not contain more than 1,000 values.
404 3.14,
405 ],
406 },
407 &quot;integerValueSpec&quot;: { # The value spec for an &#x27;INTEGER&#x27; parameter.
408 &quot;maxValue&quot;: &quot;A String&quot;, # Must be specified if type is `INTEGER`. Maximum value of the parameter.
409 &quot;minValue&quot;: &quot;A String&quot;, # Must be specified if type is `INTEGER`. Minimum value of the parameter.
410 },
411 &quot;doubleValueSpec&quot;: { # The value spec for a &#x27;DOUBLE&#x27; parameter.
412 &quot;maxValue&quot;: 3.14, # Must be specified if type is `DOUBLE`. Maximum value of the parameter.
413 &quot;minValue&quot;: 3.14, # Must be specified if type is `DOUBLE`. Minimum value of the parameter.
414 },
415 &quot;type&quot;: &quot;A String&quot;, # Required. The type of the parameter.
416 &quot;childParameterSpecs&quot;: [ # A child node is active if the parameter&#x27;s value matches the child node&#x27;s matching_parent_values. If two items in child_parameter_specs have the same name, they must have disjoint matching_parent_values.
417 # Object with schema name: GoogleCloudMlV1_StudyConfig_ParameterSpec
418 ],
419 &quot;parameter&quot;: &quot;A String&quot;, # Required. The parameter name must be unique amongst all ParameterSpecs.
420 &quot;parentIntValues&quot;: { # Represents the spec to match integer values from parent parameter.
421 &quot;values&quot;: [ # Matches values of the parent parameter with type &#x27;INTEGER&#x27;. All values must lie in `integer_value_spec` of parent parameter.
422 &quot;A String&quot;,
423 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700424 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700425 },
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800426 ],
427 &quot;metrics&quot;: [ # Metric specs for the study.
428 { # Represents a metric to optimize.
429 &quot;goal&quot;: &quot;A String&quot;, # Required. The optimization goal of the metric.
430 &quot;metric&quot;: &quot;A String&quot;, # Required. The name of the metric.
431 },
432 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700433 },
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800434 &quot;state&quot;: &quot;A String&quot;, # Output only. The detailed state of a study.
435 &quot;name&quot;: &quot;A String&quot;, # Output only. The name of a study.
436 &quot;inactiveReason&quot;: &quot;A String&quot;, # Output only. A human readable reason why the Study is inactive. This should be empty if a study is ACTIVE or COMPLETED.
437 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700438 ],
439 }</pre>
440</div>
441
442</body></html>