Class: Google::Cloud::DocumentAI::V1beta3::Evaluation::MultiConfidenceMetrics

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/documentai/v1beta3/evaluation.rb

Overview

Metrics across multiple confidence levels.

Defined Under Namespace

Modules: MetricsType

Instance Attribute Summary collapse

Instance Attribute Details

#auprc ⇒ ::Float

Returns The calculated area under the precision recall curve (AUPRC), computed by integrating over all confidence thresholds.

Returns:

  • (::Float) —

    The calculated area under the precision recall curve (AUPRC), computed by integrating over all confidence thresholds.



149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
 
# File 'proto_docs/google/cloud/documentai/v1beta3/evaluation.rb', line 149

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

  # A type that determines how metrics should be interpreted.
  module MetricsType
    # The metrics type is unspecified. By default, metrics without a
    # particular specification are for leaf entity types (i.e., top-level
    # entity types without child types, or child types which are not
    # parent types themselves).
    METRICS_TYPE_UNSPECIFIED = 0

    # Indicates whether metrics for this particular label type represent an
    # aggregate of metrics for other types instead of being based on actual
    # TP/FP/FN values for the label type. Metrics for parent (i.e., non-leaf)
    # entity types are an aggregate of metrics for their children.
    AGGREGATE = 1
  end
end

#auprc_exact ⇒ ::Float

Returns The AUPRC for metrics with fuzzy matching disabled, i.e., exact matching only.

Returns:

  • (::Float) —

    The AUPRC for metrics with fuzzy matching disabled, i.e., exact matching only.



149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
 
# File 'proto_docs/google/cloud/documentai/v1beta3/evaluation.rb', line 149

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

  # A type that determines how metrics should be interpreted.
  module MetricsType
    # The metrics type is unspecified. By default, metrics without a
    # particular specification are for leaf entity types (i.e., top-level
    # entity types without child types, or child types which are not
    # parent types themselves).
    METRICS_TYPE_UNSPECIFIED = 0

    # Indicates whether metrics for this particular label type represent an
    # aggregate of metrics for other types instead of being based on actual
    # TP/FP/FN values for the label type. Metrics for parent (i.e., non-leaf)
    # entity types are an aggregate of metrics for their children.
    AGGREGATE = 1
  end
end

#confidence_level_metrics ⇒ ::Array<::Google::Cloud::DocumentAI::V1beta3::Evaluation::ConfidenceLevelMetrics>

Returns Metrics across confidence levels with fuzzy matching enabled.

Returns:



149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
 
# File 'proto_docs/google/cloud/documentai/v1beta3/evaluation.rb', line 149

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

  # A type that determines how metrics should be interpreted.
  module MetricsType
    # The metrics type is unspecified. By default, metrics without a
    # particular specification are for leaf entity types (i.e., top-level
    # entity types without child types, or child types which are not
    # parent types themselves).
    METRICS_TYPE_UNSPECIFIED = 0

    # Indicates whether metrics for this particular label type represent an
    # aggregate of metrics for other types instead of being based on actual
    # TP/FP/FN values for the label type. Metrics for parent (i.e., non-leaf)
    # entity types are an aggregate of metrics for their children.
    AGGREGATE = 1
  end
end

#confidence_level_metrics_exact ⇒ ::Array<::Google::Cloud::DocumentAI::V1beta3::Evaluation::ConfidenceLevelMetrics>

Returns Metrics across confidence levels with only exact matching.

Returns:



149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
 
# File 'proto_docs/google/cloud/documentai/v1beta3/evaluation.rb', line 149

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

  # A type that determines how metrics should be interpreted.
  module MetricsType
    # The metrics type is unspecified. By default, metrics without a
    # particular specification are for leaf entity types (i.e., top-level
    # entity types without child types, or child types which are not
    # parent types themselves).
    METRICS_TYPE_UNSPECIFIED = 0

    # Indicates whether metrics for this particular label type represent an
    # aggregate of metrics for other types instead of being based on actual
    # TP/FP/FN values for the label type. Metrics for parent (i.e., non-leaf)
    # entity types are an aggregate of metrics for their children.
    AGGREGATE = 1
  end
end

#estimated_calibration_error ⇒ ::Float

Returns The Estimated Calibration Error (ECE) of the confidence of the predicted entities.

Returns:

  • (::Float) —

    The Estimated Calibration Error (ECE) of the confidence of the predicted entities.



149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
 
# File 'proto_docs/google/cloud/documentai/v1beta3/evaluation.rb', line 149

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

  # A type that determines how metrics should be interpreted.
  module MetricsType
    # The metrics type is unspecified. By default, metrics without a
    # particular specification are for leaf entity types (i.e., top-level
    # entity types without child types, or child types which are not
    # parent types themselves).
    METRICS_TYPE_UNSPECIFIED = 0

    # Indicates whether metrics for this particular label type represent an
    # aggregate of metrics for other types instead of being based on actual
    # TP/FP/FN values for the label type. Metrics for parent (i.e., non-leaf)
    # entity types are an aggregate of metrics for their children.
    AGGREGATE = 1
  end
end

#estimated_calibration_error_exact ⇒ ::Float

Returns The ECE for the predicted entities with fuzzy matching disabled, i.e., exact matching only.

Returns:

  • (::Float) —

    The ECE for the predicted entities with fuzzy matching disabled, i.e., exact matching only.



149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
 
# File 'proto_docs/google/cloud/documentai/v1beta3/evaluation.rb', line 149

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

  # A type that determines how metrics should be interpreted.
  module MetricsType
    # The metrics type is unspecified. By default, metrics without a
    # particular specification are for leaf entity types (i.e., top-level
    # entity types without child types, or child types which are not
    # parent types themselves).
    METRICS_TYPE_UNSPECIFIED = 0

    # Indicates whether metrics for this particular label type represent an
    # aggregate of metrics for other types instead of being based on actual
    # TP/FP/FN values for the label type. Metrics for parent (i.e., non-leaf)
    # entity types are an aggregate of metrics for their children.
    AGGREGATE = 1
  end
end

#metrics_type ⇒ ::Google::Cloud::DocumentAI::V1beta3::Evaluation::MultiConfidenceMetrics::MetricsType

Returns The metrics type for the label.

Returns:



149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
 
# File 'proto_docs/google/cloud/documentai/v1beta3/evaluation.rb', line 149

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

  # A type that determines how metrics should be interpreted.
  module MetricsType
    # The metrics type is unspecified. By default, metrics without a
    # particular specification are for leaf entity types (i.e., top-level
    # entity types without child types, or child types which are not
    # parent types themselves).
    METRICS_TYPE_UNSPECIFIED = 0

    # Indicates whether metrics for this particular label type represent an
    # aggregate of metrics for other types instead of being based on actual
    # TP/FP/FN values for the label type. Metrics for parent (i.e., non-leaf)
    # entity types are an aggregate of metrics for their children.
    AGGREGATE = 1
  end
end