Module org.elasticsearch.xcore

Package org.elasticsearch.xpack.core.ml.dataframe.evaluation.outlierdetection

Class ConfusionMatrix

java.lang.Object

org.elasticsearch.xpack.core.ml.dataframe.evaluation.outlierdetection.ConfusionMatrix

All Implemented Interfaces:

NamedWriteable, Writeable, ToXContent, ToXContentObject, EvaluationMetric

public class ConfusionMatrix
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ConfusionMatrix.Result

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields

Modifier and Type	Field	Description
static final ParseField	AT
static final ParseField	NAME
protected final double[]	thresholds

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
ConfusionMatrix(List<Double> at)
ConfusionMatrix(StreamInput in)

Method Summary

Modifier and Type	Method	Description
protected String	aggName(double threshold, org.elasticsearch.xpack.core.ml.dataframe.evaluation.outlierdetection.AbstractConfusionMatrixMetric.Condition condition)
Tuple<List<AggregationBuilder>,List<PipelineAggregationBuilder>>	aggs(EvaluationParameters parameters, EvaluationFields fields)	Builds the aggregation that collect required data to compute the metric
protected List<AggregationBuilder>	aggsAt(String actualField, String predictedProbabilityField)
protected AggregationBuilder	buildAgg(String actualField, String predictedProbabilityField, double threshold, org.elasticsearch.xpack.core.ml.dataframe.evaluation.outlierdetection.AbstractConfusionMatrixMetric.Condition condition)
boolean	equals(Object o)
EvaluationMetricResult	evaluate(InternalAggregations aggs)
static ConfusionMatrix	fromXContent(XContentParser parser)
String	getName()	Returns the name of the metric (which may differ to the writeable name)
Set<String>	getRequiredFields()	Returns the set of fields that this metric requires in order to be calculated.
Optional<EvaluationMetricResult>	getResult()	Gets the evaluation result for this metric.
String	getWriteableName()
int	hashCode()
void	process(InternalAggregations aggs)	Processes given aggregations as a step towards computing result
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	writeTo(StreamOutput out)

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

public static final ParseField NAME

AT

public static final ParseField AT

thresholds

protected final double[] thresholds

Constructor Details

ConfusionMatrix

public ConfusionMatrix(List<Double> at)

ConfusionMatrix

public ConfusionMatrix(StreamInput in)
                throws IOException

Throws:

IOException

Method Details

fromXContent

public static ConfusionMatrix fromXContent(XContentParser parser)

getWriteableName

public String getWriteableName()

getName

public String getName()

Description copied from interface: EvaluationMetric

Returns the name of the metric (which may differ to the writeable name)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

aggsAt

protected List<AggregationBuilder> aggsAt(String actualField,
 String predictedProbabilityField)

evaluate

public EvaluationMetricResult evaluate(InternalAggregations aggs)

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Writeable

Throws:

IOException

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

IOException

getRequiredFields

public Set<String> getRequiredFields()

Description copied from interface: EvaluationMetric

Returns the set of fields that this metric requires in order to be calculated.

Specified by:

getRequiredFields in interface EvaluationMetric

aggs

public Tuple<List<AggregationBuilder>,List<PipelineAggregationBuilder>> aggs(EvaluationParameters parameters,
 EvaluationFields fields)

Description copied from interface: EvaluationMetric

Builds the aggregation that collect required data to compute the metric

Specified by:

aggs in interface EvaluationMetric

Parameters:

parameters - settings that may be needed by aggregations

fields - fields that may be needed by aggregations

Returns:

the aggregations required to compute the metric

process

public void process(InternalAggregations aggs)

Description copied from interface: EvaluationMetric

Processes given aggregations as a step towards computing result

Specified by:

process in interface EvaluationMetric

Parameters:

aggs - aggregations from SearchResponse

getResult

public Optional<EvaluationMetricResult> getResult()

Description copied from interface: EvaluationMetric

Gets the evaluation result for this metric.

Specified by:

getResult in interface EvaluationMetric

Returns:

Optional.empty() if the result is not available yet, Optional.of(result) otherwise

aggName

protected String aggName(double threshold,
 org.elasticsearch.xpack.core.ml.dataframe.evaluation.outlierdetection.AbstractConfusionMatrixMetric.Condition condition)

buildAgg

protected AggregationBuilder buildAgg(String actualField,
 String predictedProbabilityField,
 double threshold,
 org.elasticsearch.xpack.core.ml.dataframe.evaluation.outlierdetection.AbstractConfusionMatrixMetric.Condition condition)