Class Model (2.12.0rc0)

Version 2.12.0-rc0

• 2.14.1 (latest)
• 2.14.0
• 2.13.5
• 2.12.0
• 2.11.4
• 2.10.1
• 2.9.0
• 2.8.3
• 2.7.3
• 2.6.0
• 2.5.2
• 2.4.2
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.0
• 1.0.3
• 0.10.0
• 0.9.0
• 0.8.0
• 0.7.1
• 0.6.0
• 0.5.0
• 0.4.0

Model(mapping=None, *, ignore_unknown_fields=False, **kwargs)

API proto representing a trained machine learning model.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Attributes
Name	Description
translation_model_metadata	google.cloud.automl_v1.types.TranslationModelMetadata Metadata for translation models. This field is a member of oneof_ model_metadata.
image_classification_model_metadata	google.cloud.automl_v1.types.ImageClassificationModelMetadata Metadata for image classification models. This field is a member of oneof_ model_metadata.
text_classification_model_metadata	google.cloud.automl_v1.types.TextClassificationModelMetadata Metadata for text classification models. This field is a member of oneof_ model_metadata.
image_object_detection_model_metadata	google.cloud.automl_v1.types.ImageObjectDetectionModelMetadata Metadata for image object detection models. This field is a member of oneof_ model_metadata.
text_extraction_model_metadata	google.cloud.automl_v1.types.TextExtractionModelMetadata Metadata for text extraction models. This field is a member of oneof_ model_metadata.
text_sentiment_model_metadata	google.cloud.automl_v1.types.TextSentimentModelMetadata Metadata for text sentiment models. This field is a member of oneof_ model_metadata.
name	str Output only. Resource name of the model. Format: projects/{project_id}/locations/{location_id}/models/{model_id}
display_name	str Required. The name of the model to show in the interface. 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.
dataset_id	str Required. The resource ID of the dataset used to create the model. The dataset must come from the same ancestor project and location.
create_time	google.protobuf.timestamp_pb2.Timestamp Output only. Timestamp when the model training finished and can be used for prediction.
update_time	google.protobuf.timestamp_pb2.Timestamp Output only. Timestamp when this model was last updated.
deployment_state	google.cloud.automl_v1.types.Model.DeploymentState Output only. Deployment state of the model. A model can only serve prediction requests after it gets deployed.
etag	str Used to perform a consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
labels	MutableMapping[str, str] Optional. The labels with user-defined metadata to organize your model. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter. See https://goo.gl/xmQnxf for more information on and examples of labels.

Classes

DeploymentState

DeploymentState(value)

Deployment state of the model.

Values: DEPLOYMENT_STATE_UNSPECIFIED (0): Should not be used, an un-set enum has this value by default. DEPLOYED (1): Model is deployed. UNDEPLOYED (2): Model is not deployed.

LabelsEntry

LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The abstract base class for a message.

Parameters
Name	Description
kwargs	dict Keys and values corresponding to the fields of the message.
mapping	Union[dict, .Message] A dictionary or message to be used to determine the values for this message.
ignore_unknown_fields	Optional(bool) If True, do not raise errors for unknown fields. Only applied if mapping is a mapping type or there are keyword parameters.