Class RecallMetric
java.lang.Object
org.elasticsearch.client.ml.dataframe.evaluation.classification.RecallMetric
- All Implemented Interfaces:
EvaluationMetric
,org.elasticsearch.xcontent.ToXContent
,org.elasticsearch.xcontent.ToXContentObject
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/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent
org.elasticsearch.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.xcontent.ToXContent.MapParams, org.elasticsearch.xcontent.ToXContent.Params
-
Field Summary
Fields inherited from interface org.elasticsearch.xcontent.ToXContent
EMPTY_PARAMS
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionboolean
static RecallMetric
fromXContent
(org.elasticsearch.xcontent.XContentParser parser) getName()
Returns the name of the metricint
hashCode()
org.elasticsearch.xcontent.XContentBuilder
toXContent
(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.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.xcontent.ToXContentObject
isFragment
-
Field Details
-
NAME
- See Also:
-
-
Constructor Details
-
RecallMetric
public RecallMetric()
-
-
Method Details
-
fromXContent
-
getName
Description copied from interface:EvaluationMetric
Returns the name of the metric- Specified by:
getName
in interfaceEvaluationMetric
-
toXContent
public org.elasticsearch.xcontent.XContentBuilder toXContent(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params) throws IOException - Specified by:
toXContent
in interfaceorg.elasticsearch.xcontent.ToXContent
- Throws:
IOException
-
equals
-
hashCode
public int hashCode()
-