Class RecallMetric
java.lang.Object
org.elasticsearch.client.ml.dataframe.evaluation.classification.RecallMetric
- All Implemented Interfaces:
EvaluationMetric
,org.elasticsearch.common.xcontent.ToXContent
,org.elasticsearch.common.xcontent.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
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
NAME
-
Constructor Summary
Constructors Constructor Description RecallMetric()
-
Method Summary
Modifier and Type Method Description boolean
equals(java.lang.Object o)
static RecallMetric
fromXContent(org.elasticsearch.common.xcontent.XContentParser parser)
java.lang.String
getName()
Returns the name of the metricint
hashCode()
org.elasticsearch.common.xcontent.XContentBuilder
toXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)
-
Field Details
-
NAME
public static final java.lang.String NAME- See Also:
- Constant Field Values
-
-
Constructor Details
-
RecallMetric
public RecallMetric()
-
-
Method Details
-
fromXContent
-
getName
public java.lang.String getName()Description copied from interface:EvaluationMetric
Returns the name of the metric- Specified by:
getName
in interfaceEvaluationMetric
-
toXContent
public org.elasticsearch.common.xcontent.XContentBuilder toXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params) throws java.io.IOException- Specified by:
toXContent
in interfaceorg.elasticsearch.common.xcontent.ToXContent
- Throws:
java.io.IOException
-
equals
public boolean equals(java.lang.Object o)- Overrides:
equals
in classjava.lang.Object
-
hashCode
public int hashCode()- Overrides:
hashCode
in classjava.lang.Object
-