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.



17573
17574
17575
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 17573

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) 


17482
17483
17484
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 17482

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:



17487
17488
17489
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 17487

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) 


17493
17494
17495
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 17493

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) 


17498
17499
17500
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 17498

def f1_score_at1
  @f1_score_at1
end

#f1_score_macro ⇒ Float

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

Returns:

  • (Float) 


17503
17504
17505
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 17503

def f1_score_macro
  @f1_score_macro
end

#f1_score_micro ⇒ Float

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

Returns:

  • (Float) 


17508
17509
17510
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 17508

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) 


17514
17515
17516
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 17514

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) 


17519
17520
17521
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 17519

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) 


17524
17525
17526
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 17524

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) 


17530
17531
17532
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 17530

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) 


17537
17538
17539
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 17537

def max_predictions
  @max_predictions
end

#precision ⇒ Float

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

Returns:

  • (Float) 


17542
17543
17544
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 17542

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) 


17548
17549
17550
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 17548

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) 


17553
17554
17555
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 17553

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) 


17560
17561
17562
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 17560

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) 


17566
17567
17568
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 17566

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) 


17571
17572
17573
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 17571

def true_positive_count
  @true_positive_count
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



17578
17579
17580
17581
17582
17583
17584
17585
17586
17587
17588
17589
17590
17591
17592
17593
17594
17595
17596
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 17578

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