software.amazon.awssdk.services.forecast.model

Class Metrics

java.lang.Object

software.amazon.awssdk.services.forecast.model.Metrics

All Implemented Interfaces:

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

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

Provides metrics that are used to evaluate the performance of a predictor. This object is part of the WindowSummary object.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Metrics.Builder

Method Summary

Modifier and Type	Method and Description
static Metrics.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<ErrorMetric>	errorMetrics() Provides detailed error metrics on forecast type, root-mean square-error (RMSE), and weighted average percentage error (WAPE).
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasErrorMetrics() Returns true if the ErrorMetrics property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
int	hashCode()
boolean	hasWeightedQuantileLosses() Returns true if the WeightedQuantileLosses property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
Double	rmse() The root-mean-square error (RMSE).
List<SdkField<?>>	sdkFields()
static Class<? extends Metrics.Builder>	serializableBuilderClass()
Metrics.Builder	toBuilder()
String	toString() Returns a string representation of this object.
List<WeightedQuantileLoss>	weightedQuantileLosses() An array of weighted quantile losses.

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

rmse

public final Double rmse()

The root-mean-square error (RMSE).

Returns:

The root-mean-square error (RMSE).

hasWeightedQuantileLosses

public final boolean hasWeightedQuantileLosses()

Returns true if the WeightedQuantileLosses property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

weightedQuantileLosses

public final List<WeightedQuantileLoss> weightedQuantileLosses()

An array of weighted quantile losses. Quantiles divide a probability distribution into regions of equal probability. The distribution in this case is the loss function.

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

You can use hasWeightedQuantileLosses() to see if a value was sent in this field.

Returns:

An array of weighted quantile losses. Quantiles divide a probability distribution into regions of equal probability. The distribution in this case is the loss function.

hasErrorMetrics

public final boolean hasErrorMetrics()

Returns true if the ErrorMetrics property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

errorMetrics

public final List<ErrorMetric> errorMetrics()

Provides detailed error metrics on forecast type, root-mean square-error (RMSE), and weighted average percentage error (WAPE).

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

You can use hasErrorMetrics() to see if a value was sent in this field.

Returns:

Provides detailed error metrics on forecast type, root-mean square-error (RMSE), and weighted average percentage error (WAPE).

toBuilder

public Metrics.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Metrics.Builder,Metrics>

builder

public static Metrics.Builder builder()

serializableBuilderClass

public static Class<? extends Metrics.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