Package org.elasticsearch.client.ml.dataframe.evaluation.classification

Class RecallMetric

java.lang.Object

org.elasticsearch.client.ml.dataframe.evaluation.classification.RecallMetric

All Implemented Interfaces:

EvaluationMetric, ToXContent, ToXContentObject

public class RecallMetric
extends java.lang.Object
implements EvaluationMetric

RecallMetric is a metric that answers the question: "What fraction of documents belonging to X have been predicted as X by the classifier?" for any given class X equation: recall(X) = TP(X) / (TP(X) + FN(X)) where: TP(X) - number of true positives wrt X FN(X) - number of false negatives wrt X

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RecallMetric.PerClassResult
static class	RecallMetric.Result

Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	NAME

Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
RecallMetric()

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object o)
static RecallMetric	fromXContent(XContentParser parser)
java.lang.String	getName()	Returns the name of the metric
int	hashCode()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentObject

isFragment

Field Details

NAME

public static final java.lang.String NAME

See Also:

Constant Field Values

Constructor Details

RecallMetric

public RecallMetric()

Method Details

fromXContent

public static RecallMetric fromXContent(XContentParser parser)

getName

public java.lang.String getName()

Description copied from interface: EvaluationMetric

Returns the name of the metric

Specified by:

getName in interface EvaluationMetric

toXContent

public XContentBuilder toXContent(XContentBuilder builder, ToXContent.Params params) throws java.io.IOException

Specified by:

toXContent in interface ToXContent

Throws:

java.io.IOException

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object