Package org.elasticsearch.client.ml.dataframe.evaluation.softclassification

Class BinarySoftClassification

java.lang.Object

org.elasticsearch.client.ml.dataframe.evaluation.softclassification.BinarySoftClassification

All Implemented Interfaces:

Evaluation, ToXContent, ToXContentObject

public class BinarySoftClassification
extends java.lang.Object
implements Evaluation

Evaluation of binary soft classification methods, e.g. outlier detection. This is useful to evaluate problems where a model outputs a probability of whether a data frame row belongs to one of two groups.

Nested Class Summary

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
static ConstructingObjectParser<BinarySoftClassification,java.lang.Void>	PARSER

Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
BinarySoftClassification(java.lang.String actualField, java.lang.String predictedField)
BinarySoftClassification(java.lang.String actualField, java.lang.String predictedProbabilityField, java.util.List<EvaluationMetric> metrics)
BinarySoftClassification(java.lang.String actualField, java.lang.String predictedProbabilityField, EvaluationMetric... metric)

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object o)
static BinarySoftClassification	fromXContent(XContentParser parser)
java.lang.String	getName()	Returns the evaluation name
int	hashCode()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentObject

isFragment

Field Detail

NAME

public static final java.lang.String NAME

See Also:

Constant Field Values

PARSER

public static final ConstructingObjectParser<BinarySoftClassification,java.lang.Void> PARSER

Constructor Detail

BinarySoftClassification

public BinarySoftClassification(java.lang.String actualField,
                                java.lang.String predictedField)

BinarySoftClassification

public BinarySoftClassification(java.lang.String actualField,
                                java.lang.String predictedProbabilityField,
                                EvaluationMetric... metric)

BinarySoftClassification

public BinarySoftClassification(java.lang.String actualField,
                                java.lang.String predictedProbabilityField,
                                @Nullable
                                java.util.List<EvaluationMetric> metrics)

Method Detail

fromXContent

public static BinarySoftClassification fromXContent(XContentParser parser)

getName

public java.lang.String getName()

Description copied from interface: Evaluation

Returns the evaluation name

Specified by:

getName in interface Evaluation

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

java.io.IOException

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object