Package software.amazon.awssdk.services.forecast.model

Class EvaluationParameters

java.lang.Object

software.amazon.awssdk.services.forecast.model.EvaluationParameters

All Implemented Interfaces:

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

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

Parameters that define how to split a dataset into training data and testing data, and the number of iterations to perform. These parameters are specified in the predefined algorithms but you can override them in the CreatePredictor request.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	EvaluationParameters.Builder

Method Summary

Modifier and Type	Method	Description
Integer	backTestWindowOffset()	The point from the end of the dataset where you want to split the data for model training and testing (evaluation).
static EvaluationParameters.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	numberOfBacktestWindows()	The number of times to split the input data.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends EvaluationParameters.Builder>	serializableBuilderClass()
EvaluationParameters.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

numberOfBacktestWindows

public final Integer numberOfBacktestWindows()

The number of times to split the input data. The default is 1. Valid values are 1 through 5.

Returns:

The number of times to split the input data. The default is 1. Valid values are 1 through 5.

backTestWindowOffset

public final Integer backTestWindowOffset()

The point from the end of the dataset where you want to split the data for model training and testing (evaluation). Specify the value as the number of data points. The default is the value of the forecast horizon. BackTestWindowOffset can be used to mimic a past virtual forecast start date. This value must be greater than or equal to the forecast horizon and less than half of the TARGET_TIME_SERIES dataset length.

ForecastHorizon <= BackTestWindowOffset < 1/2 * TARGET_TIME_SERIES dataset length

Returns:

The point from the end of the dataset where you want to split the data for model training and testing (evaluation). Specify the value as the number of data points. The default is the value of the forecast horizon. BackTestWindowOffset can be used to mimic a past virtual forecast start date. This value must be greater than or equal to the forecast horizon and less than half of the TARGET_TIME_SERIES dataset length.

ForecastHorizon <= BackTestWindowOffset < 1/2 * TARGET_TIME_SERIES dataset length

toBuilder

public EvaluationParameters.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<EvaluationParameters.Builder,EvaluationParameters>

builder

public static EvaluationParameters.Builder builder()

serializableBuilderClass

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo