Class ErrorMetric

java.lang.Object
software.amazon.awssdk.services.forecast.model.ErrorMetric
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<ErrorMetric.Builder,ErrorMetric>
@Generated("software.amazon.awssdk:codegen") public final class ErrorMetric extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ErrorMetric.Builder,ErrorMetric>

Provides detailed error metrics to evaluate the performance of a predictor. This object is part of the Metrics object.

See Also:

  • Method Details

    • forecastType

      public final String forecastType()

      The Forecast type used to compute WAPE, MAPE, MASE, and RMSE.

      Returns:
      The Forecast type used to compute WAPE, MAPE, MASE, and RMSE.

    • wape

      public final Double wape()

      The weighted absolute percentage error (WAPE).

      Returns:
      The weighted absolute percentage error (WAPE).

    • rmse

      public final Double rmse()

      The root-mean-square error (RMSE).

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

    • mase

      public final Double mase()

      The Mean Absolute Scaled Error (MASE)

      Returns:
      The Mean Absolute Scaled Error (MASE)

    • mape

      public final Double mape()

      The Mean Absolute Percentage Error (MAPE)

      Returns:
      The Mean Absolute Percentage Error (MAPE)

    • toBuilder

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

    • builder

      public static ErrorMetric.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.