software.amazon.awssdk.services.forecast.model

Interface Metrics.Builder

All Superinterfaces:

Buildable, CopyableBuilder<Metrics.Builder,Metrics>, SdkBuilder<Metrics.Builder,Metrics>, SdkPojo

Enclosing class:

Metrics

public static interface Metrics.Builder
extends SdkPojo, CopyableBuilder<Metrics.Builder,Metrics>

Method Summary

Modifier and Type	Method and Description
Metrics.Builder	averageWeightedQuantileLoss(Double averageWeightedQuantileLoss) The average value of all weighted quantile losses.
Metrics.Builder	errorMetrics(Collection<ErrorMetric> errorMetrics) Provides detailed error metrics for each forecast type.
Metrics.Builder	errorMetrics(Consumer<ErrorMetric.Builder>... errorMetrics) Provides detailed error metrics for each forecast type.
Metrics.Builder	errorMetrics(ErrorMetric... errorMetrics) Provides detailed error metrics for each forecast type.
Metrics.Builder	rmse(Double rmse) Deprecated. This property is deprecated, please refer to ErrorMetrics for both RMSE and WAPE
Metrics.Builder	weightedQuantileLosses(Collection<WeightedQuantileLoss> weightedQuantileLosses) An array of weighted quantile losses.
Metrics.Builder	weightedQuantileLosses(Consumer<WeightedQuantileLoss.Builder>... weightedQuantileLosses) An array of weighted quantile losses.
Metrics.Builder	weightedQuantileLosses(WeightedQuantileLoss... weightedQuantileLosses) An array of weighted quantile losses.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

rmse

@Deprecated
Metrics.Builder rmse(Double rmse)

Deprecated. This property is deprecated, please refer to ErrorMetrics for both RMSE and WAPE

The root-mean-square error (RMSE).

Parameters:

rmse - The root-mean-square error (RMSE).

Returns:

Returns a reference to this object so that method calls can be chained together.

weightedQuantileLosses

Metrics.Builder weightedQuantileLosses(Collection<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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

weightedQuantileLosses

Metrics.Builder weightedQuantileLosses(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

weightedQuantileLosses

Metrics.Builder weightedQuantileLosses(Consumer<WeightedQuantileLoss.Builder>... 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.

This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #weightedQuantileLosses(List).

Parameters:

weightedQuantileLosses - a consumer that will call methods on List.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#weightedQuantileLosses(List)

errorMetrics

Metrics.Builder errorMetrics(Collection<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).

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

errorMetrics

Metrics.Builder errorMetrics(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).

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

errorMetrics

Metrics.Builder errorMetrics(Consumer<ErrorMetric.Builder>... 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).

This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #errorMetrics(List).

Parameters:

errorMetrics - a consumer that will call methods on List.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#errorMetrics(List)

averageWeightedQuantileLoss

Metrics.Builder averageWeightedQuantileLoss(Double averageWeightedQuantileLoss)

The average value of all weighted quantile losses.

Parameters:

averageWeightedQuantileLoss - The average value of all weighted quantile losses.

Returns:

Returns a reference to this object so that method calls can be chained together.