Class Metrics
- All Implemented Interfaces:
Serializable
,SdkPojo
,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:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal Double
The average value of all weighted quantile losses.static Metrics.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final List
<ErrorMetric> Provides detailed error metrics for each forecast type.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the ErrorMetrics property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the WeightedQuantileLosses property.final Double
rmse()
Deprecated.This property is deprecated, please refer to ErrorMetrics for both RMSE and WAPEstatic Class
<? extends Metrics.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final List
<WeightedQuantileLoss> An array of weighted quantile losses.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
rmse
Deprecated.This property is deprecated, please refer to ErrorMetrics for both RMSE and WAPEThe 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 theisEmpty()
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
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 theisEmpty()
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
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
The average value of all weighted quantile losses.
- Returns:
- The average value of all weighted quantile losses.
-
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 interfaceToCopyableBuilder<Metrics.Builder,
Metrics> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-