LSTM

长短期记忆循环神经网络（LSTM）使用多层 LSTM 编码器和 MLP 解码器。它建立在 LSTM 单元的基础上，该单元改进了经典 RNN 的梯度爆炸和梯度消失问题。该网络已被广泛用于序列预测任务，例如语言建模、语音标注和预测。通过将隐藏状态转换为上下文 $\mathbf{c}_{[t+1:t+H]}$，然后通过 MLP 将其解码并转换为 $\mathbf{\hat{y}}_{[t+1:t+H],[q]}$ 来获得预测结果。

其中 $\mathbf{h}_{t}$ 是时间 $t$ 的隐藏状态，$\mathbf{y}_{t}$ 是时间 $t$ 的输入，$\mathbf{h}_{t-1}$ 是 $t-1$ 时前一层的隐藏状态，$\mathbf{x}^{(s)}$ 是静态外部输入，$\mathbf{x}^{(h)}_{t}$ 是历史外部输入，$\mathbf{x}^{(f)}_{[:t+H]}$ 是预测时可用的未来外部输入。

参考文献
-Jeffrey L. Elman (1990). “Finding Structure in Time”.
-Haşim Sak, Andrew Senior, Françoise Beaufays (2014). “Long Short-Term Memory Based Recurrent Neural Network Architectures for Large Vocabulary Speech Recognition.”

​

LSTM

 LSTM (h:int, input_size:int=-1, inference_input_size:Optional[int]=None,
       encoder_n_layers:int=2, encoder_hidden_size:int=128,
       encoder_bias:bool=True, encoder_dropout:float=0.0,
       context_size:Optional[int]=None, decoder_hidden_size:int=128,
       decoder_layers:int=2, futr_exog_list=None, hist_exog_list=None,
       stat_exog_list=None, exclude_insample_y=False, recurrent=False,
       loss=MAE(), valid_loss=None, max_steps:int=1000,
       learning_rate:float=0.001, num_lr_decays:int=-1,
       early_stop_patience_steps:int=-1, val_check_steps:int=100,
       batch_size=32, valid_batch_size:Optional[int]=None,
       windows_batch_size=128, inference_windows_batch_size=1024,
       start_padding_enabled=False, step_size:int=1,
       scaler_type:str='robust', random_seed=1, drop_last_loader=False,
       alias:Optional[str]=None, optimizer=None, optimizer_kwargs=None,
       lr_scheduler=None, lr_scheduler_kwargs=None,
       dataloader_kwargs=None, **trainer_kwargs)

*LSTM

LSTM 编码器，带 MLP 解码器。该网络具有 tanh 或 relu 非线性激活函数，使用 ADAM 随机梯度下降进行训练。该网络接受静态、历史和未来外部数据。

参数
h: int，预测范围。
input_size: int，截断训练反向传播的最大序列长度。默认 -1 使用 3 * horizon
inference_input_size: int，截断推理的最大序列长度。默认 None 使用 input_size 的历史长度。
encoder_n_layers: int=2，LSTM 的层数。
encoder_hidden_size: int=200，LSTM 隐藏状态的大小单元。
encoder_bias: bool=True，是否在 LSTM 单元内使用 b_ih, b_hh 偏置。
encoder_dropout: float=0.，应用于 LSTM 输出的 dropout 正则化。
context_size: 已弃用。
decoder_hidden_size: int=200，MLP 解码器隐藏层的大小。
decoder_layers: int=2，MLP 解码器的层数。
futr_exog_list: str list，未来外部变量列。
hist_exog_list: str list，历史外部变量列。
stat_exog_list: str list，静态外部变量列。
exclude_insample_y: bool=False，是否从输入中排除目标变量。
recurrent: bool=False，是否递归生成预测结果 (True) 或直接生成 (False)。
loss: PyTorch module，来自损失函数集合的实例化训练损失类。
valid_loss: PyTorch module=loss，来自损失函数集合的实例化验证损失类。
max_steps: int=1000，最大训练步数。
learning_rate: float=1e-3，学习率，介于 (0, 1) 之间。
num_lr_decays: int=-1，学习率衰减次数，均匀分布在 max_steps 中。
early_stop_patience_steps: int=-1，早停前验证迭代次数。
val_check_steps: int=100，每次验证损失检查之间的训练步数。
batch_size: int=32，每个批次中不同时间序列的数量。
valid_batch_size: int=None，每个验证和测试批次中不同时间序列的数量。
windows_batch_size: int=128，每个训练批次中采样的窗口数量，默认使用全部。
inference_windows_batch_size: int=1024，每个推理批次中采样的窗口数量，-1 使用全部。
start_padding_enabled: bool=False，如果为 True，模型将在时间序列开头填充零，填充大小由 input size 决定。
step_size: int=1，每个时间数据窗口之间的步长。

scaler_type: str=‘robust’，时间输入归一化的缩放器类型，参见时间缩放器。
random_seed: int=1，用于 pytorch 初始化器和 numpy 生成器的随机种子。
drop_last_loader: bool=False，如果为 True，TimeSeriesDataLoader 将丢弃最后一个非完整批次。
alias: str，可选，模型的自定义名称。
optimizer: ‘torch.optim.Optimizer’ 的子类，可选，用户指定的优化器，而非默认选择 (Adam)。
optimizer_kwargs: dict，可选，用户指定的 optimizer 使用的参数列表。
lr_scheduler: ‘torch.optim.lr_scheduler.LRScheduler’ 的子类，可选，用户指定的学习率调度器，而非默认选择 (StepLR)。
lr_scheduler_kwargs: dict，可选，用户指定的 lr_scheduler 使用的参数列表。

dataloader_kwargs: dict，可选，由 TimeSeriesDataLoader 传递给 PyTorch Lightning dataloader 的参数列表。
**trainer_kwargs: int，继承自PyTorch Lighning 的 trainer 的关键字 trainer 参数。
*

​

LSTM.fit

 LSTM.fit (dataset, val_size=0, test_size=0, random_seed=None,
           distributed_config=None)

*拟合。

fit 方法使用初始化参数（learning_rate、windows_batch_size 等）和初始化时定义的 loss 函数来优化神经网络的权重。在 fit 方法中，我们使用继承了初始化参数 self.trainer_kwargs 的 PyTorch Lightning Trainer 来定制其输入，参见PL 的 trainer 参数。

该方法设计用于兼容类似 SKLearn 的类，特别是兼容 StatsForecast 库。

默认情况下，model 不保存训练检查点以保护磁盘内存，如需保存，请在 __init__ 中更改 enable_checkpointing=True。

参数
dataset: NeuralForecast 的 TimeSeriesDataset，参见文档。
val_size: int，用于时间交叉验证的验证集大小。
random_seed: int=None，用于 pytorch 初始化器和 numpy 生成器的随机种子，覆盖 model.__init__ 中的设置。
test_size: int，用于时间交叉验证的测试集大小。
*

​

LSTM.predict

 LSTM.predict (dataset, test_size=None, step_size=1, random_seed=None,
               quantiles=None, **data_module_kwargs)

*预测。

使用 PL 的 Trainer 执行 predict_step 进行神经网络预测。

参数
dataset: NeuralForecast 的 TimeSeriesDataset，参见文档。
test_size: int=None，用于时间交叉验证的测试集大小。
step_size: int=1，每个窗口之间的步长。
random_seed: int=None，用于 pytorch 初始化器和 numpy 生成器的随机种子，覆盖 model.__init__ 中的设置。
quantiles: float 列表，可选 (default=None)，要预测的目标分位数。
**data_module_kwargs: PL 的 TimeSeriesDataModule 参数，参见文档。*

​

使用示例

import pandas as pd
import matplotlib.pyplot as plt

from neuralforecast import NeuralForecast
from neuralforecast.models import LSTM
from neuralforecast.losses.pytorch import DistributionLoss
from neuralforecast.utils import AirPassengersPanel, AirPassengersStatic

Y_train_df = AirPassengersPanel[AirPassengersPanel.ds<AirPassengersPanel['ds'].values[-12]] # 132 train
Y_test_df = AirPassengersPanel[AirPassengersPanel.ds>=AirPassengersPanel['ds'].values[-12]].reset_index(drop=True) # 12 test

nf = NeuralForecast(
    models=[LSTM(h=12, 
                 input_size=24,
                 loss=DistributionLoss(distribution="Normal", level=[80, 90]),
                 scaler_type='robust',
                 encoder_n_layers=2,
                 encoder_hidden_size=128,
                 decoder_hidden_size=128,
                 decoder_layers=2,
                 max_steps=200,
                 futr_exog_list=['y_[lag12]'],
                 stat_exog_list=['airline1'],
                 recurrent=False,
                 )
    ],
    freq='ME'
)
nf.fit(df=Y_train_df, static_df=AirPassengersStatic)
Y_hat_df = nf.predict(futr_df=Y_test_df)

# Plots
Y_hat_df = Y_hat_df.reset_index(drop=False).drop(columns=['unique_id','ds'])
plot_df = pd.concat([Y_test_df, Y_hat_df], axis=1)
plot_df = pd.concat([Y_train_df, plot_df])

plot_df = plot_df[plot_df.unique_id=='Airline1'].drop('unique_id', axis=1)
plt.plot(plot_df['ds'], plot_df['y'], c='black', label='True')
plt.plot(plot_df['ds'], plot_df['LSTM-median'], c='blue', label='median')
plt.fill_between(x=plot_df['ds'][-12:], 
                 y1=plot_df['LSTM-lo-90'][-12:].values,
                 y2=plot_df['LSTM-hi-90'][-12:].values,
                 alpha=0.4, label='level 90')
plt.grid()
plt.plot()