Module org.elasticsearch.xcore

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

Class MulticlassConfusionMatrix

java.lang.Object

org.elasticsearch.xpack.core.ml.dataframe.evaluation.classification.MulticlassConfusionMatrix

All Implemented Interfaces:

NamedWriteable, Writeable, ToXContent, ToXContentObject, EvaluationMetric

public class MulticlassConfusionMatrix
extends Object
implements EvaluationMetric

MulticlassConfusionMatrix is a metric that answers the question: "How many documents belonging to class X were classified as Y by the classifier?" for all the possible class pairs {X, Y}.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MulticlassConfusionMatrix.ActualClass
static class	MulticlassConfusionMatrix.PredictedClass
static class	MulticlassConfusionMatrix.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	AGG_NAME_PREFIX
static final ParseField	NAME
static final ParseField	SIZE

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
MulticlassConfusionMatrix()
MulticlassConfusionMatrix(Integer size, String aggNamePrefix)
MulticlassConfusionMatrix(StreamInput in)

Method Summary

Modifier and Type	Method	Description
final Tuple<List<AggregationBuilder>,List<PipelineAggregationBuilder>>	aggs(EvaluationParameters parameters, EvaluationFields fields)	Builds the aggregation that collect required data to compute the metric
boolean	equals(Object o)
static MulticlassConfusionMatrix	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<MulticlassConfusionMatrix.Result>	getResult()	Gets the evaluation result for this metric.
int	getSize()
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

SIZE

public static final ParseField SIZE

AGG_NAME_PREFIX

public static final ParseField AGG_NAME_PREFIX

Constructor Details

MulticlassConfusionMatrix

public MulticlassConfusionMatrix()

MulticlassConfusionMatrix

public MulticlassConfusionMatrix(@Nullable
 Integer size,
 @Nullable
 String aggNamePrefix)

MulticlassConfusionMatrix

public MulticlassConfusionMatrix(StreamInput in)
                          throws IOException

Throws:

IOException

Method Details

fromXContent

public static MulticlassConfusionMatrix fromXContent(XContentParser parser)

getWriteableName

public String getWriteableName()

Specified by:

getWriteableName in interface NamedWriteable

getName

public String getName()

Description copied from interface: EvaluationMetric

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

Specified by:

getName in interface EvaluationMetric

getSize

public int getSize()

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 final 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<MulticlassConfusionMatrix.Result> 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

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

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object