Class: Google::Cloud::AutoML::V1beta1::ModelEvaluation

Inherits:

Object

• Object
• Google::Cloud::AutoML::V1beta1::ModelEvaluation

Extended by:

Protobuf::MessageExts::ClassMethods

Includes:

Protobuf::MessageExts

Defined in:

proto_docs/google/cloud/automl/v1beta1/model_evaluation.rb

Overview

Evaluation results of a model.

Instance Attribute Summary

• #annotation_spec_id ⇒ ::String

  Output only.

• #classification_evaluation_metrics ⇒ ::Google::Cloud::AutoML::V1beta1::ClassificationEvaluationMetrics

  Model evaluation metrics for image, text, video and tables classification.

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

  Output only.

• #display_name ⇒ ::String

  Output only.

• #evaluated_example_count ⇒ ::Integer

  Output only.

• #image_object_detection_evaluation_metrics ⇒ ::Google::Cloud::AutoML::V1beta1::ImageObjectDetectionEvaluationMetrics

  Model evaluation metrics for image object detection.

• #name ⇒ ::String

  Output only.

• #regression_evaluation_metrics ⇒ ::Google::Cloud::AutoML::V1beta1::RegressionEvaluationMetrics

  Model evaluation metrics for Tables regression.

• #text_extraction_evaluation_metrics ⇒ ::Google::Cloud::AutoML::V1beta1::TextExtractionEvaluationMetrics

  Evaluation metrics for text extraction models.

• #text_sentiment_evaluation_metrics ⇒ ::Google::Cloud::AutoML::V1beta1::TextSentimentEvaluationMetrics

  Evaluation metrics for text sentiment models.

• #translation_evaluation_metrics ⇒ ::Google::Cloud::AutoML::V1beta1::TranslationEvaluationMetrics

  Model evaluation metrics for translation.

• #video_object_tracking_evaluation_metrics ⇒ ::Google::Cloud::AutoML::V1beta1::VideoObjectTrackingEvaluationMetrics

  Model evaluation metrics for video object tracking.

Instance Attribute Details

#annotation_spec_id ⇒ ::String

Returns Output only. The ID of the annotation spec that the model evaluation applies to. The The ID is empty for the overall model evaluation. For Tables annotation specs in the dataset do not exist and this ID is always not set, but for CLASSIFICATION

[prediction_type-s][google.cloud.automl.v1beta1.TablesModelMetadata.prediction_type] the display_name field is used.

Returns:

• (::String) —

  Output only. The ID of the annotation spec that the model evaluation applies to. The The ID is empty for the overall model evaluation. For Tables annotation specs in the dataset do not exist and this ID is always not set, but for CLASSIFICATION

  [prediction_type-s][google.cloud.automl.v1beta1.TablesModelMetadata.prediction_type] the display_name field is used.

# File 'proto_docs/google/cloud/automl/v1beta1/model_evaluation.rb', line 110

class ModelEvaluation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#classification_evaluation_metrics ⇒ ::Google::Cloud::AutoML::V1beta1::ClassificationEvaluationMetrics

Returns Model evaluation metrics for image, text, video and tables classification. Tables problem is considered a classification when the target column is CATEGORY DataType.

Note: The following fields are mutually exclusive: classification_evaluation_metrics, regression_evaluation_metrics, translation_evaluation_metrics, image_object_detection_evaluation_metrics, video_object_tracking_evaluation_metrics, text_sentiment_evaluation_metrics, text_extraction_evaluation_metrics. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

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

  Model evaluation metrics for image, text, video and tables classification. Tables problem is considered a classification when the target column is CATEGORY DataType.

  Note: The following fields are mutually exclusive: classification_evaluation_metrics, regression_evaluation_metrics, translation_evaluation_metrics, image_object_detection_evaluation_metrics, video_object_tracking_evaluation_metrics, text_sentiment_evaluation_metrics, text_extraction_evaluation_metrics. If a field in that set is populated, all other fields in the set will automatically be cleared.

# File 'proto_docs/google/cloud/automl/v1beta1/model_evaluation.rb', line 110

class ModelEvaluation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

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

Returns Output only. Timestamp when this model evaluation was created.

Returns:

• (::Google::Protobuf::Timestamp) —

  Output only. Timestamp when this model evaluation was created.

# File 'proto_docs/google/cloud/automl/v1beta1/model_evaluation.rb', line 110

class ModelEvaluation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#display_name ⇒ ::String

Returns Output only. The value of display_name at the moment when the model was trained. Because this field returns a value at model training time, for different models trained from the same dataset, the values may differ, since display names could had been changed between the two model's trainings. For Tables CLASSIFICATION

[prediction_type-s][google.cloud.automl.v1beta1.TablesModelMetadata.prediction_type] distinct values of the target column at the moment of the model evaluation are populated here. The display_name is empty for the overall model evaluation.

Returns:

• (::String) —

  Output only. The value of display_name at the moment when the model was trained. Because this field returns a value at model training time, for different models trained from the same dataset, the values may differ, since display names could had been changed between the two model's trainings. For Tables CLASSIFICATION

  [prediction_type-s][google.cloud.automl.v1beta1.TablesModelMetadata.prediction_type] distinct values of the target column at the moment of the model evaluation are populated here. The display_name is empty for the overall model evaluation.

# File 'proto_docs/google/cloud/automl/v1beta1/model_evaluation.rb', line 110

class ModelEvaluation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#evaluated_example_count ⇒ ::Integer

Returns Output only. The number of examples used for model evaluation, i.e. for which ground truth from time of model creation is compared against the predicted annotations created by the model. For overall ModelEvaluation (i.e. with annotation_spec_id not set) this is the total number of all examples used for evaluation. Otherwise, this is the count of examples that according to the ground truth were annotated by the

annotation_spec_id.

Returns:

• (::Integer) —

  Output only. The number of examples used for model evaluation, i.e. for which ground truth from time of model creation is compared against the predicted annotations created by the model. For overall ModelEvaluation (i.e. with annotation_spec_id not set) this is the total number of all examples used for evaluation. Otherwise, this is the count of examples that according to the ground truth were annotated by the

  annotation_spec_id.

# File 'proto_docs/google/cloud/automl/v1beta1/model_evaluation.rb', line 110

class ModelEvaluation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#image_object_detection_evaluation_metrics ⇒ ::Google::Cloud::AutoML::V1beta1::ImageObjectDetectionEvaluationMetrics

Returns Model evaluation metrics for image object detection.

Note: The following fields are mutually exclusive: image_object_detection_evaluation_metrics, classification_evaluation_metrics, regression_evaluation_metrics, translation_evaluation_metrics, video_object_tracking_evaluation_metrics, text_sentiment_evaluation_metrics, text_extraction_evaluation_metrics. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

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

  Model evaluation metrics for image object detection.

  Note: The following fields are mutually exclusive: image_object_detection_evaluation_metrics, classification_evaluation_metrics, regression_evaluation_metrics, translation_evaluation_metrics, video_object_tracking_evaluation_metrics, text_sentiment_evaluation_metrics, text_extraction_evaluation_metrics. If a field in that set is populated, all other fields in the set will automatically be cleared.

# File 'proto_docs/google/cloud/automl/v1beta1/model_evaluation.rb', line 110

class ModelEvaluation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#name ⇒ ::String

Returns Output only. Resource name of the model evaluation. Format:

projects/{project_id}/locations/{location_id}/models/{model_id}/modelEvaluations/{model_evaluation_id}.

Returns:

• (::String) —

  Output only. Resource name of the model evaluation. Format:

  projects/{project_id}/locations/{location_id}/models/{model_id}/modelEvaluations/{model_evaluation_id}

# File 'proto_docs/google/cloud/automl/v1beta1/model_evaluation.rb', line 110

class ModelEvaluation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#regression_evaluation_metrics ⇒ ::Google::Cloud::AutoML::V1beta1::RegressionEvaluationMetrics

Returns Model evaluation metrics for Tables regression. Tables problem is considered a regression when the target column has FLOAT64 DataType.

Note: The following fields are mutually exclusive: regression_evaluation_metrics, classification_evaluation_metrics, translation_evaluation_metrics, image_object_detection_evaluation_metrics, video_object_tracking_evaluation_metrics, text_sentiment_evaluation_metrics, text_extraction_evaluation_metrics. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

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

  Model evaluation metrics for Tables regression. Tables problem is considered a regression when the target column has FLOAT64 DataType.

  Note: The following fields are mutually exclusive: regression_evaluation_metrics, classification_evaluation_metrics, translation_evaluation_metrics, image_object_detection_evaluation_metrics, video_object_tracking_evaluation_metrics, text_sentiment_evaluation_metrics, text_extraction_evaluation_metrics. If a field in that set is populated, all other fields in the set will automatically be cleared.

# File 'proto_docs/google/cloud/automl/v1beta1/model_evaluation.rb', line 110

class ModelEvaluation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#text_extraction_evaluation_metrics ⇒ ::Google::Cloud::AutoML::V1beta1::TextExtractionEvaluationMetrics

Returns Evaluation metrics for text extraction models.

Note: The following fields are mutually exclusive: text_extraction_evaluation_metrics, classification_evaluation_metrics, regression_evaluation_metrics, translation_evaluation_metrics, image_object_detection_evaluation_metrics, video_object_tracking_evaluation_metrics, text_sentiment_evaluation_metrics. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

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

  Evaluation metrics for text extraction models.

  Note: The following fields are mutually exclusive: text_extraction_evaluation_metrics, classification_evaluation_metrics, regression_evaluation_metrics, translation_evaluation_metrics, image_object_detection_evaluation_metrics, video_object_tracking_evaluation_metrics, text_sentiment_evaluation_metrics. If a field in that set is populated, all other fields in the set will automatically be cleared.

# File 'proto_docs/google/cloud/automl/v1beta1/model_evaluation.rb', line 110

class ModelEvaluation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#text_sentiment_evaluation_metrics ⇒ ::Google::Cloud::AutoML::V1beta1::TextSentimentEvaluationMetrics

Returns Evaluation metrics for text sentiment models.

Note: The following fields are mutually exclusive: text_sentiment_evaluation_metrics, classification_evaluation_metrics, regression_evaluation_metrics, translation_evaluation_metrics, image_object_detection_evaluation_metrics, video_object_tracking_evaluation_metrics, text_extraction_evaluation_metrics. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

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

  Evaluation metrics for text sentiment models.

  Note: The following fields are mutually exclusive: text_sentiment_evaluation_metrics, classification_evaluation_metrics, regression_evaluation_metrics, translation_evaluation_metrics, image_object_detection_evaluation_metrics, video_object_tracking_evaluation_metrics, text_extraction_evaluation_metrics. If a field in that set is populated, all other fields in the set will automatically be cleared.

# File 'proto_docs/google/cloud/automl/v1beta1/model_evaluation.rb', line 110

class ModelEvaluation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#translation_evaluation_metrics ⇒ ::Google::Cloud::AutoML::V1beta1::TranslationEvaluationMetrics

Returns Model evaluation metrics for translation.

Note: The following fields are mutually exclusive: translation_evaluation_metrics, classification_evaluation_metrics, regression_evaluation_metrics, image_object_detection_evaluation_metrics, video_object_tracking_evaluation_metrics, text_sentiment_evaluation_metrics, text_extraction_evaluation_metrics. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

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

  Model evaluation metrics for translation.

  Note: The following fields are mutually exclusive: translation_evaluation_metrics, classification_evaluation_metrics, regression_evaluation_metrics, image_object_detection_evaluation_metrics, video_object_tracking_evaluation_metrics, text_sentiment_evaluation_metrics, text_extraction_evaluation_metrics. If a field in that set is populated, all other fields in the set will automatically be cleared.

# File 'proto_docs/google/cloud/automl/v1beta1/model_evaluation.rb', line 110

class ModelEvaluation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#video_object_tracking_evaluation_metrics ⇒ ::Google::Cloud::AutoML::V1beta1::VideoObjectTrackingEvaluationMetrics

Returns Model evaluation metrics for video object tracking.

Note: The following fields are mutually exclusive: video_object_tracking_evaluation_metrics, classification_evaluation_metrics, regression_evaluation_metrics, translation_evaluation_metrics, image_object_detection_evaluation_metrics, text_sentiment_evaluation_metrics, text_extraction_evaluation_metrics. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

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

  Model evaluation metrics for video object tracking.

  Note: The following fields are mutually exclusive: video_object_tracking_evaluation_metrics, classification_evaluation_metrics, regression_evaluation_metrics, translation_evaluation_metrics, image_object_detection_evaluation_metrics, text_sentiment_evaluation_metrics, text_extraction_evaluation_metrics. If a field in that set is populated, all other fields in the set will automatically be cleared.

# File 'proto_docs/google/cloud/automl/v1beta1/model_evaluation.rb', line 110

class ModelEvaluation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end