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