Class: Google::Cloud::AutoML::V1beta1::Model

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/automl/v1beta1/model.rb

Overview

API proto representing a trained machine learning model.

Defined Under Namespace

Modules: DeploymentState

Instance Attribute Summary collapse

Instance Attribute Details

#create_time ⇒ ::Google::Protobuf::Timestamp

Returns Output only. Timestamp when the model training finished and can be used for prediction.

Returns:



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'proto_docs/google/cloud/automl/v1beta1/model.rb', line 94

class Model
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Deployment state of the model.
  module DeploymentState
    # Should not be used, an un-set enum has this value by default.
    DEPLOYMENT_STATE_UNSPECIFIED = 0

    # Model is deployed.
    DEPLOYED = 1

    # Model is not deployed.
    UNDEPLOYED = 2
  end
end

#dataset_id ⇒ ::String

Returns Required. The resource ID of the dataset used to create the model. The dataset must come from the same ancestor project and location.

Returns:

  • (::String) —

    Required. The resource ID of the dataset used to create the model. The dataset must come from the same ancestor project and location.



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'proto_docs/google/cloud/automl/v1beta1/model.rb', line 94

class Model
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Deployment state of the model.
  module DeploymentState
    # Should not be used, an un-set enum has this value by default.
    DEPLOYMENT_STATE_UNSPECIFIED = 0

    # Model is deployed.
    DEPLOYED = 1

    # Model is not deployed.
    UNDEPLOYED = 2
  end
end

#deployment_state ⇒ ::Google::Cloud::AutoML::V1beta1::Model::DeploymentState

Returns Output only. Deployment state of the model. A model can only serve prediction requests after it gets deployed.

Returns:



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'proto_docs/google/cloud/automl/v1beta1/model.rb', line 94

class Model
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Deployment state of the model.
  module DeploymentState
    # Should not be used, an un-set enum has this value by default.
    DEPLOYMENT_STATE_UNSPECIFIED = 0

    # Model is deployed.
    DEPLOYED = 1

    # Model is not deployed.
    UNDEPLOYED = 2
  end
end

#display_name ⇒ ::String

Returns 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.

Returns:

  • (::String) —

    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.



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'proto_docs/google/cloud/automl/v1beta1/model.rb', line 94

class Model
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Deployment state of the model.
  module DeploymentState
    # Should not be used, an un-set enum has this value by default.
    DEPLOYMENT_STATE_UNSPECIFIED = 0

    # Model is deployed.
    DEPLOYED = 1

    # Model is not deployed.
    UNDEPLOYED = 2
  end
end

#image_classification_model_metadata ⇒ ::Google::Cloud::AutoML::V1beta1::ImageClassificationModelMetadata

Returns Metadata for image classification models.

Note: The following fields are mutually exclusive: image_classification_model_metadata, translation_model_metadata, text_classification_model_metadata, image_object_detection_model_metadata, video_classification_model_metadata, video_object_tracking_model_metadata, text_extraction_model_metadata, tables_model_metadata, text_sentiment_model_metadata. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Cloud::AutoML::V1beta1::ImageClassificationModelMetadata) —

    Metadata for image classification models.

    Note: The following fields are mutually exclusive: image_classification_model_metadata, translation_model_metadata, text_classification_model_metadata, image_object_detection_model_metadata, video_classification_model_metadata, video_object_tracking_model_metadata, text_extraction_model_metadata, tables_model_metadata, text_sentiment_model_metadata. If a field in that set is populated, all other fields in the set will automatically be cleared.



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'proto_docs/google/cloud/automl/v1beta1/model.rb', line 94

class Model
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Deployment state of the model.
  module DeploymentState
    # Should not be used, an un-set enum has this value by default.
    DEPLOYMENT_STATE_UNSPECIFIED = 0

    # Model is deployed.
    DEPLOYED = 1

    # Model is not deployed.
    UNDEPLOYED = 2
  end
end

#image_object_detection_model_metadata ⇒ ::Google::Cloud::AutoML::V1beta1::ImageObjectDetectionModelMetadata

Returns Metadata for image object detection models.

Note: The following fields are mutually exclusive: image_object_detection_model_metadata, translation_model_metadata, image_classification_model_metadata, text_classification_model_metadata, video_classification_model_metadata, video_object_tracking_model_metadata, text_extraction_model_metadata, tables_model_metadata, text_sentiment_model_metadata. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Cloud::AutoML::V1beta1::ImageObjectDetectionModelMetadata) —

    Metadata for image object detection models.

    Note: The following fields are mutually exclusive: image_object_detection_model_metadata, translation_model_metadata, image_classification_model_metadata, text_classification_model_metadata, video_classification_model_metadata, video_object_tracking_model_metadata, text_extraction_model_metadata, tables_model_metadata, text_sentiment_model_metadata. If a field in that set is populated, all other fields in the set will automatically be cleared.



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'proto_docs/google/cloud/automl/v1beta1/model.rb', line 94

class Model
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Deployment state of the model.
  module DeploymentState
    # Should not be used, an un-set enum has this value by default.
    DEPLOYMENT_STATE_UNSPECIFIED = 0

    # Model is deployed.
    DEPLOYED = 1

    # Model is not deployed.
    UNDEPLOYED = 2
  end
end

#name ⇒ ::String

Returns Output only. Resource name of the model. Format: projects/{project_id}/locations/{location_id}/models/{model_id}.

Returns:

  • (::String) —

    Output only. Resource name of the model. Format: projects/{project_id}/locations/{location_id}/models/{model_id}



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'proto_docs/google/cloud/automl/v1beta1/model.rb', line 94

class Model
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Deployment state of the model.
  module DeploymentState
    # Should not be used, an un-set enum has this value by default.
    DEPLOYMENT_STATE_UNSPECIFIED = 0

    # Model is deployed.
    DEPLOYED = 1

    # Model is not deployed.
    UNDEPLOYED = 2
  end
end

#tables_model_metadata ⇒ ::Google::Cloud::AutoML::V1beta1::TablesModelMetadata

Returns Metadata for Tables models.

Note: The following fields are mutually exclusive: tables_model_metadata, translation_model_metadata, image_classification_model_metadata, text_classification_model_metadata, image_object_detection_model_metadata, video_classification_model_metadata, video_object_tracking_model_metadata, text_extraction_model_metadata, text_sentiment_model_metadata. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Cloud::AutoML::V1beta1::TablesModelMetadata) —

    Metadata for Tables models.

    Note: The following fields are mutually exclusive: tables_model_metadata, translation_model_metadata, image_classification_model_metadata, text_classification_model_metadata, image_object_detection_model_metadata, video_classification_model_metadata, video_object_tracking_model_metadata, text_extraction_model_metadata, text_sentiment_model_metadata. If a field in that set is populated, all other fields in the set will automatically be cleared.



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'proto_docs/google/cloud/automl/v1beta1/model.rb', line 94

class Model
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Deployment state of the model.
  module DeploymentState
    # Should not be used, an un-set enum has this value by default.
    DEPLOYMENT_STATE_UNSPECIFIED = 0

    # Model is deployed.
    DEPLOYED = 1

    # Model is not deployed.
    UNDEPLOYED = 2
  end
end

#text_classification_model_metadata ⇒ ::Google::Cloud::AutoML::V1beta1::TextClassificationModelMetadata

Returns Metadata for text classification models.

Note: The following fields are mutually exclusive: text_classification_model_metadata, translation_model_metadata, image_classification_model_metadata, image_object_detection_model_metadata, video_classification_model_metadata, video_object_tracking_model_metadata, text_extraction_model_metadata, tables_model_metadata, text_sentiment_model_metadata. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Cloud::AutoML::V1beta1::TextClassificationModelMetadata) —

    Metadata for text classification models.

    Note: The following fields are mutually exclusive: text_classification_model_metadata, translation_model_metadata, image_classification_model_metadata, image_object_detection_model_metadata, video_classification_model_metadata, video_object_tracking_model_metadata, text_extraction_model_metadata, tables_model_metadata, text_sentiment_model_metadata. If a field in that set is populated, all other fields in the set will automatically be cleared.



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'proto_docs/google/cloud/automl/v1beta1/model.rb', line 94

class Model
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Deployment state of the model.
  module DeploymentState
    # Should not be used, an un-set enum has this value by default.
    DEPLOYMENT_STATE_UNSPECIFIED = 0

    # Model is deployed.
    DEPLOYED = 1

    # Model is not deployed.
    UNDEPLOYED = 2
  end
end

#text_extraction_model_metadata ⇒ ::Google::Cloud::AutoML::V1beta1::TextExtractionModelMetadata

Returns Metadata for text extraction models.

Note: The following fields are mutually exclusive: text_extraction_model_metadata, translation_model_metadata, image_classification_model_metadata, text_classification_model_metadata, image_object_detection_model_metadata, video_classification_model_metadata, video_object_tracking_model_metadata, tables_model_metadata, text_sentiment_model_metadata. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Cloud::AutoML::V1beta1::TextExtractionModelMetadata) —

    Metadata for text extraction models.

    Note: The following fields are mutually exclusive: text_extraction_model_metadata, translation_model_metadata, image_classification_model_metadata, text_classification_model_metadata, image_object_detection_model_metadata, video_classification_model_metadata, video_object_tracking_model_metadata, tables_model_metadata, text_sentiment_model_metadata. If a field in that set is populated, all other fields in the set will automatically be cleared.



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'proto_docs/google/cloud/automl/v1beta1/model.rb', line 94

class Model
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Deployment state of the model.
  module DeploymentState
    # Should not be used, an un-set enum has this value by default.
    DEPLOYMENT_STATE_UNSPECIFIED = 0

    # Model is deployed.
    DEPLOYED = 1

    # Model is not deployed.
    UNDEPLOYED = 2
  end
end

#text_sentiment_model_metadata ⇒ ::Google::Cloud::AutoML::V1beta1::TextSentimentModelMetadata

Returns Metadata for text sentiment models.

Note: The following fields are mutually exclusive: text_sentiment_model_metadata, translation_model_metadata, image_classification_model_metadata, text_classification_model_metadata, image_object_detection_model_metadata, video_classification_model_metadata, video_object_tracking_model_metadata, text_extraction_model_metadata, tables_model_metadata. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Cloud::AutoML::V1beta1::TextSentimentModelMetadata) —

    Metadata for text sentiment models.

    Note: The following fields are mutually exclusive: text_sentiment_model_metadata, translation_model_metadata, image_classification_model_metadata, text_classification_model_metadata, image_object_detection_model_metadata, video_classification_model_metadata, video_object_tracking_model_metadata, text_extraction_model_metadata, tables_model_metadata. If a field in that set is populated, all other fields in the set will automatically be cleared.



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'proto_docs/google/cloud/automl/v1beta1/model.rb', line 94

class Model
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Deployment state of the model.
  module DeploymentState
    # Should not be used, an un-set enum has this value by default.
    DEPLOYMENT_STATE_UNSPECIFIED = 0

    # Model is deployed.
    DEPLOYED = 1

    # Model is not deployed.
    UNDEPLOYED = 2
  end
end

#translation_model_metadata ⇒ ::Google::Cloud::AutoML::V1beta1::TranslationModelMetadata

Returns Metadata for translation models.

Note: The following fields are mutually exclusive: translation_model_metadata, image_classification_model_metadata, text_classification_model_metadata, image_object_detection_model_metadata, video_classification_model_metadata, video_object_tracking_model_metadata, text_extraction_model_metadata, tables_model_metadata, text_sentiment_model_metadata. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Cloud::AutoML::V1beta1::TranslationModelMetadata) —

    Metadata for translation models.

    Note: The following fields are mutually exclusive: translation_model_metadata, image_classification_model_metadata, text_classification_model_metadata, image_object_detection_model_metadata, video_classification_model_metadata, video_object_tracking_model_metadata, text_extraction_model_metadata, tables_model_metadata, text_sentiment_model_metadata. If a field in that set is populated, all other fields in the set will automatically be cleared.



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'proto_docs/google/cloud/automl/v1beta1/model.rb', line 94

class Model
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Deployment state of the model.
  module DeploymentState
    # Should not be used, an un-set enum has this value by default.
    DEPLOYMENT_STATE_UNSPECIFIED = 0

    # Model is deployed.
    DEPLOYED = 1

    # Model is not deployed.
    UNDEPLOYED = 2
  end
end

#update_time ⇒ ::Google::Protobuf::Timestamp

Returns Output only. Timestamp when this model was last updated.

Returns:



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'proto_docs/google/cloud/automl/v1beta1/model.rb', line 94

class Model
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Deployment state of the model.
  module DeploymentState
    # Should not be used, an un-set enum has this value by default.
    DEPLOYMENT_STATE_UNSPECIFIED = 0

    # Model is deployed.
    DEPLOYED = 1

    # Model is not deployed.
    UNDEPLOYED = 2
  end
end

#video_classification_model_metadata ⇒ ::Google::Cloud::AutoML::V1beta1::VideoClassificationModelMetadata

Returns Metadata for video classification models.

Note: The following fields are mutually exclusive: video_classification_model_metadata, translation_model_metadata, image_classification_model_metadata, text_classification_model_metadata, image_object_detection_model_metadata, video_object_tracking_model_metadata, text_extraction_model_metadata, tables_model_metadata, text_sentiment_model_metadata. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Cloud::AutoML::V1beta1::VideoClassificationModelMetadata) —

    Metadata for video classification models.

    Note: The following fields are mutually exclusive: video_classification_model_metadata, translation_model_metadata, image_classification_model_metadata, text_classification_model_metadata, image_object_detection_model_metadata, video_object_tracking_model_metadata, text_extraction_model_metadata, tables_model_metadata, text_sentiment_model_metadata. If a field in that set is populated, all other fields in the set will automatically be cleared.



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'proto_docs/google/cloud/automl/v1beta1/model.rb', line 94

class Model
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Deployment state of the model.
  module DeploymentState
    # Should not be used, an un-set enum has this value by default.
    DEPLOYMENT_STATE_UNSPECIFIED = 0

    # Model is deployed.
    DEPLOYED = 1

    # Model is not deployed.
    UNDEPLOYED = 2
  end
end

#video_object_tracking_model_metadata ⇒ ::Google::Cloud::AutoML::V1beta1::VideoObjectTrackingModelMetadata

Returns Metadata for video object tracking models.

Note: The following fields are mutually exclusive: video_object_tracking_model_metadata, translation_model_metadata, image_classification_model_metadata, text_classification_model_metadata, image_object_detection_model_metadata, video_classification_model_metadata, text_extraction_model_metadata, tables_model_metadata, text_sentiment_model_metadata. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Cloud::AutoML::V1beta1::VideoObjectTrackingModelMetadata) —

    Metadata for video object tracking models.

    Note: The following fields are mutually exclusive: video_object_tracking_model_metadata, translation_model_metadata, image_classification_model_metadata, text_classification_model_metadata, image_object_detection_model_metadata, video_classification_model_metadata, text_extraction_model_metadata, tables_model_metadata, text_sentiment_model_metadata. If a field in that set is populated, all other fields in the set will automatically be cleared.



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'proto_docs/google/cloud/automl/v1beta1/model.rb', line 94

class Model
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Deployment state of the model.
  module DeploymentState
    # Should not be used, an un-set enum has this value by default.
    DEPLOYMENT_STATE_UNSPECIFIED = 0

    # Model is deployed.
    DEPLOYED = 1

    # Model is not deployed.
    UNDEPLOYED = 2
  end
end