gluonts.torch.model.tft.estimator module#
- class gluonts.torch.model.tft.estimator.TemporalFusionTransformerEstimator(freq: str, prediction_length: int, context_length: Optional[int] = None, quantiles: Optional[List[float]] = None, distr_output: Optional[gluonts.torch.distributions.output.Output] = None, num_heads: int = 4, hidden_dim: int = 32, variable_dim: int = 32, static_dims: Optional[List[int]] = None, dynamic_dims: Optional[List[int]] = None, past_dynamic_dims: Optional[List[int]] = None, static_cardinalities: Optional[List[int]] = None, dynamic_cardinalities: Optional[List[int]] = None, past_dynamic_cardinalities: Optional[List[int]] = None, time_features: Optional[List[Callable[[pandas.core.indexes.period.PeriodIndex], numpy.ndarray]]] = None, lr: float = 0.001, weight_decay: float = 1e-08, dropout_rate: float = 0.1, patience: int = 10, batch_size: int = 32, num_batches_per_epoch: int = 50, trainer_kwargs: Optional[Dict[str, Any]] = None, train_sampler: Optional[gluonts.transform.sampler.InstanceSampler] = None, validation_sampler: Optional[gluonts.transform.sampler.InstanceSampler] = None)[源码]#
基类:
gluonts.torch.model.estimator.PyTorchLightningEstimator
用于训练 Temporal Fusion Transformer (TFT) 模型的估计器类,如 [LAL+21] 所述。
TFT 在进行预测时内部执行特征选择。因此,如果实值特征的维度对应于同一变量,则可以将其分组(例如,将天气特征视为一个特征,将假日指标视为另一个特征)。
例如,如果数据集中包含键为 “feat_static_real”,形状为 [batch_size, 3] 的特征,我们可以,例如: - 设置
static_dims = [3]
将所有三个维度视为一个特征 - 设置static_dims = [1, 1, 1]
将每个维度视为一个单独的特征 - 设置static_dims = [2, 1]
将前两个维度视为一个特征有关模型配置如何对应预期输入形状的更多详细信息,请参阅
gluonts.torch.model.tft.TemporalFusionTransformerModel.input_shapes
。- 参数
freq – 用于训练和预测的数据频率。
prediction_length (int) – 预测范围的长度。
context_length – 作为输入提供给编码器的先前时间序列值的数量。(默认值:None,在这种情况下 context_length = prediction_length)。
quantiles – 模型将学习预测的分位数列表。默认为 [0.1, 0.2, 0.3, 0.4, 0.5, 0.6, 0.7, 0.8, 0.9]
distr_output – 要使用的分布输出(默认值:
QuantileOutput
)。num_heads – 解码器中自注意力层的注意力头数量。
hidden_dim – LSTM 和 Transformer 隐藏状态的大小。
variable_dim – 特征嵌入的大小。
static_dims – 实值静态特征的大小。
dynamic_dims – 未来已知的实值动态特征的大小。
past_dynamic_dims – 仅在过去已知的实值动态特征的大小。
static_cardinalities – 分类静态特征的基数。
dynamic_cardinalities – 未来已知的分类动态特征的基数。
past_dynamic_cardinalities – 仅在过去已知的分类动态特征的基数。
time_features – 来自
gluonts.time_feature
的时间特征列表,除了提供的数据外,用作动态实值特征(默认值:None,在这种情况下会根据 freq 自动确定这些特征)。lr – 学习率(默认值:
1e-3
)。weight_decay – 权重衰减(默认值:
1e-8
)。dropout_rate – Dropout 正则化参数(默认值:0.1)。
patience – 学习率调度器的耐心参数。
batch_size – 用于训练的批次大小(默认值:32)。
num_batches_per_epoch (int = 50,) – 每个训练周期要处理的批次数量(默认值:50)。
trainer_kwargs – 提供给
pl.Trainer
用于构建的额外参数。train_sampler – 控制训练期间窗口的采样。
validation_sampler – 控制验证期间窗口的采样。
- create_lightning_module() gluonts.torch.model.tft.lightning_module.TemporalFusionTransformerLightningModule [源码]#
创建并返回用于训练的网络(即计算损失)。
- 返回
给定输入数据后计算损失的网络。
- 返回类型
pl.LightningModule
- create_predictor(transformation: gluonts.transform._base.Transformation, module: gluonts.torch.model.tft.lightning_module.TemporalFusionTransformerLightningModule) gluonts.torch.model.predictor.PyTorchPredictor [源码]#
创建并返回一个预测器对象。
- 参数
transformation – 在数据进入模型之前应用的转换。
module – 一个训练好的 pl.LightningModule 对象。
- 返回
包装用于推理的 nn.Module 的预测器。
- 返回类型
- create_training_data_loader(data: gluonts.dataset.Dataset, module: gluonts.torch.model.tft.lightning_module.TemporalFusionTransformerLightningModule, shuffle_buffer_length: Optional[int] = None, **kwargs) Iterable [源码]#
创建用于训练目的的数据加载器。
- 参数
data – 用于创建数据加载器的数据集。
module – 将接收来自数据加载器的批次的 pl.LightningModule 对象。
- 返回
数据加载器,即一个可迭代的数据批次。
- 返回类型
Iterable
- create_transformation() gluonts.transform._base.Transformation [源码]#
创建并返回训练和推理所需的转换。
- 返回
在训练和推理时,将逐条应用于数据集的转换。
- 返回类型
- create_validation_data_loader(data: gluonts.dataset.Dataset, module: gluonts.torch.model.tft.lightning_module.TemporalFusionTransformerLightningModule, **kwargs) Iterable [源码]#
创建用于验证目的的数据加载器。
- 参数
data – 用于创建数据加载器的数据集。
module – 将接收来自数据加载器的批次的 pl.LightningModule 对象。
- 返回
数据加载器,即一个可迭代的数据批次。
- 返回类型
Iterable
- lead_time: int#
- prediction_length: int#