org.apache.ignite.ml.selection.scoring.metric.classification

Class Recall<L>

java.lang.Object

org.apache.ignite.ml.selection.scoring.metric.classification.ClassMetric<L>

org.apache.ignite.ml.selection.scoring.metric.classification.Recall<L>

Type Parameters:

L - Type of a label (truth or prediction).

All Implemented Interfaces:

Metric<L>

public class Recall<L>
extends ClassMetric<L>

Recall calculator.

Field Summary

Fields inherited from class org.apache.ignite.ml.selection.scoring.metric.classification.ClassMetric

clsLb

Constructor Summary

Constructors

Constructor and Description
Recall(L clsLb) The class of interest or positive class.

Method Summary

Modifier and Type	Method and Description
String	name() Returns the metric's name.
double	score(Iterator<LabelPair<L>> it) Calculates score.

Methods inherited from class java.lang.Object

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

Constructor Detail

Recall

public Recall(L clsLb)

The class of interest or positive class.

Parameters:

clsLb - The label.

Method Detail

score

public double score(Iterator<LabelPair<L>> it)

Calculates score.

Parameters:

it - Iterator that supplies pairs of truth values and predicated.

Returns:

Score.

name

public String name()

Returns the metric's name. NOTE: Should be unique to calculate multiple metrics correctly.

Returns:

String name representation.