Class Metrics

java.lang.Object
software.amazon.awssdk.services.forecast.model.Metrics
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<Metrics.Builder,Metrics>
@Generated("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:

  • Method Details

    • rmse

      @Deprecated public final Double rmse()
      Deprecated.
      This property is deprecated, please refer to ErrorMetrics for both RMSE and WAPE

      The root-mean-square error (RMSE).

      Returns:
      The root-mean-square error (RMSE).

    • hasWeightedQuantileLosses

      public final boolean hasWeightedQuantileLosses()
      For responses, this returns true if the service returned a value for the WeightedQuantileLosses 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.

    • 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.

      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 hasWeightedQuantileLosses() method.

      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()
      For responses, this returns true if the service returned a value for the ErrorMetrics 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.

    • errorMetrics

      public final List<ErrorMetric> errorMetrics()

      Provides detailed error metrics for each forecast type. Metrics include root-mean square-error (RMSE), mean absolute percentage error (MAPE), mean absolute scaled error (MASE), and weighted average percentage error (WAPE).

      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 hasErrorMetrics() method.

      Returns:
      Provides detailed error metrics for each forecast type. Metrics include root-mean square-error (RMSE), mean absolute percentage error (MAPE), mean absolute scaled error (MASE), and weighted average percentage error (WAPE).

    • averageWeightedQuantileLoss

      public final Double averageWeightedQuantileLoss()

      The average value of all weighted quantile losses.

      Returns:
      The average value of all weighted quantile losses.

    • toBuilder

      public Metrics.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<Metrics.Builder,Metrics>
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.