Class: SVMKit::EvaluationMeasure::Recall

Inherits:
Object
  • Object
show all
Includes:
Base::Evaluator
Defined in:
lib/svmkit/evaluation_measure/recall.rb

Overview

Recall is a class that calculates the recall of the predicted labels.

Examples:

evaluator = SVMKit::EvaluationMeasure::Recall.new
puts evaluator.score(ground_truth, predicted)

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(average: 'binary') ⇒ Recall

Create a new evaluation measure calculater for recall score.



26
27
28
29
 
# File 'lib/svmkit/evaluation_measure/recall.rb', line 26

def initialize(average: 'binary')
  SVMKit::Validation.check_params_string(average: average)
  @average = average
end

Instance Attribute Details

#average ⇒ String (readonly)

Return the average type for calculation of recall.



21
22
23
 
# File 'lib/svmkit/evaluation_measure/recall.rb', line 21

def average
  @average
end

Instance Method Details

#score(y_true, y_pred) ⇒ Float

Calculate average recall



36
37
38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/svmkit/evaluation_measure/recall.rb', line 36

def score(y_true, y_pred)
  SVMKit::Validation.check_label_array(y_true)
  SVMKit::Validation.check_label_array(y_pred)

  case @average
  when 'binary'
    recall_each_class(y_true, y_pred).last
  when 'micro'
    micro_average_recall(y_true, y_pred)
  when 'macro'
    macro_average_recall(y_true, y_pred)
  end
end