software.amazon.awssdk.services.comprehend.model

Class ClassifierEvaluationMetrics

java.lang.Object

software.amazon.awssdk.services.comprehend.model.ClassifierEvaluationMetrics

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ClassifierEvaluationMetrics.Builder,ClassifierEvaluationMetrics>

@Generated(value="software.amazon.awssdk:codegen")
public final class ClassifierEvaluationMetrics
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ClassifierEvaluationMetrics.Builder,ClassifierEvaluationMetrics>

Describes the result metrics for the test data associated with an documentation classifier.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ClassifierEvaluationMetrics.Builder

Method Summary

Modifier and Type	Method and Description
Double	accuracy() The fraction of the labels that were correct recognized.
static ClassifierEvaluationMetrics.Builder	builder()
boolean	equals(Object obj)
Double	f1Score() A measure of how accurate the classifier results are for the test data.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Double	precision() A measure of the usefulness of the classifier results in the test data.
Double	recall() A measure of how complete the classifier results are for the test data.
List<SdkField<?>>	sdkFields()
static Class<? extends ClassifierEvaluationMetrics.Builder>	serializableBuilderClass()
ClassifierEvaluationMetrics.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

accuracy

public Double accuracy()

The fraction of the labels that were correct recognized. It is computed by dividing the number of labels in the test documents that were correctly recognized by the total number of labels in the test documents.

Returns:

The fraction of the labels that were correct recognized. It is computed by dividing the number of labels in the test documents that were correctly recognized by the total number of labels in the test documents.

precision

public Double precision()

A measure of the usefulness of the classifier results in the test data. High precision means that the classifier returned substantially more relevant results than irrelevant ones.

Returns:

A measure of the usefulness of the classifier results in the test data. High precision means that the classifier returned substantially more relevant results than irrelevant ones.

recall

public Double recall()

A measure of how complete the classifier results are for the test data. High recall means that the classifier returned most of the relevant results.

Returns:

A measure of how complete the classifier results are for the test data. High recall means that the classifier returned most of the relevant results.

f1Score

public Double f1Score()

A measure of how accurate the classifier results are for the test data. It is derived from the Precision and Recall values. The F1Score is the harmonic average of the two scores. The highest score is 1, and the worst score is 0.

Returns:

A measure of how accurate the classifier results are for the test data. It is derived from the Precision and Recall values. The F1Score is the harmonic average of the two scores. The highest score is 1, and the worst score is 0.

toBuilder

public ClassifierEvaluationMetrics.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<ClassifierEvaluationMetrics.Builder,ClassifierEvaluationMetrics>

Returns:

a builder for type T

builder

public static ClassifierEvaluationMetrics.Builder builder()

serializableBuilderClass

public static Class<? extends ClassifierEvaluationMetrics.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.