Package com.google.cloud.automl.v1

Class ClassificationEvaluationMetrics

  • All Implemented Interfaces:
    ClassificationEvaluationMetricsOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class ClassificationEvaluationMetrics
extends com.google.protobuf.GeneratedMessageV3
implements ClassificationEvaluationMetricsOrBuilder
     Model evaluation metrics for classification problems.
 Note: For Video Classification this metrics only describe quality of the
 Video Classification predictions of "segment_classification" type.
    Protobuf type google.cloud.automl.v1.ClassificationEvaluationMetrics
    See Also:
    Serialized Form

    • Field Detail

      • CONFIDENCE_METRICS_ENTRY_FIELD_NUMBER

        public static final int CONFIDENCE_METRICS_ENTRY_FIELD_NUMBER
        See Also:
        Constant Field Values

      • CONFUSION_MATRIX_FIELD_NUMBER

        public static final int CONFUSION_MATRIX_FIELD_NUMBER
        See Also:
        Constant Field Values

      • ANNOTATION_SPEC_ID_FIELD_NUMBER

        public static final int ANNOTATION_SPEC_ID_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • getAuPrc

        public float getAuPrc()
         Output only. The Area Under Precision-Recall Curve metric. Micro-averaged
 for the overall evaluation.
        float au_prc = 1;
        Specified by:
        getAuPrc in interface ClassificationEvaluationMetricsOrBuilder
        Returns:
        The auPrc.

      • getAuRoc

        public float getAuRoc()
         Output only. The Area Under Receiver Operating Characteristic curve metric.
 Micro-averaged for the overall evaluation.
        float au_roc = 6;
        Specified by:
        getAuRoc in interface ClassificationEvaluationMetricsOrBuilder
        Returns:
        The auRoc.

      • getConfidenceMetricsEntryList

        public List<ClassificationEvaluationMetrics.ConfidenceMetricsEntry> getConfidenceMetricsEntryList()
         Output only. Metrics for each confidence_threshold in
 0.00,0.05,0.10,...,0.95,0.96,0.97,0.98,0.99 and
 position_threshold = INT32_MAX_VALUE.
 ROC and precision-recall curves, and other aggregated metrics are derived
 from them. The confidence metrics entries may also be supplied for
 additional values of position_threshold, but from these no aggregated
 metrics are computed.
        repeated .google.cloud.automl.v1.ClassificationEvaluationMetrics.ConfidenceMetricsEntry confidence_metrics_entry = 3;
        Specified by:
        getConfidenceMetricsEntryList in interface ClassificationEvaluationMetricsOrBuilder

      • getConfidenceMetricsEntryOrBuilderList

        public List<? extends ClassificationEvaluationMetrics.ConfidenceMetricsEntryOrBuilder> getConfidenceMetricsEntryOrBuilderList()
         Output only. Metrics for each confidence_threshold in
 0.00,0.05,0.10,...,0.95,0.96,0.97,0.98,0.99 and
 position_threshold = INT32_MAX_VALUE.
 ROC and precision-recall curves, and other aggregated metrics are derived
 from them. The confidence metrics entries may also be supplied for
 additional values of position_threshold, but from these no aggregated
 metrics are computed.
        repeated .google.cloud.automl.v1.ClassificationEvaluationMetrics.ConfidenceMetricsEntry confidence_metrics_entry = 3;
        Specified by:
        getConfidenceMetricsEntryOrBuilderList in interface ClassificationEvaluationMetricsOrBuilder

      • getConfidenceMetricsEntryCount

        public int getConfidenceMetricsEntryCount()
         Output only. Metrics for each confidence_threshold in
 0.00,0.05,0.10,...,0.95,0.96,0.97,0.98,0.99 and
 position_threshold = INT32_MAX_VALUE.
 ROC and precision-recall curves, and other aggregated metrics are derived
 from them. The confidence metrics entries may also be supplied for
 additional values of position_threshold, but from these no aggregated
 metrics are computed.
        repeated .google.cloud.automl.v1.ClassificationEvaluationMetrics.ConfidenceMetricsEntry confidence_metrics_entry = 3;
        Specified by:
        getConfidenceMetricsEntryCount in interface ClassificationEvaluationMetricsOrBuilder

      • getConfidenceMetricsEntry

        public ClassificationEvaluationMetrics.ConfidenceMetricsEntry getConfidenceMetricsEntry​(int index)
         Output only. Metrics for each confidence_threshold in
 0.00,0.05,0.10,...,0.95,0.96,0.97,0.98,0.99 and
 position_threshold = INT32_MAX_VALUE.
 ROC and precision-recall curves, and other aggregated metrics are derived
 from them. The confidence metrics entries may also be supplied for
 additional values of position_threshold, but from these no aggregated
 metrics are computed.
        repeated .google.cloud.automl.v1.ClassificationEvaluationMetrics.ConfidenceMetricsEntry confidence_metrics_entry = 3;
        Specified by:
        getConfidenceMetricsEntry in interface ClassificationEvaluationMetricsOrBuilder

      • getConfidenceMetricsEntryOrBuilder

        public ClassificationEvaluationMetrics.ConfidenceMetricsEntryOrBuilder getConfidenceMetricsEntryOrBuilder​(int index)
         Output only. Metrics for each confidence_threshold in
 0.00,0.05,0.10,...,0.95,0.96,0.97,0.98,0.99 and
 position_threshold = INT32_MAX_VALUE.
 ROC and precision-recall curves, and other aggregated metrics are derived
 from them. The confidence metrics entries may also be supplied for
 additional values of position_threshold, but from these no aggregated
 metrics are computed.
        repeated .google.cloud.automl.v1.ClassificationEvaluationMetrics.ConfidenceMetricsEntry confidence_metrics_entry = 3;
        Specified by:
        getConfidenceMetricsEntryOrBuilder in interface ClassificationEvaluationMetricsOrBuilder

      • hasConfusionMatrix

        public boolean hasConfusionMatrix()
         Output only. Confusion matrix of the evaluation.
 Only set for MULTICLASS classification problems where number
 of labels is no more than 10.
 Only set for model level evaluation, not for evaluation per label.
        .google.cloud.automl.v1.ClassificationEvaluationMetrics.ConfusionMatrix confusion_matrix = 4;
        Specified by:
        hasConfusionMatrix in interface ClassificationEvaluationMetricsOrBuilder
        Returns:
        Whether the confusionMatrix field is set.

      • getAnnotationSpecIdList

        public com.google.protobuf.ProtocolStringList getAnnotationSpecIdList()
         Output only. The annotation spec ids used for this evaluation.
        repeated string annotation_spec_id = 5;
        Specified by:
        getAnnotationSpecIdList in interface ClassificationEvaluationMetricsOrBuilder
        Returns:
        A list containing the annotationSpecId.

      • getAnnotationSpecId

        public String getAnnotationSpecId​(int index)
         Output only. The annotation spec ids used for this evaluation.
        repeated string annotation_spec_id = 5;
        Specified by:
        getAnnotationSpecId in interface ClassificationEvaluationMetricsOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The annotationSpecId at the given index.

      • getAnnotationSpecIdBytes

        public com.google.protobuf.ByteString getAnnotationSpecIdBytes​(int index)
         Output only. The annotation spec ids used for this evaluation.
        repeated string annotation_spec_id = 5;
        Specified by:
        getAnnotationSpecIdBytes in interface ClassificationEvaluationMetricsOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the annotationSpecId at the given index.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static ClassificationEvaluationMetrics parseFrom​(ByteBuffer data)
                                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ClassificationEvaluationMetrics parseFrom​(ByteBuffer data,
                                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ClassificationEvaluationMetrics parseFrom​(com.google.protobuf.ByteString data)
                                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ClassificationEvaluationMetrics parseFrom​(com.google.protobuf.ByteString data,
                                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ClassificationEvaluationMetrics parseFrom​(byte[] data)
                                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ClassificationEvaluationMetrics parseFrom​(byte[] data,
                                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • newBuilderForType

        public ClassificationEvaluationMetrics.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public ClassificationEvaluationMetrics.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected ClassificationEvaluationMetrics.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

        public com.google.protobuf.Parser<ClassificationEvaluationMetrics> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public ClassificationEvaluationMetrics getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder