MLP

​

MLP

 MLP (h, input_size, stat_exog_list=None, hist_exog_list=None,
      futr_exog_list=None, exclude_insample_y=False, num_layers=2,
      hidden_size=1024, 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=1024, inference_windows_batch_size=-1,
      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)

*MLP

简单的多层感知器架构 (MLP)。这个深度神经网络在其层中具有恒定数量的单元，每个单元都带有 ReLU 非线性激活函数，使用 ADAM 随机梯度下降进行训练。该网络接受静态、历史和未来外部数据，将输入展平并学习针对目标变量的全连接关系。

参数
h: int，预测范围（horizon）。
input_size: int，考虑的自回归输入（lag），y=[1,2,3,4] input_size=2 -> lags=[1,2]。
stat_exog_list: str list，静态外部变量列。
hist_exog_list: str list，历史外部变量列。
futr_exog_list: str list，未来外部变量列。
exclude_insample_y: bool=False，如果为 True，模型会跳过自回归特征 y[t-input_size:t]。
num_layers: int，MLP 的层数。
hidden_size: int，MLP 每层的单元数。
loss: PyTorch 模块，从 losses collection 实例化训练损失类。
valid_loss: PyTorch 模块=loss，从 losses collection 实例化验证损失类。
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，每个验证和测试批次中不同时间序列的数量，如果为 None 则使用 batch_size。
windows_batch_size: int=1024，每个训练批次中采样的窗口数，默认为全部。
inference_windows_batch_size: int=-1，每个推理批次中采样的窗口数，-1 为全部。
start_padding_enabled: bool=False，如果为 True，模型会根据 input_size 在时间序列开头用零填充。
step_size: int=1，每个时间数据窗口之间的步长。
scaler_type: str='identity'，用于时间输入标准化的缩放器类型，请参见 temporal scalers。
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' 的子类，可选，用户指定的 lr_scheduler，而非默认选择 (StepLR)。
lr_scheduler_kwargs: dict，可选，用户指定 lr_scheduler 使用的参数列表。

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

​

MLP.fit

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

*拟合 (Fit)。

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

此方法设计为与 SKLearn-like 类兼容，特别是与 StatsForecast 库兼容。

默认情况下，model 不保存训练检查点以保护磁盘空间，若要获取它们，请在 __init__ 中更改 enable_checkpointing=True。

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

​

MLP.predict

 MLP.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: 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 MLP
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

model = MLP(h=12, input_size=24,
            loss=DistributionLoss(distribution='Normal', level=[80, 90]),
            scaler_type='robust',
            learning_rate=1e-3,
            max_steps=200,
            val_check_steps=10,
            early_stop_patience_steps=2)

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
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['MLP-median'], c='blue', label='median')
plt.fill_between(x=plot_df['ds'][-12:], 
                 y1=plot_df['MLP-lo-90'][-12:].values, 
                 y2=plot_df['MLP-hi-90'][-12:].values,
                 alpha=0.4, label='level 90')
plt.grid()
plt.legend()
plt.plot()