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.



19735
19736
19737
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 19735

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) 


19644
19645
19646
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 19644

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:



19649
19650
19651
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 19649

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) 


19655
19656
19657
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 19655

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) 


19660
19661
19662
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 19660

def f1_score_at1
  @f1_score_at1
end

#f1_score_macro ⇒ Float

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

Returns:

  • (Float) 


19665
19666
19667
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 19665

def f1_score_macro
  @f1_score_macro
end

#f1_score_micro ⇒ Float

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

Returns:

  • (Float) 


19670
19671
19672
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 19670

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) 


19676
19677
19678
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 19676

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) 


19681
19682
19683
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 19681

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) 


19686
19687
19688
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 19686

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) 


19692
19693
19694
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 19692

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) 


19699
19700
19701
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 19699

def max_predictions
  @max_predictions
end

#precision ⇒ Float

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

Returns:

  • (Float) 


19704
19705
19706
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 19704

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) 


19710
19711
19712
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 19710

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) 


19715
19716
19717
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 19715

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) 


19722
19723
19724
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 19722

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) 


19728
19729
19730
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 19728

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) 


19733
19734
19735
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 19733

def true_positive_count
  @true_positive_count
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



19740
19741
19742
19743
19744
19745
19746
19747
19748
19749
19750
19751
19752
19753
19754
19755
19756
19757
19758
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 19740

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