OLD | NEW |
(Empty) | |
| 1 { |
| 2 "auth": { |
| 3 "oauth2": { |
| 4 "scopes": { |
| 5 "https://www.googleapis.com/auth/cloud-platform": { |
| 6 "description": "View and manage your data across Google Clou
d Platform services" |
| 7 } |
| 8 } |
| 9 } |
| 10 }, |
| 11 "basePath": "", |
| 12 "baseUrl": "https://ml.googleapis.com/", |
| 13 "batchPath": "batch", |
| 14 "canonicalName": "Cloud Machine Learning", |
| 15 "description": "An API to enable creating and using machine learning models.
", |
| 16 "discoveryVersion": "v1", |
| 17 "documentationLink": "https://cloud.google.com/ml/", |
| 18 "icons": { |
| 19 "x16": "http://www.google.com/images/icons/product/search-16.gif", |
| 20 "x32": "http://www.google.com/images/icons/product/search-32.gif" |
| 21 }, |
| 22 "id": "ml:v1beta1", |
| 23 "kind": "discovery#restDescription", |
| 24 "name": "ml", |
| 25 "ownerDomain": "google.com", |
| 26 "ownerName": "Google", |
| 27 "parameters": { |
| 28 "access_token": { |
| 29 "description": "OAuth access token.", |
| 30 "location": "query", |
| 31 "type": "string" |
| 32 }, |
| 33 "prettyPrint": { |
| 34 "default": "true", |
| 35 "description": "Returns response with indentations and line breaks."
, |
| 36 "location": "query", |
| 37 "type": "boolean" |
| 38 }, |
| 39 "key": { |
| 40 "description": "API key. Your API key identifies your project and pr
ovides you with API access, quota, and reports. Required unless you provide an O
Auth 2.0 token.", |
| 41 "location": "query", |
| 42 "type": "string" |
| 43 }, |
| 44 "quotaUser": { |
| 45 "description": "Available to use for quota purposes for server-side
applications. Can be any arbitrary string assigned to a user, but should not exc
eed 40 characters.", |
| 46 "location": "query", |
| 47 "type": "string" |
| 48 }, |
| 49 "pp": { |
| 50 "default": "true", |
| 51 "description": "Pretty-print response.", |
| 52 "location": "query", |
| 53 "type": "boolean" |
| 54 }, |
| 55 "fields": { |
| 56 "description": "Selector specifying which fields to include in a par
tial response.", |
| 57 "location": "query", |
| 58 "type": "string" |
| 59 }, |
| 60 "alt": { |
| 61 "default": "json", |
| 62 "description": "Data format for response.", |
| 63 "enum": [ |
| 64 "json", |
| 65 "media", |
| 66 "proto" |
| 67 ], |
| 68 "enumDescriptions": [ |
| 69 "Responses with Content-Type of application/json", |
| 70 "Media download with context-dependent Content-Type", |
| 71 "Responses with Content-Type of application/x-protobuf" |
| 72 ], |
| 73 "location": "query", |
| 74 "type": "string" |
| 75 }, |
| 76 "$.xgafv": { |
| 77 "description": "V1 error format.", |
| 78 "enum": [ |
| 79 "1", |
| 80 "2" |
| 81 ], |
| 82 "enumDescriptions": [ |
| 83 "v1 error format", |
| 84 "v2 error format" |
| 85 ], |
| 86 "location": "query", |
| 87 "type": "string" |
| 88 }, |
| 89 "callback": { |
| 90 "description": "JSONP", |
| 91 "location": "query", |
| 92 "type": "string" |
| 93 }, |
| 94 "oauth_token": { |
| 95 "description": "OAuth 2.0 token for the current user.", |
| 96 "location": "query", |
| 97 "type": "string" |
| 98 }, |
| 99 "uploadType": { |
| 100 "description": "Legacy upload protocol for media (e.g. \"media\", \"
multipart\").", |
| 101 "location": "query", |
| 102 "type": "string" |
| 103 }, |
| 104 "bearer_token": { |
| 105 "description": "OAuth bearer token.", |
| 106 "location": "query", |
| 107 "type": "string" |
| 108 }, |
| 109 "upload_protocol": { |
| 110 "description": "Upload protocol for media (e.g. \"raw\", \"multipart
\").", |
| 111 "location": "query", |
| 112 "type": "string" |
| 113 } |
| 114 }, |
| 115 "protocol": "rest", |
| 116 "resources": { |
| 117 "projects": { |
| 118 "methods": { |
| 119 "predict": { |
| 120 "description": "Performs prediction on the data in the reque
st.\n\nResponses are very similar to requests. There are two top-level fields,\n
each of which are JSON lists:\n\n<dl>\n <dt>predictions</dt>\n <dd>The list of
predictions, one per instance in the request.</dd>\n <dt>error</dt>\n <dd>An
error message returned instead of a prediction list if any\n instance produ
ced an error.</dd>\n</dl>\n\nIf the call is successful, the response body will c
ontain one prediction\nentry per instance in the request body. If prediction fai
ls for any\ninstance, the response body will contain no predictions and will con
tian\na single error entry instead.\n\nEven though there is one prediction per i
nstance, the format of a\nprediction is not directly related to the format of an
instance.\nPredictions take whatever format is specified in the outputs collect
ion\ndefined in the model. The collection of predictions is returned in a JSON\n
list. Each member of the list can be a simple value, a list, or a JSON\nobject o
f any complexity. If your model has more than one output tensor,\neach predictio
n will be a JSON object containing a name/value pair for each\noutput. The names
identify the output aliases in the graph.\n\nThe following examples show some p
ossible responses:\n\nA simple set of predictions for three input instances, whe
re each\nprediction is an integer value:\n<pre>\n{\"predictions\": [5, 4, 3]}\n<
/pre>\nA more complex set of predictions, each containing two named values that\
ncorrespond to output tensors, named **label** and **scores** respectively.\nThe
value of **label** is the predicted category (\"car\" or \"beach\") and\n**scor
es** contains a list of probabilities for that instance across the\npossible cat
egories.\n<pre>\n{\"predictions\": [{\"label\": \"beach\", \"scores\": [0.1, 0.9
]},\n {\"label\": \"car\", \"scores\": [0.75, 0.25]}]}\n</pre>\n
A response when there is an error processing an input instance:\n<pre>\n{\"error
\": \"Divide by zero\"}\n</pre>", |
| 121 "httpMethod": "POST", |
| 122 "id": "ml.projects.predict", |
| 123 "parameterOrder": [ |
| 124 "name" |
| 125 ], |
| 126 "parameters": { |
| 127 "name": { |
| 128 "description": "Required. The resource name of a mod
el or a version.\n\nAuthorization: requires `Viewer` role on the parent project.
", |
| 129 "location": "path", |
| 130 "pattern": "^projects/.+$", |
| 131 "required": true, |
| 132 "type": "string" |
| 133 } |
| 134 }, |
| 135 "path": "v1beta1/{+name}:predict", |
| 136 "request": { |
| 137 "$ref": "GoogleCloudMlV1beta1__PredictRequest" |
| 138 }, |
| 139 "response": { |
| 140 "$ref": "GoogleApi__HttpBody" |
| 141 }, |
| 142 "scopes": [ |
| 143 "https://www.googleapis.com/auth/cloud-platform" |
| 144 ] |
| 145 }, |
| 146 "getConfig": { |
| 147 "description": "Get the service account information associat
ed with your project. You need\nthis information in order to grant the service a
ccount persmissions for\nthe Google Cloud Storage location where you put your mo
del training code\nfor training the model with Google Cloud Machine Learning.", |
| 148 "httpMethod": "GET", |
| 149 "id": "ml.projects.getConfig", |
| 150 "parameterOrder": [ |
| 151 "name" |
| 152 ], |
| 153 "parameters": { |
| 154 "name": { |
| 155 "description": "Required. The project name.\n\nAutho
rization: requires `Viewer` role on the specified project.", |
| 156 "location": "path", |
| 157 "pattern": "^projects/[^/]+$", |
| 158 "required": true, |
| 159 "type": "string" |
| 160 } |
| 161 }, |
| 162 "path": "v1beta1/{+name}:getConfig", |
| 163 "response": { |
| 164 "$ref": "GoogleCloudMlV1beta1__GetConfigResponse" |
| 165 }, |
| 166 "scopes": [ |
| 167 "https://www.googleapis.com/auth/cloud-platform" |
| 168 ] |
| 169 } |
| 170 }, |
| 171 "resources": { |
| 172 "models": { |
| 173 "methods": { |
| 174 "create": { |
| 175 "description": "Creates a model which will later con
tain one or more versions.\n\nYou must add at least one version before you can r
equest predictions from\nthe model. Add versions by calling\n[projects.models.ve
rsions.create](/ml/reference/rest/v1beta1/projects.models.versions/create).", |
| 176 "httpMethod": "POST", |
| 177 "id": "ml.projects.models.create", |
| 178 "parameterOrder": [ |
| 179 "parent" |
| 180 ], |
| 181 "parameters": { |
| 182 "parent": { |
| 183 "description": "Required. The project name.\
n\nAuthorization: requires `Editor` role on the specified project.", |
| 184 "location": "path", |
| 185 "pattern": "^projects/[^/]+$", |
| 186 "required": true, |
| 187 "type": "string" |
| 188 } |
| 189 }, |
| 190 "path": "v1beta1/{+parent}/models", |
| 191 "request": { |
| 192 "$ref": "GoogleCloudMlV1beta1__Model" |
| 193 }, |
| 194 "response": { |
| 195 "$ref": "GoogleCloudMlV1beta1__Model" |
| 196 }, |
| 197 "scopes": [ |
| 198 "https://www.googleapis.com/auth/cloud-platform" |
| 199 ] |
| 200 }, |
| 201 "get": { |
| 202 "description": "Gets information about a model, incl
uding its name, the description (if\nset), and the default version (if at least
one version of the model has\nbeen deployed).", |
| 203 "httpMethod": "GET", |
| 204 "id": "ml.projects.models.get", |
| 205 "parameterOrder": [ |
| 206 "name" |
| 207 ], |
| 208 "parameters": { |
| 209 "name": { |
| 210 "description": "Required. The name of the mo
del.\n\nAuthorization: requires `Viewer` role on the parent project.", |
| 211 "location": "path", |
| 212 "pattern": "^projects/[^/]+/models/[^/]+$", |
| 213 "required": true, |
| 214 "type": "string" |
| 215 } |
| 216 }, |
| 217 "path": "v1beta1/{+name}", |
| 218 "response": { |
| 219 "$ref": "GoogleCloudMlV1beta1__Model" |
| 220 }, |
| 221 "scopes": [ |
| 222 "https://www.googleapis.com/auth/cloud-platform" |
| 223 ] |
| 224 }, |
| 225 "list": { |
| 226 "description": "Lists the models in a project.\n\nEa
ch project can contain multiple models, and each model can have multiple\nversio
ns.", |
| 227 "httpMethod": "GET", |
| 228 "id": "ml.projects.models.list", |
| 229 "parameterOrder": [ |
| 230 "parent" |
| 231 ], |
| 232 "parameters": { |
| 233 "pageSize": { |
| 234 "description": "Optional. The number of mode
ls to retrieve per \"page\" of results. If there\nare more remaining results tha
n this number, the response message will\ncontain a valid value in the `next_pag
e_token` field.\n\nThe default value is 20, and the maximum page size is 100.", |
| 235 "format": "int32", |
| 236 "location": "query", |
| 237 "type": "integer" |
| 238 }, |
| 239 "parent": { |
| 240 "description": "Required. The name of the pr
oject whose models are to be listed.\n\nAuthorization: requires `Viewer` role on
the specified project.", |
| 241 "location": "path", |
| 242 "pattern": "^projects/[^/]+$", |
| 243 "required": true, |
| 244 "type": "string" |
| 245 }, |
| 246 "pageToken": { |
| 247 "description": "Optional. A page token to re
quest the next page of results.\n\nYou get the token from the `next_page_token`
field of the response from\nthe previous call.", |
| 248 "location": "query", |
| 249 "type": "string" |
| 250 } |
| 251 }, |
| 252 "path": "v1beta1/{+parent}/models", |
| 253 "response": { |
| 254 "$ref": "GoogleCloudMlV1beta1__ListModelsRespons
e" |
| 255 }, |
| 256 "scopes": [ |
| 257 "https://www.googleapis.com/auth/cloud-platform" |
| 258 ] |
| 259 }, |
| 260 "delete": { |
| 261 "description": "Deletes a model.\n\nYou can only del
ete a model if there are no versions in it. You can delete\nversions by calling\
n[projects.models.versions.delete](/ml/reference/rest/v1beta1/projects.models.ve
rsions/delete).", |
| 262 "httpMethod": "DELETE", |
| 263 "id": "ml.projects.models.delete", |
| 264 "parameterOrder": [ |
| 265 "name" |
| 266 ], |
| 267 "parameters": { |
| 268 "name": { |
| 269 "description": "Required. The name of the mo
del.\n\nAuthorization: requires `Editor` role on the parent project.", |
| 270 "location": "path", |
| 271 "pattern": "^projects/[^/]+/models/[^/]+$", |
| 272 "required": true, |
| 273 "type": "string" |
| 274 } |
| 275 }, |
| 276 "path": "v1beta1/{+name}", |
| 277 "response": { |
| 278 "$ref": "GoogleLongrunning__Operation" |
| 279 }, |
| 280 "scopes": [ |
| 281 "https://www.googleapis.com/auth/cloud-platform" |
| 282 ] |
| 283 } |
| 284 }, |
| 285 "resources": { |
| 286 "versions": { |
| 287 "methods": { |
| 288 "create": { |
| 289 "description": "Creates a new version of a m
odel from a trained TensorFlow model.\n\nIf the version created in the cloud by
this call is the first deployed\nversion of the specified model, it will be made
the default version of the\nmodel. When you add a version to a model that alrea
dy has one or more\nversions, the default version does not automatically change.
If you want a\nnew version to be the default, you must call\n[projects.models.v
ersions.setDefault](/ml/reference/rest/v1beta1/projects.models.versions/setDefau
lt).", |
| 290 "httpMethod": "POST", |
| 291 "id": "ml.projects.models.versions.create", |
| 292 "parameterOrder": [ |
| 293 "parent" |
| 294 ], |
| 295 "parameters": { |
| 296 "parent": { |
| 297 "description": "Required. The name o
f the model.\n\nAuthorization: requires `Editor` role on the parent project.", |
| 298 "location": "path", |
| 299 "pattern": "^projects/[^/]+/models/[
^/]+$", |
| 300 "required": true, |
| 301 "type": "string" |
| 302 } |
| 303 }, |
| 304 "path": "v1beta1/{+parent}/versions", |
| 305 "request": { |
| 306 "$ref": "GoogleCloudMlV1beta1__Version" |
| 307 }, |
| 308 "response": { |
| 309 "$ref": "GoogleLongrunning__Operation" |
| 310 }, |
| 311 "scopes": [ |
| 312 "https://www.googleapis.com/auth/cloud-p
latform" |
| 313 ] |
| 314 }, |
| 315 "get": { |
| 316 "description": "Gets information about a mod
el version.\n\nModels can have multiple versions. You can call\n[projects.models
.versions.list](/ml/reference/rest/v1beta1/projects.models.versions/list)\nto ge
t the same information that this method returns for all of the\nversions of a mo
del.", |
| 317 "httpMethod": "GET", |
| 318 "id": "ml.projects.models.versions.get", |
| 319 "parameterOrder": [ |
| 320 "name" |
| 321 ], |
| 322 "parameters": { |
| 323 "name": { |
| 324 "description": "Required. The name o
f the version.\n\nAuthorization: requires `Viewer` role on the parent project.", |
| 325 "location": "path", |
| 326 "pattern": "^projects/[^/]+/models/[
^/]+/versions/[^/]+$", |
| 327 "required": true, |
| 328 "type": "string" |
| 329 } |
| 330 }, |
| 331 "path": "v1beta1/{+name}", |
| 332 "response": { |
| 333 "$ref": "GoogleCloudMlV1beta1__Version" |
| 334 }, |
| 335 "scopes": [ |
| 336 "https://www.googleapis.com/auth/cloud-p
latform" |
| 337 ] |
| 338 }, |
| 339 "setDefault": { |
| 340 "description": "Designates a version to be t
he default for the model.\n\nThe default version is used for prediction requests
made against the model\nthat don't specify a version.\n\nThe first version to b
e created for a model is automatically set as the\ndefault. You must make any su
bsequent changes to the default version\nsetting manually using this method.", |
| 341 "httpMethod": "POST", |
| 342 "id": "ml.projects.models.versions.setDefaul
t", |
| 343 "parameterOrder": [ |
| 344 "name" |
| 345 ], |
| 346 "parameters": { |
| 347 "name": { |
| 348 "description": "Required. The name o
f the version to make the default for the model. You\ncan get the names of all t
he versions of a model by calling\n[projects.models.versions.list](/ml/reference
/rest/v1beta1/projects.models.versions/list).\n\nAuthorization: requires `Editor
` role on the parent project.", |
| 349 "location": "path", |
| 350 "pattern": "^projects/[^/]+/models/[
^/]+/versions/[^/]+$", |
| 351 "required": true, |
| 352 "type": "string" |
| 353 } |
| 354 }, |
| 355 "path": "v1beta1/{+name}:setDefault", |
| 356 "request": { |
| 357 "$ref": "GoogleCloudMlV1beta1__SetDefaul
tVersionRequest" |
| 358 }, |
| 359 "response": { |
| 360 "$ref": "GoogleCloudMlV1beta1__Version" |
| 361 }, |
| 362 "scopes": [ |
| 363 "https://www.googleapis.com/auth/cloud-p
latform" |
| 364 ] |
| 365 }, |
| 366 "list": { |
| 367 "description": "Gets basic information about
all the versions of a model.\n\nIf you expect that a model has a lot of version
s, or if you need to handle\nonly a limited number of results at a time, you can
request that the list\nbe retrieved in batches (called pages):", |
| 368 "httpMethod": "GET", |
| 369 "id": "ml.projects.models.versions.list", |
| 370 "parameterOrder": [ |
| 371 "parent" |
| 372 ], |
| 373 "parameters": { |
| 374 "pageSize": { |
| 375 "description": "Optional. The number
of versions to retrieve per \"page\" of results. If\nthere are more remaining r
esults than this number, the response message\nwill contain a valid value in the
`next_page_token` field.\n\nThe default value is 20, and the maximum page size
is 100.", |
| 376 "format": "int32", |
| 377 "location": "query", |
| 378 "type": "integer" |
| 379 }, |
| 380 "parent": { |
| 381 "description": "Required. The name o
f the model for which to list the version.\n\nAuthorization: requires `Viewer` r
ole on the parent project.", |
| 382 "location": "path", |
| 383 "pattern": "^projects/[^/]+/models/[
^/]+$", |
| 384 "required": true, |
| 385 "type": "string" |
| 386 }, |
| 387 "pageToken": { |
| 388 "description": "Optional. A page tok
en to request the next page of results.\n\nYou get the token from the `next_page
_token` field of the response from\nthe previous call.", |
| 389 "location": "query", |
| 390 "type": "string" |
| 391 } |
| 392 }, |
| 393 "path": "v1beta1/{+parent}/versions", |
| 394 "response": { |
| 395 "$ref": "GoogleCloudMlV1beta1__ListVersi
onsResponse" |
| 396 }, |
| 397 "scopes": [ |
| 398 "https://www.googleapis.com/auth/cloud-p
latform" |
| 399 ] |
| 400 }, |
| 401 "delete": { |
| 402 "description": "Deletes a model version.\n\n
Each model can have multiple versions deployed and in use at any given\ntime. Us
e this method to remove a single version.\n\nNote: You cannot delete the version
that is set as the default version\nof the model unless it is the only remainin
g version.", |
| 403 "httpMethod": "DELETE", |
| 404 "id": "ml.projects.models.versions.delete", |
| 405 "parameterOrder": [ |
| 406 "name" |
| 407 ], |
| 408 "parameters": { |
| 409 "name": { |
| 410 "description": "Required. The name o
f the version. You can get the names of all the\nversions of a model by calling\
n[projects.models.versions.list](/ml/reference/rest/v1beta1/projects.models.vers
ions/list).\n\nAuthorization: requires `Editor` role on the parent project.", |
| 411 "location": "path", |
| 412 "pattern": "^projects/[^/]+/models/[
^/]+/versions/[^/]+$", |
| 413 "required": true, |
| 414 "type": "string" |
| 415 } |
| 416 }, |
| 417 "path": "v1beta1/{+name}", |
| 418 "response": { |
| 419 "$ref": "GoogleLongrunning__Operation" |
| 420 }, |
| 421 "scopes": [ |
| 422 "https://www.googleapis.com/auth/cloud-p
latform" |
| 423 ] |
| 424 } |
| 425 } |
| 426 } |
| 427 } |
| 428 }, |
| 429 "jobs": { |
| 430 "methods": { |
| 431 "create": { |
| 432 "description": "Creates a training or a batch predic
tion job.", |
| 433 "httpMethod": "POST", |
| 434 "id": "ml.projects.jobs.create", |
| 435 "parameterOrder": [ |
| 436 "parent" |
| 437 ], |
| 438 "parameters": { |
| 439 "parent": { |
| 440 "description": "Required. The project name.\
n\nAuthorization: requires `Editor` role on the specified project.", |
| 441 "location": "path", |
| 442 "pattern": "^projects/[^/]+$", |
| 443 "required": true, |
| 444 "type": "string" |
| 445 } |
| 446 }, |
| 447 "path": "v1beta1/{+parent}/jobs", |
| 448 "request": { |
| 449 "$ref": "GoogleCloudMlV1beta1__Job" |
| 450 }, |
| 451 "response": { |
| 452 "$ref": "GoogleCloudMlV1beta1__Job" |
| 453 }, |
| 454 "scopes": [ |
| 455 "https://www.googleapis.com/auth/cloud-platform" |
| 456 ] |
| 457 }, |
| 458 "get": { |
| 459 "description": "Describes a job.", |
| 460 "httpMethod": "GET", |
| 461 "id": "ml.projects.jobs.get", |
| 462 "parameterOrder": [ |
| 463 "name" |
| 464 ], |
| 465 "parameters": { |
| 466 "name": { |
| 467 "description": "Required. The name of the jo
b to get the description of.\n\nAuthorization: requires `Viewer` role on the par
ent project.", |
| 468 "location": "path", |
| 469 "pattern": "^projects/[^/]+/jobs/[^/]+$", |
| 470 "required": true, |
| 471 "type": "string" |
| 472 } |
| 473 }, |
| 474 "path": "v1beta1/{+name}", |
| 475 "response": { |
| 476 "$ref": "GoogleCloudMlV1beta1__Job" |
| 477 }, |
| 478 "scopes": [ |
| 479 "https://www.googleapis.com/auth/cloud-platform" |
| 480 ] |
| 481 }, |
| 482 "list": { |
| 483 "description": "Lists the jobs in the project.", |
| 484 "httpMethod": "GET", |
| 485 "id": "ml.projects.jobs.list", |
| 486 "parameterOrder": [ |
| 487 "parent" |
| 488 ], |
| 489 "parameters": { |
| 490 "pageSize": { |
| 491 "description": "Optional. The number of jobs
to retrieve per \"page\" of results. If there\nare more remaining results than
this number, the response message will\ncontain a valid value in the `next_page_
token` field.\n\nThe default value is 20, and the maximum page size is 100.", |
| 492 "format": "int32", |
| 493 "location": "query", |
| 494 "type": "integer" |
| 495 }, |
| 496 "filter": { |
| 497 "description": "Optional. Specifies the subs
et of jobs to retrieve.", |
| 498 "location": "query", |
| 499 "type": "string" |
| 500 }, |
| 501 "parent": { |
| 502 "description": "Required. The name of the pr
oject for which to list jobs.\n\nAuthorization: requires `Viewer` role on the sp
ecified project.", |
| 503 "location": "path", |
| 504 "pattern": "^projects/[^/]+$", |
| 505 "required": true, |
| 506 "type": "string" |
| 507 }, |
| 508 "pageToken": { |
| 509 "description": "Optional. A page token to re
quest the next page of results.\n\nYou get the token from the `next_page_token`
field of the response from\nthe previous call.", |
| 510 "location": "query", |
| 511 "type": "string" |
| 512 } |
| 513 }, |
| 514 "path": "v1beta1/{+parent}/jobs", |
| 515 "response": { |
| 516 "$ref": "GoogleCloudMlV1beta1__ListJobsResponse" |
| 517 }, |
| 518 "scopes": [ |
| 519 "https://www.googleapis.com/auth/cloud-platform" |
| 520 ] |
| 521 }, |
| 522 "cancel": { |
| 523 "description": "Cancels a running job.", |
| 524 "httpMethod": "POST", |
| 525 "id": "ml.projects.jobs.cancel", |
| 526 "parameterOrder": [ |
| 527 "name" |
| 528 ], |
| 529 "parameters": { |
| 530 "name": { |
| 531 "description": "Required. The name of the jo
b to cancel.\n\nAuthorization: requires `Editor` role on the parent project.", |
| 532 "location": "path", |
| 533 "pattern": "^projects/[^/]+/jobs/[^/]+$", |
| 534 "required": true, |
| 535 "type": "string" |
| 536 } |
| 537 }, |
| 538 "path": "v1beta1/{+name}:cancel", |
| 539 "request": { |
| 540 "$ref": "GoogleCloudMlV1beta1__CancelJobRequest" |
| 541 }, |
| 542 "response": { |
| 543 "$ref": "GoogleProtobuf__Empty" |
| 544 }, |
| 545 "scopes": [ |
| 546 "https://www.googleapis.com/auth/cloud-platform" |
| 547 ] |
| 548 } |
| 549 } |
| 550 }, |
| 551 "operations": { |
| 552 "methods": { |
| 553 "get": { |
| 554 "description": "Gets the latest state of a long-runn
ing operation. Clients can use this\nmethod to poll the operation result at int
ervals as recommended by the API\nservice.", |
| 555 "httpMethod": "GET", |
| 556 "id": "ml.projects.operations.get", |
| 557 "parameterOrder": [ |
| 558 "name" |
| 559 ], |
| 560 "parameters": { |
| 561 "name": { |
| 562 "description": "The name of the operation re
source.", |
| 563 "location": "path", |
| 564 "pattern": "^projects/[^/]+/operations/[^/]+
$", |
| 565 "required": true, |
| 566 "type": "string" |
| 567 } |
| 568 }, |
| 569 "path": "v1beta1/{+name}", |
| 570 "response": { |
| 571 "$ref": "GoogleLongrunning__Operation" |
| 572 }, |
| 573 "scopes": [ |
| 574 "https://www.googleapis.com/auth/cloud-platform" |
| 575 ] |
| 576 }, |
| 577 "list": { |
| 578 "description": "Lists operations that match the spec
ified filter in the request. If the\nserver doesn't support this method, it retu
rns `UNIMPLEMENTED`.\n\nNOTE: the `name` binding below allows API services to ov
erride the binding\nto use different resource name schemes, such as `users/*/ope
rations`.", |
| 579 "httpMethod": "GET", |
| 580 "id": "ml.projects.operations.list", |
| 581 "parameterOrder": [ |
| 582 "name" |
| 583 ], |
| 584 "parameters": { |
| 585 "pageSize": { |
| 586 "description": "The standard list page size.
", |
| 587 "format": "int32", |
| 588 "location": "query", |
| 589 "type": "integer" |
| 590 }, |
| 591 "filter": { |
| 592 "description": "The standard list filter.", |
| 593 "location": "query", |
| 594 "type": "string" |
| 595 }, |
| 596 "name": { |
| 597 "description": "The name of the operation co
llection.", |
| 598 "location": "path", |
| 599 "pattern": "^projects/[^/]+$", |
| 600 "required": true, |
| 601 "type": "string" |
| 602 }, |
| 603 "pageToken": { |
| 604 "description": "The standard list page token
.", |
| 605 "location": "query", |
| 606 "type": "string" |
| 607 } |
| 608 }, |
| 609 "path": "v1beta1/{+name}/operations", |
| 610 "response": { |
| 611 "$ref": "GoogleLongrunning__ListOperationsRespon
se" |
| 612 }, |
| 613 "scopes": [ |
| 614 "https://www.googleapis.com/auth/cloud-platform" |
| 615 ] |
| 616 }, |
| 617 "delete": { |
| 618 "description": "Deletes a long-running operation. Th
is method indicates that the client is\nno longer interested in the operation re
sult. It does not cancel the\noperation. If the server doesn't support this meth
od, it returns\n`google.rpc.Code.UNIMPLEMENTED`.", |
| 619 "httpMethod": "DELETE", |
| 620 "id": "ml.projects.operations.delete", |
| 621 "parameterOrder": [ |
| 622 "name" |
| 623 ], |
| 624 "parameters": { |
| 625 "name": { |
| 626 "description": "The name of the operation re
source to be deleted.", |
| 627 "location": "path", |
| 628 "pattern": "^projects/[^/]+/operations/[^/]+
$", |
| 629 "required": true, |
| 630 "type": "string" |
| 631 } |
| 632 }, |
| 633 "path": "v1beta1/{+name}", |
| 634 "response": { |
| 635 "$ref": "GoogleProtobuf__Empty" |
| 636 }, |
| 637 "scopes": [ |
| 638 "https://www.googleapis.com/auth/cloud-platform" |
| 639 ] |
| 640 }, |
| 641 "cancel": { |
| 642 "description": "Starts asynchronous cancellation on
a long-running operation. The server\nmakes a best effort to cancel the operati
on, but success is not\nguaranteed. If the server doesn't support this method,
it returns\n`google.rpc.Code.UNIMPLEMENTED`. Clients can use\nOperations.GetOpe
ration or\nother methods to check whether the cancellation succeeded or whether
the\noperation completed despite cancellation. On successful cancellation,\nthe
operation is not deleted; instead, it becomes an operation with\nan Operation.er
ror value with a google.rpc.Status.code of 1,\ncorresponding to `Code.CANCELLED`
.", |
| 643 "httpMethod": "POST", |
| 644 "id": "ml.projects.operations.cancel", |
| 645 "parameterOrder": [ |
| 646 "name" |
| 647 ], |
| 648 "parameters": { |
| 649 "name": { |
| 650 "description": "The name of the operation re
source to be cancelled.", |
| 651 "location": "path", |
| 652 "pattern": "^projects/[^/]+/operations/[^/]+
$", |
| 653 "required": true, |
| 654 "type": "string" |
| 655 } |
| 656 }, |
| 657 "path": "v1beta1/{+name}:cancel", |
| 658 "response": { |
| 659 "$ref": "GoogleProtobuf__Empty" |
| 660 }, |
| 661 "scopes": [ |
| 662 "https://www.googleapis.com/auth/cloud-platform" |
| 663 ] |
| 664 } |
| 665 } |
| 666 } |
| 667 } |
| 668 } |
| 669 }, |
| 670 "revision": "20161103", |
| 671 "rootUrl": "https://ml.googleapis.com/", |
| 672 "schemas": { |
| 673 "GoogleCloudMlV1beta1__HyperparameterOutput": { |
| 674 "description": "Represents the result of a single hyperparameter tun
ing trial from a\ntraining job. The TrainingOutput object that is returned on su
ccessful\ncompletion of a training job with hyperparameter tuning includes a lis
t\nof HyperparameterOutput objects, one for each successful trial.", |
| 675 "id": "GoogleCloudMlV1beta1__HyperparameterOutput", |
| 676 "properties": { |
| 677 "finalMetric": { |
| 678 "$ref": "GoogleCloudMlV1beta1_HyperparameterOutput_Hyperpara
meterMetric", |
| 679 "description": "The final objective metric seen for this tri
al." |
| 680 }, |
| 681 "allMetrics": { |
| 682 "description": "All recorded object metrics for this trial."
, |
| 683 "items": { |
| 684 "$ref": "GoogleCloudMlV1beta1_HyperparameterOutput_Hyper
parameterMetric" |
| 685 }, |
| 686 "type": "array" |
| 687 }, |
| 688 "trialId": { |
| 689 "description": "The trial id for these results.", |
| 690 "type": "string" |
| 691 }, |
| 692 "hyperparameters": { |
| 693 "additionalProperties": { |
| 694 "type": "string" |
| 695 }, |
| 696 "description": "The hyperparameters given to this trial.", |
| 697 "type": "object" |
| 698 } |
| 699 }, |
| 700 "type": "object" |
| 701 }, |
| 702 "GoogleCloudMlV1beta1__GetConfigResponse": { |
| 703 "description": "Returns service account information associated with
a project.", |
| 704 "id": "GoogleCloudMlV1beta1__GetConfigResponse", |
| 705 "properties": { |
| 706 "serviceAccount": { |
| 707 "description": "The service account Cloud ML uses to access
resources in the project.", |
| 708 "type": "string" |
| 709 }, |
| 710 "serviceAccountProject": { |
| 711 "description": "The project number for `service_account`.", |
| 712 "format": "int64", |
| 713 "type": "string" |
| 714 } |
| 715 }, |
| 716 "type": "object" |
| 717 }, |
| 718 "GoogleCloudMlV1beta1__ListVersionsResponse": { |
| 719 "description": "Response message for the ListVersions method.", |
| 720 "id": "GoogleCloudMlV1beta1__ListVersionsResponse", |
| 721 "properties": { |
| 722 "nextPageToken": { |
| 723 "description": "Optional. Pass this token as the `page_token
` field of the request for a\nsubsequent call.", |
| 724 "type": "string" |
| 725 }, |
| 726 "versions": { |
| 727 "description": "The list of versions.", |
| 728 "items": { |
| 729 "$ref": "GoogleCloudMlV1beta1__Version" |
| 730 }, |
| 731 "type": "array" |
| 732 } |
| 733 }, |
| 734 "type": "object" |
| 735 }, |
| 736 "GoogleApi__HttpBody": { |
| 737 "description": "Message that represents an arbitrary HTTP body. It s
hould only be used for\npayload formats that can't be represented as JSON, such
as raw binary or\nan HTML page.\n\n\nThis message can be used both in streaming
and non-streaming API methods in\nthe request as well as the response.\n\nIt can
be used as a top-level request field, which is convenient if one\nwants to extr
act parameters from either the URL or HTTP template into the\nrequest fields and
also want access to the raw HTTP body.\n\nExample:\n\n message GetResourceRe
quest {\n // A unique request id.\n string request_id = 1;\n\n //
The raw HTTP body is bound to this field.\n google.api.HttpBody http_body
= 2;\n }\n\n service ResourceService {\n rpc GetResource(GetResourceR
equest) returns (google.api.HttpBody);\n rpc UpdateResource(google.api.Http
Body) returns (google.protobuf.Empty);\n }\n\nExample with streaming methods:
\n\n service CaldavService {\n rpc GetCalendar(stream google.api.HttpBod
y)\n returns (stream google.api.HttpBody);\n rpc UpdateCalendar(stre
am google.api.HttpBody)\n returns (stream google.api.HttpBody);\n }\n\
nUse of this type only changes how the request and response bodies are\nhandled,
all other features will continue to work unchanged.", |
| 738 "id": "GoogleApi__HttpBody", |
| 739 "properties": { |
| 740 "data": { |
| 741 "description": "HTTP body binary data.", |
| 742 "format": "byte", |
| 743 "type": "string" |
| 744 }, |
| 745 "contentType": { |
| 746 "description": "The HTTP Content-Type string representing th
e content type of the body.", |
| 747 "type": "string" |
| 748 } |
| 749 }, |
| 750 "type": "object" |
| 751 }, |
| 752 "GoogleCloudMlV1beta1__Job": { |
| 753 "description": "Represents a training or prediction job.", |
| 754 "id": "GoogleCloudMlV1beta1__Job", |
| 755 "properties": { |
| 756 "predictionInput": { |
| 757 "$ref": "GoogleCloudMlV1beta1__PredictionInput", |
| 758 "description": "Input parameters to create a prediction job.
" |
| 759 }, |
| 760 "state": { |
| 761 "description": "Output only. The detailed state of a job.", |
| 762 "enum": [ |
| 763 "STATE_UNSPECIFIED", |
| 764 "QUEUED", |
| 765 "PREPARING", |
| 766 "RUNNING", |
| 767 "SUCCEEDED", |
| 768 "FAILED", |
| 769 "CANCELLING", |
| 770 "CANCELLED" |
| 771 ], |
| 772 "enumDescriptions": [ |
| 773 "The job state is unspecified.", |
| 774 "The job has been just created and processing has not ye
t begun.", |
| 775 "The service is preparing to run the job.", |
| 776 "The job is in progress.", |
| 777 "The job completed successfully.", |
| 778 "The job failed.\n`error_message` should contain the det
ails of the failure.", |
| 779 "The job is being cancelled.\n`error_message` should des
cribe the reason for the cancellation.", |
| 780 "The job has been cancelled.\n`error_message` should des
cribe the reason for the cancellation." |
| 781 ], |
| 782 "type": "string" |
| 783 }, |
| 784 "endTime": { |
| 785 "description": "Output only. When the job processing was com
pleted.", |
| 786 "format": "google-datetime", |
| 787 "type": "string" |
| 788 }, |
| 789 "createTime": { |
| 790 "description": "Output only. When the job was created.", |
| 791 "format": "google-datetime", |
| 792 "type": "string" |
| 793 }, |
| 794 "errorMessage": { |
| 795 "description": "Output only. The details of a failure or a c
ancellation.", |
| 796 "type": "string" |
| 797 }, |
| 798 "trainingOutput": { |
| 799 "$ref": "GoogleCloudMlV1beta1__TrainingOutput", |
| 800 "description": "The current training job result." |
| 801 }, |
| 802 "startTime": { |
| 803 "description": "Output only. When the job processing was sta
rted.", |
| 804 "format": "google-datetime", |
| 805 "type": "string" |
| 806 }, |
| 807 "trainingInput": { |
| 808 "$ref": "GoogleCloudMlV1beta1__TrainingInput", |
| 809 "description": "Input parameters to create a training job." |
| 810 }, |
| 811 "jobId": { |
| 812 "description": "Required. The user-specified id of the job."
, |
| 813 "type": "string" |
| 814 }, |
| 815 "predictionOutput": { |
| 816 "$ref": "GoogleCloudMlV1beta1__PredictionOutput", |
| 817 "description": "The current prediction job result." |
| 818 } |
| 819 }, |
| 820 "type": "object" |
| 821 }, |
| 822 "GoogleCloudMlV1beta1_HyperparameterOutput_HyperparameterMetric": { |
| 823 "description": "An observed value of a metric.", |
| 824 "id": "GoogleCloudMlV1beta1_HyperparameterOutput_HyperparameterMetri
c", |
| 825 "properties": { |
| 826 "objectiveValue": { |
| 827 "description": "The objective value at this training step.", |
| 828 "format": "double", |
| 829 "type": "number" |
| 830 }, |
| 831 "trainingStep": { |
| 832 "description": "The global training step for this metric.", |
| 833 "format": "int64", |
| 834 "type": "string" |
| 835 } |
| 836 }, |
| 837 "type": "object" |
| 838 }, |
| 839 "GoogleLongrunning__Operation": { |
| 840 "description": "This resource represents a long-running operation th
at is the result of a\nnetwork API call.", |
| 841 "id": "GoogleLongrunning__Operation", |
| 842 "properties": { |
| 843 "error": { |
| 844 "$ref": "GoogleRpc__Status", |
| 845 "description": "The error result of the operation in case of
failure or cancellation." |
| 846 }, |
| 847 "done": { |
| 848 "description": "If the value is `false`, it means the operat
ion is still in progress.\nIf true, the operation is completed, and either `erro
r` or `response` is\navailable.", |
| 849 "type": "boolean" |
| 850 }, |
| 851 "metadata": { |
| 852 "additionalProperties": { |
| 853 "description": "Properties of the object. Contains field
@type with type URL.", |
| 854 "type": "any" |
| 855 }, |
| 856 "description": "Service-specific metadata associated with th
e operation. It typically\ncontains progress information and common metadata su
ch as create time.\nSome services might not provide such metadata. Any method t
hat returns a\nlong-running operation should document the metadata type, if any.
", |
| 857 "type": "object" |
| 858 }, |
| 859 "response": { |
| 860 "additionalProperties": { |
| 861 "description": "Properties of the object. Contains field
@type with type URL.", |
| 862 "type": "any" |
| 863 }, |
| 864 "description": "The normal response of the operation in case
of success. If the original\nmethod returns no data on success, such as `Delet
e`, the response is\n`google.protobuf.Empty`. If the original method is standar
d\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmet
hods, the response should have the type `XxxResponse`, where `Xxx`\nis the origi
nal method name. For example, if the original method name\nis `TakeSnapshot()`,
the inferred response type is\n`TakeSnapshotResponse`.", |
| 865 "type": "object" |
| 866 }, |
| 867 "name": { |
| 868 "description": "The server-assigned name, which is only uniq
ue within the same service that\noriginally returns it. If you use the default H
TTP mapping, the\n`name` should have the format of `operations/some/unique/name`
.", |
| 869 "type": "string" |
| 870 } |
| 871 }, |
| 872 "type": "object" |
| 873 }, |
| 874 "GoogleCloudMlV1beta1__PredictRequest": { |
| 875 "description": "Request for predictions to be issued against a train
ed model.\n\nThe body of the request is a single JSON object with a single top-l
evel\nfield:\n\n<dl>\n <dt>instances</dt>\n <dd>A JSON array containing values
representing the instances to use for\n prediction.</dd>\n</dl>\n\nThe str
ucture of each element of the instances list is determined by your\nmodel's inpu
t definition. Instances can include named inputs or can contain\nonly unlabeled
values.\n\nMost data does not include named inputs. Some instances will be simpl
e\nJSON values (boolean, number, or string). However, instances are often lists\
nof simple values, or complex nested lists. Here are some examples of request\nb
odies:\n\nCSV data with each row encoded as a string value:\n<pre>\n{\"instances
\": [\"1.0,true,\\\\\"x\\\\\"\", \"-2.0,false,\\\\\"y\\\\\"\"]}\n</pre>\nPlain t
ext:\n<pre>\n{\"instances\": [\"the quick brown fox\", \"la bruja le dio\"]}\n</
pre>\nSentences encoded as lists of words (vectors of strings):\n<pre>\n{\"insta
nces\": [[\"the\",\"quick\",\"brown\"], [\"la\",\"bruja\",\"le\"]]}\n</pre>\nFlo
ating point scalar values:\n<pre>\n{\"instances\": [0.0, 1.1, 2.2]}\n</pre>\nVec
tors of integers:\n<pre>\n{\"instances\": [[0, 1, 2], [3, 4, 5],...]}\n</pre>\nT
ensors (in this case, two-dimensional tensors):\n<pre>\n{\"instances\": [[[0, 1,
2], [3, 4, 5]], ...]}\n</pre>\nImages represented as a three-dimensional list.
In this encoding scheme the\nfirst two dimensions represent the rows and columns
of the image, and the\nthird contains the R, G, and B values for each pixel.\n<
pre>\n{\"instances\": [[[[138, 30, 66], [130, 20, 56], ...]]]]}\n</pre>\nData mu
st be encoded as UTF-8. If your data uses another character encoding,\nyou must
base64 encode the data and mark it as binary. To mark a JSON string\nas binary,
replace it with an object with a single attribute named `b`:\n<pre>{\"b\": \"...
\"} </pre>\nFor example:\n\nTwo Serialized tf.Examples (fake data, for illustrat
ive purposes only):\n<pre>\n{\"instances\": [{\"b64\": \"X5ad6u\"}, {\"b64\": \"
IA9j4nx\"}]}\n</pre>\nTwo JPEG image byte strings (fake data, for illustrative p
urposes only):\n<pre>\n{\"instances\": [{\"b64\": \"ASa8asdf\"}, {\"b64\": \"JLK
7ljk3\"}]}\n</pre>\nIf your data includes named references, format each instance
as a JSON object\nwith the named references as the keys:\n\nJSON input data to
be preprocessed:\n<pre>\n{\"instances\": [{\"a\": 1.0, \"b\": true, \"c\": \"x
\"},\n {\"a\": -2.0, \"b\": false, \"c\": \"y\"}]}\n</pre>\nSome m
odels have an underlying TensorFlow graph that accepts multiple input\ntensors.
In this case, you should use the names of JSON name/value pairs to\nidentify the
input tensors, as shown in the following exmaples:\n\nFor a graph with input te
nsor aliases \"tag\" (string) and \"image\"\n(base64-encoded string):\n<pre>\n{\
"instances\": [{\"tag\": \"beach\", \"image\": {\"b64\": \"ASa8asdf\"}},\n
{\"tag\": \"car\", \"image\": {\"b64\": \"JLK7ljk3\"}}]}\n</pre>\nFor a
graph with input tensor aliases \"tag\" (string) and \"image\"\n(3-dimensional
array of 8-bit ints):\n<pre>\n{\"instances\": [{\"tag\": \"beach\", \"image\": [
[[263, 1, 10], [262, 2, 11], ...]]},\n {\"tag\": \"car\", \"image\
": [[[10, 11, 24], [23, 10, 15], ...]]}]}\n</pre>\nIf the call is successful, th
e response body will contain one prediction\nentry per instance in the request b
ody. If prediction fails for any\ninstance, the response body will contain no pr
edictions and will contian\na single error entry instead.", |
| 876 "id": "GoogleCloudMlV1beta1__PredictRequest", |
| 877 "properties": { |
| 878 "httpBody": { |
| 879 "$ref": "GoogleApi__HttpBody", |
| 880 "description": "\nRequired. The prediction request body." |
| 881 } |
| 882 }, |
| 883 "type": "object" |
| 884 }, |
| 885 "GoogleRpc__Status": { |
| 886 "description": "The `Status` type defines a logical error model that
is suitable for different\nprogramming environments, including REST APIs and RP
C APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is desig
ned to be:\n\n- Simple to use and understand for most users\n- Flexible enough t
o meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pie
ces of data: error code, error message,\nand error details. The error code shoul
d be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes
if needed. The\nerror message should be a developer-facing English message tha
t helps\ndevelopers *understand* and *resolve* the error. If a localized user-fa
cing\nerror message is needed, put the localized message in the error details or
\nlocalize it in the client. The optional error details may contain arbitrary\ni
nformation about the error. There is a predefined set of error detail types\nin
the package `google.rpc` which can be used for common error conditions.\n\n# Lan
guage mapping\n\nThe `Status` message is the logical representation of the error
model, but it\nis not necessarily the actual wire format. When the `Status` mes
sage is\nexposed in different client libraries and different wire protocols, it
can be\nmapped differently. For example, it will likely be mapped to some except
ions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\
n\nThe error model and the `Status` message can be used in a variety of\nenviron
ments, either with or without APIs, to provide a\nconsistent developer experienc
e across different environments.\n\nExample uses of this error model include:\n\
n- Partial errors. If a service needs to return partial errors to the client,\n
it may embed the `Status` in the normal response to indicate the partial\n
errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step
may\n have a `Status` message for error reporting purpose.\n\n- Batch operati
ons. If a client uses batch request and batch response, the\n `Status` messag
e should be used directly inside batch response, one for\n each error sub-res
ponse.\n\n- Asynchronous operations. If an API call embeds asynchronous operatio
n\n results in its response, the status of those operations should be\n re
presented directly using the `Status` message.\n\n- Logging. If some API errors
are stored in logs, the message `Status` could\n be used directly after any s
tripping needed for security/privacy reasons.", |
| 887 "id": "GoogleRpc__Status", |
| 888 "properties": { |
| 889 "code": { |
| 890 "description": "The status code, which should be an enum val
ue of google.rpc.Code.", |
| 891 "format": "int32", |
| 892 "type": "integer" |
| 893 }, |
| 894 "details": { |
| 895 "description": "A list of messages that carry the error deta
ils. There will be a\ncommon set of message types for APIs to use.", |
| 896 "items": { |
| 897 "additionalProperties": { |
| 898 "description": "Properties of the object. Contains f
ield @type with type URL.", |
| 899 "type": "any" |
| 900 }, |
| 901 "type": "object" |
| 902 }, |
| 903 "type": "array" |
| 904 }, |
| 905 "message": { |
| 906 "description": "A developer-facing error message, which shou
ld be in English. Any\nuser-facing error message should be localized and sent in
the\ngoogle.rpc.Status.details field, or localized by the client.", |
| 907 "type": "string" |
| 908 } |
| 909 }, |
| 910 "type": "object" |
| 911 }, |
| 912 "GoogleCloudMlV1beta1__CancelJobRequest": { |
| 913 "description": "Request message for the CancelJob method.", |
| 914 "id": "GoogleCloudMlV1beta1__CancelJobRequest", |
| 915 "properties": {}, |
| 916 "type": "object" |
| 917 }, |
| 918 "GoogleCloudMlV1beta1__TrainingOutput": { |
| 919 "description": "Represents results of a training job.", |
| 920 "id": "GoogleCloudMlV1beta1__TrainingOutput", |
| 921 "properties": { |
| 922 "completedTrialCount": { |
| 923 "description": "The number of hyperparameter tuning trials t
hat completed successfully.", |
| 924 "format": "int64", |
| 925 "type": "string" |
| 926 }, |
| 927 "trials": { |
| 928 "description": "Results for individual Hyperparameter trials
.", |
| 929 "items": { |
| 930 "$ref": "GoogleCloudMlV1beta1__HyperparameterOutput" |
| 931 }, |
| 932 "type": "array" |
| 933 } |
| 934 }, |
| 935 "type": "object" |
| 936 }, |
| 937 "GoogleLongrunning__ListOperationsResponse": { |
| 938 "description": "The response message for Operations.ListOperations."
, |
| 939 "id": "GoogleLongrunning__ListOperationsResponse", |
| 940 "properties": { |
| 941 "nextPageToken": { |
| 942 "description": "The standard List next-page token.", |
| 943 "type": "string" |
| 944 }, |
| 945 "operations": { |
| 946 "description": "A list of operations that matches the specif
ied filter in the request.", |
| 947 "items": { |
| 948 "$ref": "GoogleLongrunning__Operation" |
| 949 }, |
| 950 "type": "array" |
| 951 } |
| 952 }, |
| 953 "type": "object" |
| 954 }, |
| 955 "GoogleCloudMlV1beta1__PredictionOutput": { |
| 956 "description": "Represents results of a prediction job.", |
| 957 "id": "GoogleCloudMlV1beta1__PredictionOutput", |
| 958 "properties": { |
| 959 "errorCount": { |
| 960 "description": "The number of data instances which resulted
in errors.", |
| 961 "format": "int64", |
| 962 "type": "string" |
| 963 }, |
| 964 "predictionCount": { |
| 965 "description": "The number of generated predictions.", |
| 966 "format": "int64", |
| 967 "type": "string" |
| 968 }, |
| 969 "outputPath": { |
| 970 "description": "The output Google Cloud Storage location pro
vided at the job creation time.", |
| 971 "type": "string" |
| 972 } |
| 973 }, |
| 974 "type": "object" |
| 975 }, |
| 976 "GoogleCloudMlV1beta1__HyperparameterSpec": { |
| 977 "description": "Represents a set of hyperparameters to optimize.", |
| 978 "id": "GoogleCloudMlV1beta1__HyperparameterSpec", |
| 979 "properties": { |
| 980 "maxParallelTrials": { |
| 981 "description": "Optional. The number of training trials to r
un concurrently.\nYou can reduce the time it takes to perform hyperparameter tun
ing by adding\ntrials in parallel. However, each trail only benefits from the in
formation\ngained in completed trials. That means that a trial does not get acce
ss to\nthe results of trials running at the same time, which could reduce the\nq
uality of the overall optimization.\n\nEach trial will use the same scale tier a
nd machine types.\n\nDefaults to one.", |
| 982 "format": "int32", |
| 983 "type": "integer" |
| 984 }, |
| 985 "maxTrials": { |
| 986 "description": "Optional. How many training trials should be
attempted to optimize\nthe specified hyperparameters.\n\nDefaults to one.", |
| 987 "format": "int32", |
| 988 "type": "integer" |
| 989 }, |
| 990 "goal": { |
| 991 "description": "Required. The type of goal to use for tuning
. Available types are\n`MAXIMIZE` and `MINIMIZE`.\n\nDefaults to `MAXIMIZE`.", |
| 992 "enum": [ |
| 993 "GOAL_TYPE_UNSPECIFIED", |
| 994 "MAXIMIZE", |
| 995 "MINIMIZE" |
| 996 ], |
| 997 "enumDescriptions": [ |
| 998 "Goal Type will default to maximize.", |
| 999 "Maximize the goal metric.", |
| 1000 "Minimize the goal metric." |
| 1001 ], |
| 1002 "type": "string" |
| 1003 }, |
| 1004 "params": { |
| 1005 "description": "Required. The set of parameters to tune.", |
| 1006 "items": { |
| 1007 "$ref": "GoogleCloudMlV1beta1__ParameterSpec" |
| 1008 }, |
| 1009 "type": "array" |
| 1010 } |
| 1011 }, |
| 1012 "type": "object" |
| 1013 }, |
| 1014 "GoogleProtobuf__Empty": { |
| 1015 "description": "A generic empty message that you can re-use to avoid
defining duplicated\nempty messages in your APIs. A typical example is to use i
t as the request\nor the response type of an API method. For instance:\n\n se
rvice Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty
);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.", |
| 1016 "id": "GoogleProtobuf__Empty", |
| 1017 "properties": {}, |
| 1018 "type": "object" |
| 1019 }, |
| 1020 "GoogleCloudMlV1beta1__PredictionInput": { |
| 1021 "description": "Represents input parameters for a prediction job.", |
| 1022 "id": "GoogleCloudMlV1beta1__PredictionInput", |
| 1023 "properties": { |
| 1024 "modelName": { |
| 1025 "description": "Use this field if you want to use the defaul
t version for the specified\nmodel. The string must use the following format:\n\
n`\"projects/<var>[YOUR_PROJECT]</var>/models/<var>[YOUR_MODEL]</var>\"`", |
| 1026 "type": "string" |
| 1027 }, |
| 1028 "outputPath": { |
| 1029 "description": "Required. The output Google Cloud Storage lo
cation.", |
| 1030 "type": "string" |
| 1031 }, |
| 1032 "inputPaths": { |
| 1033 "description": "Required. The Google Cloud Storage location
of the input data files.\nMay contain wildcards.", |
| 1034 "items": { |
| 1035 "type": "string" |
| 1036 }, |
| 1037 "type": "array" |
| 1038 }, |
| 1039 "dataFormat": { |
| 1040 "description": "Required. The format of the input data files
.", |
| 1041 "enum": [ |
| 1042 "DATA_FORMAT_UNSPECIFIED", |
| 1043 "TEXT", |
| 1044 "TF_RECORD", |
| 1045 "TF_RECORD_GZIP" |
| 1046 ], |
| 1047 "enumDescriptions": [ |
| 1048 "Unspecified format.", |
| 1049 "The source file is a text file with instances separated
by the\nnew-line character.", |
| 1050 "The source file is a TFRecord file.", |
| 1051 "The source file is a GZIP-compressed TFRecord file." |
| 1052 ], |
| 1053 "type": "string" |
| 1054 }, |
| 1055 "maxWorkerCount": { |
| 1056 "description": "Optional. The maximum number of workers to b
e used for parallel processing.\nDefaults to 10 if not specified.", |
| 1057 "format": "int64", |
| 1058 "type": "string" |
| 1059 }, |
| 1060 "versionName": { |
| 1061 "description": "Use this field if you want to specify a vers
ion of the model to use. The\nstring is formatted the same way as `model_version
`, with the addition\nof the version information:\n\n`\"projects/<var>[YOUR_PROJ
ECT]</var>/models/<var>YOUR_MODEL/versions/<var>[YOUR_VERSION]</var>\"`", |
| 1062 "type": "string" |
| 1063 }, |
| 1064 "region": { |
| 1065 "description": "Required. The Google Compute Engine region t
o run the prediction job in.", |
| 1066 "type": "string" |
| 1067 } |
| 1068 }, |
| 1069 "type": "object" |
| 1070 }, |
| 1071 "GoogleCloudMlV1beta1__ListJobsResponse": { |
| 1072 "description": "Response message for the ListJobs method.", |
| 1073 "id": "GoogleCloudMlV1beta1__ListJobsResponse", |
| 1074 "properties": { |
| 1075 "nextPageToken": { |
| 1076 "description": "Optional. Pass this token as the `page_token
` field of the request for a\nsubsequent call.", |
| 1077 "type": "string" |
| 1078 }, |
| 1079 "jobs": { |
| 1080 "description": "The list of jobs.", |
| 1081 "items": { |
| 1082 "$ref": "GoogleCloudMlV1beta1__Job" |
| 1083 }, |
| 1084 "type": "array" |
| 1085 } |
| 1086 }, |
| 1087 "type": "object" |
| 1088 }, |
| 1089 "GoogleCloudMlV1beta1__SetDefaultVersionRequest": { |
| 1090 "description": "Request message for the SetDefaultVersion request.", |
| 1091 "id": "GoogleCloudMlV1beta1__SetDefaultVersionRequest", |
| 1092 "properties": {}, |
| 1093 "type": "object" |
| 1094 }, |
| 1095 "GoogleCloudMlV1beta1__TrainingInput": { |
| 1096 "description": "Represents input parameters for a training job.", |
| 1097 "id": "GoogleCloudMlV1beta1__TrainingInput", |
| 1098 "properties": { |
| 1099 "args": { |
| 1100 "description": "Optional. Command line arguments to pass to
the program.", |
| 1101 "items": { |
| 1102 "type": "string" |
| 1103 }, |
| 1104 "type": "array" |
| 1105 }, |
| 1106 "workerType": { |
| 1107 "description": "Optional. Specifies the type of virtual mach
ine to use for your training\njob's worker nodes.\n\nThe supported values are th
e same as those described in the entry for\n`masterType`.\n\nThis value must be
present when `scaleTier` is set to `CUSTOM` and\n`workerCount` is greater than z
ero.", |
| 1108 "type": "string" |
| 1109 }, |
| 1110 "workerCount": { |
| 1111 "description": "Optional. The number of worker replicas to u
se for the training job. Each\nreplica in the cluster will be of the type specif
ied in `worker_type`.\n\nThis value can only be used when `scale_tier` is set to
`CUSTOM`. If you\nset this value, you must also set `worker_type`.", |
| 1112 "format": "int64", |
| 1113 "type": "string" |
| 1114 }, |
| 1115 "packageUris": { |
| 1116 "description": "Required. The Google Cloud Storage location
of the packages with\nthe training program and any additional dependencies.", |
| 1117 "items": { |
| 1118 "type": "string" |
| 1119 }, |
| 1120 "type": "array" |
| 1121 }, |
| 1122 "hyperparameters": { |
| 1123 "$ref": "GoogleCloudMlV1beta1__HyperparameterSpec", |
| 1124 "description": "Optional. The set of Hyperparameters to tune
." |
| 1125 }, |
| 1126 "masterType": { |
| 1127 "description": "Optional. Specifies the type of virtual mach
ine to use for your training\njob's master worker.\n\nThe following types are su
pported:\n\n<dl>\n <dt>standard</dt>\n <dd>\n A basic machine configuration s
uitable for training simple models with\n small to moderate datasets.\n </dd>\
n <dt>large_model</dt>\n <dd>\n A machine with a lot of memory, specially sui
ted for parameter servers\n when your model is large (having many hidden layers
or layers with very\n large numbers of nodes).\n </dd>\n <dt>complex_model_s
</dt>\n <dd>\n A machine suitable for the master and workers of the cluster wh
en your\n model requires more computation than the standard machine can handle\
n satisfactorily.\n </dd>\n <dt>complex_model_m</dt>\n <dd>\n A machine wit
h roughly twice the number of cores and roughly double the\n memory of <code su
ppresswarning=\"true\">complex_model_s</code>.\n </dd>\n <dt>complex_model_l</
dt>\n <dd>\n A machine with roughly twice the number of cores and roughly doub
le the\n memory of <code suppresswarning=\"true\">complex_model_m</code>.\n </
dd>\n</dl>\n\nYou must set this value when `scaleTier` is set to `CUSTOM`.", |
| 1128 "type": "string" |
| 1129 }, |
| 1130 "parameterServerCount": { |
| 1131 "description": "Optional. The number of parameter server rep
licas to use for the training\njob. Each replica in the cluster will be of the t
ype specified in\n`parameter_server_type`.\n\nThis value can only be used when `
scale_tier` is set to `CUSTOM`.If you\nset this value, you must also set `parame
ter_server_type`.", |
| 1132 "format": "int64", |
| 1133 "type": "string" |
| 1134 }, |
| 1135 "region": { |
| 1136 "description": "Required. The Google Compute Engine region t
o run the training job in.", |
| 1137 "type": "string" |
| 1138 }, |
| 1139 "parameterServerType": { |
| 1140 "description": "Optional. Specifies the type of virtual mach
ine to use for your training\njob's parameter server.\n\nThe supported values ar
e the same as those described in the entry for\n`master_type`.\n\nThis value mus
t be present when `scaleTier` is set to `CUSTOM` and\n`parameter_server_count` i
s greater than zero.", |
| 1141 "type": "string" |
| 1142 }, |
| 1143 "scaleTier": { |
| 1144 "description": "Required. Specifies the machine types, the n
umber of replicas for workers\nand parameter servers.", |
| 1145 "enum": [ |
| 1146 "BASIC", |
| 1147 "STANDARD_1", |
| 1148 "PREMIUM_1", |
| 1149 "CUSTOM" |
| 1150 ], |
| 1151 "enumDescriptions": [ |
| 1152 "A single worker instance. This tier is suitable for lea
rning how to use\nCloud ML, and for experimenting with new models using small da
tasets.", |
| 1153 "Many workers and a few parameter servers.", |
| 1154 "A large number of workers with many parameter servers."
, |
| 1155 "The CUSTOM tier is not a set tier, but rather enables y
ou to use your\nown cluster specification. When you use this tier, set values to
\nconfigure your processing cluster according to these guidelines:\n\n* You _m
ust_ set `TrainingInput.masterType` to specify the type\n of machine to use f
or your master node. This is the only required\n setting.\n\n* You _may_ se
t `TrainingInput.workerCount` to specify the number of\n workers to use. If y
ou specify one or more workers, you _must_ also\n set `TrainingInput.workerTy
pe` to specify the type of machine to use\n for your worker nodes.\n\n* You
_may_ set `TrainingInput.parameterServerCount` to specify the\n number of pa
rameter servers to use. If you specify one or more\n parameter servers, you _
must_ also set\n `TrainingInput.parameterServerType` to specify the type of m
achine to\n use for your parameter servers.\n\nNote that all of your workers
must use the same machine type, which can\nbe different from your parameter serv
er type and master type. Your\nparameter servers must likewise use the same mach
ine type, which can be\ndifferent from your worker type and master type." |
| 1156 ], |
| 1157 "type": "string" |
| 1158 }, |
| 1159 "pythonModule": { |
| 1160 "description": "Required. The Python module name to run afte
r installing the packages.", |
| 1161 "type": "string" |
| 1162 } |
| 1163 }, |
| 1164 "type": "object" |
| 1165 }, |
| 1166 "GoogleCloudMlV1beta1__Version": { |
| 1167 "description": "Represents a version of the model.\n\nEach version i
s a trained model deployed in the cloud, ready to handle\nprediction requests. A
model can have multiple versions. You can get\ninformation about all of the ver
sions of a given model by calling\n[projects.models.versions.list](/ml/reference
/rest/v1beta1/projects.models.versions/list).", |
| 1168 "id": "GoogleCloudMlV1beta1__Version", |
| 1169 "properties": { |
| 1170 "description": { |
| 1171 "description": "Optional. The description specified for the
version when it was created.", |
| 1172 "type": "string" |
| 1173 }, |
| 1174 "deploymentUri": { |
| 1175 "description": "Required. The Google Cloud Storage location
of the trained model used to\ncreate the version. See the\n[overview of model de
ployment](/ml/docs/concepts/deployment-overview) for\nmore informaiton.\n\nWhen
passing Version to\n[projects.models.versions.create](/ml/reference/rest/v1beta1
/projects.models.versions/create)\nthe model service uses the specified location
as the source of the model.\nOnce deployed, the model version is hosted by the
prediction service, so\nthis location is useful only as a historical record.", |
| 1176 "type": "string" |
| 1177 }, |
| 1178 "createTime": { |
| 1179 "description": "Output only. The time the version was create
d.", |
| 1180 "format": "google-datetime", |
| 1181 "type": "string" |
| 1182 }, |
| 1183 "lastUseTime": { |
| 1184 "description": "Output only. The time the version was last u
sed for prediction.", |
| 1185 "format": "google-datetime", |
| 1186 "type": "string" |
| 1187 }, |
| 1188 "name": { |
| 1189 "description": "Required.The name specified for the version
when it was created.\n\nThe version name must be unique within the model it is c
reated in.", |
| 1190 "type": "string" |
| 1191 }, |
| 1192 "isDefault": { |
| 1193 "description": "Output only. If true, this version will be u
sed to handle prediction\nrequests that do not specify a version.\n\nYou can cha
nge the default version by calling\n[projects.methods.versions.setDefault](/ml/r
eference/rest/v1beta1/projects.models.versions/setDefault).", |
| 1194 "type": "boolean" |
| 1195 } |
| 1196 }, |
| 1197 "type": "object" |
| 1198 }, |
| 1199 "GoogleCloudMlV1beta1__ListModelsResponse": { |
| 1200 "description": "Response message for the ListModels method.", |
| 1201 "id": "GoogleCloudMlV1beta1__ListModelsResponse", |
| 1202 "properties": { |
| 1203 "models": { |
| 1204 "description": "The list of models.", |
| 1205 "items": { |
| 1206 "$ref": "GoogleCloudMlV1beta1__Model" |
| 1207 }, |
| 1208 "type": "array" |
| 1209 }, |
| 1210 "nextPageToken": { |
| 1211 "description": "Optional. Pass this token as the `page_token
` field of the request for a\nsubsequent call.", |
| 1212 "type": "string" |
| 1213 } |
| 1214 }, |
| 1215 "type": "object" |
| 1216 }, |
| 1217 "GoogleCloudMlV1beta1__OperationMetadata": { |
| 1218 "description": "Represents the metadata of the long-running operatio
n.", |
| 1219 "id": "GoogleCloudMlV1beta1__OperationMetadata", |
| 1220 "properties": { |
| 1221 "modelName": { |
| 1222 "description": "Contains the name of the model associated wi
th the operation.", |
| 1223 "type": "string" |
| 1224 }, |
| 1225 "isCancellationRequested": { |
| 1226 "description": "Indicates whether a request to cancel this o
peration has been made.", |
| 1227 "type": "boolean" |
| 1228 }, |
| 1229 "endTime": { |
| 1230 "description": "The time operation processing completed.", |
| 1231 "format": "google-datetime", |
| 1232 "type": "string" |
| 1233 }, |
| 1234 "createTime": { |
| 1235 "description": "The time the operation was submitted.", |
| 1236 "format": "google-datetime", |
| 1237 "type": "string" |
| 1238 }, |
| 1239 "startTime": { |
| 1240 "description": "The time operation processing started.", |
| 1241 "format": "google-datetime", |
| 1242 "type": "string" |
| 1243 }, |
| 1244 "version": { |
| 1245 "$ref": "GoogleCloudMlV1beta1__Version", |
| 1246 "description": "Contains the version associated with the ope
ration." |
| 1247 }, |
| 1248 "operationType": { |
| 1249 "description": "The operation type.", |
| 1250 "enum": [ |
| 1251 "OPERATION_TYPE_UNSPECIFIED", |
| 1252 "CREATE_VERSION", |
| 1253 "DELETE_VERSION", |
| 1254 "DELETE_MODEL" |
| 1255 ], |
| 1256 "enumDescriptions": [ |
| 1257 "Unspecified operation type.", |
| 1258 "An operation to create a new version.", |
| 1259 "An operation to delete an existing version.", |
| 1260 "An operation to delete an existing model." |
| 1261 ], |
| 1262 "type": "string" |
| 1263 } |
| 1264 }, |
| 1265 "type": "object" |
| 1266 }, |
| 1267 "GoogleCloudMlV1beta1__ParameterSpec": { |
| 1268 "description": "Represents a single hyperparameter to optimize.", |
| 1269 "id": "GoogleCloudMlV1beta1__ParameterSpec", |
| 1270 "properties": { |
| 1271 "parameterName": { |
| 1272 "description": "Required. The parameter name must be unique
amongst all ParameterConfigs in\na HyperparameterSpec message. E.g., \"learning_
rate\".", |
| 1273 "type": "string" |
| 1274 }, |
| 1275 "maxValue": { |
| 1276 "description": "Required if typeis `DOUBLE` or `INTEGER`. Th
is field\nshould be unset if type is `CATEGORICAL`. This value should be integer
s if\ntype is `INTEGER`.", |
| 1277 "format": "double", |
| 1278 "type": "number" |
| 1279 }, |
| 1280 "categoricalValues": { |
| 1281 "description": "Required if type is `CATEGORICAL`. The list
of possible categories.", |
| 1282 "items": { |
| 1283 "type": "string" |
| 1284 }, |
| 1285 "type": "array" |
| 1286 }, |
| 1287 "minValue": { |
| 1288 "description": "Required if type is `DOUBLE` or `INTEGER`. T
his field\nshould be unset if type is `CATEGORICAL`. This value should be intege
rs if\ntype is INTEGER.", |
| 1289 "format": "double", |
| 1290 "type": "number" |
| 1291 }, |
| 1292 "scaleType": { |
| 1293 "description": "Optional. How the parameter should be scaled
to the hypercube.\nLeave unset for categorical parameters.\nSome kind of scalin
g is strongly recommended for real or integral\nparameters (e.g., `UNIT_LINEAR_S
CALE`).", |
| 1294 "enum": [ |
| 1295 "NONE", |
| 1296 "UNIT_LINEAR_SCALE", |
| 1297 "UNIT_LOG_SCALE", |
| 1298 "UNIT_REVERSE_LOG_SCALE" |
| 1299 ], |
| 1300 "enumDescriptions": [ |
| 1301 "By default, no scaling is applied.", |
| 1302 "Scales the feasible space to (0, 1) linearly.", |
| 1303 "Scales the feasible space logarithmically to (0, 1). Th
e entire feasible\nspace must be strictly positive.", |
| 1304 "Scales the feasible space \"reverse\" logarithmically t
o (0, 1). The result\nis that values close to the top of the feasible space are
spread out more\nthan points near the bottom. The entire feasible space must be
strictly\npositive." |
| 1305 ], |
| 1306 "type": "string" |
| 1307 }, |
| 1308 "discreteValues": { |
| 1309 "description": "Required if type is `DISCRETE`.\nA list of f
easible points.\nThe list should be in strictly increasing order. For instance,
this\nparameter might have possible settings of 1.5, 2.5, and 4.0. This list\nsh
ould not contain more than 1,000 values.", |
| 1310 "items": { |
| 1311 "format": "double", |
| 1312 "type": "number" |
| 1313 }, |
| 1314 "type": "array" |
| 1315 }, |
| 1316 "type": { |
| 1317 "description": "Required. The type of the parameter.", |
| 1318 "enum": [ |
| 1319 "PARAMETER_TYPE_UNSPECIFIED", |
| 1320 "DOUBLE", |
| 1321 "INTEGER", |
| 1322 "CATEGORICAL", |
| 1323 "DISCRETE" |
| 1324 ], |
| 1325 "enumDescriptions": [ |
| 1326 "You must specify a valid type. Using this unspecified t
ype will result in\nan error.", |
| 1327 "Type for real-valued parameters.", |
| 1328 "Type for integral parameters.", |
| 1329 "The parameter is categorical, with a value chosen from
the categories\nfield.", |
| 1330 "The parameter is real valued, with a fixed set of feasi
ble points. If\n`type==DISCRETE`, feasible_points must be provided, and\n{`min_v
alue`, `max_value`} will be ignored." |
| 1331 ], |
| 1332 "type": "string" |
| 1333 } |
| 1334 }, |
| 1335 "type": "object" |
| 1336 }, |
| 1337 "GoogleCloudMlV1beta1__Model": { |
| 1338 "description": "Represents a machine learning solution.\n\nA model c
an have multiple versions, each of which is a deployed, trained\nmodel ready to
receive prediction requests. The model itself is just a\ncontainer.", |
| 1339 "id": "GoogleCloudMlV1beta1__Model", |
| 1340 "properties": { |
| 1341 "description": { |
| 1342 "description": "Optional. The description specified for the
model when it was created.", |
| 1343 "type": "string" |
| 1344 }, |
| 1345 "defaultVersion": { |
| 1346 "$ref": "GoogleCloudMlV1beta1__Version", |
| 1347 "description": "Output only. The default version of the mode
l. This version will be used to\nhandle prediction requests that do not specify
a version.\n\nYou can change the default version by calling\n[projects.methods.v
ersions.setDefault](/ml/reference/rest/v1beta1/projects.models.versions/setDefau
lt)." |
| 1348 }, |
| 1349 "name": { |
| 1350 "description": "Required. The name specified for the model w
hen it was created.\n\nThe model name must be unique within the project it is cr
eated in.", |
| 1351 "type": "string" |
| 1352 } |
| 1353 }, |
| 1354 "type": "object" |
| 1355 } |
| 1356 }, |
| 1357 "servicePath": "", |
| 1358 "title": "Google Cloud Machine Learning", |
| 1359 "version": "v1beta1" |
| 1360 } |
OLD | NEW |