Class ClassifyMetrics

  • All Implemented Interfaces:
    IBaseMetrics

    public final class ClassifyMetrics
    extends java.lang.Object
    implements IBaseMetrics
    • Method Detail

      • getNumFiles

        public java.util.Optional<java.lang.Double> getNumFiles()
        Specified by:
        getNumFiles in interface IBaseMetrics
        Returns:
        The total number of files that were processed.
      • getNumPages

        public java.util.Optional<java.lang.Double> getNumPages()
        Specified by:
        getNumPages in interface IBaseMetrics
        Returns:
        The total number of pages that were processed.
      • getMeanRunTimeMs

        public java.util.Optional<java.lang.Double> getMeanRunTimeMs()
        Specified by:
        getMeanRunTimeMs in interface IBaseMetrics
        Returns:
        The mean runtime in milliseconds per document.
      • getType

        public java.util.Optional<java.lang.String> getType()
        Returns:
        The type of metrics. Will always be "CLASSIFY" for classification processors.
      • getAccuracyPerc

        public java.util.Optional<java.lang.Double> getAccuracyPerc()
        Returns:
        The overall accuracy percentage.
      • getMeanConfidence

        public java.util.Optional<java.lang.Double> getMeanConfidence()
        Returns:
        The mean confidence score.
      • getDistribution

        public java.util.Optional<java.util.Map<java.lang.String,​java.lang.Object>> getDistribution()
        Returns:
        Record mapping classification values to their counts.
      • getAccuracyPercByClassification

        public java.util.Optional<java.util.Map<java.lang.String,​java.lang.Object>> getAccuracyPercByClassification()
        Returns:
        Mapping from classification to accuracy percentage as calculated from the confusion matrix.
      • getConfusionMatrix

        public java.util.Optional<java.util.Map<java.lang.String,​java.lang.Object>> getConfusionMatrix()
        Returns:
        Mapping from actual class to predicted class to count. Only present when accuracy percentage is present.
      • equals

        public boolean equals​(java.lang.Object other)
        Overrides:
        equals in class java.lang.Object
      • getAdditionalProperties

        public java.util.Map<java.lang.String,​java.lang.Object> getAdditionalProperties()
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object