ForecastingSettingsArgs

data class ForecastingSettingsArgs(val countryOrRegionForHolidays: Output<String>? = null, val cvStepSize: Output<Int>? = null, val featureLags: Output<Either<String, FeatureLags>>? = null, val forecastHorizon: Output<Either<AutoForecastHorizonArgs, CustomForecastHorizonArgs>>? = null, val frequency: Output<String>? = null, val seasonality: Output<Either<AutoSeasonalityArgs, CustomSeasonalityArgs>>? = null, val shortSeriesHandlingConfig: Output<Either<String, ShortSeriesHandlingConfiguration>>? = null, val targetAggregateFunction: Output<Either<String, TargetAggregationFunction>>? = null, val targetLags: Output<Either<AutoTargetLagsArgs, CustomTargetLagsArgs>>? = null, val targetRollingWindowSize: Output<Either<AutoTargetRollingWindowSizeArgs, CustomTargetRollingWindowSizeArgs>>? = null, val timeColumnName: Output<String>? = null, val timeSeriesIdColumnNames: Output<List<String>>? = null, val useStl: Output<Either<String, UseStl>>? = null) : ConvertibleToJava<ForecastingSettingsArgs>

Forecasting specific parameters.

Constructors

Link copied to clipboard
constructor(countryOrRegionForHolidays: Output<String>? = null, cvStepSize: Output<Int>? = null, featureLags: Output<Either<String, FeatureLags>>? = null, forecastHorizon: Output<Either<AutoForecastHorizonArgs, CustomForecastHorizonArgs>>? = null, frequency: Output<String>? = null, seasonality: Output<Either<AutoSeasonalityArgs, CustomSeasonalityArgs>>? = null, shortSeriesHandlingConfig: Output<Either<String, ShortSeriesHandlingConfiguration>>? = null, targetAggregateFunction: Output<Either<String, TargetAggregationFunction>>? = null, targetLags: Output<Either<AutoTargetLagsArgs, CustomTargetLagsArgs>>? = null, targetRollingWindowSize: Output<Either<AutoTargetRollingWindowSizeArgs, CustomTargetRollingWindowSizeArgs>>? = null, timeColumnName: Output<String>? = null, timeSeriesIdColumnNames: Output<List<String>>? = null, useStl: Output<Either<String, UseStl>>? = null)

Properties

Link copied to clipboard
val countryOrRegionForHolidays: Output<String>? = null

Country or region for holidays for forecasting tasks. These should be ISO 3166 two-letter country/region codes, for example 'US' or 'GB'.

Link copied to clipboard
val cvStepSize: Output<Int>? = null

Number of periods between the origin time of one CV fold and the next fold. For example, if CVStepSize = 3 for daily data, the origin time for each fold will be three days apart.

Link copied to clipboard
val featureLags: Output<Either<String, FeatureLags>>? = null

Flag for generating lags for the numeric features with 'auto' or null.

Link copied to clipboard

The desired maximum forecast horizon in units of time-series frequency.

Link copied to clipboard
val frequency: Output<String>? = null

When forecasting, this parameter represents the period with which the forecast is desired, for example daily, weekly, yearly, etc. The forecast frequency is dataset frequency by default.

Link copied to clipboard

Set time series seasonality as an integer multiple of the series frequency. If seasonality is set to 'auto', it will be inferred.

Link copied to clipboard

The parameter defining how if AutoML should handle short time series.

Link copied to clipboard

The function to be used to aggregate the time series target column to conform to a user specified frequency. If the TargetAggregateFunction is set i.e. not 'None', but the freq parameter is not set, the error is raised. The possible target aggregation functions are: "sum", "max", "min" and "mean".

Link copied to clipboard
val targetLags: Output<Either<AutoTargetLagsArgs, CustomTargetLagsArgs>>? = null

The number of past periods to lag from the target column.

Link copied to clipboard

The number of past periods used to create a rolling window average of the target column.

Link copied to clipboard
val timeColumnName: Output<String>? = null

The name of the time column. This parameter is required when forecasting to specify the datetime column in the input data used for building the time series and inferring its frequency.

Link copied to clipboard
val timeSeriesIdColumnNames: Output<List<String>>? = null

The names of columns used to group a timeseries. It can be used to create multiple series. If grain is not defined, the data set is assumed to be one time-series. This parameter is used with task type forecasting.

Link copied to clipboard
val useStl: Output<Either<String, UseStl>>? = null

Configure STL Decomposition of the time-series target column.

Functions

Link copied to clipboard
open override fun toJava(): ForecastingSettingsArgs