This notebooks contains examples with neural network models.
Table of contents
!pip install "etna[torch]" -q
[notice] A new release of pip is available: 23.3.1 -> 24.0 [notice] To update, run: pip install --upgrade pip
import warnings
warnings.filterwarnings("ignore")
import random
import numpy as np
import pandas as pd
import torch
from etna.analysis import plot_backtest
from etna.datasets.tsdataset import TSDataset
from etna.metrics import MAE
from etna.metrics import MAPE
from etna.metrics import SMAPE
from etna.models import SeasonalMovingAverageModel
from etna.pipeline import Pipeline
from etna.transforms import DateFlagsTransform
from etna.transforms import LagTransform
from etna.transforms import LinearTrendTransform
def set_seed(seed: int = 42):
"""Set random seed for reproducibility."""
random.seed(seed)
np.random.seed(seed)
torch.manual_seed(seed)
torch.cuda.manual_seed_all(seed)
We are going to take some toy dataset. Let's load and look at it.
df = pd.read_csv("data/example_dataset.csv")
df.head()
timestamp | segment | target | |
---|---|---|---|
0 | 2019-01-01 | segment_a | 170 |
1 | 2019-01-02 | segment_a | 243 |
2 | 2019-01-03 | segment_a | 267 |
3 | 2019-01-04 | segment_a | 287 |
4 | 2019-01-05 | segment_a | 279 |
Our library works with the special data structure TSDataset
. Let's create it as it was done in "Get started" notebook.
ts = TSDataset(df, freq="D")
ts.head(5)
segment | segment_a | segment_b | segment_c | segment_d |
---|---|---|---|---|
feature | target | target | target | target |
timestamp | ||||
2019-01-01 | 170 | 102 | 92 | 238 |
2019-01-02 | 243 | 123 | 107 | 358 |
2019-01-03 | 267 | 130 | 103 | 366 |
2019-01-04 | 287 | 138 | 103 | 385 |
2019-01-05 | 279 | 137 | 104 | 384 |
Our library has two types of models:
First, let's describe the pytorch-forecasting
models, because they require a special handling. There are two ways to use these models: default one and via using PytorchForecastingDatasetBuilder
for using extra features.
To include extra features we use PytorchForecastingDatasetBuilder
class.
Let's look at it closer.
from etna.models.nn.utils import PytorchForecastingDatasetBuilder
?PytorchForecastingDatasetBuilder
We can see a pretty scary signature, but don't panic, we will look at the most important parameters.
time_varying_known_reals
— known real values that change across the time (real regressors), now it it necessary to add "time_idx" variable to the list;time_varying_unknown_reals
— our real value target, set it to ["target"]
;max_prediction_length
— our horizon for forecasting;max_encoder_length
— length of past context to use;static_categoricals
— static categorical values, for example, if we use multiple segments it can be some its characteristics including identifier: "segment";time_varying_known_categoricals
— known categorical values that change across the time (categorical regressors);target_normalizer
— class for normalization targets across different segments.As for the native neural network models, they are simpler to use, because they don't require PytorchForecastingTransform
. We will see how to use them on examples.
In this section we will test our models on example.
HORIZON = 7
metrics = [SMAPE(), MAPE(), MAE()]
For comparison let's train some simple model as a baseline.
model_sma = SeasonalMovingAverageModel(window=5, seasonality=7)
linear_trend_transform = LinearTrendTransform(in_column="target")
pipeline_sma = Pipeline(model=model_sma, horizon=HORIZON, transforms=[linear_trend_transform])
metrics_sma, forecast_sma, fold_info_sma = pipeline_sma.backtest(ts, metrics=metrics, n_folds=3, n_jobs=1)
[Parallel(n_jobs=1)]: Using backend SequentialBackend with 1 concurrent workers. [Parallel(n_jobs=1)]: Done 1 out of 1 | elapsed: 0.0s remaining: 0.0s [Parallel(n_jobs=1)]: Done 2 out of 2 | elapsed: 0.1s remaining: 0.0s [Parallel(n_jobs=1)]: Done 3 out of 3 | elapsed: 0.1s remaining: 0.0s [Parallel(n_jobs=1)]: Done 3 out of 3 | elapsed: 0.1s finished [Parallel(n_jobs=1)]: Using backend SequentialBackend with 1 concurrent workers. [Parallel(n_jobs=1)]: Done 1 out of 1 | elapsed: 0.1s remaining: 0.0s [Parallel(n_jobs=1)]: Done 2 out of 2 | elapsed: 0.1s remaining: 0.0s [Parallel(n_jobs=1)]: Done 3 out of 3 | elapsed: 0.2s remaining: 0.0s [Parallel(n_jobs=1)]: Done 3 out of 3 | elapsed: 0.2s finished [Parallel(n_jobs=1)]: Using backend SequentialBackend with 1 concurrent workers. [Parallel(n_jobs=1)]: Done 1 out of 1 | elapsed: 0.0s remaining: 0.0s [Parallel(n_jobs=1)]: Done 2 out of 2 | elapsed: 0.0s remaining: 0.0s [Parallel(n_jobs=1)]: Done 3 out of 3 | elapsed: 0.1s remaining: 0.0s [Parallel(n_jobs=1)]: Done 3 out of 3 | elapsed: 0.1s finished
metrics_sma
segment | SMAPE | MAPE | MAE | fold_number | |
---|---|---|---|---|---|
0 | segment_a | 6.343943 | 6.124296 | 33.196532 | 0 |
0 | segment_a | 5.346946 | 5.192455 | 27.938101 | 1 |
0 | segment_a | 7.510347 | 7.189999 | 40.028565 | 2 |
1 | segment_b | 7.178822 | 6.920176 | 17.818102 | 0 |
1 | segment_b | 5.672504 | 5.554555 | 13.719200 | 1 |
1 | segment_b | 3.327846 | 3.359712 | 7.680919 | 2 |
2 | segment_c | 6.430429 | 6.200580 | 10.877718 | 0 |
2 | segment_c | 5.947090 | 5.727531 | 10.701336 | 1 |
2 | segment_c | 6.186545 | 5.943679 | 11.359563 | 2 |
3 | segment_d | 4.707899 | 4.644170 | 39.918646 | 0 |
3 | segment_d | 5.403426 | 5.600978 | 43.047332 | 1 |
3 | segment_d | 2.505279 | 2.543719 | 19.347565 | 2 |
score = metrics_sma["SMAPE"].mean()
print(f"Average SMAPE for Seasonal MA: {score:.3f}")
Average SMAPE for Seasonal MA: 5.547
plot_backtest(forecast_sma, ts, history_len=20)
from etna.models.nn import DeepARModel
Before training let's fix seeds for reproducibility.
set_seed()
model_deepar = DeepARModel(
encoder_length=HORIZON,
decoder_length=HORIZON,
trainer_params=dict(max_epochs=150, gradient_clip_val=0.1),
lr=0.01,
train_batch_size=64,
)
metrics = [SMAPE(), MAPE(), MAE()]
pipeline_deepar = Pipeline(model=model_deepar, horizon=HORIZON)
metrics_deepar, forecast_deepar, fold_info_deepar = pipeline_deepar.backtest(ts, metrics=metrics, n_folds=3, n_jobs=1)
[Parallel(n_jobs=1)]: Using backend SequentialBackend with 1 concurrent workers. GPU available: False, used: False TPU available: False, using: 0 TPU cores IPU available: False, using: 0 IPUs HPU available: False, using: 0 HPUs | Name | Type | Params ------------------------------------------------------------------ 0 | loss | NormalDistributionLoss | 0 1 | logging_metrics | ModuleList | 0 2 | embeddings | MultiEmbedding | 0 3 | rnn | LSTM | 1.6 K 4 | distribution_projector | Linear | 22 ------------------------------------------------------------------ 1.6 K Trainable params 0 Non-trainable params 1.6 K Total params 0.006 Total estimated model params size (MB)
Training: 0it [00:00, ?it/s]
`Trainer.fit` stopped: `max_epochs=150` reached. [Parallel(n_jobs=1)]: Done 1 out of 1 | elapsed: 1.1min remaining: 0.0s GPU available: False, used: False TPU available: False, using: 0 TPU cores IPU available: False, using: 0 IPUs HPU available: False, using: 0 HPUs | Name | Type | Params ------------------------------------------------------------------ 0 | loss | NormalDistributionLoss | 0 1 | logging_metrics | ModuleList | 0 2 | embeddings | MultiEmbedding | 0 3 | rnn | LSTM | 1.6 K 4 | distribution_projector | Linear | 22 ------------------------------------------------------------------ 1.6 K Trainable params 0 Non-trainable params 1.6 K Total params 0.006 Total estimated model params size (MB)
Training: 0it [00:00, ?it/s]
`Trainer.fit` stopped: `max_epochs=150` reached. [Parallel(n_jobs=1)]: Done 2 out of 2 | elapsed: 2.7min remaining: 0.0s GPU available: False, used: False TPU available: False, using: 0 TPU cores IPU available: False, using: 0 IPUs HPU available: False, using: 0 HPUs | Name | Type | Params ------------------------------------------------------------------ 0 | loss | NormalDistributionLoss | 0 1 | logging_metrics | ModuleList | 0 2 | embeddings | MultiEmbedding | 0 3 | rnn | LSTM | 1.6 K 4 | distribution_projector | Linear | 22 ------------------------------------------------------------------ 1.6 K Trainable params 0 Non-trainable params 1.6 K Total params 0.006 Total estimated model params size (MB)
Training: 0it [00:00, ?it/s]
`Trainer.fit` stopped: `max_epochs=150` reached. [Parallel(n_jobs=1)]: Done 3 out of 3 | elapsed: 4.3min remaining: 0.0s [Parallel(n_jobs=1)]: Done 3 out of 3 | elapsed: 4.3min finished [Parallel(n_jobs=1)]: Using backend SequentialBackend with 1 concurrent workers. [Parallel(n_jobs=1)]: Done 1 out of 1 | elapsed: 0.1s remaining: 0.0s [Parallel(n_jobs=1)]: Done 2 out of 2 | elapsed: 0.2s remaining: 0.0s [Parallel(n_jobs=1)]: Done 3 out of 3 | elapsed: 0.3s remaining: 0.0s [Parallel(n_jobs=1)]: Done 3 out of 3 | elapsed: 0.3s finished [Parallel(n_jobs=1)]: Using backend SequentialBackend with 1 concurrent workers. [Parallel(n_jobs=1)]: Done 1 out of 1 | elapsed: 0.0s remaining: 0.0s [Parallel(n_jobs=1)]: Done 2 out of 2 | elapsed: 0.1s remaining: 0.0s [Parallel(n_jobs=1)]: Done 3 out of 3 | elapsed: 0.1s remaining: 0.0s [Parallel(n_jobs=1)]: Done 3 out of 3 | elapsed: 0.1s finished
metrics_deepar
segment | SMAPE | MAPE | MAE | fold_number | |
---|---|---|---|---|---|
0 | segment_a | 7.435973 | 7.181735 | 38.649231 | 0 |
0 | segment_a | 4.475633 | 4.612647 | 22.656804 | 1 |
0 | segment_a | 10.447333 | 9.920773 | 54.777309 | 2 |
1 | segment_b | 7.934791 | 7.639005 | 19.769889 | 0 |
1 | segment_b | 5.531228 | 5.611018 | 13.110160 | 1 |
1 | segment_b | 4.139602 | 4.343230 | 9.261778 | 2 |
2 | segment_c | 3.846263 | 3.858160 | 6.489179 | 0 |
2 | segment_c | 5.991875 | 5.917596 | 10.582674 | 1 |
2 | segment_c | 6.220793 | 6.153262 | 11.090384 | 2 |
3 | segment_d | 7.151571 | 7.089755 | 60.376482 | 0 |
3 | segment_d | 4.633771 | 4.750417 | 37.190683 | 1 |
3 | segment_d | 3.839432 | 3.753976 | 32.364362 | 2 |
To summarize it we will take mean value of SMAPE metric because it is scale tolerant.
score = metrics_deepar["SMAPE"].mean()
print(f"Average SMAPE for DeepAR: {score:.3f}")
Average SMAPE for DeepAR: 5.971
from pytorch_forecasting.data import GroupNormalizer
set_seed()
transform_date = DateFlagsTransform(day_number_in_week=True, day_number_in_month=False, out_column="dateflag")
num_lags = 10
transform_lag = LagTransform(
in_column="target",
lags=[HORIZON + i for i in range(num_lags)],
out_column="target_lag",
)
lag_columns = [f"target_lag_{HORIZON+i}" for i in range(num_lags)]
dataset_builder_deepar = PytorchForecastingDatasetBuilder(
max_encoder_length=HORIZON,
max_prediction_length=HORIZON,
time_varying_known_reals=["time_idx"] + lag_columns,
time_varying_unknown_reals=["target"],
time_varying_known_categoricals=["dateflag_day_number_in_week"],
target_normalizer=GroupNormalizer(groups=["segment"]),
)
Now we are going to start backtest.
model_deepar = DeepARModel(
dataset_builder=dataset_builder_deepar,
trainer_params=dict(max_epochs=150, gradient_clip_val=0.1),
lr=0.01,
train_batch_size=64,
)
pipeline_deepar = Pipeline(
model=model_deepar,
horizon=HORIZON,
transforms=[transform_lag, transform_date],
)
metrics_deepar, forecast_deepar, fold_info_deepar = pipeline_deepar.backtest(ts, metrics=metrics, n_folds=3, n_jobs=1)
[Parallel(n_jobs=1)]: Using backend SequentialBackend with 1 concurrent workers. GPU available: False, used: False TPU available: False, using: 0 TPU cores IPU available: False, using: 0 IPUs HPU available: False, using: 0 HPUs | Name | Type | Params ------------------------------------------------------------------ 0 | loss | NormalDistributionLoss | 0 1 | logging_metrics | ModuleList | 0 2 | embeddings | MultiEmbedding | 35 3 | rnn | LSTM | 2.2 K 4 | distribution_projector | Linear | 22 ------------------------------------------------------------------ 2.3 K Trainable params 0 Non-trainable params 2.3 K Total params 0.009 Total estimated model params size (MB)
Training: 0it [00:00, ?it/s]
`Trainer.fit` stopped: `max_epochs=150` reached. [Parallel(n_jobs=1)]: Done 1 out of 1 | elapsed: 1.3min remaining: 0.0s GPU available: False, used: False TPU available: False, using: 0 TPU cores IPU available: False, using: 0 IPUs HPU available: False, using: 0 HPUs | Name | Type | Params ------------------------------------------------------------------ 0 | loss | NormalDistributionLoss | 0 1 | logging_metrics | ModuleList | 0 2 | embeddings | MultiEmbedding | 35 3 | rnn | LSTM | 2.2 K 4 | distribution_projector | Linear | 22 ------------------------------------------------------------------ 2.3 K Trainable params 0 Non-trainable params 2.3 K Total params 0.009 Total estimated model params size (MB)
Training: 0it [00:00, ?it/s]
`Trainer.fit` stopped: `max_epochs=150` reached. [Parallel(n_jobs=1)]: Done 2 out of 2 | elapsed: 2.6min remaining: 0.0s GPU available: False, used: False TPU available: False, using: 0 TPU cores IPU available: False, using: 0 IPUs HPU available: False, using: 0 HPUs | Name | Type | Params ------------------------------------------------------------------ 0 | loss | NormalDistributionLoss | 0 1 | logging_metrics | ModuleList | 0 2 | embeddings | MultiEmbedding | 35 3 | rnn | LSTM | 2.2 K 4 | distribution_projector | Linear | 22 ------------------------------------------------------------------ 2.3 K Trainable params 0 Non-trainable params 2.3 K Total params 0.009 Total estimated model params size (MB)
Training: 0it [00:00, ?it/s]
`Trainer.fit` stopped: `max_epochs=150` reached. [Parallel(n_jobs=1)]: Done 3 out of 3 | elapsed: 3.9min remaining: 0.0s [Parallel(n_jobs=1)]: Done 3 out of 3 | elapsed: 3.9min finished [Parallel(n_jobs=1)]: Using backend SequentialBackend with 1 concurrent workers. [Parallel(n_jobs=1)]: Done 1 out of 1 | elapsed: 0.1s remaining: 0.0s [Parallel(n_jobs=1)]: Done 2 out of 2 | elapsed: 0.2s remaining: 0.0s [Parallel(n_jobs=1)]: Done 3 out of 3 | elapsed: 0.3s remaining: 0.0s [Parallel(n_jobs=1)]: Done 3 out of 3 | elapsed: 0.3s finished [Parallel(n_jobs=1)]: Using backend SequentialBackend with 1 concurrent workers. [Parallel(n_jobs=1)]: Done 1 out of 1 | elapsed: 0.0s remaining: 0.0s [Parallel(n_jobs=1)]: Done 2 out of 2 | elapsed: 0.0s remaining: 0.0s [Parallel(n_jobs=1)]: Done 3 out of 3 | elapsed: 0.1s remaining: 0.0s [Parallel(n_jobs=1)]: Done 3 out of 3 | elapsed: 0.1s finished
Let's compare results across different segments.
metrics_deepar
segment | SMAPE | MAPE | MAE | fold_number | |
---|---|---|---|---|---|
0 | segment_a | 5.781584 | 5.548413 | 29.568368 | 0 |
0 | segment_a | 3.369623 | 3.343338 | 17.032048 | 1 |
0 | segment_a | 4.461291 | 4.328079 | 23.842760 | 2 |
1 | segment_b | 6.384223 | 6.156288 | 15.758630 | 0 |
1 | segment_b | 3.447003 | 3.384705 | 8.546526 | 1 |
1 | segment_b | 2.498535 | 2.519750 | 5.769050 | 2 |
2 | segment_c | 4.055776 | 3.951736 | 7.059171 | 0 |
2 | segment_c | 5.394352 | 5.229193 | 9.654506 | 1 |
2 | segment_c | 3.798415 | 3.724526 | 6.852286 | 2 |
3 | segment_d | 5.298490 | 5.132415 | 45.330636 | 0 |
3 | segment_d | 4.460246 | 4.608107 | 35.927080 | 1 |
3 | segment_d | 2.827304 | 2.786354 | 24.269488 | 2 |
To summarize it we will take mean value of SMAPE metric because it is scale tolerant.
score = metrics_deepar["SMAPE"].mean()
print(f"Average SMAPE for DeepAR: {score:.3f}")
Average SMAPE for DeepAR: 4.315
Visualize results.
plot_backtest(forecast_deepar, ts, history_len=20)
It is recommended to use our native implementation of DeepAR, we will remove Pytorch Forecasting version in etna 3.0.0.
from etna.models.nn import DeepARNativeModel
from etna.transforms import StandardScalerTransform
set_seed()
std = StandardScalerTransform(in_column="target")
model_deepar_native = DeepARNativeModel(
input_size=1,
encoder_length=2 * HORIZON,
decoder_length=HORIZON,
lr=0.01,
scale=False,
n_samples=100,
train_batch_size=64,
trainer_params=dict(max_epochs=30, gradient_clip_val=0.1),
)
pipeline_deepar_native = Pipeline(model=model_deepar_native, horizon=HORIZON, transforms=[std])
metrics_deepar_native, forecast_deepar_native, fold_info_deepar_native = pipeline_deepar_native.backtest(
ts, metrics=metrics, n_folds=3, n_jobs=1
)
[Parallel(n_jobs=1)]: Using backend SequentialBackend with 1 concurrent workers. GPU available: False, used: False TPU available: False, using: 0 TPU cores IPU available: False, using: 0 IPUs HPU available: False, using: 0 HPUs | Name | Type | Params -------------------------------------------- 0 | loss | GaussianLoss | 0 1 | rnn | LSTM | 3.4 K 2 | projection | ModuleDict | 34 -------------------------------------------- 3.4 K Trainable params 0 Non-trainable params 3.4 K Total params 0.014 Total estimated model params size (MB)
Training: 0it [00:00, ?it/s]
`Trainer.fit` stopped: `max_epochs=30` reached. [Parallel(n_jobs=1)]: Done 1 out of 1 | elapsed: 6.9s remaining: 0.0s GPU available: False, used: False TPU available: False, using: 0 TPU cores IPU available: False, using: 0 IPUs HPU available: False, using: 0 HPUs | Name | Type | Params -------------------------------------------- 0 | loss | GaussianLoss | 0 1 | rnn | LSTM | 3.4 K 2 | projection | ModuleDict | 34 -------------------------------------------- 3.4 K Trainable params 0 Non-trainable params 3.4 K Total params 0.014 Total estimated model params size (MB)
Training: 0it [00:00, ?it/s]
`Trainer.fit` stopped: `max_epochs=30` reached. [Parallel(n_jobs=1)]: Done 2 out of 2 | elapsed: 13.1s remaining: 0.0s GPU available: False, used: False TPU available: False, using: 0 TPU cores IPU available: False, using: 0 IPUs HPU available: False, using: 0 HPUs | Name | Type | Params -------------------------------------------- 0 | loss | GaussianLoss | 0 1 | rnn | LSTM | 3.4 K 2 | projection | ModuleDict | 34 -------------------------------------------- 3.4 K Trainable params 0 Non-trainable params 3.4 K Total params 0.014 Total estimated model params size (MB)
Training: 0it [00:00, ?it/s]
`Trainer.fit` stopped: `max_epochs=30` reached. [Parallel(n_jobs=1)]: Done 3 out of 3 | elapsed: 19.9s remaining: 0.0s [Parallel(n_jobs=1)]: Done 3 out of 3 | elapsed: 19.9s finished [Parallel(n_jobs=1)]: Using backend SequentialBackend with 1 concurrent workers. [Parallel(n_jobs=1)]: Done 1 out of 1 | elapsed: 0.2s remaining: 0.0s [Parallel(n_jobs=1)]: Done 2 out of 2 | elapsed: 0.4s remaining: 0.0s [Parallel(n_jobs=1)]: Done 3 out of 3 | elapsed: 0.5s remaining: 0.0s [Parallel(n_jobs=1)]: Done 3 out of 3 | elapsed: 0.5s finished [Parallel(n_jobs=1)]: Using backend SequentialBackend with 1 concurrent workers. [Parallel(n_jobs=1)]: Done 1 out of 1 | elapsed: 0.0s remaining: 0.0s [Parallel(n_jobs=1)]: Done 2 out of 2 | elapsed: 0.0s remaining: 0.0s [Parallel(n_jobs=1)]: Done 3 out of 3 | elapsed: 0.1s remaining: 0.0s [Parallel(n_jobs=1)]: Done 3 out of 3 | elapsed: 0.1s finished
score = metrics_deepar_native["SMAPE"].mean()
print(f"Average SMAPE for DeepARNative: {score:.3f}")
Average SMAPE for DeepARNative: 6.602
plot_backtest(forecast_deepar_native, ts, history_len=20)
Let's move to the next model.
from etna.models.nn import TFTModel
set_seed()
model_tft = TFTModel(
encoder_length=HORIZON,
decoder_length=HORIZON,
trainer_params=dict(max_epochs=200, gradient_clip_val=0.1),
lr=0.01,
train_batch_size=64,
)
pipeline_tft = Pipeline(
model=model_tft,
horizon=HORIZON,
)
metrics_tft, forecast_tft, fold_info_tft = pipeline_tft.backtest(ts, metrics=metrics, n_folds=3, n_jobs=1)
[Parallel(n_jobs=1)]: Using backend SequentialBackend with 1 concurrent workers. GPU available: False, used: False TPU available: False, using: 0 TPU cores IPU available: False, using: 0 IPUs HPU available: False, using: 0 HPUs | Name | Type | Params ---------------------------------------------------------------------------------------- 0 | loss | QuantileLoss | 0 1 | logging_metrics | ModuleList | 0 2 | input_embeddings | MultiEmbedding | 0 3 | prescalers | ModuleDict | 96 4 | static_variable_selection | VariableSelectionNetwork | 1.7 K 5 | encoder_variable_selection | VariableSelectionNetwork | 1.8 K 6 | decoder_variable_selection | VariableSelectionNetwork | 1.2 K 7 | static_context_variable_selection | GatedResidualNetwork | 1.1 K 8 | static_context_initial_hidden_lstm | GatedResidualNetwork | 1.1 K 9 | static_context_initial_cell_lstm | GatedResidualNetwork | 1.1 K 10 | static_context_enrichment | GatedResidualNetwork | 1.1 K 11 | lstm_encoder | LSTM | 2.2 K 12 | lstm_decoder | LSTM | 2.2 K 13 | post_lstm_gate_encoder | GatedLinearUnit | 544 14 | post_lstm_add_norm_encoder | AddNorm | 32 15 | static_enrichment | GatedResidualNetwork | 1.4 K 16 | multihead_attn | InterpretableMultiHeadAttention | 676 17 | post_attn_gate_norm | GateAddNorm | 576 18 | pos_wise_ff | GatedResidualNetwork | 1.1 K 19 | pre_output_gate_norm | GateAddNorm | 576 20 | output_layer | Linear | 119 ---------------------------------------------------------------------------------------- 18.4 K Trainable params 0 Non-trainable params 18.4 K Total params 0.074 Total estimated model params size (MB)
Training: 0it [00:00, ?it/s]
`Trainer.fit` stopped: `max_epochs=200` reached. [Parallel(n_jobs=1)]: Done 1 out of 1 | elapsed: 2.8min remaining: 0.0s GPU available: False, used: False TPU available: False, using: 0 TPU cores IPU available: False, using: 0 IPUs HPU available: False, using: 0 HPUs | Name | Type | Params ---------------------------------------------------------------------------------------- 0 | loss | QuantileLoss | 0 1 | logging_metrics | ModuleList | 0 2 | input_embeddings | MultiEmbedding | 0 3 | prescalers | ModuleDict | 96 4 | static_variable_selection | VariableSelectionNetwork | 1.7 K 5 | encoder_variable_selection | VariableSelectionNetwork | 1.8 K 6 | decoder_variable_selection | VariableSelectionNetwork | 1.2 K 7 | static_context_variable_selection | GatedResidualNetwork | 1.1 K 8 | static_context_initial_hidden_lstm | GatedResidualNetwork | 1.1 K 9 | static_context_initial_cell_lstm | GatedResidualNetwork | 1.1 K 10 | static_context_enrichment | GatedResidualNetwork | 1.1 K 11 | lstm_encoder | LSTM | 2.2 K 12 | lstm_decoder | LSTM | 2.2 K 13 | post_lstm_gate_encoder | GatedLinearUnit | 544 14 | post_lstm_add_norm_encoder | AddNorm | 32 15 | static_enrichment | GatedResidualNetwork | 1.4 K 16 | multihead_attn | InterpretableMultiHeadAttention | 676 17 | post_attn_gate_norm | GateAddNorm | 576 18 | pos_wise_ff | GatedResidualNetwork | 1.1 K 19 | pre_output_gate_norm | GateAddNorm | 576 20 | output_layer | Linear | 119 ---------------------------------------------------------------------------------------- 18.4 K Trainable params 0 Non-trainable params 18.4 K Total params 0.074 Total estimated model params size (MB)
Training: 0it [00:00, ?it/s]
`Trainer.fit` stopped: `max_epochs=200` reached. [Parallel(n_jobs=1)]: Done 2 out of 2 | elapsed: 5.5min remaining: 0.0s GPU available: False, used: False TPU available: False, using: 0 TPU cores IPU available: False, using: 0 IPUs HPU available: False, using: 0 HPUs | Name | Type | Params ---------------------------------------------------------------------------------------- 0 | loss | QuantileLoss | 0 1 | logging_metrics | ModuleList | 0 2 | input_embeddings | MultiEmbedding | 0 3 | prescalers | ModuleDict | 96 4 | static_variable_selection | VariableSelectionNetwork | 1.7 K 5 | encoder_variable_selection | VariableSelectionNetwork | 1.8 K 6 | decoder_variable_selection | VariableSelectionNetwork | 1.2 K 7 | static_context_variable_selection | GatedResidualNetwork | 1.1 K 8 | static_context_initial_hidden_lstm | GatedResidualNetwork | 1.1 K 9 | static_context_initial_cell_lstm | GatedResidualNetwork | 1.1 K 10 | static_context_enrichment | GatedResidualNetwork | 1.1 K 11 | lstm_encoder | LSTM | 2.2 K 12 | lstm_decoder | LSTM | 2.2 K 13 | post_lstm_gate_encoder | GatedLinearUnit | 544 14 | post_lstm_add_norm_encoder | AddNorm | 32 15 | static_enrichment | GatedResidualNetwork | 1.4 K 16 | multihead_attn | InterpretableMultiHeadAttention | 676 17 | post_attn_gate_norm | GateAddNorm | 576 18 | pos_wise_ff | GatedResidualNetwork | 1.1 K 19 | pre_output_gate_norm | GateAddNorm | 576 20 | output_layer | Linear | 119 ---------------------------------------------------------------------------------------- 18.4 K Trainable params 0 Non-trainable params 18.4 K Total params 0.074 Total estimated model params size (MB)
Training: 0it [00:00, ?it/s]
`Trainer.fit` stopped: `max_epochs=200` reached. [Parallel(n_jobs=1)]: Done 3 out of 3 | elapsed: 8.7min remaining: 0.0s [Parallel(n_jobs=1)]: Done 3 out of 3 | elapsed: 8.7min finished [Parallel(n_jobs=1)]: Using backend SequentialBackend with 1 concurrent workers. [Parallel(n_jobs=1)]: Done 1 out of 1 | elapsed: 0.1s remaining: 0.0s [Parallel(n_jobs=1)]: Done 2 out of 2 | elapsed: 0.1s remaining: 0.0s [Parallel(n_jobs=1)]: Done 3 out of 3 | elapsed: 0.2s remaining: 0.0s [Parallel(n_jobs=1)]: Done 3 out of 3 | elapsed: 0.2s finished [Parallel(n_jobs=1)]: Using backend SequentialBackend with 1 concurrent workers. [Parallel(n_jobs=1)]: Done 1 out of 1 | elapsed: 0.0s remaining: 0.0s [Parallel(n_jobs=1)]: Done 2 out of 2 | elapsed: 0.0s remaining: 0.0s [Parallel(n_jobs=1)]: Done 3 out of 3 | elapsed: 0.1s remaining: 0.0s [Parallel(n_jobs=1)]: Done 3 out of 3 | elapsed: 0.1s finished
metrics_tft
segment | SMAPE | MAPE | MAE | fold_number | |
---|---|---|---|---|---|
0 | segment_a | 40.299304 | 33.173155 | 180.171897 | 0 |
0 | segment_a | 7.658153 | 7.649965 | 39.856859 | 1 |
0 | segment_a | 8.940202 | 8.550091 | 47.361341 | 2 |
1 | segment_b | 33.188092 | 41.022815 | 97.970943 | 0 |
1 | segment_b | 8.532834 | 8.286123 | 20.740119 | 1 |
1 | segment_b | 5.245063 | 5.335329 | 12.152446 | 2 |
2 | segment_c | 67.956917 | 103.912872 | 176.685237 | 0 |
2 | segment_c | 10.762866 | 10.335604 | 18.790122 | 1 |
2 | segment_c | 9.652466 | 9.398020 | 17.403102 | 2 |
3 | segment_d | 82.860153 | 58.247785 | 508.600477 | 0 |
3 | segment_d | 15.766710 | 14.702168 | 122.658064 | 1 |
3 | segment_d | 23.951142 | 21.030020 | 187.751875 | 2 |
score = metrics_tft["SMAPE"].mean()
print(f"Average SMAPE for TFT: {score:.3f}")
Average SMAPE for TFT: 26.234
set_seed()
transform_date = DateFlagsTransform(day_number_in_week=True, day_number_in_month=False, out_column="dateflag")
num_lags = 10
transform_lag = LagTransform(
in_column="target",
lags=[HORIZON + i for i in range(num_lags)],
out_column="target_lag",
)
lag_columns = [f"target_lag_{HORIZON+i}" for i in range(num_lags)]
dataset_builder_tft = PytorchForecastingDatasetBuilder(
max_encoder_length=HORIZON,
max_prediction_length=HORIZON,
time_varying_known_reals=["time_idx"],
time_varying_unknown_reals=["target"],
time_varying_known_categoricals=["dateflag_day_number_in_week"],
static_categoricals=["segment"],
target_normalizer=GroupNormalizer(groups=["segment"]),
)
model_tft = TFTModel(
dataset_builder=dataset_builder_tft,
trainer_params=dict(max_epochs=200, gradient_clip_val=0.1),
lr=0.01,
train_batch_size=64,
)
pipeline_tft = Pipeline(
model=model_tft,
horizon=HORIZON,
transforms=[transform_lag, transform_date],
)
metrics_tft, forecast_tft, fold_info_tft = pipeline_tft.backtest(ts, metrics=metrics, n_folds=3, n_jobs=1)
[Parallel(n_jobs=1)]: Using backend SequentialBackend with 1 concurrent workers. GPU available: False, used: False TPU available: False, using: 0 TPU cores IPU available: False, using: 0 IPUs HPU available: False, using: 0 HPUs | Name | Type | Params ---------------------------------------------------------------------------------------- 0 | loss | QuantileLoss | 0 1 | logging_metrics | ModuleList | 0 2 | input_embeddings | MultiEmbedding | 47 3 | prescalers | ModuleDict | 96 4 | static_variable_selection | VariableSelectionNetwork | 1.8 K 5 | encoder_variable_selection | VariableSelectionNetwork | 1.9 K 6 | decoder_variable_selection | VariableSelectionNetwork | 1.3 K 7 | static_context_variable_selection | GatedResidualNetwork | 1.1 K 8 | static_context_initial_hidden_lstm | GatedResidualNetwork | 1.1 K 9 | static_context_initial_cell_lstm | GatedResidualNetwork | 1.1 K 10 | static_context_enrichment | GatedResidualNetwork | 1.1 K 11 | lstm_encoder | LSTM | 2.2 K 12 | lstm_decoder | LSTM | 2.2 K 13 | post_lstm_gate_encoder | GatedLinearUnit | 544 14 | post_lstm_add_norm_encoder | AddNorm | 32 15 | static_enrichment | GatedResidualNetwork | 1.4 K 16 | multihead_attn | InterpretableMultiHeadAttention | 676 17 | post_attn_gate_norm | GateAddNorm | 576 18 | pos_wise_ff | GatedResidualNetwork | 1.1 K 19 | pre_output_gate_norm | GateAddNorm | 576 20 | output_layer | Linear | 119 ---------------------------------------------------------------------------------------- 18.9 K Trainable params 0 Non-trainable params 18.9 K Total params 0.075 Total estimated model params size (MB)
Training: 0it [00:00, ?it/s]
`Trainer.fit` stopped: `max_epochs=200` reached. [Parallel(n_jobs=1)]: Done 1 out of 1 | elapsed: 3.1min remaining: 0.0s GPU available: False, used: False TPU available: False, using: 0 TPU cores IPU available: False, using: 0 IPUs HPU available: False, using: 0 HPUs | Name | Type | Params ---------------------------------------------------------------------------------------- 0 | loss | QuantileLoss | 0 1 | logging_metrics | ModuleList | 0 2 | input_embeddings | MultiEmbedding | 47 3 | prescalers | ModuleDict | 96 4 | static_variable_selection | VariableSelectionNetwork | 1.8 K 5 | encoder_variable_selection | VariableSelectionNetwork | 1.9 K 6 | decoder_variable_selection | VariableSelectionNetwork | 1.3 K 7 | static_context_variable_selection | GatedResidualNetwork | 1.1 K 8 | static_context_initial_hidden_lstm | GatedResidualNetwork | 1.1 K 9 | static_context_initial_cell_lstm | GatedResidualNetwork | 1.1 K 10 | static_context_enrichment | GatedResidualNetwork | 1.1 K 11 | lstm_encoder | LSTM | 2.2 K 12 | lstm_decoder | LSTM | 2.2 K 13 | post_lstm_gate_encoder | GatedLinearUnit | 544 14 | post_lstm_add_norm_encoder | AddNorm | 32 15 | static_enrichment | GatedResidualNetwork | 1.4 K 16 | multihead_attn | InterpretableMultiHeadAttention | 676 17 | post_attn_gate_norm | GateAddNorm | 576 18 | pos_wise_ff | GatedResidualNetwork | 1.1 K 19 | pre_output_gate_norm | GateAddNorm | 576 20 | output_layer | Linear | 119 ---------------------------------------------------------------------------------------- 18.9 K Trainable params 0 Non-trainable params 18.9 K Total params 0.075 Total estimated model params size (MB)
Training: 0it [00:00, ?it/s]
`Trainer.fit` stopped: `max_epochs=200` reached. [Parallel(n_jobs=1)]: Done 2 out of 2 | elapsed: 6.3min remaining: 0.0s GPU available: False, used: False TPU available: False, using: 0 TPU cores IPU available: False, using: 0 IPUs HPU available: False, using: 0 HPUs | Name | Type | Params ---------------------------------------------------------------------------------------- 0 | loss | QuantileLoss | 0 1 | logging_metrics | ModuleList | 0 2 | input_embeddings | MultiEmbedding | 47 3 | prescalers | ModuleDict | 96 4 | static_variable_selection | VariableSelectionNetwork | 1.8 K 5 | encoder_variable_selection | VariableSelectionNetwork | 1.9 K 6 | decoder_variable_selection | VariableSelectionNetwork | 1.3 K 7 | static_context_variable_selection | GatedResidualNetwork | 1.1 K 8 | static_context_initial_hidden_lstm | GatedResidualNetwork | 1.1 K 9 | static_context_initial_cell_lstm | GatedResidualNetwork | 1.1 K 10 | static_context_enrichment | GatedResidualNetwork | 1.1 K 11 | lstm_encoder | LSTM | 2.2 K 12 | lstm_decoder | LSTM | 2.2 K 13 | post_lstm_gate_encoder | GatedLinearUnit | 544 14 | post_lstm_add_norm_encoder | AddNorm | 32 15 | static_enrichment | GatedResidualNetwork | 1.4 K 16 | multihead_attn | InterpretableMultiHeadAttention | 676 17 | post_attn_gate_norm | GateAddNorm | 576 18 | pos_wise_ff | GatedResidualNetwork | 1.1 K 19 | pre_output_gate_norm | GateAddNorm | 576 20 | output_layer | Linear | 119 ---------------------------------------------------------------------------------------- 18.9 K Trainable params 0 Non-trainable params 18.9 K Total params 0.075 Total estimated model params size (MB)
Training: 0it [00:00, ?it/s]
`Trainer.fit` stopped: `max_epochs=200` reached. [Parallel(n_jobs=1)]: Done 3 out of 3 | elapsed: 9.9min remaining: 0.0s [Parallel(n_jobs=1)]: Done 3 out of 3 | elapsed: 9.9min finished [Parallel(n_jobs=1)]: Using backend SequentialBackend with 1 concurrent workers. [Parallel(n_jobs=1)]: Done 1 out of 1 | elapsed: 0.1s remaining: 0.0s [Parallel(n_jobs=1)]: Done 2 out of 2 | elapsed: 0.2s remaining: 0.0s [Parallel(n_jobs=1)]: Done 3 out of 3 | elapsed: 0.3s remaining: 0.0s [Parallel(n_jobs=1)]: Done 3 out of 3 | elapsed: 0.3s finished [Parallel(n_jobs=1)]: Using backend SequentialBackend with 1 concurrent workers. [Parallel(n_jobs=1)]: Done 1 out of 1 | elapsed: 0.0s remaining: 0.0s [Parallel(n_jobs=1)]: Done 2 out of 2 | elapsed: 0.0s remaining: 0.0s [Parallel(n_jobs=1)]: Done 3 out of 3 | elapsed: 0.1s remaining: 0.0s [Parallel(n_jobs=1)]: Done 3 out of 3 | elapsed: 0.1s finished
metrics_tft
segment | SMAPE | MAPE | MAE | fold_number | |
---|---|---|---|---|---|
0 | segment_a | 4.466300 | 4.367662 | 22.947819 | 0 |
0 | segment_a | 8.062436 | 7.979502 | 41.606977 | 1 |
0 | segment_a | 4.987446 | 4.803478 | 27.609889 | 2 |
1 | segment_b | 5.703133 | 5.514311 | 14.282939 | 0 |
1 | segment_b | 6.095108 | 5.924447 | 14.928279 | 1 |
1 | segment_b | 4.299732 | 4.389442 | 9.946374 | 2 |
2 | segment_c | 4.983413 | 4.859331 | 8.550568 | 0 |
2 | segment_c | 5.767318 | 5.544694 | 10.415174 | 1 |
2 | segment_c | 7.289711 | 6.987309 | 13.289631 | 2 |
3 | segment_d | 9.607903 | 9.630852 | 79.336260 | 0 |
3 | segment_d | 5.248207 | 5.321135 | 42.208479 | 1 |
3 | segment_d | 3.432953 | 3.346485 | 30.365077 | 2 |
score = metrics_tft["SMAPE"].mean()
print(f"Average SMAPE for TFT: {score:.3f}")
Average SMAPE for TFT: 5.829
plot_backtest(forecast_tft, ts, history_len=20)
It is recommended to use our native implementation of TFT, we will remove Pytorch Forecasting version in etna 3.0.0.
from etna.models.nn import TFTNativeModel
from etna.transforms import DateFlagsTransform
from etna.transforms import LabelEncoderTransform
from etna.transforms import LagTransform
from etna.transforms import SegmentEncoderTransform
from etna.transforms import StandardScalerTransform
set_seed()
num_lags = 6
lag_columns = [f"target_lag_{HORIZON+i}" for i in range(num_lags)]
transform_lag = LagTransform(
in_column="target",
lags=[HORIZON + i for i in range(num_lags)],
out_column="target_lag",
)
transform_date = DateFlagsTransform(day_number_in_week=True, day_number_in_month=False, out_column="dateflag")
std = StandardScalerTransform(in_column=["target"])
encoder = SegmentEncoderTransform()
label_encoder = LabelEncoderTransform(
in_column="dateflag_day_number_in_week", strategy="none", out_column="dateflag_day_number_in_week_label"
)
model_tft_native = TFTNativeModel(
encoder_length=HORIZON,
decoder_length=HORIZON,
static_categoricals=["segment_code"],
time_varying_categoricals_encoder=["dateflag_day_number_in_week_label"],
time_varying_categoricals_decoder=["dateflag_day_number_in_week_label"],
time_varying_reals_encoder=["target"] + lag_columns,
time_varying_reals_decoder=lag_columns,
num_embeddings={"segment_code": len(ts.segments), "dateflag_day_number_in_week_label": 7},
n_heads=4,
num_layers=2,
hidden_size=64,
lr=0.0001,
train_batch_size=64,
trainer_params=dict(max_epochs=15, gradient_clip_val=0.1),
)
pipeline_tft_native = Pipeline(
model=model_tft_native, horizon=HORIZON, transforms=[std, transform_lag, transform_date, encoder, label_encoder]
)
metrics_tft_native, forecast_tft_native, fold_info_tft_native = pipeline_tft_native.backtest(
ts, metrics=metrics, n_folds=3, n_jobs=1
)
[Parallel(n_jobs=1)]: Using backend SequentialBackend with 1 concurrent workers. GPU available: False, used: False TPU available: False, using: 0 TPU cores IPU available: False, using: 0 IPUs HPU available: False, using: 0 HPUs | Name | Type | Params ------------------------------------------------------------------------------ 0 | loss | MSELoss | 0 1 | static_scalers | ModuleDict | 0 2 | static_embeddings | ModuleDict | 320 3 | time_varying_scalers_encoder | ModuleDict | 896 4 | time_varying_embeddings_encoder | ModuleDict | 512 5 | time_varying_scalers_decoder | ModuleDict | 768 6 | time_varying_embeddings_decoder | ModuleDict | 512 7 | static_variable_selection | VariableSelectionNetwork | 25.3 K 8 | encoder_variable_selection | VariableSelectionNetwork | 704 K 9 | decoder_variable_selection | VariableSelectionNetwork | 557 K 10 | static_covariate_encoder | StaticCovariateEncoder | 67.1 K 11 | lstm_encoder | LSTM | 66.6 K 12 | lstm_decoder | LSTM | 66.6 K 13 | gated_norm1 | GateAddNorm | 8.4 K 14 | temporal_fusion_decoder | TemporalFusionDecoder | 62.7 K 15 | gated_norm2 | GateAddNorm | 8.4 K 16 | output_fc | Linear | 65 ------------------------------------------------------------------------------ 1.6 M Trainable params 0 Non-trainable params 1.6 M Total params 6.282 Total estimated model params size (MB)
Training: 0it [00:00, ?it/s]
`Trainer.fit` stopped: `max_epochs=15` reached. [Parallel(n_jobs=1)]: Done 1 out of 1 | elapsed: 54.9s remaining: 0.0s GPU available: False, used: False TPU available: False, using: 0 TPU cores IPU available: False, using: 0 IPUs HPU available: False, using: 0 HPUs | Name | Type | Params ------------------------------------------------------------------------------ 0 | loss | MSELoss | 0 1 | static_scalers | ModuleDict | 0 2 | static_embeddings | ModuleDict | 320 3 | time_varying_scalers_encoder | ModuleDict | 896 4 | time_varying_embeddings_encoder | ModuleDict | 512 5 | time_varying_scalers_decoder | ModuleDict | 768 6 | time_varying_embeddings_decoder | ModuleDict | 512 7 | static_variable_selection | VariableSelectionNetwork | 25.3 K 8 | encoder_variable_selection | VariableSelectionNetwork | 704 K 9 | decoder_variable_selection | VariableSelectionNetwork | 557 K 10 | static_covariate_encoder | StaticCovariateEncoder | 67.1 K 11 | lstm_encoder | LSTM | 66.6 K 12 | lstm_decoder | LSTM | 66.6 K 13 | gated_norm1 | GateAddNorm | 8.4 K 14 | temporal_fusion_decoder | TemporalFusionDecoder | 62.7 K 15 | gated_norm2 | GateAddNorm | 8.4 K 16 | output_fc | Linear | 65 ------------------------------------------------------------------------------ 1.6 M Trainable params 0 Non-trainable params 1.6 M Total params 6.282 Total estimated model params size (MB)
Training: 0it [00:00, ?it/s]
`Trainer.fit` stopped: `max_epochs=15` reached. [Parallel(n_jobs=1)]: Done 2 out of 2 | elapsed: 1.8min remaining: 0.0s GPU available: False, used: False TPU available: False, using: 0 TPU cores IPU available: False, using: 0 IPUs HPU available: False, using: 0 HPUs | Name | Type | Params ------------------------------------------------------------------------------ 0 | loss | MSELoss | 0 1 | static_scalers | ModuleDict | 0 2 | static_embeddings | ModuleDict | 320 3 | time_varying_scalers_encoder | ModuleDict | 896 4 | time_varying_embeddings_encoder | ModuleDict | 512 5 | time_varying_scalers_decoder | ModuleDict | 768 6 | time_varying_embeddings_decoder | ModuleDict | 512 7 | static_variable_selection | VariableSelectionNetwork | 25.3 K 8 | encoder_variable_selection | VariableSelectionNetwork | 704 K 9 | decoder_variable_selection | VariableSelectionNetwork | 557 K 10 | static_covariate_encoder | StaticCovariateEncoder | 67.1 K 11 | lstm_encoder | LSTM | 66.6 K 12 | lstm_decoder | LSTM | 66.6 K 13 | gated_norm1 | GateAddNorm | 8.4 K 14 | temporal_fusion_decoder | TemporalFusionDecoder | 62.7 K 15 | gated_norm2 | GateAddNorm | 8.4 K 16 | output_fc | Linear | 65 ------------------------------------------------------------------------------ 1.6 M Trainable params 0 Non-trainable params 1.6 M Total params 6.282 Total estimated model params size (MB)
Training: 0it [00:00, ?it/s]
`Trainer.fit` stopped: `max_epochs=15` reached. [Parallel(n_jobs=1)]: Done 3 out of 3 | elapsed: 2.9min remaining: 0.0s [Parallel(n_jobs=1)]: Done 3 out of 3 | elapsed: 2.9min finished [Parallel(n_jobs=1)]: Using backend SequentialBackend with 1 concurrent workers. [Parallel(n_jobs=1)]: Done 1 out of 1 | elapsed: 0.1s remaining: 0.0s [Parallel(n_jobs=1)]: Done 2 out of 2 | elapsed: 0.2s remaining: 0.0s [Parallel(n_jobs=1)]: Done 3 out of 3 | elapsed: 0.3s remaining: 0.0s [Parallel(n_jobs=1)]: Done 3 out of 3 | elapsed: 0.3s finished [Parallel(n_jobs=1)]: Using backend SequentialBackend with 1 concurrent workers. [Parallel(n_jobs=1)]: Done 1 out of 1 | elapsed: 0.0s remaining: 0.0s [Parallel(n_jobs=1)]: Done 2 out of 2 | elapsed: 0.0s remaining: 0.0s [Parallel(n_jobs=1)]: Done 3 out of 3 | elapsed: 0.1s remaining: 0.0s [Parallel(n_jobs=1)]: Done 3 out of 3 | elapsed: 0.1s finished
score = metrics_tft_native["SMAPE"].mean()
print(f"Average SMAPE for TFTNative: {score:.3f}")
Average SMAPE for TFTNative: 6.284
plot_backtest(forecast_tft_native, ts, history_len=20)
We'll use RNN model based on LSTM cell
from etna.models.nn import RNNModel
from etna.transforms import StandardScalerTransform
num_lags = 10
transform_lag = LagTransform(
in_column="target",
lags=[HORIZON + i for i in range(num_lags)],
out_column="target_lag",
)
model_rnn = RNNModel(
decoder_length=HORIZON,
encoder_length=2 * HORIZON,
input_size=11,
trainer_params=dict(max_epochs=5),
lr=1e-3,
)
pipeline_rnn = Pipeline(
model=model_rnn,
horizon=HORIZON,
transforms=[StandardScalerTransform(in_column="target"), transform_lag],
)
metrics_rnn, forecast_rnn, fold_info_rnn = pipeline_rnn.backtest(ts, metrics=metrics, n_folds=3, n_jobs=1)
[Parallel(n_jobs=1)]: Using backend SequentialBackend with 1 concurrent workers. GPU available: False, used: False TPU available: False, using: 0 TPU cores IPU available: False, using: 0 IPUs HPU available: False, using: 0 HPUs | Name | Type | Params --------------------------------------- 0 | loss | MSELoss | 0 1 | rnn | LSTM | 4.0 K 2 | projection | Linear | 17 --------------------------------------- 4.0 K Trainable params 0 Non-trainable params 4.0 K Total params 0.016 Total estimated model params size (MB)
Training: 0it [00:00, ?it/s]
`Trainer.fit` stopped: `max_epochs=5` reached. [Parallel(n_jobs=1)]: Done 1 out of 1 | elapsed: 2.6s remaining: 0.0s GPU available: False, used: False TPU available: False, using: 0 TPU cores IPU available: False, using: 0 IPUs HPU available: False, using: 0 HPUs | Name | Type | Params --------------------------------------- 0 | loss | MSELoss | 0 1 | rnn | LSTM | 4.0 K 2 | projection | Linear | 17 --------------------------------------- 4.0 K Trainable params 0 Non-trainable params 4.0 K Total params 0.016 Total estimated model params size (MB)
Training: 0it [00:00, ?it/s]
`Trainer.fit` stopped: `max_epochs=5` reached. [Parallel(n_jobs=1)]: Done 2 out of 2 | elapsed: 5.4s remaining: 0.0s GPU available: False, used: False TPU available: False, using: 0 TPU cores IPU available: False, using: 0 IPUs HPU available: False, using: 0 HPUs | Name | Type | Params --------------------------------------- 0 | loss | MSELoss | 0 1 | rnn | LSTM | 4.0 K 2 | projection | Linear | 17 --------------------------------------- 4.0 K Trainable params 0 Non-trainable params 4.0 K Total params 0.016 Total estimated model params size (MB)
Training: 0it [00:00, ?it/s]
`Trainer.fit` stopped: `max_epochs=5` reached. [Parallel(n_jobs=1)]: Done 3 out of 3 | elapsed: 8.6s remaining: 0.0s [Parallel(n_jobs=1)]: Done 3 out of 3 | elapsed: 8.6s finished [Parallel(n_jobs=1)]: Using backend SequentialBackend with 1 concurrent workers. [Parallel(n_jobs=1)]: Done 1 out of 1 | elapsed: 0.1s remaining: 0.0s [Parallel(n_jobs=1)]: Done 2 out of 2 | elapsed: 0.1s remaining: 0.0s [Parallel(n_jobs=1)]: Done 3 out of 3 | elapsed: 0.2s remaining: 0.0s [Parallel(n_jobs=1)]: Done 3 out of 3 | elapsed: 0.2s finished [Parallel(n_jobs=1)]: Using backend SequentialBackend with 1 concurrent workers. [Parallel(n_jobs=1)]: Done 1 out of 1 | elapsed: 0.0s remaining: 0.0s [Parallel(n_jobs=1)]: Done 2 out of 2 | elapsed: 0.0s remaining: 0.0s [Parallel(n_jobs=1)]: Done 3 out of 3 | elapsed: 0.1s remaining: 0.0s [Parallel(n_jobs=1)]: Done 3 out of 3 | elapsed: 0.1s finished
score = metrics_rnn["SMAPE"].mean()
print(f"Average SMAPE for LSTM: {score:.3f}")
Average SMAPE for LSTM: 6.304
plot_backtest(forecast_rnn, ts, history_len=20)
Deep State Model
works well with multiple similar time-series. It inffers shared patterns from them.
We have to determine the type of seasonality in data (based on data granularity), SeasonalitySSM
class is responsible for this. In this example, we have daily data, so we use day-of-week (7 seasons) and day-of-month (31 seasons) models. We also set the trend component using the LevelTrendSSM
class. Also in the model we use time-based features like day-of-week, day-of-month and time independent feature representing the segment of time series.
from etna.models.nn import DeepStateModel
from etna.models.nn.deepstate import CompositeSSM
from etna.models.nn.deepstate import LevelTrendSSM
from etna.models.nn.deepstate import SeasonalitySSM
from etna.transforms import DateFlagsTransform
from etna.transforms import SegmentEncoderTransform
from etna.transforms import StandardScalerTransform
transforms = [
SegmentEncoderTransform(),
StandardScalerTransform(in_column="target"),
DateFlagsTransform(
day_number_in_week=True,
day_number_in_month=True,
week_number_in_month=False,
week_number_in_year=False,
month_number_in_year=False,
year_number=False,
is_weekend=False,
out_column="df",
),
]
monthly_smm = SeasonalitySSM(num_seasons=31, timestamp_transform=lambda x: x.day - 1)
weekly_smm = SeasonalitySSM(num_seasons=7, timestamp_transform=lambda x: x.weekday())
model_dsm = DeepStateModel(
ssm=CompositeSSM(seasonal_ssms=[weekly_smm, monthly_smm], nonseasonal_ssm=LevelTrendSSM()),
decoder_length=HORIZON,
encoder_length=2 * HORIZON,
input_size=3,
trainer_params=dict(max_epochs=5),
lr=1e-3,
)
pipeline_dsm = Pipeline(
model=model_dsm,
horizon=HORIZON,
transforms=transforms,
)
metrics_dsm, forecast_dsm, fold_info_dsm = pipeline_dsm.backtest(ts, metrics=metrics, n_folds=3, n_jobs=1)
[Parallel(n_jobs=1)]: Using backend SequentialBackend with 1 concurrent workers. GPU available: False, used: False TPU available: False, using: 0 TPU cores IPU available: False, using: 0 IPUs HPU available: False, using: 0 HPUs | Name | Type | Params ------------------------------------------ 0 | RNN | LSTM | 7.2 K 1 | projectors | ModuleDict | 5.0 K ------------------------------------------ 12.2 K Trainable params 0 Non-trainable params 12.2 K Total params 0.049 Total estimated model params size (MB)
Training: 0it [00:00, ?it/s]
`Trainer.fit` stopped: `max_epochs=5` reached. [Parallel(n_jobs=1)]: Done 1 out of 1 | elapsed: 13.2s remaining: 0.0s GPU available: False, used: False TPU available: False, using: 0 TPU cores IPU available: False, using: 0 IPUs HPU available: False, using: 0 HPUs | Name | Type | Params ------------------------------------------ 0 | RNN | LSTM | 7.2 K 1 | projectors | ModuleDict | 5.0 K ------------------------------------------ 12.2 K Trainable params 0 Non-trainable params 12.2 K Total params 0.049 Total estimated model params size (MB)
Training: 0it [00:00, ?it/s]
`Trainer.fit` stopped: `max_epochs=5` reached. [Parallel(n_jobs=1)]: Done 2 out of 2 | elapsed: 28.0s remaining: 0.0s GPU available: False, used: False TPU available: False, using: 0 TPU cores IPU available: False, using: 0 IPUs HPU available: False, using: 0 HPUs | Name | Type | Params ------------------------------------------ 0 | RNN | LSTM | 7.2 K 1 | projectors | ModuleDict | 5.0 K ------------------------------------------ 12.2 K Trainable params 0 Non-trainable params 12.2 K Total params 0.049 Total estimated model params size (MB)
Training: 0it [00:00, ?it/s]
`Trainer.fit` stopped: `max_epochs=5` reached. [Parallel(n_jobs=1)]: Done 3 out of 3 | elapsed: 42.6s remaining: 0.0s [Parallel(n_jobs=1)]: Done 3 out of 3 | elapsed: 42.6s finished [Parallel(n_jobs=1)]: Using backend SequentialBackend with 1 concurrent workers. [Parallel(n_jobs=1)]: Done 1 out of 1 | elapsed: 0.1s remaining: 0.0s [Parallel(n_jobs=1)]: Done 2 out of 2 | elapsed: 0.2s remaining: 0.0s [Parallel(n_jobs=1)]: Done 3 out of 3 | elapsed: 0.2s remaining: 0.0s [Parallel(n_jobs=1)]: Done 3 out of 3 | elapsed: 0.2s finished [Parallel(n_jobs=1)]: Using backend SequentialBackend with 1 concurrent workers. [Parallel(n_jobs=1)]: Done 1 out of 1 | elapsed: 0.0s remaining: 0.0s [Parallel(n_jobs=1)]: Done 2 out of 2 | elapsed: 0.0s remaining: 0.0s [Parallel(n_jobs=1)]: Done 3 out of 3 | elapsed: 0.1s remaining: 0.0s [Parallel(n_jobs=1)]: Done 3 out of 3 | elapsed: 0.1s finished
score = metrics_dsm["SMAPE"].mean()
print(f"Average SMAPE for DeepStateModel: {score:.3f}")
Average SMAPE for DeepStateModel: 6.870
plot_backtest(forecast_dsm, ts, history_len=20)
This architecture is based on backward and forward residual links and a deep stack of fully connected layers.
There are two types of models in the library. The NBeatsGenericModel
class implements a generic deep learning model, while the NBeatsInterpretableModel
is augmented with certain inductive biases to be interpretable (trend and seasonality).
from etna.models.nn import NBeatsGenericModel
from etna.models.nn import NBeatsInterpretableModel
model_nbeats_generic = NBeatsGenericModel(
input_size=2 * HORIZON,
output_size=HORIZON,
loss="smape",
stacks=30,
layers=4,
layer_size=256,
trainer_params=dict(max_epochs=1000),
lr=1e-3,
)
pipeline_nbeats_generic = Pipeline(
model=model_nbeats_generic,
horizon=HORIZON,
transforms=[],
)
metrics_nbeats_generic, forecast_nbeats_generic, _ = pipeline_nbeats_generic.backtest(
ts, metrics=metrics, n_folds=3, n_jobs=1
)
[Parallel(n_jobs=1)]: Using backend SequentialBackend with 1 concurrent workers. GPU available: False, used: False TPU available: False, using: 0 TPU cores IPU available: False, using: 0 IPUs HPU available: False, using: 0 HPUs | Name | Type | Params -------------------------------------- 0 | model | NBeats | 206 K 1 | loss | NBeatsSMAPE | 0 -------------------------------------- 206 K Trainable params 0 Non-trainable params 206 K Total params 0.826 Total estimated model params size (MB)
Training: 0it [00:00, ?it/s]
`Trainer.fit` stopped: `max_epochs=1000` reached. [Parallel(n_jobs=1)]: Done 1 out of 1 | elapsed: 54.3s remaining: 0.0s GPU available: False, used: False TPU available: False, using: 0 TPU cores IPU available: False, using: 0 IPUs HPU available: False, using: 0 HPUs | Name | Type | Params -------------------------------------- 0 | model | NBeats | 206 K 1 | loss | NBeatsSMAPE | 0 -------------------------------------- 206 K Trainable params 0 Non-trainable params 206 K Total params 0.826 Total estimated model params size (MB)
Training: 0it [00:00, ?it/s]
`Trainer.fit` stopped: `max_epochs=1000` reached. [Parallel(n_jobs=1)]: Done 2 out of 2 | elapsed: 1.7min remaining: 0.0s GPU available: False, used: False TPU available: False, using: 0 TPU cores IPU available: False, using: 0 IPUs HPU available: False, using: 0 HPUs | Name | Type | Params -------------------------------------- 0 | model | NBeats | 206 K 1 | loss | NBeatsSMAPE | 0 -------------------------------------- 206 K Trainable params 0 Non-trainable params 206 K Total params 0.826 Total estimated model params size (MB)
Training: 0it [00:00, ?it/s]
`Trainer.fit` stopped: `max_epochs=1000` reached. [Parallel(n_jobs=1)]: Done 3 out of 3 | elapsed: 2.4min remaining: 0.0s [Parallel(n_jobs=1)]: Done 3 out of 3 | elapsed: 2.4min finished [Parallel(n_jobs=1)]: Using backend SequentialBackend with 1 concurrent workers. [Parallel(n_jobs=1)]: Done 1 out of 1 | elapsed: 0.0s remaining: 0.0s [Parallel(n_jobs=1)]: Done 2 out of 2 | elapsed: 0.0s remaining: 0.0s [Parallel(n_jobs=1)]: Done 3 out of 3 | elapsed: 0.1s remaining: 0.0s [Parallel(n_jobs=1)]: Done 3 out of 3 | elapsed: 0.1s finished [Parallel(n_jobs=1)]: Using backend SequentialBackend with 1 concurrent workers. [Parallel(n_jobs=1)]: Done 1 out of 1 | elapsed: 0.0s remaining: 0.0s [Parallel(n_jobs=1)]: Done 2 out of 2 | elapsed: 0.0s remaining: 0.0s [Parallel(n_jobs=1)]: Done 3 out of 3 | elapsed: 0.1s remaining: 0.0s [Parallel(n_jobs=1)]: Done 3 out of 3 | elapsed: 0.1s finished
score = metrics_nbeats_generic["SMAPE"].mean()
print(f"Average SMAPE for N-BEATS Generic: {score:.3f}")
Average SMAPE for N-BEATS Generic: 5.719
plot_backtest(forecast_nbeats_generic, ts, history_len=20)
model_nbeats_interp = NBeatsInterpretableModel(
input_size=4 * HORIZON,
output_size=HORIZON,
loss="smape",
trend_layer_size=64,
seasonality_layer_size=256,
trainer_params=dict(max_epochs=2000),
lr=1e-3,
)
pipeline_nbeats_interp = Pipeline(
model=model_nbeats_interp,
horizon=HORIZON,
transforms=[],
)
metrics_nbeats_interp, forecast_nbeats_interp, _ = pipeline_nbeats_interp.backtest(
ts, metrics=metrics, n_folds=3, n_jobs=1
)
[Parallel(n_jobs=1)]: Using backend SequentialBackend with 1 concurrent workers. GPU available: False, used: False TPU available: False, using: 0 TPU cores IPU available: False, using: 0 IPUs HPU available: False, using: 0 HPUs | Name | Type | Params -------------------------------------- 0 | model | NBeats | 224 K 1 | loss | NBeatsSMAPE | 0 -------------------------------------- 223 K Trainable params 385 Non-trainable params 224 K Total params 0.896 Total estimated model params size (MB)
Training: 0it [00:00, ?it/s]
`Trainer.fit` stopped: `max_epochs=2000` reached. [Parallel(n_jobs=1)]: Done 1 out of 1 | elapsed: 39.6s remaining: 0.0s GPU available: False, used: False TPU available: False, using: 0 TPU cores IPU available: False, using: 0 IPUs HPU available: False, using: 0 HPUs | Name | Type | Params -------------------------------------- 0 | model | NBeats | 224 K 1 | loss | NBeatsSMAPE | 0 -------------------------------------- 223 K Trainable params 385 Non-trainable params 224 K Total params 0.896 Total estimated model params size (MB)
Training: 0it [00:00, ?it/s]
`Trainer.fit` stopped: `max_epochs=2000` reached. [Parallel(n_jobs=1)]: Done 2 out of 2 | elapsed: 1.4min remaining: 0.0s GPU available: False, used: False TPU available: False, using: 0 TPU cores IPU available: False, using: 0 IPUs HPU available: False, using: 0 HPUs | Name | Type | Params -------------------------------------- 0 | model | NBeats | 224 K 1 | loss | NBeatsSMAPE | 0 -------------------------------------- 223 K Trainable params 385 Non-trainable params 224 K Total params 0.896 Total estimated model params size (MB)
Training: 0it [00:00, ?it/s]
`Trainer.fit` stopped: `max_epochs=2000` reached. [Parallel(n_jobs=1)]: Done 3 out of 3 | elapsed: 2.3min remaining: 0.0s [Parallel(n_jobs=1)]: Done 3 out of 3 | elapsed: 2.3min finished [Parallel(n_jobs=1)]: Using backend SequentialBackend with 1 concurrent workers. [Parallel(n_jobs=1)]: Done 1 out of 1 | elapsed: 0.0s remaining: 0.0s [Parallel(n_jobs=1)]: Done 2 out of 2 | elapsed: 0.1s remaining: 0.0s [Parallel(n_jobs=1)]: Done 3 out of 3 | elapsed: 0.1s remaining: 0.0s [Parallel(n_jobs=1)]: Done 3 out of 3 | elapsed: 0.1s finished [Parallel(n_jobs=1)]: Using backend SequentialBackend with 1 concurrent workers. [Parallel(n_jobs=1)]: Done 1 out of 1 | elapsed: 0.0s remaining: 0.0s [Parallel(n_jobs=1)]: Done 2 out of 2 | elapsed: 0.0s remaining: 0.0s [Parallel(n_jobs=1)]: Done 3 out of 3 | elapsed: 0.1s remaining: 0.0s [Parallel(n_jobs=1)]: Done 3 out of 3 | elapsed: 0.1s finished
score = metrics_nbeats_interp["SMAPE"].mean()
print(f"Average SMAPE for N-BEATS Interpretable: {score:.3f}")
Average SMAPE for N-BEATS Interpretable: 5.177
plot_backtest(forecast_nbeats_interp, ts, history_len=20)
Model with transformer encoder that uses patches of timeseries as input words and linear decoder.
from etna.models.nn import PatchTSModel
model_patchts = PatchTSModel(
decoder_length=HORIZON,
encoder_length=2 * HORIZON,
patch_len=1,
trainer_params=dict(max_epochs=100),
lr=1e-3,
)
pipeline_patchts = Pipeline(
model=model_patchts, horizon=HORIZON, transforms=[StandardScalerTransform(in_column="target")]
)
metrics_patchts, forecast_patchts, fold_info_patchs = pipeline_patchts.backtest(
ts, metrics=metrics, n_folds=3, n_jobs=1
)
[Parallel(n_jobs=1)]: Using backend SequentialBackend with 1 concurrent workers. GPU available: False, used: False TPU available: False, using: 0 TPU cores IPU available: False, using: 0 IPUs HPU available: False, using: 0 HPUs | Name | Type | Params ------------------------------------------ 0 | loss | MSELoss | 0 1 | model | Sequential | 397 K 2 | projection | Sequential | 1.8 K ------------------------------------------ 399 K Trainable params 0 Non-trainable params 399 K Total params 1.598 Total estimated model params size (MB)
Training: 0it [00:00, ?it/s]
`Trainer.fit` stopped: `max_epochs=100` reached. [Parallel(n_jobs=1)]: Done 1 out of 1 | elapsed: 18.7min remaining: 0.0s GPU available: False, used: False TPU available: False, using: 0 TPU cores IPU available: False, using: 0 IPUs HPU available: False, using: 0 HPUs | Name | Type | Params ------------------------------------------ 0 | loss | MSELoss | 0 1 | model | Sequential | 397 K 2 | projection | Sequential | 1.8 K ------------------------------------------ 399 K Trainable params 0 Non-trainable params 399 K Total params 1.598 Total estimated model params size (MB)
Training: 0it [00:00, ?it/s]
`Trainer.fit` stopped: `max_epochs=100` reached. [Parallel(n_jobs=1)]: Done 2 out of 2 | elapsed: 36.6min remaining: 0.0s GPU available: False, used: False TPU available: False, using: 0 TPU cores IPU available: False, using: 0 IPUs HPU available: False, using: 0 HPUs | Name | Type | Params ------------------------------------------ 0 | loss | MSELoss | 0 1 | model | Sequential | 397 K 2 | projection | Sequential | 1.8 K ------------------------------------------ 399 K Trainable params 0 Non-trainable params 399 K Total params 1.598 Total estimated model params size (MB)
Training: 0it [00:00, ?it/s]
`Trainer.fit` stopped: `max_epochs=100` reached. [Parallel(n_jobs=1)]: Done 3 out of 3 | elapsed: 54.6min remaining: 0.0s [Parallel(n_jobs=1)]: Done 3 out of 3 | elapsed: 54.6min finished [Parallel(n_jobs=1)]: Using backend SequentialBackend with 1 concurrent workers. [Parallel(n_jobs=1)]: Done 1 out of 1 | elapsed: 0.1s remaining: 0.0s [Parallel(n_jobs=1)]: Done 2 out of 2 | elapsed: 0.1s remaining: 0.0s [Parallel(n_jobs=1)]: Done 3 out of 3 | elapsed: 0.1s remaining: 0.0s [Parallel(n_jobs=1)]: Done 3 out of 3 | elapsed: 0.1s finished [Parallel(n_jobs=1)]: Using backend SequentialBackend with 1 concurrent workers. [Parallel(n_jobs=1)]: Done 1 out of 1 | elapsed: 0.0s remaining: 0.0s [Parallel(n_jobs=1)]: Done 2 out of 2 | elapsed: 0.0s remaining: 0.0s [Parallel(n_jobs=1)]: Done 3 out of 3 | elapsed: 0.1s remaining: 0.0s [Parallel(n_jobs=1)]: Done 3 out of 3 | elapsed: 0.1s finished
score = metrics_patchts["SMAPE"].mean()
print(f"Average SMAPE for PatchTS: {score:.3f}")
Average SMAPE for PatchTS: 6.072
plot_backtest(forecast_patchts, ts, history_len=20)