Class Recall

java.lang.Object
smile.deep.metric.Recall
All Implemented Interfaces:
Metric
public class Recall extends Object implements Metric
Recall or true positive rate (TPR) (also called hit rate, sensitivity) is a statistical measures of the performance of a binary classification test. Recall is the proportion of actual positives which are correctly identified as such. 
    TPR = TP / P = TP / (TP + FN)
Recall and precision are closely related to the concepts of type I and type II errors. For any test, there is usually a trade-off between the measures. This trade-off can be represented graphically using an ROC curve.

In this implementation, the class label 1 is regarded as positive and 0 is regarded as negative.

  • Constructor Details

    • Recall

      public Recall()
      Constructor.

    • Recall

      public Recall(double threshold)
      Constructor.
      Parameters:
      threshold - The threshold for converting input into binary labels.

    • Recall

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

  • Method Details

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • name

      public String name()
      Description copied from interface: Metric
      Returns the name of metric.
      Specified by:
      name in interface Metric
      Returns:
      the name of metric.

    • update

      public void update(Tensor output, Tensor target)
      Description copied from interface: Metric
      Updates the metric states with input data. This is often used when new data needs to be added for metric computation.
      Specified by:
      update in interface Metric
      Parameters:
      output - the model output.
      target - the ground truth.

    • compute

      public double compute()
      Description copied from interface: Metric
      Computes the metric value from the metric state, which are updated by previous update() calls. The compute frequency can be less than the update frequency.
      Specified by:
      compute in interface Metric
      Returns:
      the metric value.

    • reset

      public void reset()
      Description copied from interface: Metric
      Resets the metric state variables to their default value. Usually this is called at the end of every epoch to clean up metric states.
      Specified by:
      reset in interface Metric