Class: Google::Cloud::AIPlatform::V1::EvaluatedAnnotation

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/aiplatform/v1/evaluated_annotation.rb

Overview

True positive, false positive, or false negative.

EvaluatedAnnotation is only available under ModelEvaluationSlice with slice of annotationSpec dimension.

Defined Under Namespace

Modules: EvaluatedAnnotationType

Instance Attribute Summary collapse

Instance Attribute Details

#data_item_payload ⇒ ::Google::Protobuf::Value (readonly)

Returns Output only. The data item payload that the Model predicted this EvaluatedAnnotation on.

Returns:



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'proto_docs/google/cloud/aiplatform/v1/evaluated_annotation.rb', line 95

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

  # Describes the type of the EvaluatedAnnotation. The type is determined
  module EvaluatedAnnotationType
    # Invalid value.
    EVALUATED_ANNOTATION_TYPE_UNSPECIFIED = 0

    # The EvaluatedAnnotation is a true positive. It has a prediction created
    # by the Model and a ground truth Annotation which the prediction matches.
    TRUE_POSITIVE = 1

    # The EvaluatedAnnotation is false positive. It has a prediction created by
    # the Model which does not match any ground truth annotation.
    FALSE_POSITIVE = 2

    # The EvaluatedAnnotation is false negative. It has a ground truth
    # annotation which is not matched by any of the model created predictions.
    FALSE_NEGATIVE = 3
  end
end

#error_analysis_annotations ⇒ ::Array<::Google::Cloud::AIPlatform::V1::ErrorAnalysisAnnotation>

Returns Annotations of model error analysis results.

Returns:



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'proto_docs/google/cloud/aiplatform/v1/evaluated_annotation.rb', line 95

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

  # Describes the type of the EvaluatedAnnotation. The type is determined
  module EvaluatedAnnotationType
    # Invalid value.
    EVALUATED_ANNOTATION_TYPE_UNSPECIFIED = 0

    # The EvaluatedAnnotation is a true positive. It has a prediction created
    # by the Model and a ground truth Annotation which the prediction matches.
    TRUE_POSITIVE = 1

    # The EvaluatedAnnotation is false positive. It has a prediction created by
    # the Model which does not match any ground truth annotation.
    FALSE_POSITIVE = 2

    # The EvaluatedAnnotation is false negative. It has a ground truth
    # annotation which is not matched by any of the model created predictions.
    FALSE_NEGATIVE = 3
  end
end

#evaluated_data_item_view_id ⇒ ::String (readonly)

Returns Output only. ID of the EvaluatedDataItemView under the same ancestor ModelEvaluation. The EvaluatedDataItemView consists of all ground truths and predictions on data_item_payload.

Returns:

  • (::String) —

    Output only. ID of the EvaluatedDataItemView under the same ancestor ModelEvaluation. The EvaluatedDataItemView consists of all ground truths and predictions on data_item_payload.



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'proto_docs/google/cloud/aiplatform/v1/evaluated_annotation.rb', line 95

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

  # Describes the type of the EvaluatedAnnotation. The type is determined
  module EvaluatedAnnotationType
    # Invalid value.
    EVALUATED_ANNOTATION_TYPE_UNSPECIFIED = 0

    # The EvaluatedAnnotation is a true positive. It has a prediction created
    # by the Model and a ground truth Annotation which the prediction matches.
    TRUE_POSITIVE = 1

    # The EvaluatedAnnotation is false positive. It has a prediction created by
    # the Model which does not match any ground truth annotation.
    FALSE_POSITIVE = 2

    # The EvaluatedAnnotation is false negative. It has a ground truth
    # annotation which is not matched by any of the model created predictions.
    FALSE_NEGATIVE = 3
  end
end

#explanations ⇒ ::Array<::Google::Cloud::AIPlatform::V1::EvaluatedAnnotationExplanation>

Returns Explanations of predictions. Each element of the explanations indicates the explanation for one explanation Method.

The attributions list in the EvaluatedAnnotationExplanation.explanation object corresponds to the predictions list. For example, the second element in the attributions list explains the second element in the predictions list.

Returns:



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'proto_docs/google/cloud/aiplatform/v1/evaluated_annotation.rb', line 95

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

  # Describes the type of the EvaluatedAnnotation. The type is determined
  module EvaluatedAnnotationType
    # Invalid value.
    EVALUATED_ANNOTATION_TYPE_UNSPECIFIED = 0

    # The EvaluatedAnnotation is a true positive. It has a prediction created
    # by the Model and a ground truth Annotation which the prediction matches.
    TRUE_POSITIVE = 1

    # The EvaluatedAnnotation is false positive. It has a prediction created by
    # the Model which does not match any ground truth annotation.
    FALSE_POSITIVE = 2

    # The EvaluatedAnnotation is false negative. It has a ground truth
    # annotation which is not matched by any of the model created predictions.
    FALSE_NEGATIVE = 3
  end
end

#ground_truths ⇒ ::Array<::Google::Protobuf::Value> (readonly)

Returns Output only. The ground truth Annotations, i.e. the Annotations that exist in the test data the Model is evaluated on.

For true positive, there is one and only one ground truth annotation, which matches the only prediction in predictions.

For false positive, there are zero or more ground truth annotations that are similar to the only prediction in predictions, but not enough for a match.

For false negative, there is one and only one ground truth annotation, which doesn't match any predictions created by the model.

The schema of the ground truth is stored in ModelEvaluation.annotation_schema_uri.

Returns:

  • (::Array<::Google::Protobuf::Value>) —

    Output only. The ground truth Annotations, i.e. the Annotations that exist in the test data the Model is evaluated on.

    For true positive, there is one and only one ground truth annotation, which matches the only prediction in predictions.

    For false positive, there are zero or more ground truth annotations that are similar to the only prediction in predictions, but not enough for a match.

    For false negative, there is one and only one ground truth annotation, which doesn't match any predictions created by the model.

    The schema of the ground truth is stored in ModelEvaluation.annotation_schema_uri



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'proto_docs/google/cloud/aiplatform/v1/evaluated_annotation.rb', line 95

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

  # Describes the type of the EvaluatedAnnotation. The type is determined
  module EvaluatedAnnotationType
    # Invalid value.
    EVALUATED_ANNOTATION_TYPE_UNSPECIFIED = 0

    # The EvaluatedAnnotation is a true positive. It has a prediction created
    # by the Model and a ground truth Annotation which the prediction matches.
    TRUE_POSITIVE = 1

    # The EvaluatedAnnotation is false positive. It has a prediction created by
    # the Model which does not match any ground truth annotation.
    FALSE_POSITIVE = 2

    # The EvaluatedAnnotation is false negative. It has a ground truth
    # annotation which is not matched by any of the model created predictions.
    FALSE_NEGATIVE = 3
  end
end

#predictions ⇒ ::Array<::Google::Protobuf::Value> (readonly)

Returns Output only. The model predicted annotations.

For true positive, there is one and only one prediction, which matches the only one ground truth annotation in ground_truths.

For false positive, there is one and only one prediction, which doesn't match any ground truth annotation of the corresponding [data_item_view_id][EvaluatedAnnotation.data_item_view_id].

For false negative, there are zero or more predictions which are similar to the only ground truth annotation in ground_truths but not enough for a match.

The schema of the prediction is stored in ModelEvaluation.annotation_schema_uri.

Returns:

  • (::Array<::Google::Protobuf::Value>) —

    Output only. The model predicted annotations.

    For true positive, there is one and only one prediction, which matches the only one ground truth annotation in ground_truths.

    For false positive, there is one and only one prediction, which doesn't match any ground truth annotation of the corresponding [data_item_view_id][EvaluatedAnnotation.data_item_view_id].

    For false negative, there are zero or more predictions which are similar to the only ground truth annotation in ground_truths but not enough for a match.

    The schema of the prediction is stored in ModelEvaluation.annotation_schema_uri



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'proto_docs/google/cloud/aiplatform/v1/evaluated_annotation.rb', line 95

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

  # Describes the type of the EvaluatedAnnotation. The type is determined
  module EvaluatedAnnotationType
    # Invalid value.
    EVALUATED_ANNOTATION_TYPE_UNSPECIFIED = 0

    # The EvaluatedAnnotation is a true positive. It has a prediction created
    # by the Model and a ground truth Annotation which the prediction matches.
    TRUE_POSITIVE = 1

    # The EvaluatedAnnotation is false positive. It has a prediction created by
    # the Model which does not match any ground truth annotation.
    FALSE_POSITIVE = 2

    # The EvaluatedAnnotation is false negative. It has a ground truth
    # annotation which is not matched by any of the model created predictions.
    FALSE_NEGATIVE = 3
  end
end

#type ⇒ ::Google::Cloud::AIPlatform::V1::EvaluatedAnnotation::EvaluatedAnnotationType (readonly)

Returns Output only. Type of the EvaluatedAnnotation.

Returns:



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'proto_docs/google/cloud/aiplatform/v1/evaluated_annotation.rb', line 95

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

  # Describes the type of the EvaluatedAnnotation. The type is determined
  module EvaluatedAnnotationType
    # Invalid value.
    EVALUATED_ANNOTATION_TYPE_UNSPECIFIED = 0

    # The EvaluatedAnnotation is a true positive. It has a prediction created
    # by the Model and a ground truth Annotation which the prediction matches.
    TRUE_POSITIVE = 1

    # The EvaluatedAnnotation is false positive. It has a prediction created by
    # the Model which does not match any ground truth annotation.
    FALSE_POSITIVE = 2

    # The EvaluatedAnnotation is false negative. It has a ground truth
    # annotation which is not matched by any of the model created predictions.
    FALSE_NEGATIVE = 3
  end
end