Class: Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1SchemaModelevaluationMetricsClassificationEvaluationMetricsConfidenceMetrics

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudAiplatformV1beta1SchemaModelevaluationMetricsClassificationEvaluationMetricsConfidenceMetrics

Returns a new instance of GoogleCloudAiplatformV1beta1SchemaModelevaluationMetricsClassificationEvaluationMetricsConfidenceMetrics.



51105
51106
51107
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 51105

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) 


51014
51015
51016
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 51014

def confidence_threshold
  @confidence_threshold
end

#confusion_matrix ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1SchemaModelevaluationMetricsConfusionMatrix

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

Returns:



51019
51020
51021
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 51019

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) 


51025
51026
51027
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 51025

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) 


51030
51031
51032
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 51030

def f1_score_at1
  @f1_score_at1
end

#f1_score_macro ⇒ Float

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

Returns:

  • (Float) 


51035
51036
51037
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 51035

def f1_score_macro
  @f1_score_macro
end

#f1_score_micro ⇒ Float

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

Returns:

  • (Float) 


51040
51041
51042
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 51040

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) 


51046
51047
51048
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 51046

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) 


51051
51052
51053
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 51051

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) 


51056
51057
51058
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 51056

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) 


51062
51063
51064
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 51062

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) 


51069
51070
51071
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 51069

def max_predictions
  @max_predictions
end

#precision ⇒ Float

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

Returns:

  • (Float) 


51074
51075
51076
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 51074

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) 


51080
51081
51082
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 51080

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) 


51085
51086
51087
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 51085

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) 


51092
51093
51094
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 51092

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) 


51098
51099
51100
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 51098

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) 


51103
51104
51105
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 51103

def true_positive_count
  @true_positive_count
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



51110
51111
51112
51113
51114
51115
51116
51117
51118
51119
51120
51121
51122
51123
51124
51125
51126
51127
51128
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 51110

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