Class AccuracyMetric
java.lang.Object
org.elasticsearch.client.ml.dataframe.evaluation.classification.AccuracyMetric
- All Implemented Interfaces:
EvaluationMetric
,ToXContent
,ToXContentObject
public class AccuracyMetric extends java.lang.Object implements EvaluationMetric
AccuracyMetric
is a metric that answers the following two questions:
1. What is the fraction of documents for which predicted class equals the actual class?
equation: overall_accuracy = 1/n * Σ(y == y')
where: n = total number of documents
y = document's actual class
y' = document's predicted class
2. For any given class X, what is the fraction of documents for which either
a) both actual and predicted class are equal to X (true positives)
or
b) both actual and predicted class are not equal to X (true negatives)
equation: accuracy(X) = 1/n * (TP(X) + TN(X))
where: X = class being examined
n = total number of documents
TP(X) = number of true positives wrt X
TN(X) = number of true negatives wrt X-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
AccuracyMetric.PerClassResult
static class
AccuracyMetric.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
-
Constructor Summary
Constructors Constructor Description AccuracyMetric()
-
Method Summary
Modifier and Type Method Description boolean
equals(java.lang.Object o)
static AccuracyMetric
fromXContent(XContentParser parser)
java.lang.String
getName()
Returns the name of the metricint
hashCode()
XContentBuilder
toXContent(XContentBuilder builder, ToXContent.Params params)
-
Field Details
-
NAME
public static final java.lang.String NAME- See Also:
- Constant Field Values
-
-
Constructor Details
-
AccuracyMetric
public AccuracyMetric()
-
-
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 XContentBuilder toXContent(XContentBuilder builder, ToXContent.Params params) throws java.io.IOException- Specified by:
toXContent
in interfaceToXContent
- 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
-