​

1. 辅助函数

​

FlattenHead

 FlattenHead (n_vars, nf, target_window, head_dropout=0)

*所有神经网络模块的基类。

您的模型也应该继承此类别。

模块也可以包含其他模块，允许它们以树状结构嵌套。您可以将子模块作为常规属性分配：

import torch.nn as nn
import torch.nn.functional as F

class Model(nn.Module):
    def __init__(self) -> None:
        super().__init__()
        self.conv1 = nn.Conv2d(1, 20, 5)
        self.conv2 = nn.Conv2d(20, 20, 5)

    def forward(self, x):
        x = F.relu(self.conv1(x))
        return F.relu(self.conv2(x))

以这种方式分配的子模块将被注册，并且当您调用 :meth:to 等方法时，它们的参数也会被转换。

.. 注意:: 根据上面的例子，在子类中进行属性分配之前，必须调用父类的 __init__() 方法。

:ivar training: 布尔值，表示此模块是处于训练模式还是评估模式。 :vartype training: bool*

​

编码器

 Encoder (layers, norm_layer=None, projection=None)

*所有神经网络模块的基类。

您的模型也应该继承此类别。

模块也可以包含其他模块，允许它们以树状结构嵌套。您可以将子模块作为常规属性分配：

import torch.nn as nn
import torch.nn.functional as F

class Model(nn.Module):
    def __init__(self) -> None:
        super().__init__()
        self.conv1 = nn.Conv2d(1, 20, 5)
        self.conv2 = nn.Conv2d(20, 20, 5)

    def forward(self, x):
        x = F.relu(self.conv1(x))
        return F.relu(self.conv2(x))

以这种方式分配的子模块将被注册，并且当您调用 :meth:to 等方法时，它们的参数也会被转换。

.. 注意:: 根据上面的例子，在子类中进行属性分配之前，必须调用父类的 __init__() 方法。

:ivar training: 布尔值，表示此模块是处于训练模式还是评估模式。 :vartype training: bool*

​

编码器层

 EncoderLayer (self_attention, cross_attention, d_model, d_ff=None,
               dropout=0.1, activation='relu')

*所有神经网络模块的基类。

您的模型也应该继承此类别。

模块也可以包含其他模块，允许它们以树状结构嵌套。您可以将子模块作为常规属性分配：

import torch.nn as nn
import torch.nn.functional as F

class Model(nn.Module):
    def __init__(self) -> None:
        super().__init__()
        self.conv1 = nn.Conv2d(1, 20, 5)
        self.conv2 = nn.Conv2d(20, 20, 5)

    def forward(self, x):
        x = F.relu(self.conv1(x))
        return F.relu(self.conv2(x))

以这种方式分配的子模块将被注册，并且当您调用 :meth:to 等方法时，它们的参数也会被转换。

.. 注意:: 根据上面的例子，在子类中进行属性分配之前，必须调用父类的 __init__() 方法。

:ivar training: 布尔值，表示此模块是处于训练模式还是评估模式。 :vartype training: bool*

​

EnEmbedding

 EnEmbedding (n_vars, d_model, patch_len, dropout)

*所有神经网络模块的基类。

您的模型也应该继承此类别。

模块也可以包含其他模块，允许它们以树状结构嵌套。您可以将子模块作为常规属性分配：

import torch.nn as nn
import torch.nn.functional as F

class Model(nn.Module):
    def __init__(self) -> None:
        super().__init__()
        self.conv1 = nn.Conv2d(1, 20, 5)
        self.conv2 = nn.Conv2d(20, 20, 5)

    def forward(self, x):
        x = F.relu(self.conv1(x))
        return F.relu(self.conv2(x))

以这种方式分配的子模块将被注册，并且当您调用 :meth:to 等方法时，它们的参数也会被转换。

.. 注意:: 根据上面的例子，在子类中进行属性分配之前，必须调用父类的 __init__() 方法。

:ivar training: 布尔值，表示此模块是处于训练模式还是评估模式。 :vartype training: bool*

​

2. 模型

​

TimeXer

 TimeXer (h, input_size, n_series, futr_exog_list=None,
          hist_exog_list=None, stat_exog_list=None, patch_len:int=16,
          hidden_size:int=512, n_heads:int=8, e_layers:int=2,
          d_ff:int=2048, factor:int=1, 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)

*TimeXer

参数
h: int, 预测范围（horizon）。
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, 静态外部变量列。
patch_len: int, 块的长度。
hidden_size: int, 模型的维度。
n_heads: int, 注意力头的数量。
e_layers: int, 编码器层的数量。
d_ff: int, 全连接层的维度。
factor: int, 注意力因子。
dropout: float, dropout 率。
use_norm: bool, 是否进行归一化。
loss: PyTorch module, 从损失函数集合中实例化的训练损失类别。
valid_loss: PyTorch module=loss, 从损失函数集合中实例化的验证损失类别。
max_steps: int=1000, 最大训练步数。
learning_rate: float=1e-3, 学习率，介于 (0, 1) 之间。
num_lr_decays: int=-1, 学习率衰减次数，均匀分布在最大训练步数中。
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=32, 每个批次中的窗口数量。

inference_windows_batch_size: int=32, 每个推理批次中采样的窗口数量，-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 将丢弃最后一个非完整批次。
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 的关键字训练器参数。

参数

参考文献 - Yuxuan Wang, Haixu Wu, Jiaxiang Dong, Guo Qin, Haoran Zhang, Yong Liu, Yunzhong Qiu, Jianmin Wang, Mingsheng Long. “TimeXer: Empowering Transformers for Time Series Forecasting with Exogenous Variables”*

​

TimeXer.fit

 TimeXer.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 不保存训练检查点以保护磁盘内存，要启用检查点，请在 __init__ 中将 enable_checkpointing 设置为 True。

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

​

TimeXer.predict

 TimeXer.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 参数，参见文档。*

# Unit tests for models
logging.getLogger("pytorch_lightning").setLevel(logging.ERROR)
logging.getLogger("lightning_fabric").setLevel(logging.ERROR)
with warnings.catch_warnings():
    warnings.simplefilter("ignore")
    check_model(TimeXer, ["airpassengers"])

​

3. 使用示例

import pandas as pd
import matplotlib.pyplot as plt

from neuralforecast import NeuralForecast
from neuralforecast.models import TimeXer
from neuralforecast.losses.pytorch import MSE
from neuralforecast.utils import AirPassengersPanel, AirPassengersStatic, augment_calendar_df

AirPassengersPanel, calendar_cols = augment_calendar_df(df=AirPassengersPanel, freq='M')

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 = TimeXer(h=12,
                input_size=24,
                n_series=2,
                futr_exog_list=["trend", "month"],
                patch_len=12,
                hidden_size=128,
                n_heads=16,
                e_layers=2,
                d_ff=256,
                factor=1,
                dropout=0.1,
                use_norm=True,
                loss=MSE(),
                valid_loss=MAE(),
                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['TimeXer'], 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()