1. 辅助函数

1.1 Embedding


源代码

DataEmbedding_inverted

 DataEmbedding_inverted (c_in, d_model, dropout=0.1)

数据 Embedding

1.2 STAD (STar Aggregate Dispatch)


源代码

STAD

 STAD (d_series, d_core)

STar Aggregate Dispatch 模块

2. 模型


源代码

SOFTS

 SOFTS (h, input_size, n_series, futr_exog_list=None, hist_exog_list=None,
        stat_exog_list=None, exclude_insample_y=False,
        hidden_size:int=512, d_core:int=512, e_layers:int=2,
        d_ff:int=2048, dropout:float=0.1, use_norm:bool=True, 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:int=32,
        valid_batch_size:Optional[int]=None, windows_batch_size=32,
        inference_windows_batch_size=32, start_padding_enabled=False,
        step_size:int=1, scaler_type:str='identity', random_seed:int=1,
        drop_last_loader:bool=False, alias:Optional[str]=None,
        optimizer=None, optimizer_kwargs=None, lr_scheduler=None,
        lr_scheduler_kwargs=None, dataloader_kwargs=None,
        **trainer_kwargs)

*SOFTS

参数
h: int, 预测范围。
input_size: int, 自回归输入大小, y=[1,2,3,4] input_size=2 -> y_[t-2:t]=[1,2]。
n_series: int, 时间序列的数量。
futr_exog_list: str list, 未来外部变量列。
hist_exog_list: str list, 历史外部变量列。
stat_exog_list: str list, 静态外部变量列。
exclude_insample_y: bool=False, 是否从输入中排除目标变量。

hidden_size: int, 模型维度。
d_core: int, STAD 中 core 的维度。
e_layers: int, 编码器层数。
d_ff: int, 全连接层维度。
dropout: float, dropout 率。
use_norm: bool, 是否进行归一化。
loss: PyTorch 模块, 从 损失集合 实例化训练损失类。
valid_loss: PyTorch 模块=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, 每个 batch 中不同序列的数量。
valid_batch_size: int=None, 每个验证和测试 batch 中不同序列的数量, 如果为 None 则使用 batch_size。
windows_batch_size: int=32, 每个训练 batch 中采样的窗口数量, 默认为全部。
inference_windows_batch_size: int=32, 每个推理 batch 中采样的窗口数量, -1 表示全部。
start_padding_enabled: bool=False, 如果为 True, 模型将在时间序列开头按输入大小用零进行填充。
step_size: int=1, 每个时间数据窗口之间的步长。
scaler_type: str=‘identity’, 时间输入归一化的缩放器类型, 参见 时间缩放器
random_seed: int=1, 用于 pytorch 初始化器和 numpy 生成器的随机种子。
drop_last_loader: bool=False, 如果为 True, TimeSeriesDataLoader 将丢弃最后一个非完整 batch。
alias: str, 可选, 模型的自定义名称。
optimizer: ‘torch.optim.Optimizer’ 的子类, 可选, 用户指定的优化器, 代替默认选择 (Adam)。
optimizer_kwargs: dict, 可选, 用户指定的 optimizer 使用的参数列表。
lr_scheduler: ‘torch.optim.lr_scheduler.LRScheduler’ 的子类, 可选, 用户指定的 lr_scheduler, 代替默认选择 (StepLR)。
lr_scheduler_kwargs: dict, 可选, 用户指定的 lr_scheduler 使用的参数列表。
dataloader_kwargs: dict, 可选, 由 TimeSeriesDataLoader 传递给 PyTorch Lightning dataloader 的参数列表。
**trainer_kwargs: int, 继承自 PyTorch Lighning 的 trainer 的关键字 trainer 参数。

参考文献
Lu Han, Xu-Yang Chen, Han-Jia Ye, De-Chuan Zhan. “SOFTS: 高效的基于序列-核心融合的多元时间序列预测”*


SOFTS.fit

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

*Fit。

fit 方法使用初始化参数 (learning_rate, windows_batch_size, …) 和初始化时定义的 loss 函数来优化神经网络的权重。在 fit 中, 我们使用一个继承初始化参数 self.trainer_kwargs 的 PyTorch Lightning Trainer 来定制其输入, 参见 PL 的 trainer 参数

此方法设计用于兼容 SKLearn 类库, 特别是兼容 StatsForecast 库。

默认情况下, model 不保存训练 checkpoint 以保护磁盘内存, 要获取它们, 请在 __init__ 中将 enable_checkpointing 设置为 True

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


SOFTS.predict

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

*Predict。

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

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

3. 使用示例

import pandas as pd
import matplotlib.pyplot as plt

from neuralforecast import NeuralForecast
from neuralforecast.models import SOFTS
from neuralforecast.utils import AirPassengersPanel, AirPassengersStatic
from neuralforecast.losses.pytorch import MASE
Y_train_df = AirPassengersPanel[AirPassengersPanel.ds<AirPassengersPanel['ds'].values[-12]].reset_index(drop=True) # 132 train
Y_test_df = AirPassengersPanel[AirPassengersPanel.ds>=AirPassengersPanel['ds'].values[-12]].reset_index(drop=True) # 12 test

model = SOFTS(h=12,
              input_size=24,
              n_series=2,
              hidden_size=256,
              d_core=256,
              e_layers=2,
              d_ff=64,
              dropout=0.1,
              use_norm=True,
              loss=MASE(seasonality=4),
              early_stop_patience_steps=3,
              batch_size=32)

fcst = NeuralForecast(models=[model], freq='ME')
fcst.fit(df=Y_train_df, static_df=AirPassengersStatic, val_size=12)
forecasts = fcst.predict(futr_df=Y_test_df)

# Plot predictions
fig, ax = plt.subplots(1, 1, figsize = (20, 7))
Y_hat_df = forecasts.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['SOFTS'], c='blue', label='Forecast')
ax.set_title('AirPassengers Forecast', fontsize=22)
ax.set_ylabel('Monthly Passengers', fontsize=20)
ax.set_xlabel('Year', fontsize=20)
ax.legend(prop={'size': 15})
ax.grid()