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

Class AucRocMetric

java.lang.Object
org.elasticsearch.client.ml.dataframe.evaluation.classification.AucRocMetric
All Implemented Interfaces:
EvaluationMetric, org.elasticsearch.xcontent.ToXContent, org.elasticsearch.xcontent.ToXContentObject
public class AucRocMetric extends 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/interfaces inherited from interface org.elasticsearch.client.ml.dataframe.evaluation.EvaluationMetric

    EvaluationMetric.Result

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

    org.elasticsearch.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.xcontent.ToXContent.MapParams, org.elasticsearch.xcontent.ToXContent.Params

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final org.elasticsearch.xcontent.ParseField
    CLASS_NAME
     
    static final org.elasticsearch.xcontent.ParseField
    INCLUDE_CURVE
     
    static final String
    NAME
     
    static final org.elasticsearch.xcontent.ConstructingObjectParser<AucRocMetric,Void>
    PARSER
     

    Fields inherited from interface org.elasticsearch.xcontent.ToXContent

    EMPTY_PARAMS

  • Constructor Summary

    Constructors
    Constructor
    Description
    AucRocMetric(String className, Boolean includeCurve)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object o)
     
    static AucRocMetric
    forClass(String className)
     
    static AucRocMetric
    forClassWithCurve(String className)
     
    static AucRocMetric
    fromXContent(org.elasticsearch.xcontent.XContentParser parser)
     
    String
    getName()
    Returns the name of the metric
    int
    hashCode()
     
    org.elasticsearch.xcontent.XContentBuilder
    toXContent(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.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.xcontent.ToXContentObject

    isFragment

  • Field Details

    • NAME

      public static final String NAME
      See Also:

    • CLASS_NAME

      public static final org.elasticsearch.xcontent.ParseField CLASS_NAME

    • INCLUDE_CURVE

      public static final org.elasticsearch.xcontent.ParseField INCLUDE_CURVE

    • PARSER

      public static final org.elasticsearch.xcontent.ConstructingObjectParser<AucRocMetric,Void> PARSER

  • Constructor Details

    • AucRocMetric

      public AucRocMetric(String className, Boolean includeCurve)

  • Method Details

    • fromXContent

      public static AucRocMetric fromXContent(org.elasticsearch.xcontent.XContentParser parser)

    • forClass

      public static AucRocMetric forClass(String className)

    • forClassWithCurve

      public static AucRocMetric forClassWithCurve(String className)

    • toXContent

      public org.elasticsearch.xcontent.XContentBuilder toXContent(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params) throws IOException
      Specified by:
      toXContent in interface org.elasticsearch.xcontent.ToXContent
      Throws:
      IOException

    • getName

      public String getName()
      Description copied from interface: EvaluationMetric
      Returns the name of the metric
      Specified by:
      getName in interface EvaluationMetric

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object