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