Class: Google::Apis::AiplatformV1::GoogleCloudAiplatformV1SchemaModelevaluationMetricsClassificationEvaluationMetricsConfidenceMetrics

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/aiplatform_v1/classes.rb,
lib/google/apis/aiplatform_v1/representations.rb,
lib/google/apis/aiplatform_v1/representations.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudAiplatformV1SchemaModelevaluationMetricsClassificationEvaluationMetricsConfidenceMetrics

Returns a new instance of GoogleCloudAiplatformV1SchemaModelevaluationMetricsClassificationEvaluationMetricsConfidenceMetrics.



20152
20153
20154
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 20152

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#confidence_threshold ⇒ Float

Metrics are computed with an assumption that the Model never returns predictions with score lower than this value. Corresponds to the JSON property confidenceThreshold

Returns:

  • (Float) 


20061
20062
20063
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 20061

def confidence_threshold
  @confidence_threshold
end

#confusion_matrix ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1SchemaModelevaluationMetricsConfusionMatrix

Confusion matrix of the evaluation for this confidence_threshold. Corresponds to the JSON property confusionMatrix

Returns:



20066
20067
20068
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 20066

def confusion_matrix
  @confusion_matrix
end

#f1_score ⇒ Float

The harmonic mean of recall and precision. For summary metrics, it computes the micro-averaged F1 score. Corresponds to the JSON property f1Score

Returns:

  • (Float) 


20072
20073
20074
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 20072

def f1_score
  @f1_score
end

#f1_score_at1 ⇒ Float

The harmonic mean of recallAt1 and precisionAt1. Corresponds to the JSON property f1ScoreAt1

Returns:

  • (Float) 


20077
20078
20079
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 20077

def f1_score_at1
  @f1_score_at1
end

#f1_score_macro ⇒ Float

Macro-averaged F1 Score. Corresponds to the JSON property f1ScoreMacro

Returns:

  • (Float) 


20082
20083
20084
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 20082

def f1_score_macro
  @f1_score_macro
end

#f1_score_micro ⇒ Float

Micro-averaged F1 Score. Corresponds to the JSON property f1ScoreMicro

Returns:

  • (Float) 


20087
20088
20089
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 20087

def f1_score_micro
  @f1_score_micro
end

#false_negative_count ⇒ Fixnum

The number of ground truth labels that are not matched by a Model created label. Corresponds to the JSON property falseNegativeCount

Returns:

  • (Fixnum) 


20093
20094
20095
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 20093

def false_negative_count
  @false_negative_count
end

#false_positive_count ⇒ Fixnum

The number of Model created labels that do not match a ground truth label. Corresponds to the JSON property falsePositiveCount

Returns:

  • (Fixnum) 


20098
20099
20100
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 20098

def false_positive_count
  @false_positive_count
end

#false_positive_rate ⇒ Float

False Positive Rate for the given confidence threshold. Corresponds to the JSON property falsePositiveRate

Returns:

  • (Float) 


20103
20104
20105
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 20103

def false_positive_rate
  @false_positive_rate
end

#false_positive_rate_at1 ⇒ Float

The False Positive Rate when only considering the label that has the highest prediction score and not below the confidence threshold for each DataItem. Corresponds to the JSON property falsePositiveRateAt1

Returns:

  • (Float) 


20109
20110
20111
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 20109

def false_positive_rate_at1
  @false_positive_rate_at1
end

#max_predictions ⇒ Fixnum

Metrics are computed with an assumption that the Model always returns at most this many predictions (ordered by their score, descendingly), but they all still need to meet the confidenceThreshold. Corresponds to the JSON property maxPredictions

Returns:

  • (Fixnum) 


20116
20117
20118
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 20116

def max_predictions
  @max_predictions
end

#precision ⇒ Float

Precision for the given confidence threshold. Corresponds to the JSON property precision

Returns:

  • (Float) 


20121
20122
20123
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 20121

def precision
  @precision
end

#precision_at1 ⇒ Float

The precision when only considering the label that has the highest prediction score and not below the confidence threshold for each DataItem. Corresponds to the JSON property precisionAt1

Returns:

  • (Float) 


20127
20128
20129
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 20127

def precision_at1
  @precision_at1
end

#recall ⇒ Float

Recall (True Positive Rate) for the given confidence threshold. Corresponds to the JSON property recall

Returns:

  • (Float) 


20132
20133
20134
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 20132

def recall
  @recall
end

#recall_at1 ⇒ Float

The Recall (True Positive Rate) when only considering the label that has the highest prediction score and not below the confidence threshold for each DataItem. Corresponds to the JSON property recallAt1

Returns:

  • (Float) 


20139
20140
20141
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 20139

def recall_at1
  @recall_at1
end

#true_negative_count ⇒ Fixnum

The number of labels that were not created by the Model, but if they would, they would not match a ground truth label. Corresponds to the JSON property trueNegativeCount

Returns:

  • (Fixnum) 


20145
20146
20147
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 20145

def true_negative_count
  @true_negative_count
end

#true_positive_count ⇒ Fixnum

The number of Model created labels that match a ground truth label. Corresponds to the JSON property truePositiveCount

Returns:

  • (Fixnum) 


20150
20151
20152
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 20150

def true_positive_count
  @true_positive_count
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



20157
20158
20159
20160
20161
20162
20163
20164
20165
20166
20167
20168
20169
20170
20171
20172
20173
20174
20175
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 20157

def update!(**args)
  @confidence_threshold = args[:confidence_threshold] if args.key?(:confidence_threshold)
  @confusion_matrix = args[:confusion_matrix] if args.key?(:confusion_matrix)
  @f1_score = args[:f1_score] if args.key?(:f1_score)
  @f1_score_at1 = args[:f1_score_at1] if args.key?(:f1_score_at1)
  @f1_score_macro = args[:f1_score_macro] if args.key?(:f1_score_macro)
  @f1_score_micro = args[:f1_score_micro] if args.key?(:f1_score_micro)
  @false_negative_count = args[:false_negative_count] if args.key?(:false_negative_count)
  @false_positive_count = args[:false_positive_count] if args.key?(:false_positive_count)
  @false_positive_rate = args[:false_positive_rate] if args.key?(:false_positive_rate)
  @false_positive_rate_at1 = args[:false_positive_rate_at1] if args.key?(:false_positive_rate_at1)
  @max_predictions = args[:max_predictions] if args.key?(:max_predictions)
  @precision = args[:precision] if args.key?(:precision)
  @precision_at1 = args[:precision_at1] if args.key?(:precision_at1)
  @recall = args[:recall] if args.key?(:recall)
  @recall_at1 = args[:recall_at1] if args.key?(:recall_at1)
  @true_negative_count = args[:true_negative_count] if args.key?(:true_negative_count)
  @true_positive_count = args[:true_positive_count] if args.key?(:true_positive_count)
end