Package software.amazon.awssdk.services.machinelearning.model

Class PerformanceMetrics

java.lang.Object

software.amazon.awssdk.services.machinelearning.model.PerformanceMetrics

All Implemented Interfaces:

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

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

Measurements of how well the MLModel performed on known observations. One of the following metrics is returned, based on the type of the MLModel:

• BinaryAUC: The binary MLModel uses the Area Under the Curve (AUC) technique to measure performance.

• RegressionRMSE: The regression MLModel uses the Root Mean Square Error (RMSE) technique to measure performance. RMSE measures the difference between predicted and actual values for a single variable.

• MulticlassAvgFScore: The multiclass MLModel uses the F1 score technique to measure performance.

For more information about performance metrics, please see the Amazon Machine Learning Developer Guide.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	PerformanceMetrics.Builder

Method Summary

Modifier and Type	Method	Description
static PerformanceMetrics.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasProperties()	For responses, this returns true if the service returned a value for the Properties property.
Map<String,String>	properties()	Returns the value of the Properties property for this object.
List<SdkField<?>>	sdkFields()
static Class<? extends PerformanceMetrics.Builder>	serializableBuilderClass()
PerformanceMetrics.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

hasProperties

public final boolean hasProperties()

For responses, this returns true if the service returned a value for the Properties property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

properties

public final Map<String,String> properties()

Returns the value of the Properties property for this object.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasProperties() method.

Returns:

The value of the Properties property for this object.

toBuilder

public PerformanceMetrics.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<PerformanceMetrics.Builder,PerformanceMetrics>

builder

public static PerformanceMetrics.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

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

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo