Package smile.validation.metric

Class Recall

java.lang.Object
smile.validation.metric.Recall
All Implemented Interfaces:
Serializable, ToDoubleBiFunction<int[],int[]>, ClassificationMetric
public class Recall extends Object implements ClassificationMetric
In information retrieval area, sensitivity is called recall.
See Also:

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final Recall
    instance
    Default instance.

  • Constructor Summary

    Constructors
    Constructor
    Description
    Recall()
    Constructor.
    Recall(Averaging strategy)
    Constructor.

  • Method Summary

    Modifier and Type
    Method
    Description
    static double
    of(int[] truth, int[] prediction)
    Calculates the recall/sensitivity of binary classification.
    static double
    of(int[] truth, int[] prediction, Averaging strategy)
    Calculates the recall/sensitivity.
    double
    score(int[] truth, int[] prediction)
    Returns a score to measure the quality of classification.
    String
    toString()
     

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    Methods inherited from interface smile.validation.metric.ClassificationMetric

    applyAsDouble

  • Field Details

    • instance

      public static final Recall instance
      Default instance.

  • Constructor Details

    • Recall

      public Recall()
      Constructor.

    • Recall

      public Recall(Averaging strategy)
      Constructor.
      Parameters:
      strategy - The aggregating strategy for multi-classes.

  • Method Details

    • score

      public double score(int[] truth, int[] prediction)
      Description copied from interface: ClassificationMetric
      Returns a score to measure the quality of classification.
      Specified by:
      score in interface ClassificationMetric
      Parameters:
      truth - the true class labels.
      prediction - the predicted class labels.
      Returns:
      the metric.

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • of

      public static double of(int[] truth, int[] prediction)
      Calculates the recall/sensitivity of binary classification.
      Parameters:
      truth - the ground truth.
      prediction - the prediction.
      Returns:
      the metric.

    • of

      public static double of(int[] truth, int[] prediction, Averaging strategy)
      Calculates the recall/sensitivity.
      Parameters:
      truth - the ground truth.
      prediction - the prediction.
      strategy - The aggregating strategy for multi-classes.
      Returns:
      the metric.