| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, 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 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, 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"> |
| 83 | <code><a href="#create">create(parent, body=None, studyId=None, x__xgafv=None)</a></code></p> |
| 84 | <p class="firstline">Creates a study.</p> |
| 85 | <p class="toc_element"> |
| 86 | <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> |
| 87 | <p class="firstline">Deletes a study.</p> |
| 88 | <p class="toc_element"> |
| 89 | <code><a href="#get">get(name, x__xgafv=None)</a></code></p> |
| 90 | <p class="firstline">Gets a study.</p> |
| 91 | <p class="toc_element"> |
| 92 | <code><a href="#list">list(parent, x__xgafv=None)</a></code></p> |
| 93 | <p class="firstline">Lists all the studies in a region for an associated project.</p> |
| 94 | <h3>Method Details</h3> |
| 95 | <div class="method"> |
| 96 | <code class="details" id="create">create(parent, body=None, studyId=None, x__xgafv=None)</code> |
| 97 | <pre>Creates a study. |
| 98 | |
| 99 | Args: |
| 100 | parent: string, Required. The project and location that the study belongs to. |
| 101 | Format: projects/{project}/locations/{location} (required) |
| 102 | body: object, The request body. |
| 103 | The object takes the form of: |
| 104 | |
| 105 | { # A message representing a Study. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 106 | "name": "A String", # Output only. The name of a study. |
| 107 | "state": "A String", # Output only. The detailed state of a study. |
| 108 | "createTime": "A String", # Output only. Time at which the study was created. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 109 | "inactiveReason": "A String", # Output only. A human readable reason why the Study is inactive. |
| 110 | # This should be empty if a study is ACTIVE or COMPLETED. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 111 | "studyConfig": { # Represents configuration of a study. # Required. Configuration of the study. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 112 | "algorithm": "A String", # The search algorithm specified for the study. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 113 | "automatedStoppingConfig": { # Configuration for Automated Early Stopping of Trials. If no # Configuration for automated stopping of unpromising Trials. |
| 114 | # implementation_config is set, automated early stopping will not be run. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 115 | "decayCurveStoppingConfig": { |
| 116 | "useElapsedTime": True or False, # If true, measurement.elapsed_time is used as the x-axis of each |
| 117 | # Trials Decay Curve. Otherwise, Measurement.steps will be used as the |
| 118 | # x-axis. |
| 119 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 120 | "medianAutomatedStoppingConfig": { # The median automated stopping rule stops a pending trial if the trial's |
| 121 | # best objective_value is strictly below the median 'performance' of all |
| 122 | # completed trials reported up to the trial's last measurement. |
| 123 | # Currently, 'performance' refers to the running average of the objective |
| 124 | # values reported by the trial in each measurement. |
| 125 | "useElapsedTime": True or False, # If true, the median automated stopping rule applies to |
| 126 | # measurement.use_elapsed_time, which means the elapsed_time field of |
| 127 | # the current trial's |
| 128 | # latest measurement is used to compute the median objective |
| 129 | # value for each completed trial. |
| 130 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 131 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 132 | "parameters": [ # Required. The set of parameters to tune. |
| 133 | { # Represents a single parameter to optimize. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 134 | "categoricalValueSpec": { # The value spec for a 'CATEGORICAL' parameter. |
| 135 | "values": [ # Must be specified if type is `CATEGORICAL`. |
| 136 | # The list of possible categories. |
| 137 | "A String", |
| 138 | ], |
| 139 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 140 | "type": "A String", # Required. The type of the parameter. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 141 | "childParameterSpecs": [ # A child node is active if the parameter's value matches the child node's |
| 142 | # matching_parent_values. |
| 143 | # |
| 144 | # If two items in child_parameter_specs have the same name, they must have |
| 145 | # disjoint matching_parent_values. |
| 146 | # Object with schema name: GoogleCloudMlV1_StudyConfig_ParameterSpec |
| 147 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 148 | "parentIntValues": { # Represents the spec to match integer values from parent parameter. |
| 149 | "values": [ # Matches values of the parent parameter with type 'INTEGER'. |
| 150 | # All values must lie in `integer_value_spec` of parent parameter. |
| 151 | "A String", |
| 152 | ], |
| 153 | }, |
| 154 | "scaleType": "A String", # How the parameter should be scaled. |
| 155 | # Leave unset for categorical parameters. |
| 156 | "doubleValueSpec": { # The value spec for a 'DOUBLE' parameter. |
| 157 | "maxValue": 3.14, # Must be specified if type is `DOUBLE`. Maximum value of the parameter. |
| 158 | "minValue": 3.14, # Must be specified if type is `DOUBLE`. Minimum value of the parameter. |
| 159 | }, |
| 160 | "parameter": "A String", # Required. The parameter name must be unique amongst all ParameterSpecs. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 161 | "discreteValueSpec": { # The value spec for a 'DISCRETE' parameter. |
| 162 | "values": [ # Must be specified if type is `DISCRETE`. |
| 163 | # A list of feasible points. |
| 164 | # The list should be in strictly increasing order. For instance, this |
| 165 | # parameter might have possible settings of 1.5, 2.5, and 4.0. This list |
| 166 | # should not contain more than 1,000 values. |
| 167 | 3.14, |
| 168 | ], |
| 169 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 170 | "parentDiscreteValues": { # Represents the spec to match discrete values from parent parameter. |
| 171 | "values": [ # Matches values of the parent parameter with type 'DISCRETE'. |
| 172 | # All values must exist in `discrete_value_spec` of parent parameter. |
| 173 | 3.14, |
| 174 | ], |
| 175 | }, |
| 176 | "integerValueSpec": { # The value spec for an 'INTEGER' parameter. |
| 177 | "maxValue": "A String", # Must be specified if type is `INTEGER`. Maximum value of the parameter. |
| 178 | "minValue": "A String", # Must be specified if type is `INTEGER`. Minimum value of the parameter. |
| 179 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 180 | "parentCategoricalValues": { # Represents the spec to match categorical values from parent parameter. |
| 181 | "values": [ # Matches values of the parent parameter with type 'CATEGORICAL'. |
| 182 | # All values must exist in `categorical_value_spec` of parent parameter. |
| 183 | "A String", |
| 184 | ], |
| 185 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 186 | }, |
| 187 | ], |
| 188 | "metrics": [ # Metric specs for the study. |
| 189 | { # Represents a metric to optimize. |
| 190 | "goal": "A String", # Required. The optimization goal of the metric. |
| 191 | "metric": "A String", # Required. The name of the metric. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 192 | }, |
| 193 | ], |
| 194 | }, |
| 195 | } |
| 196 | |
| 197 | studyId: string, Required. The ID to use for the study, which will become the final component of |
| 198 | the study's resource name. |
| 199 | x__xgafv: string, V1 error format. |
| 200 | Allowed values |
| 201 | 1 - v1 error format |
| 202 | 2 - v2 error format |
| 203 | |
| 204 | Returns: |
| 205 | An object of the form: |
| 206 | |
| 207 | { # A message representing a Study. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 208 | "name": "A String", # Output only. The name of a study. |
| 209 | "state": "A String", # Output only. The detailed state of a study. |
| 210 | "createTime": "A String", # Output only. Time at which the study was created. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 211 | "inactiveReason": "A String", # Output only. A human readable reason why the Study is inactive. |
| 212 | # This should be empty if a study is ACTIVE or COMPLETED. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 213 | "studyConfig": { # Represents configuration of a study. # Required. Configuration of the study. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 214 | "algorithm": "A String", # The search algorithm specified for the study. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 215 | "automatedStoppingConfig": { # Configuration for Automated Early Stopping of Trials. If no # Configuration for automated stopping of unpromising Trials. |
| 216 | # implementation_config is set, automated early stopping will not be run. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 217 | "decayCurveStoppingConfig": { |
| 218 | "useElapsedTime": True or False, # If true, measurement.elapsed_time is used as the x-axis of each |
| 219 | # Trials Decay Curve. Otherwise, Measurement.steps will be used as the |
| 220 | # x-axis. |
| 221 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 222 | "medianAutomatedStoppingConfig": { # The median automated stopping rule stops a pending trial if the trial's |
| 223 | # best objective_value is strictly below the median 'performance' of all |
| 224 | # completed trials reported up to the trial's last measurement. |
| 225 | # Currently, 'performance' refers to the running average of the objective |
| 226 | # values reported by the trial in each measurement. |
| 227 | "useElapsedTime": True or False, # If true, the median automated stopping rule applies to |
| 228 | # measurement.use_elapsed_time, which means the elapsed_time field of |
| 229 | # the current trial's |
| 230 | # latest measurement is used to compute the median objective |
| 231 | # value for each completed trial. |
| 232 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 233 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 234 | "parameters": [ # Required. The set of parameters to tune. |
| 235 | { # Represents a single parameter to optimize. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 236 | "categoricalValueSpec": { # The value spec for a 'CATEGORICAL' parameter. |
| 237 | "values": [ # Must be specified if type is `CATEGORICAL`. |
| 238 | # The list of possible categories. |
| 239 | "A String", |
| 240 | ], |
| 241 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 242 | "type": "A String", # Required. The type of the parameter. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 243 | "childParameterSpecs": [ # A child node is active if the parameter's value matches the child node's |
| 244 | # matching_parent_values. |
| 245 | # |
| 246 | # If two items in child_parameter_specs have the same name, they must have |
| 247 | # disjoint matching_parent_values. |
| 248 | # Object with schema name: GoogleCloudMlV1_StudyConfig_ParameterSpec |
| 249 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 250 | "parentIntValues": { # Represents the spec to match integer values from parent parameter. |
| 251 | "values": [ # Matches values of the parent parameter with type 'INTEGER'. |
| 252 | # All values must lie in `integer_value_spec` of parent parameter. |
| 253 | "A String", |
| 254 | ], |
| 255 | }, |
| 256 | "scaleType": "A String", # How the parameter should be scaled. |
| 257 | # Leave unset for categorical parameters. |
| 258 | "doubleValueSpec": { # The value spec for a 'DOUBLE' parameter. |
| 259 | "maxValue": 3.14, # Must be specified if type is `DOUBLE`. Maximum value of the parameter. |
| 260 | "minValue": 3.14, # Must be specified if type is `DOUBLE`. Minimum value of the parameter. |
| 261 | }, |
| 262 | "parameter": "A String", # Required. The parameter name must be unique amongst all ParameterSpecs. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 263 | "discreteValueSpec": { # The value spec for a 'DISCRETE' parameter. |
| 264 | "values": [ # Must be specified if type is `DISCRETE`. |
| 265 | # A list of feasible points. |
| 266 | # The list should be in strictly increasing order. For instance, this |
| 267 | # parameter might have possible settings of 1.5, 2.5, and 4.0. This list |
| 268 | # should not contain more than 1,000 values. |
| 269 | 3.14, |
| 270 | ], |
| 271 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 272 | "parentDiscreteValues": { # Represents the spec to match discrete values from parent parameter. |
| 273 | "values": [ # Matches values of the parent parameter with type 'DISCRETE'. |
| 274 | # All values must exist in `discrete_value_spec` of parent parameter. |
| 275 | 3.14, |
| 276 | ], |
| 277 | }, |
| 278 | "integerValueSpec": { # The value spec for an 'INTEGER' parameter. |
| 279 | "maxValue": "A String", # Must be specified if type is `INTEGER`. Maximum value of the parameter. |
| 280 | "minValue": "A String", # Must be specified if type is `INTEGER`. Minimum value of the parameter. |
| 281 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 282 | "parentCategoricalValues": { # Represents the spec to match categorical values from parent parameter. |
| 283 | "values": [ # Matches values of the parent parameter with type 'CATEGORICAL'. |
| 284 | # All values must exist in `categorical_value_spec` of parent parameter. |
| 285 | "A String", |
| 286 | ], |
| 287 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 288 | }, |
| 289 | ], |
| 290 | "metrics": [ # Metric specs for the study. |
| 291 | { # Represents a metric to optimize. |
| 292 | "goal": "A String", # Required. The optimization goal of the metric. |
| 293 | "metric": "A String", # Required. The name of the metric. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 294 | }, |
| 295 | ], |
| 296 | }, |
| 297 | }</pre> |
| 298 | </div> |
| 299 | |
| 300 | <div class="method"> |
| 301 | <code class="details" id="delete">delete(name, x__xgafv=None)</code> |
| 302 | <pre>Deletes a study. |
| 303 | |
| 304 | Args: |
| 305 | name: string, Required. The study name. (required) |
| 306 | x__xgafv: string, V1 error format. |
| 307 | Allowed values |
| 308 | 1 - v1 error format |
| 309 | 2 - v2 error format |
| 310 | |
| 311 | Returns: |
| 312 | An object of the form: |
| 313 | |
| 314 | { # A generic empty message that you can re-use to avoid defining duplicated |
| 315 | # empty messages in your APIs. A typical example is to use it as the request |
| 316 | # or the response type of an API method. For instance: |
| 317 | # |
| 318 | # service Foo { |
| 319 | # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); |
| 320 | # } |
| 321 | # |
| 322 | # The JSON representation for `Empty` is empty JSON object `{}`. |
| 323 | }</pre> |
| 324 | </div> |
| 325 | |
| 326 | <div class="method"> |
| 327 | <code class="details" id="get">get(name, x__xgafv=None)</code> |
| 328 | <pre>Gets a study. |
| 329 | |
| 330 | Args: |
| 331 | name: string, Required. The study name. (required) |
| 332 | x__xgafv: string, V1 error format. |
| 333 | Allowed values |
| 334 | 1 - v1 error format |
| 335 | 2 - v2 error format |
| 336 | |
| 337 | Returns: |
| 338 | An object of the form: |
| 339 | |
| 340 | { # A message representing a Study. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 341 | "name": "A String", # Output only. The name of a study. |
| 342 | "state": "A String", # Output only. The detailed state of a study. |
| 343 | "createTime": "A String", # Output only. Time at which the study was created. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 344 | "inactiveReason": "A String", # Output only. A human readable reason why the Study is inactive. |
| 345 | # This should be empty if a study is ACTIVE or COMPLETED. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 346 | "studyConfig": { # Represents configuration of a study. # Required. Configuration of the study. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 347 | "algorithm": "A String", # The search algorithm specified for the study. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 348 | "automatedStoppingConfig": { # Configuration for Automated Early Stopping of Trials. If no # Configuration for automated stopping of unpromising Trials. |
| 349 | # implementation_config is set, automated early stopping will not be run. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 350 | "decayCurveStoppingConfig": { |
| 351 | "useElapsedTime": True or False, # If true, measurement.elapsed_time is used as the x-axis of each |
| 352 | # Trials Decay Curve. Otherwise, Measurement.steps will be used as the |
| 353 | # x-axis. |
| 354 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 355 | "medianAutomatedStoppingConfig": { # The median automated stopping rule stops a pending trial if the trial's |
| 356 | # best objective_value is strictly below the median 'performance' of all |
| 357 | # completed trials reported up to the trial's last measurement. |
| 358 | # Currently, 'performance' refers to the running average of the objective |
| 359 | # values reported by the trial in each measurement. |
| 360 | "useElapsedTime": True or False, # If true, the median automated stopping rule applies to |
| 361 | # measurement.use_elapsed_time, which means the elapsed_time field of |
| 362 | # the current trial's |
| 363 | # latest measurement is used to compute the median objective |
| 364 | # value for each completed trial. |
| 365 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 366 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 367 | "parameters": [ # Required. The set of parameters to tune. |
| 368 | { # Represents a single parameter to optimize. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 369 | "categoricalValueSpec": { # The value spec for a 'CATEGORICAL' parameter. |
| 370 | "values": [ # Must be specified if type is `CATEGORICAL`. |
| 371 | # The list of possible categories. |
| 372 | "A String", |
| 373 | ], |
| 374 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 375 | "type": "A String", # Required. The type of the parameter. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 376 | "childParameterSpecs": [ # A child node is active if the parameter's value matches the child node's |
| 377 | # matching_parent_values. |
| 378 | # |
| 379 | # If two items in child_parameter_specs have the same name, they must have |
| 380 | # disjoint matching_parent_values. |
| 381 | # Object with schema name: GoogleCloudMlV1_StudyConfig_ParameterSpec |
| 382 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 383 | "parentIntValues": { # Represents the spec to match integer values from parent parameter. |
| 384 | "values": [ # Matches values of the parent parameter with type 'INTEGER'. |
| 385 | # All values must lie in `integer_value_spec` of parent parameter. |
| 386 | "A String", |
| 387 | ], |
| 388 | }, |
| 389 | "scaleType": "A String", # How the parameter should be scaled. |
| 390 | # Leave unset for categorical parameters. |
| 391 | "doubleValueSpec": { # The value spec for a 'DOUBLE' parameter. |
| 392 | "maxValue": 3.14, # Must be specified if type is `DOUBLE`. Maximum value of the parameter. |
| 393 | "minValue": 3.14, # Must be specified if type is `DOUBLE`. Minimum value of the parameter. |
| 394 | }, |
| 395 | "parameter": "A String", # Required. The parameter name must be unique amongst all ParameterSpecs. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 396 | "discreteValueSpec": { # The value spec for a 'DISCRETE' parameter. |
| 397 | "values": [ # Must be specified if type is `DISCRETE`. |
| 398 | # A list of feasible points. |
| 399 | # The list should be in strictly increasing order. For instance, this |
| 400 | # parameter might have possible settings of 1.5, 2.5, and 4.0. This list |
| 401 | # should not contain more than 1,000 values. |
| 402 | 3.14, |
| 403 | ], |
| 404 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 405 | "parentDiscreteValues": { # Represents the spec to match discrete values from parent parameter. |
| 406 | "values": [ # Matches values of the parent parameter with type 'DISCRETE'. |
| 407 | # All values must exist in `discrete_value_spec` of parent parameter. |
| 408 | 3.14, |
| 409 | ], |
| 410 | }, |
| 411 | "integerValueSpec": { # The value spec for an 'INTEGER' parameter. |
| 412 | "maxValue": "A String", # Must be specified if type is `INTEGER`. Maximum value of the parameter. |
| 413 | "minValue": "A String", # Must be specified if type is `INTEGER`. Minimum value of the parameter. |
| 414 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 415 | "parentCategoricalValues": { # Represents the spec to match categorical values from parent parameter. |
| 416 | "values": [ # Matches values of the parent parameter with type 'CATEGORICAL'. |
| 417 | # All values must exist in `categorical_value_spec` of parent parameter. |
| 418 | "A String", |
| 419 | ], |
| 420 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 421 | }, |
| 422 | ], |
| 423 | "metrics": [ # Metric specs for the study. |
| 424 | { # Represents a metric to optimize. |
| 425 | "goal": "A String", # Required. The optimization goal of the metric. |
| 426 | "metric": "A String", # Required. The name of the metric. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 427 | }, |
| 428 | ], |
| 429 | }, |
| 430 | }</pre> |
| 431 | </div> |
| 432 | |
| 433 | <div class="method"> |
| 434 | <code class="details" id="list">list(parent, x__xgafv=None)</code> |
| 435 | <pre>Lists all the studies in a region for an associated project. |
| 436 | |
| 437 | Args: |
| 438 | parent: string, Required. The project and location that the study belongs to. |
| 439 | Format: projects/{project}/locations/{location} (required) |
| 440 | x__xgafv: string, V1 error format. |
| 441 | Allowed values |
| 442 | 1 - v1 error format |
| 443 | 2 - v2 error format |
| 444 | |
| 445 | Returns: |
| 446 | An object of the form: |
| 447 | |
| 448 | { |
| 449 | "studies": [ # The studies associated with the project. |
| 450 | { # A message representing a Study. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 451 | "name": "A String", # Output only. The name of a study. |
| 452 | "state": "A String", # Output only. The detailed state of a study. |
| 453 | "createTime": "A String", # Output only. Time at which the study was created. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 454 | "inactiveReason": "A String", # Output only. A human readable reason why the Study is inactive. |
| 455 | # This should be empty if a study is ACTIVE or COMPLETED. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 456 | "studyConfig": { # Represents configuration of a study. # Required. Configuration of the study. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 457 | "algorithm": "A String", # The search algorithm specified for the study. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 458 | "automatedStoppingConfig": { # Configuration for Automated Early Stopping of Trials. If no # Configuration for automated stopping of unpromising Trials. |
| 459 | # implementation_config is set, automated early stopping will not be run. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 460 | "decayCurveStoppingConfig": { |
| 461 | "useElapsedTime": True or False, # If true, measurement.elapsed_time is used as the x-axis of each |
| 462 | # Trials Decay Curve. Otherwise, Measurement.steps will be used as the |
| 463 | # x-axis. |
| 464 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 465 | "medianAutomatedStoppingConfig": { # The median automated stopping rule stops a pending trial if the trial's |
| 466 | # best objective_value is strictly below the median 'performance' of all |
| 467 | # completed trials reported up to the trial's last measurement. |
| 468 | # Currently, 'performance' refers to the running average of the objective |
| 469 | # values reported by the trial in each measurement. |
| 470 | "useElapsedTime": True or False, # If true, the median automated stopping rule applies to |
| 471 | # measurement.use_elapsed_time, which means the elapsed_time field of |
| 472 | # the current trial's |
| 473 | # latest measurement is used to compute the median objective |
| 474 | # value for each completed trial. |
| 475 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 476 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 477 | "parameters": [ # Required. The set of parameters to tune. |
| 478 | { # Represents a single parameter to optimize. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 479 | "categoricalValueSpec": { # The value spec for a 'CATEGORICAL' parameter. |
| 480 | "values": [ # Must be specified if type is `CATEGORICAL`. |
| 481 | # The list of possible categories. |
| 482 | "A String", |
| 483 | ], |
| 484 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 485 | "type": "A String", # Required. The type of the parameter. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 486 | "childParameterSpecs": [ # A child node is active if the parameter's value matches the child node's |
| 487 | # matching_parent_values. |
| 488 | # |
| 489 | # If two items in child_parameter_specs have the same name, they must have |
| 490 | # disjoint matching_parent_values. |
| 491 | # Object with schema name: GoogleCloudMlV1_StudyConfig_ParameterSpec |
| 492 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 493 | "parentIntValues": { # Represents the spec to match integer values from parent parameter. |
| 494 | "values": [ # Matches values of the parent parameter with type 'INTEGER'. |
| 495 | # All values must lie in `integer_value_spec` of parent parameter. |
| 496 | "A String", |
| 497 | ], |
| 498 | }, |
| 499 | "scaleType": "A String", # How the parameter should be scaled. |
| 500 | # Leave unset for categorical parameters. |
| 501 | "doubleValueSpec": { # The value spec for a 'DOUBLE' parameter. |
| 502 | "maxValue": 3.14, # Must be specified if type is `DOUBLE`. Maximum value of the parameter. |
| 503 | "minValue": 3.14, # Must be specified if type is `DOUBLE`. Minimum value of the parameter. |
| 504 | }, |
| 505 | "parameter": "A String", # Required. The parameter name must be unique amongst all ParameterSpecs. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 506 | "discreteValueSpec": { # The value spec for a 'DISCRETE' parameter. |
| 507 | "values": [ # Must be specified if type is `DISCRETE`. |
| 508 | # A list of feasible points. |
| 509 | # The list should be in strictly increasing order. For instance, this |
| 510 | # parameter might have possible settings of 1.5, 2.5, and 4.0. This list |
| 511 | # should not contain more than 1,000 values. |
| 512 | 3.14, |
| 513 | ], |
| 514 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 515 | "parentDiscreteValues": { # Represents the spec to match discrete values from parent parameter. |
| 516 | "values": [ # Matches values of the parent parameter with type 'DISCRETE'. |
| 517 | # All values must exist in `discrete_value_spec` of parent parameter. |
| 518 | 3.14, |
| 519 | ], |
| 520 | }, |
| 521 | "integerValueSpec": { # The value spec for an 'INTEGER' parameter. |
| 522 | "maxValue": "A String", # Must be specified if type is `INTEGER`. Maximum value of the parameter. |
| 523 | "minValue": "A String", # Must be specified if type is `INTEGER`. Minimum value of the parameter. |
| 524 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 525 | "parentCategoricalValues": { # Represents the spec to match categorical values from parent parameter. |
| 526 | "values": [ # Matches values of the parent parameter with type 'CATEGORICAL'. |
| 527 | # All values must exist in `categorical_value_spec` of parent parameter. |
| 528 | "A String", |
| 529 | ], |
| 530 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 531 | }, |
| 532 | ], |
| 533 | "metrics": [ # Metric specs for the study. |
| 534 | { # Represents a metric to optimize. |
| 535 | "goal": "A String", # Required. The optimization goal of the metric. |
| 536 | "metric": "A String", # Required. The name of the metric. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 537 | }, |
| 538 | ], |
| 539 | }, |
| 540 | }, |
| 541 | ], |
| 542 | }</pre> |
| 543 | </div> |
| 544 | |
| 545 | </body></html> |