| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, h1, h2, h3, div, span, p, pre, a { |
| 5 | margin: 0; |
| 6 | padding: 0; |
| 7 | border: 0; |
| 8 | font-weight: inherit; |
| 9 | font-style: inherit; |
| 10 | font-size: 100%; |
| 11 | font-family: inherit; |
| 12 | vertical-align: baseline; |
| 13 | } |
| 14 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, h2, h3 { |
| 50 | border-bottom: solid #CCC 1px; |
| 51 | } |
| 52 | |
| 53 | .toc_element { |
| 54 | margin-top: 0.5em; |
| 55 | } |
| 56 | |
| 57 | .firstline { |
| 58 | margin-left: 2 em; |
| 59 | } |
| 60 | |
| 61 | .method { |
| 62 | margin-top: 1em; |
| 63 | border: solid 1px #CCC; |
| 64 | padding: 1em; |
| 65 | background: #EEE; |
| 66 | } |
| 67 | |
| 68 | .details { |
| 69 | font-weight: bold; |
| 70 | font-size: 14px; |
| 71 | } |
| 72 | |
| 73 | </style> |
| 74 | |
| 75 | <h1><a href="ml_v1.html">AI Platform Training & Prediction API</a> . <a href="ml_v1.projects.html">projects</a> . <a href="ml_v1.projects.locations.html">locations</a> . <a href="ml_v1.projects.locations.studies.html">studies</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| 78 | <code><a href="ml_v1.projects.locations.studies.trials.html">trials()</a></code> |
| 79 | </p> |
| 80 | <p class="firstline">Returns the trials Resource.</p> |
| 81 | |
| 82 | <p class="toc_element"> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 83 | <code><a href="#close">close()</a></code></p> |
| 84 | <p class="firstline">Close httplib2 connections.</p> |
| 85 | <p class="toc_element"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 86 | <code><a href="#create">create(parent, body=None, studyId=None, x__xgafv=None)</a></code></p> |
| 87 | <p class="firstline">Creates a study.</p> |
| 88 | <p class="toc_element"> |
| 89 | <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> |
| 90 | <p class="firstline">Deletes a study.</p> |
| 91 | <p class="toc_element"> |
| 92 | <code><a href="#get">get(name, x__xgafv=None)</a></code></p> |
| 93 | <p class="firstline">Gets a study.</p> |
| 94 | <p class="toc_element"> |
| 95 | <code><a href="#list">list(parent, x__xgafv=None)</a></code></p> |
| 96 | <p class="firstline">Lists all the studies in a region for an associated project.</p> |
| 97 | <h3>Method Details</h3> |
| 98 | <div class="method"> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 99 | <code class="details" id="close">close()</code> |
| 100 | <pre>Close httplib2 connections.</pre> |
| 101 | </div> |
| 102 | |
| 103 | <div class="method"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 104 | <code class="details" id="create">create(parent, body=None, studyId=None, x__xgafv=None)</code> |
| 105 | <pre>Creates a study. |
| 106 | |
| 107 | Args: |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 108 | parent: string, Required. The project and location that the study belongs to. Format: projects/{project}/locations/{location} (required) |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 109 | body: object, The request body. |
| 110 | The object takes the form of: |
| 111 | |
| 112 | { # A message representing a Study. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 113 | "createTime": "A String", # Output only. Time at which the study was created. |
| 114 | "inactiveReason": "A String", # Output only. A human readable reason why the Study is inactive. This should be empty if a study is ACTIVE or COMPLETED. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 115 | "name": "A String", # Output only. The name of a study. |
| 116 | "state": "A String", # Output only. The detailed state of a study. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 117 | "studyConfig": { # Represents configuration of a study. # Required. Configuration of the study. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 118 | "algorithm": "A String", # The search algorithm specified for the study. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 119 | "automatedStoppingConfig": { # Configuration for Automated Early Stopping of Trials. If no implementation_config is set, automated early stopping will not be run. # Configuration for automated stopping of unpromising Trials. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 120 | "decayCurveStoppingConfig": { |
| 121 | "useElapsedTime": True or False, # If true, measurement.elapsed_time is used as the x-axis of each Trials Decay Curve. Otherwise, Measurement.steps will be used as the x-axis. |
| 122 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 123 | "medianAutomatedStoppingConfig": { # The median automated stopping rule stops a pending trial if the trial's best objective_value is strictly below the median 'performance' of all completed trials reported up to the trial's last measurement. Currently, 'performance' refers to the running average of the objective values reported by the trial in each measurement. |
| 124 | "useElapsedTime": True or False, # If true, the median automated stopping rule applies to measurement.use_elapsed_time, which means the elapsed_time field of the current trial's latest measurement is used to compute the median objective value for each completed trial. |
| 125 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 126 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 127 | "metrics": [ # Metric specs for the study. |
| 128 | { # Represents a metric to optimize. |
| 129 | "goal": "A String", # Required. The optimization goal of the metric. |
| 130 | "metric": "A String", # Required. The name of the metric. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 131 | }, |
| 132 | ], |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 133 | "parameters": [ # Required. The set of parameters to tune. |
| 134 | { # Represents a single parameter to optimize. |
| 135 | "categoricalValueSpec": { # The value spec for a 'CATEGORICAL' parameter. |
| 136 | "values": [ # Must be specified if type is `CATEGORICAL`. The list of possible categories. |
| 137 | "A String", |
| 138 | ], |
| 139 | }, |
| 140 | "childParameterSpecs": [ # A child node is active if the parameter's value matches the child node's matching_parent_values. If two items in child_parameter_specs have the same name, they must have disjoint matching_parent_values. |
| 141 | # Object with schema name: GoogleCloudMlV1_StudyConfig_ParameterSpec |
| 142 | ], |
| 143 | "discreteValueSpec": { # The value spec for a 'DISCRETE' parameter. |
| 144 | "values": [ # Must be specified if type is `DISCRETE`. A list of feasible points. The list should be in strictly increasing order. For instance, this parameter might have possible settings of 1.5, 2.5, and 4.0. This list should not contain more than 1,000 values. |
| 145 | 3.14, |
| 146 | ], |
| 147 | }, |
| 148 | "doubleValueSpec": { # The value spec for a 'DOUBLE' parameter. |
| 149 | "maxValue": 3.14, # Must be specified if type is `DOUBLE`. Maximum value of the parameter. |
| 150 | "minValue": 3.14, # Must be specified if type is `DOUBLE`. Minimum value of the parameter. |
| 151 | }, |
| 152 | "integerValueSpec": { # The value spec for an 'INTEGER' parameter. |
| 153 | "maxValue": "A String", # Must be specified if type is `INTEGER`. Maximum value of the parameter. |
| 154 | "minValue": "A String", # Must be specified if type is `INTEGER`. Minimum value of the parameter. |
| 155 | }, |
| 156 | "parameter": "A String", # Required. The parameter name must be unique amongst all ParameterSpecs. |
| 157 | "parentCategoricalValues": { # Represents the spec to match categorical values from parent parameter. |
| 158 | "values": [ # Matches values of the parent parameter with type 'CATEGORICAL'. All values must exist in `categorical_value_spec` of parent parameter. |
| 159 | "A String", |
| 160 | ], |
| 161 | }, |
| 162 | "parentDiscreteValues": { # Represents the spec to match discrete values from parent parameter. |
| 163 | "values": [ # Matches values of the parent parameter with type 'DISCRETE'. All values must exist in `discrete_value_spec` of parent parameter. |
| 164 | 3.14, |
| 165 | ], |
| 166 | }, |
| 167 | "parentIntValues": { # Represents the spec to match integer values from parent parameter. |
| 168 | "values": [ # Matches values of the parent parameter with type 'INTEGER'. All values must lie in `integer_value_spec` of parent parameter. |
| 169 | "A String", |
| 170 | ], |
| 171 | }, |
| 172 | "scaleType": "A String", # How the parameter should be scaled. Leave unset for categorical parameters. |
| 173 | "type": "A String", # Required. The type of the parameter. |
| 174 | }, |
| 175 | ], |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 176 | }, |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 177 | } |
| 178 | |
| 179 | studyId: string, Required. The ID to use for the study, which will become the final component of the study's resource name. |
| 180 | x__xgafv: string, V1 error format. |
| 181 | Allowed values |
| 182 | 1 - v1 error format |
| 183 | 2 - v2 error format |
| 184 | |
| 185 | Returns: |
| 186 | An object of the form: |
| 187 | |
| 188 | { # A message representing a Study. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 189 | "createTime": "A String", # Output only. Time at which the study was created. |
| 190 | "inactiveReason": "A String", # Output only. A human readable reason why the Study is inactive. This should be empty if a study is ACTIVE or COMPLETED. |
| 191 | "name": "A String", # Output only. The name of a study. |
| 192 | "state": "A String", # Output only. The detailed state of a study. |
| 193 | "studyConfig": { # Represents configuration of a study. # Required. Configuration of the study. |
| 194 | "algorithm": "A String", # The search algorithm specified for the study. |
| 195 | "automatedStoppingConfig": { # Configuration for Automated Early Stopping of Trials. If no implementation_config is set, automated early stopping will not be run. # Configuration for automated stopping of unpromising Trials. |
| 196 | "decayCurveStoppingConfig": { |
| 197 | "useElapsedTime": True or False, # If true, measurement.elapsed_time is used as the x-axis of each Trials Decay Curve. Otherwise, Measurement.steps will be used as the x-axis. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 198 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 199 | "medianAutomatedStoppingConfig": { # The median automated stopping rule stops a pending trial if the trial's best objective_value is strictly below the median 'performance' of all completed trials reported up to the trial's last measurement. Currently, 'performance' refers to the running average of the objective values reported by the trial in each measurement. |
| 200 | "useElapsedTime": True or False, # If true, the median automated stopping rule applies to measurement.use_elapsed_time, which means the elapsed_time field of the current trial's latest measurement is used to compute the median objective value for each completed trial. |
| 201 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 202 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 203 | "metrics": [ # Metric specs for the study. |
| 204 | { # Represents a metric to optimize. |
| 205 | "goal": "A String", # Required. The optimization goal of the metric. |
| 206 | "metric": "A String", # Required. The name of the metric. |
| 207 | }, |
| 208 | ], |
| 209 | "parameters": [ # Required. The set of parameters to tune. |
| 210 | { # Represents a single parameter to optimize. |
| 211 | "categoricalValueSpec": { # The value spec for a 'CATEGORICAL' parameter. |
| 212 | "values": [ # Must be specified if type is `CATEGORICAL`. The list of possible categories. |
| 213 | "A String", |
| 214 | ], |
| 215 | }, |
| 216 | "childParameterSpecs": [ # A child node is active if the parameter's value matches the child node's matching_parent_values. If two items in child_parameter_specs have the same name, they must have disjoint matching_parent_values. |
| 217 | # Object with schema name: GoogleCloudMlV1_StudyConfig_ParameterSpec |
| 218 | ], |
| 219 | "discreteValueSpec": { # The value spec for a 'DISCRETE' parameter. |
| 220 | "values": [ # Must be specified if type is `DISCRETE`. A list of feasible points. The list should be in strictly increasing order. For instance, this parameter might have possible settings of 1.5, 2.5, and 4.0. This list should not contain more than 1,000 values. |
| 221 | 3.14, |
| 222 | ], |
| 223 | }, |
| 224 | "doubleValueSpec": { # The value spec for a 'DOUBLE' parameter. |
| 225 | "maxValue": 3.14, # Must be specified if type is `DOUBLE`. Maximum value of the parameter. |
| 226 | "minValue": 3.14, # Must be specified if type is `DOUBLE`. Minimum value of the parameter. |
| 227 | }, |
| 228 | "integerValueSpec": { # The value spec for an 'INTEGER' parameter. |
| 229 | "maxValue": "A String", # Must be specified if type is `INTEGER`. Maximum value of the parameter. |
| 230 | "minValue": "A String", # Must be specified if type is `INTEGER`. Minimum value of the parameter. |
| 231 | }, |
| 232 | "parameter": "A String", # Required. The parameter name must be unique amongst all ParameterSpecs. |
| 233 | "parentCategoricalValues": { # Represents the spec to match categorical values from parent parameter. |
| 234 | "values": [ # Matches values of the parent parameter with type 'CATEGORICAL'. All values must exist in `categorical_value_spec` of parent parameter. |
| 235 | "A String", |
| 236 | ], |
| 237 | }, |
| 238 | "parentDiscreteValues": { # Represents the spec to match discrete values from parent parameter. |
| 239 | "values": [ # Matches values of the parent parameter with type 'DISCRETE'. All values must exist in `discrete_value_spec` of parent parameter. |
| 240 | 3.14, |
| 241 | ], |
| 242 | }, |
| 243 | "parentIntValues": { # Represents the spec to match integer values from parent parameter. |
| 244 | "values": [ # Matches values of the parent parameter with type 'INTEGER'. All values must lie in `integer_value_spec` of parent parameter. |
| 245 | "A String", |
| 246 | ], |
| 247 | }, |
| 248 | "scaleType": "A String", # How the parameter should be scaled. Leave unset for categorical parameters. |
| 249 | "type": "A String", # Required. The type of the parameter. |
| 250 | }, |
| 251 | ], |
| 252 | }, |
| 253 | }</pre> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 254 | </div> |
| 255 | |
| 256 | <div class="method"> |
| 257 | <code class="details" id="delete">delete(name, x__xgafv=None)</code> |
| 258 | <pre>Deletes a study. |
| 259 | |
| 260 | Args: |
| 261 | name: string, Required. The study name. (required) |
| 262 | x__xgafv: string, V1 error format. |
| 263 | Allowed values |
| 264 | 1 - v1 error format |
| 265 | 2 - v2 error format |
| 266 | |
| 267 | Returns: |
| 268 | An object of the form: |
| 269 | |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 270 | { # 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 `{}`. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 271 | }</pre> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 272 | </div> |
| 273 | |
| 274 | <div class="method"> |
| 275 | <code class="details" id="get">get(name, x__xgafv=None)</code> |
| 276 | <pre>Gets a study. |
| 277 | |
| 278 | Args: |
| 279 | name: string, Required. The study name. (required) |
| 280 | x__xgafv: string, V1 error format. |
| 281 | Allowed values |
| 282 | 1 - v1 error format |
| 283 | 2 - v2 error format |
| 284 | |
| 285 | Returns: |
| 286 | An object of the form: |
| 287 | |
| 288 | { # A message representing a Study. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 289 | "createTime": "A String", # Output only. Time at which the study was created. |
| 290 | "inactiveReason": "A String", # Output only. A human readable reason why the Study is inactive. This should be empty if a study is ACTIVE or COMPLETED. |
| 291 | "name": "A String", # Output only. The name of a study. |
| 292 | "state": "A String", # Output only. The detailed state of a study. |
| 293 | "studyConfig": { # Represents configuration of a study. # Required. Configuration of the study. |
| 294 | "algorithm": "A String", # The search algorithm specified for the study. |
| 295 | "automatedStoppingConfig": { # Configuration for Automated Early Stopping of Trials. If no implementation_config is set, automated early stopping will not be run. # Configuration for automated stopping of unpromising Trials. |
| 296 | "decayCurveStoppingConfig": { |
| 297 | "useElapsedTime": True or False, # If true, measurement.elapsed_time is used as the x-axis of each Trials Decay Curve. Otherwise, Measurement.steps will be used as the x-axis. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 298 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 299 | "medianAutomatedStoppingConfig": { # The median automated stopping rule stops a pending trial if the trial's best objective_value is strictly below the median 'performance' of all completed trials reported up to the trial's last measurement. Currently, 'performance' refers to the running average of the objective values reported by the trial in each measurement. |
| 300 | "useElapsedTime": True or False, # If true, the median automated stopping rule applies to measurement.use_elapsed_time, which means the elapsed_time field of the current trial's latest measurement is used to compute the median objective value for each completed trial. |
| 301 | }, |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 302 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 303 | "metrics": [ # Metric specs for the study. |
| 304 | { # Represents a metric to optimize. |
| 305 | "goal": "A String", # Required. The optimization goal of the metric. |
| 306 | "metric": "A String", # Required. The name of the metric. |
| 307 | }, |
| 308 | ], |
| 309 | "parameters": [ # Required. The set of parameters to tune. |
| 310 | { # Represents a single parameter to optimize. |
| 311 | "categoricalValueSpec": { # The value spec for a 'CATEGORICAL' parameter. |
| 312 | "values": [ # Must be specified if type is `CATEGORICAL`. The list of possible categories. |
| 313 | "A String", |
| 314 | ], |
| 315 | }, |
| 316 | "childParameterSpecs": [ # A child node is active if the parameter's value matches the child node's matching_parent_values. If two items in child_parameter_specs have the same name, they must have disjoint matching_parent_values. |
| 317 | # Object with schema name: GoogleCloudMlV1_StudyConfig_ParameterSpec |
| 318 | ], |
| 319 | "discreteValueSpec": { # The value spec for a 'DISCRETE' parameter. |
| 320 | "values": [ # Must be specified if type is `DISCRETE`. A list of feasible points. The list should be in strictly increasing order. For instance, this parameter might have possible settings of 1.5, 2.5, and 4.0. This list should not contain more than 1,000 values. |
| 321 | 3.14, |
| 322 | ], |
| 323 | }, |
| 324 | "doubleValueSpec": { # The value spec for a 'DOUBLE' parameter. |
| 325 | "maxValue": 3.14, # Must be specified if type is `DOUBLE`. Maximum value of the parameter. |
| 326 | "minValue": 3.14, # Must be specified if type is `DOUBLE`. Minimum value of the parameter. |
| 327 | }, |
| 328 | "integerValueSpec": { # The value spec for an 'INTEGER' parameter. |
| 329 | "maxValue": "A String", # Must be specified if type is `INTEGER`. Maximum value of the parameter. |
| 330 | "minValue": "A String", # Must be specified if type is `INTEGER`. Minimum value of the parameter. |
| 331 | }, |
| 332 | "parameter": "A String", # Required. The parameter name must be unique amongst all ParameterSpecs. |
| 333 | "parentCategoricalValues": { # Represents the spec to match categorical values from parent parameter. |
| 334 | "values": [ # Matches values of the parent parameter with type 'CATEGORICAL'. All values must exist in `categorical_value_spec` of parent parameter. |
| 335 | "A String", |
| 336 | ], |
| 337 | }, |
| 338 | "parentDiscreteValues": { # Represents the spec to match discrete values from parent parameter. |
| 339 | "values": [ # Matches values of the parent parameter with type 'DISCRETE'. All values must exist in `discrete_value_spec` of parent parameter. |
| 340 | 3.14, |
| 341 | ], |
| 342 | }, |
| 343 | "parentIntValues": { # Represents the spec to match integer values from parent parameter. |
| 344 | "values": [ # Matches values of the parent parameter with type 'INTEGER'. All values must lie in `integer_value_spec` of parent parameter. |
| 345 | "A String", |
| 346 | ], |
| 347 | }, |
| 348 | "scaleType": "A String", # How the parameter should be scaled. Leave unset for categorical parameters. |
| 349 | "type": "A String", # Required. The type of the parameter. |
| 350 | }, |
| 351 | ], |
| 352 | }, |
| 353 | }</pre> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 354 | </div> |
| 355 | |
| 356 | <div class="method"> |
| 357 | <code class="details" id="list">list(parent, x__xgafv=None)</code> |
| 358 | <pre>Lists all the studies in a region for an associated project. |
| 359 | |
| 360 | Args: |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 361 | parent: string, Required. The project and location that the study belongs to. Format: projects/{project}/locations/{location} (required) |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 362 | x__xgafv: string, V1 error format. |
| 363 | Allowed values |
| 364 | 1 - v1 error format |
| 365 | 2 - v2 error format |
| 366 | |
| 367 | Returns: |
| 368 | An object of the form: |
| 369 | |
| 370 | { |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 371 | "studies": [ # The studies associated with the project. |
| 372 | { # A message representing a Study. |
| 373 | "createTime": "A String", # Output only. Time at which the study was created. |
| 374 | "inactiveReason": "A String", # Output only. A human readable reason why the Study is inactive. This should be empty if a study is ACTIVE or COMPLETED. |
| 375 | "name": "A String", # Output only. The name of a study. |
| 376 | "state": "A String", # Output only. The detailed state of a study. |
| 377 | "studyConfig": { # Represents configuration of a study. # Required. Configuration of the study. |
| 378 | "algorithm": "A String", # The search algorithm specified for the study. |
| 379 | "automatedStoppingConfig": { # Configuration for Automated Early Stopping of Trials. If no implementation_config is set, automated early stopping will not be run. # Configuration for automated stopping of unpromising Trials. |
| 380 | "decayCurveStoppingConfig": { |
| 381 | "useElapsedTime": True or False, # If true, measurement.elapsed_time is used as the x-axis of each Trials Decay Curve. Otherwise, Measurement.steps will be used as the x-axis. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 382 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 383 | "medianAutomatedStoppingConfig": { # The median automated stopping rule stops a pending trial if the trial's best objective_value is strictly below the median 'performance' of all completed trials reported up to the trial's last measurement. Currently, 'performance' refers to the running average of the objective values reported by the trial in each measurement. |
| 384 | "useElapsedTime": True or False, # If true, the median automated stopping rule applies to measurement.use_elapsed_time, which means the elapsed_time field of the current trial's latest measurement is used to compute the median objective value for each completed trial. |
| 385 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 386 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 387 | "metrics": [ # Metric specs for the study. |
| 388 | { # Represents a metric to optimize. |
| 389 | "goal": "A String", # Required. The optimization goal of the metric. |
| 390 | "metric": "A String", # Required. The name of the metric. |
| 391 | }, |
| 392 | ], |
| 393 | "parameters": [ # Required. The set of parameters to tune. |
| 394 | { # Represents a single parameter to optimize. |
| 395 | "categoricalValueSpec": { # The value spec for a 'CATEGORICAL' parameter. |
| 396 | "values": [ # Must be specified if type is `CATEGORICAL`. The list of possible categories. |
| 397 | "A String", |
| 398 | ], |
| 399 | }, |
| 400 | "childParameterSpecs": [ # A child node is active if the parameter's value matches the child node's matching_parent_values. If two items in child_parameter_specs have the same name, they must have disjoint matching_parent_values. |
| 401 | # Object with schema name: GoogleCloudMlV1_StudyConfig_ParameterSpec |
| 402 | ], |
| 403 | "discreteValueSpec": { # The value spec for a 'DISCRETE' parameter. |
| 404 | "values": [ # Must be specified if type is `DISCRETE`. A list of feasible points. The list should be in strictly increasing order. For instance, this parameter might have possible settings of 1.5, 2.5, and 4.0. This list should not contain more than 1,000 values. |
| 405 | 3.14, |
| 406 | ], |
| 407 | }, |
| 408 | "doubleValueSpec": { # The value spec for a 'DOUBLE' parameter. |
| 409 | "maxValue": 3.14, # Must be specified if type is `DOUBLE`. Maximum value of the parameter. |
| 410 | "minValue": 3.14, # Must be specified if type is `DOUBLE`. Minimum value of the parameter. |
| 411 | }, |
| 412 | "integerValueSpec": { # The value spec for an 'INTEGER' parameter. |
| 413 | "maxValue": "A String", # Must be specified if type is `INTEGER`. Maximum value of the parameter. |
| 414 | "minValue": "A String", # Must be specified if type is `INTEGER`. Minimum value of the parameter. |
| 415 | }, |
| 416 | "parameter": "A String", # Required. The parameter name must be unique amongst all ParameterSpecs. |
| 417 | "parentCategoricalValues": { # Represents the spec to match categorical values from parent parameter. |
| 418 | "values": [ # Matches values of the parent parameter with type 'CATEGORICAL'. All values must exist in `categorical_value_spec` of parent parameter. |
| 419 | "A String", |
| 420 | ], |
| 421 | }, |
| 422 | "parentDiscreteValues": { # Represents the spec to match discrete values from parent parameter. |
| 423 | "values": [ # Matches values of the parent parameter with type 'DISCRETE'. All values must exist in `discrete_value_spec` of parent parameter. |
| 424 | 3.14, |
| 425 | ], |
| 426 | }, |
| 427 | "parentIntValues": { # Represents the spec to match integer values from parent parameter. |
| 428 | "values": [ # Matches values of the parent parameter with type 'INTEGER'. All values must lie in `integer_value_spec` of parent parameter. |
| 429 | "A String", |
| 430 | ], |
| 431 | }, |
| 432 | "scaleType": "A String", # How the parameter should be scaled. Leave unset for categorical parameters. |
| 433 | "type": "A String", # Required. The type of the parameter. |
| 434 | }, |
| 435 | ], |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 436 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 437 | }, |
| 438 | ], |
| 439 | }</pre> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 440 | </div> |
| 441 | |
| 442 | </body></html> |