MODULE REFERENCE
native
anomx.models.forecasting.nativeNative, inspectable forecasting baselines operating on Anomx TimeSeries.
These implementations do not import Darts. Their fit/predict convention makes chronological experiments easy to read while keeping statistical assumptions explicit: inputs are regular, deterministic, finite series; forecasts begin immediately after the supplied history; no scaling or imputation is implicit.
ForecastingModel
ForecastingModel()Bases: NormalityModel, Predictive
Base for deterministic local forecasts with explicit horizons.
Fit returns the model; predict(n, series=...) returns the next n time steps. A supplied series changes the prediction context without changing fitted parameters. Subclasses declare min_train_series_length and implement _fit_values and _predict_values.
Members
min_train_series_lengthattribute
min_train_series_length = 1min_predict_series_lengthattribute
min_predict_series_length = 1preferred_viewattribute
preferred_view = 'timeseries'capabilitiesattribute
capabilities = ComponentCapabilities(supports_unordered_samples=False, supports_sequences=True, supports_irregular_sampling=False, requires_regular_sampling=True)fitmethod
fit(series: TimeSeries, **kwargs: object) -> ForecastingModelFit one series, recording the exact training time span and components.
| Parameter | Type | Default |
|---|---|---|
series | TimeSeries | required |
**kwargs | object | — |
Returns ForecastingModel
predictmethod
predict(n: int, series: TimeSeries | None = None, *, num_samples: int = 1) -> TimeSeriesForecast after the context's end; no test observations are consumed.
| Parameter | Type | Default |
|---|---|---|
n | int | required |
series | TimeSeries | None | None |
num_sampleskeyword only | int | 1 |
Returns TimeSeries
forecastmethod
forecast(data: TimeSeries, horizon: int) -> TimeSeriesImplement the predictive capability using an explicit history and horizon.
| Parameter | Type | Default |
|---|---|---|
data | TimeSeries | required |
horizon | int | required |
Returns TimeSeries
historical_forecastsmethod
historical_forecasts(series: TimeSeries, *, start: int | float = 0.5, forecast_horizon: int = 1, stride: int = 1, retrain: bool = True, last_points_only: bool = True, verbose: bool = False) -> TimeSeries | list[TimeSeries]Walk forward without training on validation/future observations.
start is the first forecast origin (an integer position or fraction of series length). Only complete forecasts within series are made. Retraining uses a fresh model copy on each expanding history; with retrain=False the existing fitted parameters are reused.
| Parameter | Type | Default |
|---|---|---|
series | TimeSeries | required |
startkeyword only | int | float | 0.5 |
forecast_horizonkeyword only | int | 1 |
stridekeyword only | int | 1 |
retrainkeyword only | bool | True |
last_points_onlykeyword only | bool | True |
verbosekeyword only | bool | False |
Returns TimeSeries | list[TimeSeries]
backtestmethod
backtest(series: TimeSeries, *, metric: Callable[[TimeSeries, TimeSeries], float] | None = None, **kwargs: object) -> floatEvaluate historical forecasts with a metric (mean absolute error by default).
| Parameter | Type | Default |
|---|---|---|
series | TimeSeries | required |
metrickeyword only | Callable[[TimeSeries, TimeSeries], float] | None | None |
**kwargs | object | — |
Returns float
savemethod
save(path: str) -> NoneSave fitted state with pickle; only load artifacts from trusted sources.
| Parameter | Type | Default |
|---|---|---|
path | str | required |
Returns None
loadmethod
load(path: str) -> ForecastingModelRestore a trusted artifact of this same concrete model class.
| Parameter | Type | Default |
|---|---|---|
path | str | required |
Returns ForecastingModel
Inherited members
partial_fitNormalityModelscore_batchNormalityModelis_component_abstractBaseComponentget_component_typeBaseComponentget_component_keyBaseComponentget_component_nameBaseComponentget_component_docsBaseComponentget_component_descriptionBaseComponentget_component_iconBaseComponentget_component_image_pathBaseComponentget_component_statusBaseComponentget_component_default_configBaseComponentget_component_config_schemaBaseComponentget_component_code_versionBaseComponentget_component_source_pathBaseComponentget_component_import_pathBaseComponentget_component_capabilitiesBaseComponentget_component_signatureBaseComponentget_component_parametersBaseComponentget_configBaseComponentget_capability_keyCapabilityLinearRegressionModel
LinearRegressionModel(lags: int | list[int] = 12, *, ridge: float = 0.0, fit_intercept: bool = True)Bases: ForecastingModel
Fit an autoregression with jointly modeled components and ridge regularization.
A positive integer lags uses the preceding lags observations. A sequence of distinct negative offsets selects specific history positions. ridge=0 uses ordinary least squares; the intercept is never penalized. Prediction recursively appends each one-step forecast to the context. Covariates and probabilistic forecasts are deliberately not implicit.
| Parameter | Type | Default |
|---|---|---|
lags | int | list[int] | 12 |
ridgekeyword only | float | 0.0 |
fit_interceptkeyword only | bool | True |
Members
component_keyattribute
component_key = 'linear_regression'Inherited members
fitForecastingModelpredictForecastingModelforecastForecastingModelhistorical_forecastsForecastingModelbacktestForecastingModelsaveForecastingModelloadForecastingModelpartial_fitNormalityModelscore_batchNormalityModelis_component_abstractBaseComponentget_component_typeBaseComponentget_component_keyBaseComponentget_component_nameBaseComponentget_component_docsBaseComponentget_component_descriptionBaseComponentget_component_iconBaseComponentget_component_image_pathBaseComponentget_component_statusBaseComponentget_component_default_configBaseComponentget_component_config_schemaBaseComponentget_component_code_versionBaseComponentget_component_source_pathBaseComponentget_component_import_pathBaseComponentget_component_capabilitiesBaseComponentget_component_signatureBaseComponentget_component_parametersBaseComponentget_configBaseComponentget_capability_keyCapabilityNaiveDrift
NaiveDrift()Bases: ForecastingModel
Extrapolate the line joining the first and last context observation.
Members
component_keyattribute
component_key = 'naive_drift'min_train_series_lengthattribute
min_train_series_length = 2min_predict_series_lengthattribute
min_predict_series_length = 2Inherited members
fitForecastingModelpredictForecastingModelforecastForecastingModelhistorical_forecastsForecastingModelbacktestForecastingModelsaveForecastingModelloadForecastingModelpartial_fitNormalityModelscore_batchNormalityModelis_component_abstractBaseComponentget_component_typeBaseComponentget_component_keyBaseComponentget_component_nameBaseComponentget_component_docsBaseComponentget_component_descriptionBaseComponentget_component_iconBaseComponentget_component_image_pathBaseComponentget_component_statusBaseComponentget_component_default_configBaseComponentget_component_config_schemaBaseComponentget_component_code_versionBaseComponentget_component_source_pathBaseComponentget_component_import_pathBaseComponentget_component_capabilitiesBaseComponentget_component_signatureBaseComponentget_component_parametersBaseComponentget_configBaseComponentget_capability_keyCapabilityNaiveMean
NaiveMean()Bases: ForecastingModel
Repeat the fitted per-component mean for every forecast step.
Members
component_keyattribute
component_key = 'naive_mean'Inherited members
fitForecastingModelpredictForecastingModelforecastForecastingModelhistorical_forecastsForecastingModelbacktestForecastingModelsaveForecastingModelloadForecastingModelpartial_fitNormalityModelscore_batchNormalityModelis_component_abstractBaseComponentget_component_typeBaseComponentget_component_keyBaseComponentget_component_nameBaseComponentget_component_docsBaseComponentget_component_descriptionBaseComponentget_component_iconBaseComponentget_component_image_pathBaseComponentget_component_statusBaseComponentget_component_default_configBaseComponentget_component_config_schemaBaseComponentget_component_code_versionBaseComponentget_component_source_pathBaseComponentget_component_import_pathBaseComponentget_component_capabilitiesBaseComponentget_component_signatureBaseComponentget_component_parametersBaseComponentget_configBaseComponentget_capability_keyCapabilityNaiveSeasonal
NaiveSeasonal(K: int = 1)Bases: ForecastingModel
Repeat the last K observations; K=1 is persistence.
| Parameter | Type | Default |
|---|---|---|
K | int | 1 |
Members
component_keyattribute
component_key = 'naive_seasonal'Inherited members
fitForecastingModelpredictForecastingModelforecastForecastingModelhistorical_forecastsForecastingModelbacktestForecastingModelsaveForecastingModelloadForecastingModelpartial_fitNormalityModelscore_batchNormalityModelis_component_abstractBaseComponentget_component_typeBaseComponentget_component_keyBaseComponentget_component_nameBaseComponentget_component_docsBaseComponentget_component_descriptionBaseComponentget_component_iconBaseComponentget_component_image_pathBaseComponentget_component_statusBaseComponentget_component_default_configBaseComponentget_component_config_schemaBaseComponentget_component_code_versionBaseComponentget_component_source_pathBaseComponentget_component_import_pathBaseComponentget_component_capabilitiesBaseComponentget_component_signatureBaseComponentget_component_parametersBaseComponentget_configBaseComponentget_capability_keyCapabilityTorchForecastingModel
TorchForecastingModel(input_chunk_length: int = 12, output_chunk_length: int = 1, module: Module | None = None, *, n_epochs: int = 20, batch_size: int = 32, learning_rate: float = 0.001, random_state: int = 42, device: str = 'cpu', loss_fn: Callable[[Tensor, Tensor], Tensor] | None = None, verbose: bool = False)Bases: ForecastingModel
Train any PyTorch module on chronological time-series windows.
The module receives (batch, input_chunk_length, components) and must return (batch, output_chunk_length, components). If omitted, a small linear module is constructed on first fit. The model uses GenericModel's training adapter and recursively forecasts in output-sized chunks.
| Parameter | Type | Default |
|---|---|---|
input_chunk_length | int | 12 |
output_chunk_length | int | 1 |
module | Module | None | None |
n_epochskeyword only | int | 20 |
batch_sizekeyword only | int | 32 |
learning_ratekeyword only | float | 0.001 |
random_statekeyword only | int | 42 |
devicekeyword only | str | 'cpu' |
loss_fnkeyword only | Callable[[Tensor, Tensor], Tensor] | None | None |
verbosekeyword only | bool | False |
Members
component_keyattribute
component_key = 'torch_forecasting'Inherited members
fitForecastingModelpredictForecastingModelforecastForecastingModelhistorical_forecastsForecastingModelbacktestForecastingModelsaveForecastingModelloadForecastingModelpartial_fitNormalityModelscore_batchNormalityModelis_component_abstractBaseComponentget_component_typeBaseComponentget_component_keyBaseComponentget_component_nameBaseComponentget_component_docsBaseComponentget_component_descriptionBaseComponentget_component_iconBaseComponentget_component_image_pathBaseComponentget_component_statusBaseComponentget_component_default_configBaseComponentget_component_config_schemaBaseComponentget_component_code_versionBaseComponentget_component_source_pathBaseComponentget_component_import_pathBaseComponentget_component_capabilitiesBaseComponentget_component_signatureBaseComponentget_component_parametersBaseComponentget_configBaseComponentget_capability_keyCapability