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

Class AucRocMetric

java.lang.Object

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

All Implemented Interfaces:

EvaluationMetric, ToXContent, ToXContentObject

public class AucRocMetric
extends java.lang.Object
implements EvaluationMetric

Area under the curve (AUC) of the receiver operating characteristic (ROC). The ROC curve is a plot of the TPR (true positive rate) against the FPR (false positive rate) over a varying threshold.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AucRocMetric.AucRocPoint
static class	AucRocMetric.Result

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 ParseField	INCLUDE_CURVE
static java.lang.String	NAME
static ConstructingObjectParser<AucRocMetric,java.lang.Void>	PARSER

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
AucRocMetric(java.lang.Boolean includeCurve)

Method Summary

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

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

INCLUDE_CURVE

public static final ParseField INCLUDE_CURVE

PARSER

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

Constructor Detail

AucRocMetric

public AucRocMetric(java.lang.Boolean includeCurve)

Method Detail

fromXContent

public static AucRocMetric fromXContent(XContentParser parser)

withCurve

public static AucRocMetric withCurve()

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

java.io.IOException

getName

public java.lang.String getName()

Description copied from interface: EvaluationMetric

Returns the name of the metric

Specified by:

getName in interface EvaluationMetric

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