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

Class RecallMetric

java.lang.Object
org.elasticsearch.client.ml.dataframe.evaluation.classification.RecallMetric
All Implemented Interfaces:
EvaluationMetric, org.elasticsearch.xcontent.ToXContent, org.elasticsearch.xcontent.ToXContentObject
public class RecallMetric extends Object implements EvaluationMetric
RecallMetric is a metric that answers the question: "What fraction of documents belonging to X have been predicted as X by the classifier?" for any given class X equation: recall(X) = TP(X) / (TP(X) + FN(X)) where: TP(X) - number of true positives wrt X FN(X) - number of false negatives wrt X

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static class 
    RecallMetric.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 String
    NAME
     

    Fields inherited from interface org.elasticsearch.xcontent.ToXContent

    EMPTY_PARAMS

  • Constructor Summary

    Constructors
    Constructor
    Description
    RecallMetric()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object o)
     
    static RecallMetric
    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

  • Constructor Details

    • RecallMetric

      public RecallMetric()

  • Method Details

    • fromXContent

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

    • getName

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

    • 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

    • equals

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

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object