Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / c30d2b5d4478b230246dcaaa9f1c533ca3304387 / . / docs / dyn / ml_v1.projects.models.versions.html
blob: 116096f4d95a357b7b230cb2490c3e409e76682f [file] [log] [blame]
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]1<html><body>
2<style>
3
4body, 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
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, 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">Google Cloud Machine Learning Engine</a> . <a href="ml_v1.projects.html">projects</a> . <a href="ml_v1.projects.models.html">models</a> . <a href="ml_v1.projects.models.versions.html">versions</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#create">create(parent=None, body, x__xgafv=None)</a></code></p>
79<p class="firstline">Creates a new version of a model from a trained TensorFlow model.</p>
80<p class="toc_element">
81 <code><a href="#delete">delete(name=None, x__xgafv=None)</a></code></p>
82<p class="firstline">Deletes a model version.</p>
83<p class="toc_element">
84 <code><a href="#get">get(name=None, x__xgafv=None)</a></code></p>
85<p class="firstline">Gets information about a model version.</p>
86<p class="toc_element">
87 <code><a href="#list">list(parent=None, pageToken=None, x__xgafv=None, pageSize=None)</a></code></p>
88<p class="firstline">Gets basic information about all the versions of a model.</p>
89<p class="toc_element">
90 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
91<p class="firstline">Retrieves the next page of results.</p>
92<p class="toc_element">
93 <code><a href="#setDefault">setDefault(name=None, body, x__xgafv=None)</a></code></p>
94<p class="firstline">Designates a version to be the default for the model.</p>
95<h3>Method Details</h3>
96<div class="method">
97 <code class="details" id="create">create(parent=None, body, x__xgafv=None)</code>
98 <pre>Creates a new version of a model from a trained TensorFlow model.
99
100If the version created in the cloud by this call is the first deployed
101version of the specified model, it will be made the default version of the
102model. When you add a version to a model that already has one or more
103versions, the default version does not automatically change. If you want a
104new version to be the default, you must call
105[projects.models.versions.setDefault](/ml/reference/rest/v1/projects.models.versions/setDefault).
106
107Args:
108 parent: string, Required. The name of the model.
109
110Authorization: requires `Editor` role on the parent project. (required)
111 body: object, The request body. (required)
112 The object takes the form of:
113
114{ # Represents a version of the model.
115 #
116 # Each version is a trained model deployed in the cloud, ready to handle
117 # prediction requests. A model can have multiple versions. You can get
118 # information about all of the versions of a given model by calling
119 # [projects.models.versions.list](/ml/reference/rest/v1/projects.models.versions/list).
120 "description": "A String", # Optional. The description specified for the version when it was created.
121 "runtimeVersion": "A String", # Optional. The Google Cloud ML runtime version to use for this deployment.
122 # If not set, Google Cloud ML will choose a version.
123 "manualScaling": { # Options for manually scaling a model. # Optional. Manually select the number of nodes to use for serving the
124 # model. If unset (i.e., by default), the number of nodes used to serve
125 # the model automatically scales with traffic. However, care should be
126 # taken to ramp up traffic according to the model's ability to scale. If
127 # your model needs to handle bursts of traffic beyond it's ability to
128 # scale, it is recommended you set this field appropriately.
129 "nodes": 42, # The number of nodes to allocate for this model. These nodes are always up,
130 # starting from the time the model is deployed, so the cost of operating
131 # this model will be proportional to nodes * number of hours since
132 # deployment.
133 },
134 "lastUseTime": "A String", # Output only. The time the version was last used for prediction.
135 "deploymentUri": "A String", # Required. The Google Cloud Storage location of the trained model used to
136 # create the version. See the
137 # [overview of model deployment](/ml/docs/concepts/deployment-overview) for
138 # more informaiton.
139 #
140 # When passing Version to
141 # [projects.models.versions.create](/ml/reference/rest/v1/projects.models.versions/create)
142 # the model service uses the specified location as the source of the model.
143 # Once deployed, the model version is hosted by the prediction service, so
144 # this location is useful only as a historical record.
145 "createTime": "A String", # Output only. The time the version was created.
146 "isDefault": True or False, # Output only. If true, this version will be used to handle prediction
147 # requests that do not specify a version.
148 #
149 # You can change the default version by calling
150 # [projects.methods.versions.setDefault](/ml/reference/rest/v1/projects.models.versions/setDefault).
151 "name": "A String", # Required.The name specified for the version when it was created.
152 #
153 # The version name must be unique within the model it is created in.
154}
155
156 x__xgafv: string, V1 error format.
157 Allowed values
158 1 - v1 error format
159 2 - v2 error format
160
161Returns:
162 An object of the form:
163
164 { # This resource represents a long-running operation that is the result of a
165 # network API call.
166 "metadata": { # Service-specific metadata associated with the operation. It typically
167 # contains progress information and common metadata such as create time.
168 # Some services might not provide such metadata. Any method that returns a
169 # long-running operation should document the metadata type, if any.
170 "a_key": "", # Properties of the object. Contains field @type with type URL.
171 },
172 "error": { # The `Status` type defines a logical error model that is suitable for different # The error result of the operation in case of failure or cancellation.
173 # programming environments, including REST APIs and RPC APIs. It is used by
174 # [gRPC](https://github.com/grpc). The error model is designed to be:
175 #
176 # - Simple to use and understand for most users
177 # - Flexible enough to meet unexpected needs
178 #
179 # # Overview
180 #
181 # The `Status` message contains three pieces of data: error code, error message,
182 # and error details. The error code should be an enum value of
183 # google.rpc.Code, but it may accept additional error codes if needed. The
184 # error message should be a developer-facing English message that helps
185 # developers *understand* and *resolve* the error. If a localized user-facing
186 # error message is needed, put the localized message in the error details or
187 # localize it in the client. The optional error details may contain arbitrary
188 # information about the error. There is a predefined set of error detail types
189 # in the package `google.rpc` which can be used for common error conditions.
190 #
191 # # Language mapping
192 #
193 # The `Status` message is the logical representation of the error model, but it
194 # is not necessarily the actual wire format. When the `Status` message is
195 # exposed in different client libraries and different wire protocols, it can be
196 # mapped differently. For example, it will likely be mapped to some exceptions
197 # in Java, but more likely mapped to some error codes in C.
198 #
199 # # Other uses
200 #
201 # The error model and the `Status` message can be used in a variety of
202 # environments, either with or without APIs, to provide a
203 # consistent developer experience across different environments.
204 #
205 # Example uses of this error model include:
206 #
207 # - Partial errors. If a service needs to return partial errors to the client,
208 # it may embed the `Status` in the normal response to indicate the partial
209 # errors.
210 #
211 # - Workflow errors. A typical workflow has multiple steps. Each step may
212 # have a `Status` message for error reporting purpose.
213 #
214 # - Batch operations. If a client uses batch request and batch response, the
215 # `Status` message should be used directly inside batch response, one for
216 # each error sub-response.
217 #
218 # - Asynchronous operations. If an API call embeds asynchronous operation
219 # results in its response, the status of those operations should be
220 # represented directly using the `Status` message.
221 #
222 # - Logging. If some API errors are stored in logs, the message `Status` could
223 # be used directly after any stripping needed for security/privacy reasons.
224 "message": "A String", # A developer-facing error message, which should be in English. Any
225 # user-facing error message should be localized and sent in the
226 # google.rpc.Status.details field, or localized by the client.
227 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
228 "details": [ # A list of messages that carry the error details. There will be a
229 # common set of message types for APIs to use.
230 {
231 "a_key": "", # Properties of the object. Contains field @type with type URL.
232 },
233 ],
234 },
235 "done": True or False, # If the value is `false`, it means the operation is still in progress.
236 # If true, the operation is completed, and either `error` or `response` is
237 # available.
238 "response": { # The normal response of the operation in case of success. If the original
239 # method returns no data on success, such as `Delete`, the response is
240 # `google.protobuf.Empty`. If the original method is standard
241 # `Get`/`Create`/`Update`, the response should be the resource. For other
242 # methods, the response should have the type `XxxResponse`, where `Xxx`
243 # is the original method name. For example, if the original method name
244 # is `TakeSnapshot()`, the inferred response type is
245 # `TakeSnapshotResponse`.
246 "a_key": "", # Properties of the object. Contains field @type with type URL.
247 },
248 "name": "A String", # The server-assigned name, which is only unique within the same service that
249 # originally returns it. If you use the default HTTP mapping, the
250 # `name` should have the format of `operations/some/unique/name`.
251 }</pre>
252</div>
253
254<div class="method">
255 <code class="details" id="delete">delete(name=None, x__xgafv=None)</code>
256 <pre>Deletes a model version.
257
258Each model can have multiple versions deployed and in use at any given
259time. Use this method to remove a single version.
260
261Note: You cannot delete the version that is set as the default version
262of the model unless it is the only remaining version.
263
264Args:
265 name: string, Required. The name of the version. You can get the names of all the
266versions of a model by calling
267[projects.models.versions.list](/ml/reference/rest/v1/projects.models.versions/list).
268
269Authorization: requires `Editor` role on the parent project. (required)
270 x__xgafv: string, V1 error format.
271 Allowed values
272 1 - v1 error format
273 2 - v2 error format
274
275Returns:
276 An object of the form:
277
278 { # This resource represents a long-running operation that is the result of a
279 # network API call.
280 "metadata": { # Service-specific metadata associated with the operation. It typically
281 # contains progress information and common metadata such as create time.
282 # Some services might not provide such metadata. Any method that returns a
283 # long-running operation should document the metadata type, if any.
284 "a_key": "", # Properties of the object. Contains field @type with type URL.
285 },
286 "error": { # The `Status` type defines a logical error model that is suitable for different # The error result of the operation in case of failure or cancellation.
287 # programming environments, including REST APIs and RPC APIs. It is used by
288 # [gRPC](https://github.com/grpc). The error model is designed to be:
289 #
290 # - Simple to use and understand for most users
291 # - Flexible enough to meet unexpected needs
292 #
293 # # Overview
294 #
295 # The `Status` message contains three pieces of data: error code, error message,
296 # and error details. The error code should be an enum value of
297 # google.rpc.Code, but it may accept additional error codes if needed. The
298 # error message should be a developer-facing English message that helps
299 # developers *understand* and *resolve* the error. If a localized user-facing
300 # error message is needed, put the localized message in the error details or
301 # localize it in the client. The optional error details may contain arbitrary
302 # information about the error. There is a predefined set of error detail types
303 # in the package `google.rpc` which can be used for common error conditions.
304 #
305 # # Language mapping
306 #
307 # The `Status` message is the logical representation of the error model, but it
308 # is not necessarily the actual wire format. When the `Status` message is
309 # exposed in different client libraries and different wire protocols, it can be
310 # mapped differently. For example, it will likely be mapped to some exceptions
311 # in Java, but more likely mapped to some error codes in C.
312 #
313 # # Other uses
314 #
315 # The error model and the `Status` message can be used in a variety of
316 # environments, either with or without APIs, to provide a
317 # consistent developer experience across different environments.
318 #
319 # Example uses of this error model include:
320 #
321 # - Partial errors. If a service needs to return partial errors to the client,
322 # it may embed the `Status` in the normal response to indicate the partial
323 # errors.
324 #
325 # - Workflow errors. A typical workflow has multiple steps. Each step may
326 # have a `Status` message for error reporting purpose.
327 #
328 # - Batch operations. If a client uses batch request and batch response, the
329 # `Status` message should be used directly inside batch response, one for
330 # each error sub-response.
331 #
332 # - Asynchronous operations. If an API call embeds asynchronous operation
333 # results in its response, the status of those operations should be
334 # represented directly using the `Status` message.
335 #
336 # - Logging. If some API errors are stored in logs, the message `Status` could
337 # be used directly after any stripping needed for security/privacy reasons.
338 "message": "A String", # A developer-facing error message, which should be in English. Any
339 # user-facing error message should be localized and sent in the
340 # google.rpc.Status.details field, or localized by the client.
341 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
342 "details": [ # A list of messages that carry the error details. There will be a
343 # common set of message types for APIs to use.
344 {
345 "a_key": "", # Properties of the object. Contains field @type with type URL.
346 },
347 ],
348 },
349 "done": True or False, # If the value is `false`, it means the operation is still in progress.
350 # If true, the operation is completed, and either `error` or `response` is
351 # available.
352 "response": { # The normal response of the operation in case of success. If the original
353 # method returns no data on success, such as `Delete`, the response is
354 # `google.protobuf.Empty`. If the original method is standard
355 # `Get`/`Create`/`Update`, the response should be the resource. For other
356 # methods, the response should have the type `XxxResponse`, where `Xxx`
357 # is the original method name. For example, if the original method name
358 # is `TakeSnapshot()`, the inferred response type is
359 # `TakeSnapshotResponse`.
360 "a_key": "", # Properties of the object. Contains field @type with type URL.
361 },
362 "name": "A String", # The server-assigned name, which is only unique within the same service that
363 # originally returns it. If you use the default HTTP mapping, the
364 # `name` should have the format of `operations/some/unique/name`.
365 }</pre>
366</div>
367
368<div class="method">
369 <code class="details" id="get">get(name=None, x__xgafv=None)</code>
370 <pre>Gets information about a model version.
371
372Models can have multiple versions. You can call
373[projects.models.versions.list](/ml/reference/rest/v1/projects.models.versions/list)
374to get the same information that this method returns for all of the
375versions of a model.
376
377Args:
378 name: string, Required. The name of the version.
379
380Authorization: requires `Viewer` role on the parent project. (required)
381 x__xgafv: string, V1 error format.
382 Allowed values
383 1 - v1 error format
384 2 - v2 error format
385
386Returns:
387 An object of the form:
388
389 { # Represents a version of the model.
390 #
391 # Each version is a trained model deployed in the cloud, ready to handle
392 # prediction requests. A model can have multiple versions. You can get
393 # information about all of the versions of a given model by calling
394 # [projects.models.versions.list](/ml/reference/rest/v1/projects.models.versions/list).
395 "description": "A String", # Optional. The description specified for the version when it was created.
396 "runtimeVersion": "A String", # Optional. The Google Cloud ML runtime version to use for this deployment.
397 # If not set, Google Cloud ML will choose a version.
398 "manualScaling": { # Options for manually scaling a model. # Optional. Manually select the number of nodes to use for serving the
399 # model. If unset (i.e., by default), the number of nodes used to serve
400 # the model automatically scales with traffic. However, care should be
401 # taken to ramp up traffic according to the model's ability to scale. If
402 # your model needs to handle bursts of traffic beyond it's ability to
403 # scale, it is recommended you set this field appropriately.
404 "nodes": 42, # The number of nodes to allocate for this model. These nodes are always up,
405 # starting from the time the model is deployed, so the cost of operating
406 # this model will be proportional to nodes * number of hours since
407 # deployment.
408 },
409 "lastUseTime": "A String", # Output only. The time the version was last used for prediction.
410 "deploymentUri": "A String", # Required. The Google Cloud Storage location of the trained model used to
411 # create the version. See the
412 # [overview of model deployment](/ml/docs/concepts/deployment-overview) for
413 # more informaiton.
414 #
415 # When passing Version to
416 # [projects.models.versions.create](/ml/reference/rest/v1/projects.models.versions/create)
417 # the model service uses the specified location as the source of the model.
418 # Once deployed, the model version is hosted by the prediction service, so
419 # this location is useful only as a historical record.
420 "createTime": "A String", # Output only. The time the version was created.
421 "isDefault": True or False, # Output only. If true, this version will be used to handle prediction
422 # requests that do not specify a version.
423 #
424 # You can change the default version by calling
425 # [projects.methods.versions.setDefault](/ml/reference/rest/v1/projects.models.versions/setDefault).
426 "name": "A String", # Required.The name specified for the version when it was created.
427 #
428 # The version name must be unique within the model it is created in.
429 }</pre>
430</div>
431
432<div class="method">
433 <code class="details" id="list">list(parent=None, pageToken=None, x__xgafv=None, pageSize=None)</code>
434 <pre>Gets basic information about all the versions of a model.
435
436If you expect that a model has a lot of versions, or if you need to handle
437only a limited number of results at a time, you can request that the list
438be retrieved in batches (called pages):
439
440Args:
441 parent: string, Required. The name of the model for which to list the version.
442
443Authorization: requires `Viewer` role on the parent project. (required)
444 pageToken: string, Optional. A page token to request the next page of results.
445
446You get the token from the `next_page_token` field of the response from
447the previous call.
448 x__xgafv: string, V1 error format.
449 Allowed values
450 1 - v1 error format
451 2 - v2 error format
452 pageSize: integer, Optional. The number of versions to retrieve per "page" of results. If
453there are more remaining results than this number, the response message
454will contain a valid value in the `next_page_token` field.
455
456The default value is 20, and the maximum page size is 100.
457
458Returns:
459 An object of the form:
460
461 { # Response message for the ListVersions method.
462 "nextPageToken": "A String", # Optional. Pass this token as the `page_token` field of the request for a
463 # subsequent call.
464 "versions": [ # The list of versions.
465 { # Represents a version of the model.
466 #
467 # Each version is a trained model deployed in the cloud, ready to handle
468 # prediction requests. A model can have multiple versions. You can get
469 # information about all of the versions of a given model by calling
470 # [projects.models.versions.list](/ml/reference/rest/v1/projects.models.versions/list).
471 "description": "A String", # Optional. The description specified for the version when it was created.
472 "runtimeVersion": "A String", # Optional. The Google Cloud ML runtime version to use for this deployment.
473 # If not set, Google Cloud ML will choose a version.
474 "manualScaling": { # Options for manually scaling a model. # Optional. Manually select the number of nodes to use for serving the
475 # model. If unset (i.e., by default), the number of nodes used to serve
476 # the model automatically scales with traffic. However, care should be
477 # taken to ramp up traffic according to the model's ability to scale. If
478 # your model needs to handle bursts of traffic beyond it's ability to
479 # scale, it is recommended you set this field appropriately.
480 "nodes": 42, # The number of nodes to allocate for this model. These nodes are always up,
481 # starting from the time the model is deployed, so the cost of operating
482 # this model will be proportional to nodes * number of hours since
483 # deployment.
484 },
485 "lastUseTime": "A String", # Output only. The time the version was last used for prediction.
486 "deploymentUri": "A String", # Required. The Google Cloud Storage location of the trained model used to
487 # create the version. See the
488 # [overview of model deployment](/ml/docs/concepts/deployment-overview) for
489 # more informaiton.
490 #
491 # When passing Version to
492 # [projects.models.versions.create](/ml/reference/rest/v1/projects.models.versions/create)
493 # the model service uses the specified location as the source of the model.
494 # Once deployed, the model version is hosted by the prediction service, so
495 # this location is useful only as a historical record.
496 "createTime": "A String", # Output only. The time the version was created.
497 "isDefault": True or False, # Output only. If true, this version will be used to handle prediction
498 # requests that do not specify a version.
499 #
500 # You can change the default version by calling
501 # [projects.methods.versions.setDefault](/ml/reference/rest/v1/projects.models.versions/setDefault).
502 "name": "A String", # Required.The name specified for the version when it was created.
503 #
504 # The version name must be unique within the model it is created in.
505 },
506 ],
507 }</pre>
508</div>
509
510<div class="method">
511 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
512 <pre>Retrieves the next page of results.
513
514Args:
515 previous_request: The request for the previous page. (required)
516 previous_response: The response from the request for the previous page. (required)
517
518Returns:
519 A request object that you can call 'execute()' on to request the next
520 page. Returns None if there are no more items in the collection.
521 </pre>
522</div>
523
524<div class="method">
525 <code class="details" id="setDefault">setDefault(name=None, body, x__xgafv=None)</code>
526 <pre>Designates a version to be the default for the model.
527
528The default version is used for prediction requests made against the model
529that don't specify a version.
530
531The first version to be created for a model is automatically set as the
532default. You must make any subsequent changes to the default version
533setting manually using this method.
534
535Args:
536 name: string, Required. The name of the version to make the default for the model. You
537can get the names of all the versions of a model by calling
538[projects.models.versions.list](/ml/reference/rest/v1/projects.models.versions/list).
539
540Authorization: requires `Editor` role on the parent project. (required)
541 body: object, The request body. (required)
542 The object takes the form of:
543
544{ # Request message for the SetDefaultVersion request.
545 }
546
547 x__xgafv: string, V1 error format.
548 Allowed values
549 1 - v1 error format
550 2 - v2 error format
551
552Returns:
553 An object of the form:
554
555 { # Represents a version of the model.
556 #
557 # Each version is a trained model deployed in the cloud, ready to handle
558 # prediction requests. A model can have multiple versions. You can get
559 # information about all of the versions of a given model by calling
560 # [projects.models.versions.list](/ml/reference/rest/v1/projects.models.versions/list).
561 "description": "A String", # Optional. The description specified for the version when it was created.
562 "runtimeVersion": "A String", # Optional. The Google Cloud ML runtime version to use for this deployment.
563 # If not set, Google Cloud ML will choose a version.
564 "manualScaling": { # Options for manually scaling a model. # Optional. Manually select the number of nodes to use for serving the
565 # model. If unset (i.e., by default), the number of nodes used to serve
566 # the model automatically scales with traffic. However, care should be
567 # taken to ramp up traffic according to the model's ability to scale. If
568 # your model needs to handle bursts of traffic beyond it's ability to
569 # scale, it is recommended you set this field appropriately.
570 "nodes": 42, # The number of nodes to allocate for this model. These nodes are always up,
571 # starting from the time the model is deployed, so the cost of operating
572 # this model will be proportional to nodes * number of hours since
573 # deployment.
574 },
575 "lastUseTime": "A String", # Output only. The time the version was last used for prediction.
576 "deploymentUri": "A String", # Required. The Google Cloud Storage location of the trained model used to
577 # create the version. See the
578 # [overview of model deployment](/ml/docs/concepts/deployment-overview) for
579 # more informaiton.
580 #
581 # When passing Version to
582 # [projects.models.versions.create](/ml/reference/rest/v1/projects.models.versions/create)
583 # the model service uses the specified location as the source of the model.
584 # Once deployed, the model version is hosted by the prediction service, so
585 # this location is useful only as a historical record.
586 "createTime": "A String", # Output only. The time the version was created.
587 "isDefault": True or False, # Output only. If true, this version will be used to handle prediction
588 # requests that do not specify a version.
589 #
590 # You can change the default version by calling
591 # [projects.methods.versions.setDefault](/ml/reference/rest/v1/projects.models.versions/setDefault).
592 "name": "A String", # Required.The name specified for the version when it was created.
593 #
594 # The version name must be unique within the model it is created in.
595 }</pre>
596</div>
597
598</body></html>