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

Class FMeasure<L extends Serializable>

java.lang.Object

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

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

All Implemented Interfaces:

Serializable, Metric<L,BinaryClassificationEvaluationContext<L>,BinaryClassificationPointwiseMetricStatsAggregator<L>>

public class FMeasure<L extends Serializable>
extends BinaryClassificationMetric<L>

F-measure metric class.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
FMeasure() Creates an instance of FScore class.
FMeasure(double beta) Creates an instance of FScore class.
FMeasure(L truthLabel, L falseLabel) Creates an instance of FScore class.
FMeasure(L truthLabel, L falseLabel, double betaSquare) Creates an instance of FScore class.

Method Summary

Modifier and Type	Method and Description
FMeasure<L>	initBy(BinaryClassificationPointwiseMetricStatsAggregator<L> aggr) Initializes metric value by statistics aggregator.
MetricName	name() Returns metric name.
double	value() Returns metric value.

Methods inherited from class org.apache.ignite.ml.selection.scoring.metric.classification.BinaryClassificationMetric

makeAggregator

Methods inherited from class java.lang.Object

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

Constructor Detail

FMeasure

public FMeasure(double beta)

Creates an instance of FScore class.

Parameters:

beta - Beta (see https://en.wikipedia.org/wiki/F1_score ).

FMeasure

public FMeasure()

Creates an instance of FScore class.

FMeasure

public FMeasure(L truthLabel,
                L falseLabel,
                double betaSquare)

Creates an instance of FScore class.

Parameters:

truthLabel - Truth label.

falseLabel - False label.

betaSquare - Squared beta parameter.

FMeasure

public FMeasure(L truthLabel,
                L falseLabel)

Creates an instance of FScore class.

Parameters:

truthLabel - Truth label.

falseLabel - False label.

Method Detail

initBy

public FMeasure<L> initBy(BinaryClassificationPointwiseMetricStatsAggregator<L> aggr)

Initializes metric value by statistics aggregator.

Parameters:

aggr - Aggregator.

value

public double value()

Returns metric value.

Returns:

Metric value.

name

public MetricName name()

Returns metric name.

Returns:

Metric name.