Class ClassificationEvaluationMetrics (2.55.0)

public final class ClassificationEvaluationMetrics extends 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

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > ClassificationEvaluationMetrics

Static Fields

ANNOTATION_SPEC_ID_FIELD_NUMBER

public static final int ANNOTATION_SPEC_ID_FIELD_NUMBER
Field Value
Type Description
int

AU_PRC_FIELD_NUMBER

public static final int AU_PRC_FIELD_NUMBER
Field Value
Type Description
int

AU_ROC_FIELD_NUMBER

public static final int AU_ROC_FIELD_NUMBER
Field Value
Type Description
int

CONFIDENCE_METRICS_ENTRY_FIELD_NUMBER

public static final int CONFIDENCE_METRICS_ENTRY_FIELD_NUMBER
Field Value
Type Description
int

CONFUSION_MATRIX_FIELD_NUMBER

public static final int CONFUSION_MATRIX_FIELD_NUMBER
Field Value
Type Description
int

LOG_LOSS_FIELD_NUMBER

public static final int LOG_LOSS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ClassificationEvaluationMetrics getDefaultInstance()
Returns
Type Description
ClassificationEvaluationMetrics

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static ClassificationEvaluationMetrics.Builder newBuilder()
Returns
Type Description
ClassificationEvaluationMetrics.Builder

newBuilder(ClassificationEvaluationMetrics prototype)

public static ClassificationEvaluationMetrics.Builder newBuilder(ClassificationEvaluationMetrics prototype)
Parameter
Name Description
prototype ClassificationEvaluationMetrics
Returns
Type Description
ClassificationEvaluationMetrics.Builder

parseDelimitedFrom(InputStream input)

public static ClassificationEvaluationMetrics parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ClassificationEvaluationMetrics
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ClassificationEvaluationMetrics parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ClassificationEvaluationMetrics
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static ClassificationEvaluationMetrics parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
ClassificationEvaluationMetrics
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ClassificationEvaluationMetrics parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ClassificationEvaluationMetrics
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ClassificationEvaluationMetrics parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
ClassificationEvaluationMetrics
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ClassificationEvaluationMetrics parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ClassificationEvaluationMetrics
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ClassificationEvaluationMetrics parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
ClassificationEvaluationMetrics
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ClassificationEvaluationMetrics parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ClassificationEvaluationMetrics
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static ClassificationEvaluationMetrics parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ClassificationEvaluationMetrics
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ClassificationEvaluationMetrics parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ClassificationEvaluationMetrics
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static ClassificationEvaluationMetrics parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
ClassificationEvaluationMetrics
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ClassificationEvaluationMetrics parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ClassificationEvaluationMetrics
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<ClassificationEvaluationMetrics> parser()
Returns
Type Description
Parser<ClassificationEvaluationMetrics>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getAnnotationSpecId(int index)

public String getAnnotationSpecId(int index)

Output only. The annotation spec ids used for this evaluation.

repeated string annotation_spec_id = 5;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The annotationSpecId at the given index.

getAnnotationSpecIdBytes(int index)

public ByteString getAnnotationSpecIdBytes(int index)

Output only. The annotation spec ids used for this evaluation.

repeated string annotation_spec_id = 5;

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the annotationSpecId at the given index.

getAnnotationSpecIdCount()

public int getAnnotationSpecIdCount()

Output only. The annotation spec ids used for this evaluation.

repeated string annotation_spec_id = 5;

Returns
Type Description
int

The count of annotationSpecId.

getAnnotationSpecIdList()

public ProtocolStringList getAnnotationSpecIdList()

Output only. The annotation spec ids used for this evaluation.

repeated string annotation_spec_id = 5;

Returns
Type Description
ProtocolStringList

A list containing the annotationSpecId.

getAuPrc()

public float getAuPrc()

Output only. The Area Under Precision-Recall Curve metric. Micro-averaged for the overall evaluation.

float au_prc = 1;

Returns
Type Description
float

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;

Returns
Type Description
float

The auRoc.

getConfidenceMetricsEntry(int index)

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;

Parameter
Name Description
index int
Returns
Type Description
ClassificationEvaluationMetrics.ConfidenceMetricsEntry

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;

Returns
Type Description
int

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;

Returns
Type Description
List<ConfidenceMetricsEntry>

getConfidenceMetricsEntryOrBuilder(int index)

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;

Parameter
Name Description
index int
Returns
Type Description
ClassificationEvaluationMetrics.ConfidenceMetricsEntryOrBuilder

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;

Returns
Type Description
List<? extends com.google.cloud.automl.v1.ClassificationEvaluationMetrics.ConfidenceMetricsEntryOrBuilder>

getConfusionMatrix()

public ClassificationEvaluationMetrics.ConfusionMatrix getConfusionMatrix()

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;

Returns
Type Description
ClassificationEvaluationMetrics.ConfusionMatrix

The confusionMatrix.

getConfusionMatrixOrBuilder()

public ClassificationEvaluationMetrics.ConfusionMatrixOrBuilder getConfusionMatrixOrBuilder()

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;

Returns
Type Description
ClassificationEvaluationMetrics.ConfusionMatrixOrBuilder

getDefaultInstanceForType()

public ClassificationEvaluationMetrics getDefaultInstanceForType()
Returns
Type Description
ClassificationEvaluationMetrics

getLogLoss()

public float getLogLoss()

Output only. The Log Loss metric.

float log_loss = 7;

Returns
Type Description
float

The logLoss.

getParserForType()

public Parser<ClassificationEvaluationMetrics> getParserForType()
Returns
Type Description
Parser<ClassificationEvaluationMetrics>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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;

Returns
Type Description
boolean

Whether the confusionMatrix field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public ClassificationEvaluationMetrics.Builder newBuilderForType()
Returns
Type Description
ClassificationEvaluationMetrics.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ClassificationEvaluationMetrics.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ClassificationEvaluationMetrics.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public ClassificationEvaluationMetrics.Builder toBuilder()
Returns
Type Description
ClassificationEvaluationMetrics.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException