Module org.elasticsearch.xcore
Class Accuracy
java.lang.Object
org.elasticsearch.xpack.core.ml.dataframe.evaluation.classification.Accuracy
- All Implemented Interfaces:
NamedWriteable,Writeable,org.elasticsearch.xcontent.ToXContent,org.elasticsearch.xcontent.ToXContentObject,EvaluationMetric
Accuracy 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 ClassesNested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent
org.elasticsearch.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.xcontent.ToXContent.MapParams, org.elasticsearch.xcontent.ToXContent.ParamsNested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable
Writeable.Reader<V>, Writeable.Writer<V> -
Field Summary
FieldsFields inherited from interface org.elasticsearch.xcontent.ToXContent
EMPTY, EMPTY_PARAMS -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionfinal org.elasticsearch.core.Tuple<List<AggregationBuilder>, List<PipelineAggregationBuilder>> aggs(EvaluationParameters parameters, EvaluationFields fields) Builds the aggregation that collect required data to compute the metricbooleanstatic AccuracyfromXContent(org.elasticsearch.xcontent.XContentParser parser) getName()Returns the name of the metric (which may differ to the writeable name)Returns the set of fields that this metric requires in order to be calculated.Gets the evaluation result for this metric.inthashCode()voidprocess(InternalAggregations aggs) Processes given aggregations as a step towards computing resultorg.elasticsearch.xcontent.XContentBuildertoXContent(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params) voidwriteTo(StreamOutput out) Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.elasticsearch.xcontent.ToXContentObject
isFragment
-
Field Details
-
NAME
public static final org.elasticsearch.xcontent.ParseField NAME
-
-
Constructor Details
-
Accuracy
public Accuracy() -
Accuracy
- Throws:
IOException
-
-
Method Details
-
fromXContent
-
getWriteableName
- Specified by:
getWriteableNamein interfaceNamedWriteable
-
getName
Description copied from interface:EvaluationMetricReturns the name of the metric (which may differ to the writeable name)- Specified by:
getNamein interfaceEvaluationMetric
-
getRequiredFields
Description copied from interface:EvaluationMetricReturns the set of fields that this metric requires in order to be calculated.- Specified by:
getRequiredFieldsin interfaceEvaluationMetric
-
aggs
public final org.elasticsearch.core.Tuple<List<AggregationBuilder>,List<PipelineAggregationBuilder>> aggs(EvaluationParameters parameters, EvaluationFields fields) Description copied from interface:EvaluationMetricBuilds the aggregation that collect required data to compute the metric- Specified by:
aggsin interfaceEvaluationMetric- Parameters:
parameters- settings that may be needed by aggregationsfields- fields that may be needed by aggregations- Returns:
- the aggregations required to compute the metric
-
process
Description copied from interface:EvaluationMetricProcesses given aggregations as a step towards computing result- Specified by:
processin interfaceEvaluationMetric- Parameters:
aggs- aggregations fromSearchResponse
-
getResult
Description copied from interface:EvaluationMetricGets the evaluation result for this metric.- Specified by:
getResultin interfaceEvaluationMetric- Returns:
Optional.empty()if the result is not available yet,Optional.of(result)otherwise
-
writeTo
- Specified by:
writeToin interfaceWriteable- Throws:
IOException
-
toXContent
public org.elasticsearch.xcontent.XContentBuilder toXContent(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params) throws IOException - Specified by:
toXContentin interfaceorg.elasticsearch.xcontent.ToXContent- Throws:
IOException
-
equals
-
hashCode
public int hashCode()
-