docs: update docs (#916)
* fix: re-run script
* test: fix noxfile
diff --git a/docs/dyn/firebaseml_v1beta2.projects.models.html b/docs/dyn/firebaseml_v1beta2.projects.models.html
index f4e6464..a790292 100644
--- a/docs/dyn/firebaseml_v1beta2.projects.models.html
+++ b/docs/dyn/firebaseml_v1beta2.projects.models.html
@@ -84,7 +84,7 @@
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets a model resource.</p>
<p class="toc_element">
- <code><a href="#list">list(parent, filter=None, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p>
+ <code><a href="#list">list(parent, pageToken=None, filter=None, pageSize=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists the models</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -109,25 +109,19 @@
# Model names have the form `projects/{project_id}/models/{model_id}`
# The name is ignored when creating a model.
"modelHash": "A String", # Output only. The model_hash will change if a new file is available for download.
- "tags": [ # User defined tags which can be used to group/filter models during listing
- "A String",
- ],
- "tfliteModel": { # Information that is specific to TfLite models. # A TFLite Model
- "sizeBytes": "A String", # Output only. The size of the TFLite model
- "gcsTfliteUri": "A String", # The TfLite file containing the model. (Stored in Google Cloud).
- # The gcs_tflite_uri should have form: gs://some-bucket/some-model.tflite
- # Note: If you update the file in the original location, it is
- # necessary to call UpdateModel for ML to pick up and validate the
- # updated file.
- },
"displayName": "A String", # Required. The name of the model to create. The name can be up to 32 characters long
# and can consist only of ASCII Latin letters A-Z and a-z, underscores(_)
# and ASCII digits 0-9. It must start with a letter.
- "etag": "A String", # Output only. See RFC7232
- # https://tools.ietf.org/html/rfc7232#section-2.3
+ "tags": [ # User defined tags which can be used to group/filter models during listing
+ "A String",
+ ],
+ "createTime": "A String", # Output only. Timestamp when this model was created in Firebase ML.
"activeOperations": [ # Output only. Lists operation ids associated with this model whose status is NOT done.
{ # This resource represents a long-running operation that is the result of a
# network API call.
+ "done": True or False, # If the value is `false`, it means the operation is still in progress.
+ # If `true`, the operation is completed, and either `error` or `response` is
+ # available.
"response": { # The normal response of the operation in case of success. If the original
# method returns no data on success, such as `Delete`, the response is
# `google.protobuf.Empty`. If the original method is standard
@@ -138,9 +132,6 @@
# `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
- "name": "A String", # The server-assigned name, which is only unique within the same service that
- # originally returns it. If you use the default HTTP mapping, the
- # `name` should be a resource name ending with `operations/{unique_id}`.
"error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
# different programming environments, including REST APIs and RPC APIs. It is
# used by [gRPC](https://github.com/grpc). Each `Status` message contains
@@ -159,22 +150,21 @@
},
],
},
+ "name": "A String", # The server-assigned name, which is only unique within the same service that
+ # originally returns it. If you use the default HTTP mapping, the
+ # `name` should be a resource name ending with `operations/{unique_id}`.
"metadata": { # Service-specific metadata associated with the operation. It typically
# contains progress information and common metadata such as create time.
# Some services might not provide such metadata. Any method that returns a
# long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
- "done": True or False, # If the value is `false`, it means the operation is still in progress.
- # If `true`, the operation is completed, and either `error` or `response` is
- # available.
},
],
- "createTime": "A String", # Output only. Timestamp when this model was created in Firebase ML.
+ "updateTime": "A String", # Output only. Timestamp when this model was updated in Firebase ML.
"state": { # State common to all model types. # State common to all model types.
# Includes publishing and validation information.
# Includes publishing and validation information.
- "published": True or False, # Indicates if this model has been published.
"validationError": { # The `Status` type defines a logical error model that is suitable for # Output only. Indicates the latest validation error on the model if any.
# A model may have validation errors if there were problems during
# the model creation/update.
@@ -198,8 +188,18 @@
},
],
},
+ "published": True or False, # Indicates if this model has been published.
},
- "updateTime": "A String", # Output only. Timestamp when this model was updated in Firebase ML.
+ "tfliteModel": { # Information that is specific to TfLite models. # A TFLite Model
+ "sizeBytes": "A String", # Output only. The size of the TFLite model
+ "gcsTfliteUri": "A String", # The TfLite file containing the model. (Stored in Google Cloud).
+ # The gcs_tflite_uri should have form: gs://some-bucket/some-model.tflite
+ # Note: If you update the file in the original location, it is
+ # necessary to call UpdateModel for ML to pick up and validate the
+ # updated file.
+ },
+ "etag": "A String", # Output only. See RFC7232
+ # https://tools.ietf.org/html/rfc7232#section-2.3
}
x__xgafv: string, V1 error format.
@@ -212,6 +212,9 @@
{ # This resource represents a long-running operation that is the result of a
# network API call.
+ "done": True or False, # If the value is `false`, it means the operation is still in progress.
+ # If `true`, the operation is completed, and either `error` or `response` is
+ # available.
"response": { # The normal response of the operation in case of success. If the original
# method returns no data on success, such as `Delete`, the response is
# `google.protobuf.Empty`. If the original method is standard
@@ -222,9 +225,6 @@
# `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
- "name": "A String", # The server-assigned name, which is only unique within the same service that
- # originally returns it. If you use the default HTTP mapping, the
- # `name` should be a resource name ending with `operations/{unique_id}`.
"error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
# different programming environments, including REST APIs and RPC APIs. It is
# used by [gRPC](https://github.com/grpc). Each `Status` message contains
@@ -243,15 +243,15 @@
},
],
},
+ "name": "A String", # The server-assigned name, which is only unique within the same service that
+ # originally returns it. If you use the default HTTP mapping, the
+ # `name` should be a resource name ending with `operations/{unique_id}`.
"metadata": { # Service-specific metadata associated with the operation. It typically
# contains progress information and common metadata such as create time.
# Some services might not provide such metadata. Any method that returns a
# long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
- "done": True or False, # If the value is `false`, it means the operation is still in progress.
- # If `true`, the operation is completed, and either `error` or `response` is
- # available.
}</pre>
</div>
@@ -302,25 +302,19 @@
# Model names have the form `projects/{project_id}/models/{model_id}`
# The name is ignored when creating a model.
"modelHash": "A String", # Output only. The model_hash will change if a new file is available for download.
- "tags": [ # User defined tags which can be used to group/filter models during listing
- "A String",
- ],
- "tfliteModel": { # Information that is specific to TfLite models. # A TFLite Model
- "sizeBytes": "A String", # Output only. The size of the TFLite model
- "gcsTfliteUri": "A String", # The TfLite file containing the model. (Stored in Google Cloud).
- # The gcs_tflite_uri should have form: gs://some-bucket/some-model.tflite
- # Note: If you update the file in the original location, it is
- # necessary to call UpdateModel for ML to pick up and validate the
- # updated file.
- },
"displayName": "A String", # Required. The name of the model to create. The name can be up to 32 characters long
# and can consist only of ASCII Latin letters A-Z and a-z, underscores(_)
# and ASCII digits 0-9. It must start with a letter.
- "etag": "A String", # Output only. See RFC7232
- # https://tools.ietf.org/html/rfc7232#section-2.3
+ "tags": [ # User defined tags which can be used to group/filter models during listing
+ "A String",
+ ],
+ "createTime": "A String", # Output only. Timestamp when this model was created in Firebase ML.
"activeOperations": [ # Output only. Lists operation ids associated with this model whose status is NOT done.
{ # This resource represents a long-running operation that is the result of a
# network API call.
+ "done": True or False, # If the value is `false`, it means the operation is still in progress.
+ # If `true`, the operation is completed, and either `error` or `response` is
+ # available.
"response": { # The normal response of the operation in case of success. If the original
# method returns no data on success, such as `Delete`, the response is
# `google.protobuf.Empty`. If the original method is standard
@@ -331,9 +325,6 @@
# `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
- "name": "A String", # The server-assigned name, which is only unique within the same service that
- # originally returns it. If you use the default HTTP mapping, the
- # `name` should be a resource name ending with `operations/{unique_id}`.
"error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
# different programming environments, including REST APIs and RPC APIs. It is
# used by [gRPC](https://github.com/grpc). Each `Status` message contains
@@ -352,22 +343,21 @@
},
],
},
+ "name": "A String", # The server-assigned name, which is only unique within the same service that
+ # originally returns it. If you use the default HTTP mapping, the
+ # `name` should be a resource name ending with `operations/{unique_id}`.
"metadata": { # Service-specific metadata associated with the operation. It typically
# contains progress information and common metadata such as create time.
# Some services might not provide such metadata. Any method that returns a
# long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
- "done": True or False, # If the value is `false`, it means the operation is still in progress.
- # If `true`, the operation is completed, and either `error` or `response` is
- # available.
},
],
- "createTime": "A String", # Output only. Timestamp when this model was created in Firebase ML.
+ "updateTime": "A String", # Output only. Timestamp when this model was updated in Firebase ML.
"state": { # State common to all model types. # State common to all model types.
# Includes publishing and validation information.
# Includes publishing and validation information.
- "published": True or False, # Indicates if this model has been published.
"validationError": { # The `Status` type defines a logical error model that is suitable for # Output only. Indicates the latest validation error on the model if any.
# A model may have validation errors if there were problems during
# the model creation/update.
@@ -391,21 +381,31 @@
},
],
},
+ "published": True or False, # Indicates if this model has been published.
},
- "updateTime": "A String", # Output only. Timestamp when this model was updated in Firebase ML.
+ "tfliteModel": { # Information that is specific to TfLite models. # A TFLite Model
+ "sizeBytes": "A String", # Output only. The size of the TFLite model
+ "gcsTfliteUri": "A String", # The TfLite file containing the model. (Stored in Google Cloud).
+ # The gcs_tflite_uri should have form: gs://some-bucket/some-model.tflite
+ # Note: If you update the file in the original location, it is
+ # necessary to call UpdateModel for ML to pick up and validate the
+ # updated file.
+ },
+ "etag": "A String", # Output only. See RFC7232
+ # https://tools.ietf.org/html/rfc7232#section-2.3
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(parent, filter=None, pageToken=None, pageSize=None, x__xgafv=None)</code>
+ <code class="details" id="list">list(parent, pageToken=None, filter=None, pageSize=None, x__xgafv=None)</code>
<pre>Lists the models
Args:
parent: string, Required. The name of the parent to list models for.
The parent must have the form `projects/{project_id}' (required)
+ pageToken: string, The next_page_token value returned from a previous List request, if any.
filter: string, A filter for the list
e.g. 'tags: abc' to list models which are tagged with "abc"
- pageToken: string, The next_page_token value returned from a previous List request, if any.
pageSize: integer, The maximum number of items to return
x__xgafv: string, V1 error format.
Allowed values
@@ -422,25 +422,19 @@
# Model names have the form `projects/{project_id}/models/{model_id}`
# The name is ignored when creating a model.
"modelHash": "A String", # Output only. The model_hash will change if a new file is available for download.
- "tags": [ # User defined tags which can be used to group/filter models during listing
- "A String",
- ],
- "tfliteModel": { # Information that is specific to TfLite models. # A TFLite Model
- "sizeBytes": "A String", # Output only. The size of the TFLite model
- "gcsTfliteUri": "A String", # The TfLite file containing the model. (Stored in Google Cloud).
- # The gcs_tflite_uri should have form: gs://some-bucket/some-model.tflite
- # Note: If you update the file in the original location, it is
- # necessary to call UpdateModel for ML to pick up and validate the
- # updated file.
- },
"displayName": "A String", # Required. The name of the model to create. The name can be up to 32 characters long
# and can consist only of ASCII Latin letters A-Z and a-z, underscores(_)
# and ASCII digits 0-9. It must start with a letter.
- "etag": "A String", # Output only. See RFC7232
- # https://tools.ietf.org/html/rfc7232#section-2.3
+ "tags": [ # User defined tags which can be used to group/filter models during listing
+ "A String",
+ ],
+ "createTime": "A String", # Output only. Timestamp when this model was created in Firebase ML.
"activeOperations": [ # Output only. Lists operation ids associated with this model whose status is NOT done.
{ # This resource represents a long-running operation that is the result of a
# network API call.
+ "done": True or False, # If the value is `false`, it means the operation is still in progress.
+ # If `true`, the operation is completed, and either `error` or `response` is
+ # available.
"response": { # The normal response of the operation in case of success. If the original
# method returns no data on success, such as `Delete`, the response is
# `google.protobuf.Empty`. If the original method is standard
@@ -451,9 +445,6 @@
# `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
- "name": "A String", # The server-assigned name, which is only unique within the same service that
- # originally returns it. If you use the default HTTP mapping, the
- # `name` should be a resource name ending with `operations/{unique_id}`.
"error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
# different programming environments, including REST APIs and RPC APIs. It is
# used by [gRPC](https://github.com/grpc). Each `Status` message contains
@@ -472,22 +463,21 @@
},
],
},
+ "name": "A String", # The server-assigned name, which is only unique within the same service that
+ # originally returns it. If you use the default HTTP mapping, the
+ # `name` should be a resource name ending with `operations/{unique_id}`.
"metadata": { # Service-specific metadata associated with the operation. It typically
# contains progress information and common metadata such as create time.
# Some services might not provide such metadata. Any method that returns a
# long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
- "done": True or False, # If the value is `false`, it means the operation is still in progress.
- # If `true`, the operation is completed, and either `error` or `response` is
- # available.
},
],
- "createTime": "A String", # Output only. Timestamp when this model was created in Firebase ML.
+ "updateTime": "A String", # Output only. Timestamp when this model was updated in Firebase ML.
"state": { # State common to all model types. # State common to all model types.
# Includes publishing and validation information.
# Includes publishing and validation information.
- "published": True or False, # Indicates if this model has been published.
"validationError": { # The `Status` type defines a logical error model that is suitable for # Output only. Indicates the latest validation error on the model if any.
# A model may have validation errors if there were problems during
# the model creation/update.
@@ -511,8 +501,18 @@
},
],
},
+ "published": True or False, # Indicates if this model has been published.
},
- "updateTime": "A String", # Output only. Timestamp when this model was updated in Firebase ML.
+ "tfliteModel": { # Information that is specific to TfLite models. # A TFLite Model
+ "sizeBytes": "A String", # Output only. The size of the TFLite model
+ "gcsTfliteUri": "A String", # The TfLite file containing the model. (Stored in Google Cloud).
+ # The gcs_tflite_uri should have form: gs://some-bucket/some-model.tflite
+ # Note: If you update the file in the original location, it is
+ # necessary to call UpdateModel for ML to pick up and validate the
+ # updated file.
+ },
+ "etag": "A String", # Output only. See RFC7232
+ # https://tools.ietf.org/html/rfc7232#section-2.3
},
],
"nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no
@@ -550,25 +550,19 @@
# Model names have the form `projects/{project_id}/models/{model_id}`
# The name is ignored when creating a model.
"modelHash": "A String", # Output only. The model_hash will change if a new file is available for download.
- "tags": [ # User defined tags which can be used to group/filter models during listing
- "A String",
- ],
- "tfliteModel": { # Information that is specific to TfLite models. # A TFLite Model
- "sizeBytes": "A String", # Output only. The size of the TFLite model
- "gcsTfliteUri": "A String", # The TfLite file containing the model. (Stored in Google Cloud).
- # The gcs_tflite_uri should have form: gs://some-bucket/some-model.tflite
- # Note: If you update the file in the original location, it is
- # necessary to call UpdateModel for ML to pick up and validate the
- # updated file.
- },
"displayName": "A String", # Required. The name of the model to create. The name can be up to 32 characters long
# and can consist only of ASCII Latin letters A-Z and a-z, underscores(_)
# and ASCII digits 0-9. It must start with a letter.
- "etag": "A String", # Output only. See RFC7232
- # https://tools.ietf.org/html/rfc7232#section-2.3
+ "tags": [ # User defined tags which can be used to group/filter models during listing
+ "A String",
+ ],
+ "createTime": "A String", # Output only. Timestamp when this model was created in Firebase ML.
"activeOperations": [ # Output only. Lists operation ids associated with this model whose status is NOT done.
{ # This resource represents a long-running operation that is the result of a
# network API call.
+ "done": True or False, # If the value is `false`, it means the operation is still in progress.
+ # If `true`, the operation is completed, and either `error` or `response` is
+ # available.
"response": { # The normal response of the operation in case of success. If the original
# method returns no data on success, such as `Delete`, the response is
# `google.protobuf.Empty`. If the original method is standard
@@ -579,9 +573,6 @@
# `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
- "name": "A String", # The server-assigned name, which is only unique within the same service that
- # originally returns it. If you use the default HTTP mapping, the
- # `name` should be a resource name ending with `operations/{unique_id}`.
"error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
# different programming environments, including REST APIs and RPC APIs. It is
# used by [gRPC](https://github.com/grpc). Each `Status` message contains
@@ -600,22 +591,21 @@
},
],
},
+ "name": "A String", # The server-assigned name, which is only unique within the same service that
+ # originally returns it. If you use the default HTTP mapping, the
+ # `name` should be a resource name ending with `operations/{unique_id}`.
"metadata": { # Service-specific metadata associated with the operation. It typically
# contains progress information and common metadata such as create time.
# Some services might not provide such metadata. Any method that returns a
# long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
- "done": True or False, # If the value is `false`, it means the operation is still in progress.
- # If `true`, the operation is completed, and either `error` or `response` is
- # available.
},
],
- "createTime": "A String", # Output only. Timestamp when this model was created in Firebase ML.
+ "updateTime": "A String", # Output only. Timestamp when this model was updated in Firebase ML.
"state": { # State common to all model types. # State common to all model types.
# Includes publishing and validation information.
# Includes publishing and validation information.
- "published": True or False, # Indicates if this model has been published.
"validationError": { # The `Status` type defines a logical error model that is suitable for # Output only. Indicates the latest validation error on the model if any.
# A model may have validation errors if there were problems during
# the model creation/update.
@@ -639,8 +629,18 @@
},
],
},
+ "published": True or False, # Indicates if this model has been published.
},
- "updateTime": "A String", # Output only. Timestamp when this model was updated in Firebase ML.
+ "tfliteModel": { # Information that is specific to TfLite models. # A TFLite Model
+ "sizeBytes": "A String", # Output only. The size of the TFLite model
+ "gcsTfliteUri": "A String", # The TfLite file containing the model. (Stored in Google Cloud).
+ # The gcs_tflite_uri should have form: gs://some-bucket/some-model.tflite
+ # Note: If you update the file in the original location, it is
+ # necessary to call UpdateModel for ML to pick up and validate the
+ # updated file.
+ },
+ "etag": "A String", # Output only. See RFC7232
+ # https://tools.ietf.org/html/rfc7232#section-2.3
}
updateMask: string, The update mask
@@ -654,6 +654,9 @@
{ # This resource represents a long-running operation that is the result of a
# network API call.
+ "done": True or False, # If the value is `false`, it means the operation is still in progress.
+ # If `true`, the operation is completed, and either `error` or `response` is
+ # available.
"response": { # The normal response of the operation in case of success. If the original
# method returns no data on success, such as `Delete`, the response is
# `google.protobuf.Empty`. If the original method is standard
@@ -664,9 +667,6 @@
# `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
- "name": "A String", # The server-assigned name, which is only unique within the same service that
- # originally returns it. If you use the default HTTP mapping, the
- # `name` should be a resource name ending with `operations/{unique_id}`.
"error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
# different programming environments, including REST APIs and RPC APIs. It is
# used by [gRPC](https://github.com/grpc). Each `Status` message contains
@@ -685,15 +685,15 @@
},
],
},
+ "name": "A String", # The server-assigned name, which is only unique within the same service that
+ # originally returns it. If you use the default HTTP mapping, the
+ # `name` should be a resource name ending with `operations/{unique_id}`.
"metadata": { # Service-specific metadata associated with the operation. It typically
# contains progress information and common metadata such as create time.
# Some services might not provide such metadata. Any method that returns a
# long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
- "done": True or False, # If the value is `false`, it means the operation is still in progress.
- # If `true`, the operation is completed, and either `error` or `response` is
- # available.
}</pre>
</div>