Enum Class MultiLabelMetrics

java.lang.Object
java.lang.Enum<MultiLabelMetrics>
org.tribuo.multilabel.evaluation.MultiLabelMetrics
All Implemented Interfaces:
Serializable, Comparable<MultiLabelMetrics>, Constable

public enum MultiLabelMetrics extends Enum<MultiLabelMetrics>
An enum of the default MultiLabelMetrics supported by the multi-label classification evaluation package.
  • Enum Constant Details

    • TP

      public static final MultiLabelMetrics TP
      The number of true positives.
    • FP

      public static final MultiLabelMetrics FP
      The number of false positives.
    • TN

      public static final MultiLabelMetrics TN
      The number of true negatives.
    • FN

      public static final MultiLabelMetrics FN
      The number of false negatives.
    • PRECISION

      public static final MultiLabelMetrics PRECISION
      The precision, i.e., the number of true positives divided by the number of predicted positives.
    • RECALL

      public static final MultiLabelMetrics RECALL
      The recall, i.e., the number of true positives divided by the number of ground truth positives.
    • F1

      public static final MultiLabelMetrics F1
      The F_1 score, i.e., the harmonic mean of the precision and the recall.
    • BALANCED_ERROR_RATE

      public static final MultiLabelMetrics BALANCED_ERROR_RATE
      The balanced error rate, i.e., the mean of the per class recalls.
    • JACCARD_SCORE

      public static final MultiLabelMetrics JACCARD_SCORE
      The Jaccard score, i.e., the average across the predictions of the intersection over union.
  • Method Details

    • values

      public static MultiLabelMetrics[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared
    • valueOf

      public static MultiLabelMetrics valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null
    • getImpl

      public BiFunction<MetricTarget<MultiLabel>,org.tribuo.multilabel.evaluation.MultiLabelMetric.Context,Double> getImpl()
      Get the implementation function for this metric.
      Returns:
      The function.
    • forTarget

      public MultiLabelMetric forTarget(MetricTarget<MultiLabel> tgt)
      Get the metric for the supplied target.
      Parameters:
      tgt - The metric target.
      Returns:
      The metric.
    • jaccardScore

      public static double jaccardScore(List<Prediction<MultiLabel>> predictions)
      The average Jaccard score across the predictions.
      Parameters:
      predictions - The predictions to use.
      Returns:
      The average Jaccard score.