Class: Rumale::EvaluationMeasure::Recall

Inherits:

Object

• Object
• Rumale::EvaluationMeasure::Recall

Includes:

Base::Evaluator

Defined in:

rumale-evaluation_measure/lib/rumale/evaluation_measure/recall.rb

Overview

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

Examples:

require 'rumale/evaluation_measure/recall'

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

Instance Attribute Summary

• #average ⇒ String readonly

  Return the average type for calculation of recall.

Instance Method Summary

• #initialize(average: 'binary') ⇒ Recall constructor

  Create a new evaluation measure calculater for recall score.

• #score(y_true, y_pred) ⇒ Float

  Calculate average recall.

Constructor Details

#initialize(average: 'binary') ⇒ Recall

Create a new evaluation measure calculater for recall score.

Parameters:

• average (String) (defaults to: 'binary') —

  The average type (‘binary’, ‘micro’, ‘macro’)

# File 'rumale-evaluation_measure/lib/rumale/evaluation_measure/recall.rb', line 27

def initialize(average: 'binary')
  @average = average
end

Instance Attribute Details

#average ⇒ String (readonly)

Return the average type for calculation of recall.

Returns:

• (String) —

  (‘binary’, ‘micro’, ‘macro’)

# File 'rumale-evaluation_measure/lib/rumale/evaluation_measure/recall.rb', line 22

def average
  @average
end

Instance Method Details

#score(y_true, y_pred) ⇒ Float

Calculate average recall

Parameters:

• y_true (Numo::Int32) —

  (shape: [n_samples]) Ground truth labels.

• y_pred (Numo::Int32) —

  (shape: [n_samples]) Predicted labels.

Returns:

• (Float) —

  Average recall

# File 'rumale-evaluation_measure/lib/rumale/evaluation_measure/recall.rb', line 36

def score(y_true, 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