Module org.elasticsearch.xcore

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

Class OutlierDetection

java.lang.Object

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

All Implemented Interfaces:

NamedWriteable, Writeable, ToXContent, ToXContentObject, Evaluation

public final class OutlierDetection
extends Object
implements Evaluation

Evaluation of outlier detection results.

Nested Class Summary

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	NAME
static final ConstructingObjectParser<OutlierDetection,Void>	PARSER

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
OutlierDetection(String actualField, String predictedProbabilityField, List<EvaluationMetric> metrics)
OutlierDetection(StreamInput in)

Method Summary

Modifier and Type	Method	Description
static QueryBuilder	actualIsTrueQuery(String actualField)
boolean	equals(Object o)
static OutlierDetection	fromXContent(XContentParser parser)
EvaluationFields	getFields()	Returns the collection of fields required by evaluation
List<EvaluationMetric>	getMetrics()	Returns the list of metrics to evaluate
String	getName()	Returns the evaluation name
String	getWriteableName()
int	hashCode()
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.xpack.core.ml.dataframe.evaluation.Evaluation

buildSearch, getResults, hasAllResults, initMetrics, process

Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

isFragment

Field Details

NAME

public static final ParseField NAME

PARSER

public static final ConstructingObjectParser<OutlierDetection,Void> PARSER

Constructor Details

OutlierDetection

public OutlierDetection(String actualField,
 String predictedProbabilityField,
 @Nullable
 List<EvaluationMetric> metrics)

OutlierDetection

public OutlierDetection(StreamInput in)
                 throws IOException

Throws:

IOException

Method Details

fromXContent

public static OutlierDetection fromXContent(XContentParser parser)

actualIsTrueQuery

public static QueryBuilder actualIsTrueQuery(String actualField)

getName

public String getName()

Description copied from interface: Evaluation

Returns the evaluation name

Specified by:

getName in interface Evaluation

getFields

public EvaluationFields getFields()

Description copied from interface: Evaluation

Returns the collection of fields required by evaluation

Specified by:

getFields in interface Evaluation

getMetrics

public List<EvaluationMetric> getMetrics()

Description copied from interface: Evaluation

Returns the list of metrics to evaluate

Specified by:

getMetrics in interface Evaluation

Returns:

list of metrics to evaluate

getWriteableName

public String getWriteableName()

Specified by:

getWriteableName in interface NamedWriteable

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