gluonts.torch 包#

class gluonts.torch.DLinearEstimator(prediction_length: int, context_length: Optional[int] = None, hidden_dimension: Optional[int] = None, lr: float = 0.001, weight_decay: float = 1e-08, scaling: Optional[str] = 'mean', distr_output: gluonts.torch.distributions.output.Output = gluonts.torch.distributions.studentT.StudentTOutput(beta=0.0), kernel_size: int = 25, 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)[source]#

基类: gluonts.torch.model.estimator.PyTorchLightningEstimator

一个用于训练基于论文 https://arxiv.org/pdf/2205.13504.pdf 的 D-Linear 模型，并扩展用于概率预测的估计器。

此类使用 DLinearModel 中定义的模型，并将其封装到 DLinearLightningModule 中用于训练：训练使用 PyTorch Lightning 的 pl.Trainer 类执行。

参数

  • prediction_length (int) – 预测范围的长度。

  • context_length – 模型在进行预测之前用作输入的历史时间步长数量（默认值：10 * prediction_length）。

  • hidden_dimension – 表示的大小。

  • lr – 学习率（默认值：1e-3）。

  • weight_decay – 权重衰减正则化参数（默认值：1e-8）。

  • distr_output – 用于评估观测值和采样预测的分布（默认值：StudentTOutput()）。

  • kernel_size –

  • batch_size – 用于训练的批次大小（默认值：32）。

  • num_batches_per_epoch –

    每个训练 epoch 中要处理的批次数

    （默认值：50）。

  • trainer_kwargs – 提供给 pl.Trainer 构造函数的附加参数。

  • train_sampler – 控制训练期间的窗口采样。

  • validation_sampler – 控制验证期间的窗口采样。

create_lightning_module() → lightning.pytorch.core.module.LightningModule[source]#

创建并返回用于训练（即计算损失）的网络。

返回值

根据输入数据计算损失的网络。

返回值类型

pl.LightningModule

create_predictor(transformation: gluonts.transform._base.Transformation, module) → gluonts.torch.model.predictor.PyTorchPredictor[source]#

创建并返回一个预测器对象。

参数

  • transformation – 数据进入模型之前要应用的转换。

  • module – 一个已训练的 pl.LightningModule 对象。

返回值

一个包装了用于推理的 nn.Module 的预测器。

返回值类型

预测器

create_training_data_loader(data: gluonts.dataset.Dataset, module: gluonts.torch.model.d_linear.lightning_module.DLinearLightningModule, shuffle_buffer_length: Optional[int] = None, **kwargs) → Iterable[source]#

创建一个用于训练的数据加载器。

参数

  • data – 用于创建数据加载器的数据集。

  • module – 将接收数据加载器批次的 pl.LightningModule 对象。

返回值

数据加载器，即一个可遍历数据批次的迭代器。

返回值类型

可迭代对象

create_transformation() → gluonts.transform._base.Transformation[source]#

创建并返回训练和推理所需的转换。

返回值

将在训练和推理时逐条应用于数据集的转换。

返回值类型

转换

create_validation_data_loader(data: gluonts.dataset.Dataset, module: gluonts.torch.model.d_linear.lightning_module.DLinearLightningModule, **kwargs) → Iterable[source]#

创建一个用于验证的数据加载器。

参数

  • data – 用于创建数据加载器的数据集。

  • module – 将接收数据加载器批次的 pl.LightningModule 对象。

返回值

数据加载器，即一个可遍历数据批次的迭代器。

返回值类型

可迭代对象

lead_time: int#
prediction_length: int#
class gluonts.torch.DeepAREstimator(freq: str, prediction_length: int, context_length: Optional[int] = None, num_layers: int = 2, hidden_size: int = 40, lr: float = 0.001, weight_decay: float = 1e-08, dropout_rate: float = 0.1, patience: int = 10, num_feat_dynamic_real: int =0, num_feat_static_cat: int =0, num_feat_static_real: int =0, cardinality: Optional[List[int]] =None, embedding_dimension: Optional[List[int]] =None, distr_output: gluonts.torch.distributions.distribution_output.DistributionOutput =gluonts.torch.distributions.studentT.StudentTOutput(beta=0.0), scaling: bool =True, default_scale: Optional[float] =None, lags_seq: Optional[List[int]] =None, time_features: Optional[List[Callable[[pandas.core.indexes.period.PeriodIndex], numpy.ndarray]]] =None, num_parallel_samples: int =100, batch_size: int =32, num_batches_per_epoch: int =50, imputation_method: Optional[gluonts.transform.feature.MissingValueImputation] =None, trainer_kwargs: Optional[Dict[str, Any]] =None, train_sampler: Optional[gluonts.transform.sampler.InstanceSampler] =None, validation_sampler: Optional[gluonts.transform.sampler.InstanceSampler] =None, nonnegative_pred_samples: bool =False)[source]#

基类: gluonts.torch.model.estimator.PyTorchLightningEstimator

用于训练 DeepAR 模型的估计器类，如 [SFG17] 中所述。

此类使用 DeepARModel 中定义的模型，并将其封装到 DeepARLightningModule 中用于训练：训练使用 PyTorch Lightning 的 pl.Trainer 类执行。

Note: 此模型的代码与 SageMaker’s DeepAR Forecasting Algorithm 背后的实现无关。

参数

  • freq – 用于训练和预测的数据频率。

  • prediction_length (int) – 预测范围的长度。

  • prediction_length (int) – 预测范围的长度。

  • context_length – RNN 在计算预测前展开的时间步长数量（默认值：None，在这种情况下 context_length = prediction_length）。

  • num_layers – RNN 层数（默认值：2）。

  • lr – 学习率（默认值：1e-3）。

  • weight_decay – 权重衰减正则化参数（默认值：1e-8）。

  • hidden_size – 每层的 RNN 单元数量（默认值：40）。

  • lr – 学习率（默认值：0.001）。

  • weight_decay – 权重衰减正则化参数（默认值：1e-08）。

  • dropout_rate – Dropout 正则化参数（默认值：0.1）。

  • patience – 学习率调度器的 patience 参数。

  • num_feat_dynamic_real – 数据中动态实值特征的数量（默认值：0）。

  • num_feat_static_cat – 数据中静态类别特征的数量（默认值：0）。

  • distr_output – 用于评估观测值和采样预测的分布（默认值：StudentTOutput()）。

  • num_feat_static_real – 数据中静态实值特征的数量（默认值：0）。

  • cardinality – 每个类别特征的值数量。如果 num_feat_static_cat > 0，则必须设置此参数（默认值：None）。

  • embedding_dimension – 类别特征的嵌入维度（默认值：[min(50, (cat+1)//2) for cat in cardinality]）。

  • distr_output – 用于评估观测值和采样预测的分布（默认值：StudentTOutput()）。

  • scaling – 是否自动缩放目标值（默认值：true）。

  • batch_size – 用于训练的批次大小（默认值：32）。

  • default_scale – 如果上下文长度窗口完全未观测到，则应用的默认缩放。如果未设置，则在这种情况下，缩放将是批次中的平均缩放。

  • trainer_kwargs – 提供给 pl.Trainer 构造函数的附加参数。

  • train_sampler – 控制训练期间的窗口采样。

  • validation_sampler – 控制验证期间的窗口采样。

  • lags_seq – 用作 RNN 输入的滞后目标值的索引（默认值：None，在这种情况下，这些索引根据 freq 自动确定）。

time_features – 时间特征列表，来自 gluonts.time_feature，除了提供的数据外，还用作 RNN 的输入（默认值：None，在这种情况下，这些特征根据 freq 自动确定）。

创建并返回用于训练（即计算损失）的网络。

返回值

根据输入数据计算损失的网络。

返回值类型

pl.LightningModule

num_parallel_samples – 生成的预测器应为每个时间序列生成的样本数量（默认值：100）。

创建并返回一个预测器对象。

参数

  • transformation – 数据进入模型之前要应用的转换。

  • module – 一个已训练的 pl.LightningModule 对象。

返回值

一个包装了用于推理的 nn.Module 的预测器。

返回值类型

预测器

batch_size – 用于训练的批次大小（默认值：32）。

创建一个用于训练的数据加载器。

参数

  • data – 用于创建数据加载器的数据集。

  • module – 将接收数据加载器批次的 pl.LightningModule 对象。

返回值

数据加载器，即一个可遍历数据批次的迭代器。

返回值类型

可迭代对象

num_batches_per_epoch – 每个训练 epoch 中要处理的批次数（默认值：50）。

创建并返回训练和推理所需的转换。

返回值

将在训练和推理时逐条应用于数据集的转换。

返回值类型

转换

imputation_method –

创建一个用于验证的数据加载器。

参数

  • data – 用于创建数据加载器的数据集。

  • module – 将接收数据加载器批次的 pl.LightningModule 对象。

返回值

数据加载器，即一个可遍历数据批次的迭代器。

返回值类型

可迭代对象

trainer_kwargs – 提供给 pl.Trainer 构造函数的附加参数。
train_sampler – 控制训练期间的窗口采样。
validation_sampler – 控制验证期间的窗口采样。
nonnegative_pred_samples – 最终预测样本是否应为非负值？如果是，则应用激活函数以确保非负。请注意，这仅应用于最终样本，在训练期间不应用。

create_lightning_module() → gluonts.torch.model.deepar.lightning_module.DeepARLightningModule[source]#

create_predictor(transformation: gluonts.transform._base.Transformation, module: gluonts.torch.model.deepar.lightning_module.DeepARLightningModule) → gluonts.torch.model.predictor.PyTorchPredictor[source]#

create_training_data_loader(data: gluonts.dataset.Dataset, module: gluonts.torch.model.deepar.lightning_module.DeepARLightningModule, shuffle_buffer_length: Optional[int] =None, **kwargs) → Iterable[source]#

参数

  • create_transformation() → gluonts.transform._base.Transformation[source]#

  • create_validation_data_loader(data: gluonts.dataset.Dataset, module: gluonts.torch.model.deepar.lightning_module.DeepARLightningModule, **kwargs) → Iterable[source]#

  • classmethod derive_auto_fields(train_iter)[source]#

  • lead_time: int#

  • prediction_length: int#

  • class gluonts.torch.DeepNPTSEstimator(freq: str, prediction_length: int, context_length: int, num_hidden_nodes: typing.Optional[typing.List[int]] = None, batch_norm: bool = False, use_feat_static_cat: bool = False, num_feat_static_real: int = 0, num_feat_dynamic_real: int = 0, cardinality: typing.Optional[typing.List[int]] = None, embedding_dimension: typing.Optional[typing.List[int]] = None, input_scaling: typing.Optional[typing.Union[typing.Callable, str]] = None, dropout_rate: float = 0.0, network_type: gluonts.torch.model.deep_npts._network.DeepNPTSNetwork = <class 'gluonts.torch.model.deep_npts._network.DeepNPTSNetworkDiscrete'>, epochs: int = 100, lr: float = 1e-05, batch_size: int = 32, num_batches_per_epoch: int = 100, cache_data: bool = False, loss_scaling: typing.Optional[typing.Union[typing.Callable, str]] = None)[source]#

  • 基类: gluonts.model.estimator.Estimator

  • 构建一个 DeepNPTS 估计器。这是 NPTS 的可调扩展，其中采样概率是从数据中学习的。与 NPTS 不同，这是一个全局模型。

  • 目前实现了两种模型变体：(i) DeepNPTSNetworkDiscrete：预测分布是类似于 NPTS 的离散分布，预测样本从上下文窗口的观测值中采样。(ii) DeepNPTSNetworkSmooth：预测分布是平滑的混合分布，其中混合分量是以上下文窗口的观测值为中心的 Gaussian 分布。混合概率和 Gaussian 分布的宽度是学习得来的。这里的预测可以包含在上下文窗口中未观测到的值。

  • freq – 用于训练和预测的数据频率

  • prediction_length (int) – 预测范围的长度

  • context_length – RNN 在计算预测前展开的时间步长数量（默认值：None，在这种情况下 context_length = prediction_length）

  • num_hidden_nodes – 一个列表，包含每个隐藏层的节点数量

batch_norm – 标志，指示是否在每一层应用批量归一化
use_feat_static_cat – 是否使用数据中的 feat_static_cat 字段（默认值：False）
num_feat_static_real – 数据集中的静态实值特征数量
num_feat_dynamic_real – 数据集中的动态特征数量。这些特征会添加到根据频率自动创建的时间序列特征中
cardinality – 每个类别特征的值数量。如果 use_feat_static_cat == True，则必须设置此参数（默认值：None）
embedding_dimension – 类别特征的嵌入维度（默认值：[min(50, (cat+1)//2) for cat in cardinality]）

input_scaling – 要应用于目标值的缩放。可用选项：“min_max_scaling” 和 “standard_normal_scaling”（默认值：不缩放）

参数

  • dropout_rate – Dropout 正则化参数（默认值：不进行 dropout）

  • network_type – 要使用的网络：离散版本 DeepNPTSNetworkDiscrete 或平滑版本 DeepNPTSNetworkSmooth（默认值：DeepNPTSNetworkDiscrete）

返回值

get_predictor(net: torch.nn.modules.module.Module, device='cpu') → gluonts.torch.model.predictor.PyTorchPredictor[source]#

返回值类型

预测器

input_transform() → gluonts.transform._base.Transformation[source]#
instance_splitter(instance_sampler, is_train: bool =True) → gluonts.transform.split.InstanceSplitter[source]#
lead_time: int#

基类: gluonts.torch.model.estimator.PyTorchLightningEstimator

prediction_length: int#

train(training_data: gluonts.dataset.Dataset, validation_data: Optional[gluonts.dataset.Dataset] =None, cache_data: bool =False) → gluonts.torch.model.predictor.PyTorchPredictor[source]#

参数

  • freq – 用于训练和预测的数据频率。

  • prediction_length (int) – 预测范围的长度。

  • context_length – 模型在进行预测之前用作输入的历史时间步长数量（默认值：10 * prediction_length）。

  • embedding_dimension – 类别特征的嵌入维度（默认值：[min(50, (cat+1)//2) for cat in cardinality]）。

  • 使用给定数据训练估计器。

  • training_data – 用于训练模型的数据集。

  • validation_data – 用于在训练期间验证模型的数据集。

  • 包含已训练模型的预测器。

  • train_model(training_data: gluonts.dataset.Dataset, cache_data: bool =False) → gluonts.torch.model.deep_npts._network.DeepNPTSNetwork[source]#

  • training_data_loader(training_dataset, batch_size: int, num_batches_per_epoch: int) → Iterable[Dict[str, Any]][source]#

  • class gluonts.torch.LagTSTEstimator(freq: str, prediction_length: int, context_length: Optional[int] =None, d_model: int =32, nhead: int =4, dim_feedforward: int =128, lags_seq: Optional[List[int]] =None, dropout: float =0.1, activation: str ='relu', norm_first: bool =False, num_encoder_layers: int =2, lr: float =0.001, weight_decay: float =1e-08, scaling: Optional[str] ='mean', distr_output: gluonts.torch.distributions.output.Output =gluonts.torch.distributions.studentT.StudentTOutput(beta=0.0), 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)[source]#

  • lr – 学习率（默认值：1e-3）。

  • weight_decay – 权重衰减正则化参数（默认值：1e-8）。

  • 一个用于训练 LagTST 模型进行预测的估计器。

  • distr_output – 用于评估观测值和采样预测的分布（默认值：StudentTOutput()）。

  • batch_size – 用于训练的批次大小（默认值：32）。

  • num_batches_per_epoch –

    每个训练 epoch 中要处理的批次数

    （默认值：50）。

  • trainer_kwargs – 提供给 pl.Trainer 构造函数的附加参数。

  • train_sampler – 控制训练期间的窗口采样。

  • validation_sampler – 控制验证期间的窗口采样。

此类使用 SimpleFeedForwardModel 中定义的模型，并将其封装到 LagTSTLightningModule 中用于训练：训练使用 PyTorch Lightning 的 pl.Trainer 类执行。

创建并返回用于训练（即计算损失）的网络。

返回值

根据输入数据计算损失的网络。

返回值类型

pl.LightningModule

freq – 用于训练和预测的数据频率。

创建并返回一个预测器对象。

参数

  • transformation – 数据进入模型之前要应用的转换。

  • module – 一个已训练的 pl.LightningModule 对象。

返回值

一个包装了用于推理的 nn.Module 的预测器。

返回值类型

预测器

prediction_length (int) – 预测范围的长度。

创建一个用于训练的数据加载器。

参数

  • data – 用于创建数据加载器的数据集。

  • module – 将接收数据加载器批次的 pl.LightningModule 对象。

返回值

数据加载器，即一个可遍历数据批次的迭代器。

返回值类型

可迭代对象

context_length – 模型在进行预测之前用作输入的历史时间步长数量（默认值：None，在这种情况下 context_length = prediction_length）。

创建并返回训练和推理所需的转换。

返回值

将在训练和推理时逐条应用于数据集的转换。

返回值类型

转换

d_model – Transformer 编码器中隐藏层的大小。

创建一个用于验证的数据加载器。

参数

  • data – 用于创建数据加载器的数据集。

  • module – 将接收数据加载器批次的 pl.LightningModule 对象。

返回值

数据加载器，即一个可遍历数据批次的迭代器。

返回值类型

可迭代对象

nhead – Transformer 编码器中的注意力头数量。
dim_feedforward – Transformer 编码器中隐藏层的大小。
class gluonts.torch.PatchTSTEstimator(prediction_length: int, patch_len: int, context_length: Optional[int] = None, stride: int = 8, padding_patch: str = 'end', d_model: int = 32, nhead: int = 4, dim_feedforward: int = 128, dropout: float = 0.1, activation: str = 'relu', norm_first: bool = False, num_encoder_layers: int = 2, lr: float = 0.001, weight_decay: float = 1e-08, scaling: Optional[str] = None, distr_output: gluonts.torch.distributions.output.Output = gluonts.torch.distributions.studentT.StudentTOutput(beta=0.0), 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)[source]#

基类: gluonts.torch.model.estimator.PyTorchLightningEstimator

一个用于训练 PatchTST 模型进行预测的估计器，如 https://arxiv.org/abs/2211.14730 所述，并扩展为概率模型。

此类使用在 PatchTSTModel 中定义的模型，并将其封装到 PatchTSTLightningModule 中用于训练目的：训练使用 PyTorch Lightning 的 pl.Trainer 类执行。

参数

  • prediction_length (int) – 预测范围的长度。

  • context_length – 模型在进行预测之前用作输入的历史时间步长数量（默认值：10 * prediction_length）。

  • patch_len – 补丁的长度。

  • stride – 补丁的步长。

  • padding_patch – 补丁的填充方式。

  • 使用给定数据训练估计器。

  • nhead – Transformer 编码器中的注意力头数量，必须能整除 d_model。

  • validation_data – 用于在训练期间验证模型的数据集。

  • 包含已训练模型的预测器。

  • train_model(training_data: gluonts.dataset.Dataset, cache_data: bool =False) → gluonts.torch.model.deep_npts._network.DeepNPTSNetwork[source]#

  • training_data_loader(training_dataset, batch_size: int, num_batches_per_epoch: int) → Iterable[Dict[str, Any]][source]#

  • class gluonts.torch.LagTSTEstimator(freq: str, prediction_length: int, context_length: Optional[int] =None, d_model: int =32, nhead: int =4, dim_feedforward: int =128, lags_seq: Optional[List[int]] =None, dropout: float =0.1, activation: str ='relu', norm_first: bool =False, num_encoder_layers: int =2, lr: float =0.001, weight_decay: float =1e-08, scaling: Optional[str] ='mean', distr_output: gluonts.torch.distributions.output.Output =gluonts.torch.distributions.studentT.StudentTOutput(beta=0.0), 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)[source]#

  • lr – 学习率（默认值：1e-3）。

  • weight_decay – 权重衰减正则化参数（默认值：1e-8）。

  • 一个用于训练 LagTST 模型进行预测的估计器。

  • distr_output – 用于评估观测值和采样预测的分布（默认值：StudentTOutput()）。

  • batch_size – 用于训练的批次大小（默认值：32）。

  • num_batches_per_epoch –

    每个训练 epoch 中要处理的批次数

    （默认值：50）。

  • trainer_kwargs – 提供给 pl.Trainer 构造函数的附加参数。

  • train_sampler – 控制训练期间的窗口采样。

  • validation_sampler – 控制验证期间的窗口采样。

create_lightning_module() → lightning.pytorch.core.module.LightningModule[source]#

创建并返回用于训练（即计算损失）的网络。

返回值

根据输入数据计算损失的网络。

返回值类型

pl.LightningModule

create_predictor(transformation: gluonts.transform._base.Transformation, module) → gluonts.torch.model.predictor.PyTorchPredictor[source]#

创建并返回一个预测器对象。

参数

  • transformation – 数据进入模型之前要应用的转换。

  • module – 一个已训练的 pl.LightningModule 对象。

返回值

一个包装了用于推理的 nn.Module 的预测器。

返回值类型

预测器

create_training_data_loader(data: gluonts.dataset.Dataset, module: gluonts.torch.model.patch_tst.lightning_module.PatchTSTLightningModule, shuffle_buffer_length: Optional[int] = None, **kwargs) → Iterable[source]#

创建一个用于训练的数据加载器。

参数

  • data – 用于创建数据加载器的数据集。

  • module – 将接收数据加载器批次的 pl.LightningModule 对象。

返回值

数据加载器，即一个可遍历数据批次的迭代器。

返回值类型

可迭代对象

create_transformation() → gluonts.transform._base.Transformation[source]#

创建并返回训练和推理所需的转换。

返回值

将在训练和推理时逐条应用于数据集的转换。

返回值类型

转换

create_validation_data_loader(data: gluonts.dataset.Dataset, module: gluonts.torch.model.patch_tst.lightning_module.PatchTSTLightningModule, **kwargs) → Iterable[source]#

创建一个用于验证的数据加载器。

参数

  • data – 用于创建数据加载器的数据集。

  • module – 将接收数据加载器批次的 pl.LightningModule 对象。

返回值

数据加载器，即一个可遍历数据批次的迭代器。

返回值类型

可迭代对象

lead_time: int#
prediction_length: int#
class gluonts.torch.PyTorchLightningEstimator(trainer_kwargs: Dict[str, Any], lead_time: int = 0)[source]#

create_lightning_module() → gluonts.torch.model.deepar.lightning_module.DeepARLightningModule[source]#

一种 Estimator 类型，提供了用于创建基于 PyTorch-Lightning 的模型的工具。

要扩展此类，需要实现以下方法：create_transformation、create_training_network、create_predictor、create_training_data_loader 和 create_validation_data_loader。

create_lightning_module() → lightning.pytorch.core.module.LightningModule[source]#

创建并返回用于训练（即计算损失）的网络。

返回值

根据输入数据计算损失的网络。

返回值类型

pl.LightningModule

create_predictor(transformation: gluonts.transform._base.Transformation, module) → gluonts.torch.model.predictor.PyTorchPredictor[source]#

创建并返回一个预测器对象。

参数

  • transformation – 数据进入模型之前要应用的转换。

  • module – 一个已训练的 pl.LightningModule 对象。

返回值

一个包装了用于推理的 nn.Module 的预测器。

返回值类型

预测器

create_training_data_loader(data: gluonts.dataset.Dataset, module, **kwargs) → Iterable[source]#

创建一个用于训练的数据加载器。

参数

  • data – 用于创建数据加载器的数据集。

  • module – 将接收数据加载器批次的 pl.LightningModule 对象。

返回值

数据加载器，即一个可遍历数据批次的迭代器。

返回值类型

可迭代对象

create_transformation() → gluonts.transform._base.Transformation[source]#

创建并返回训练和推理所需的转换。

返回值

将在训练和推理时逐条应用于数据集的转换。

返回值类型

转换

create_validation_data_loader(data: gluonts.dataset.Dataset, module, **kwargs) → Iterable[source]#

创建一个用于验证的数据加载器。

参数

  • data – 用于创建数据加载器的数据集。

  • module – 将接收数据加载器批次的 pl.LightningModule 对象。

返回值

数据加载器，即一个可遍历数据批次的迭代器。

返回值类型

可迭代对象

lead_time: int#
prediction_length: int#
train(training_data: gluonts.dataset.Dataset, validation_data: Optional[gluonts.dataset.Dataset] = None, shuffle_buffer_length: Optional[int] = None, cache_data: bool = False, ckpt_path: Optional[str] = None, **kwargs) → gluonts.torch.model.predictor.PyTorchPredictor[source]#

input_scaling – 要应用于目标值的缩放。可用选项：“min_max_scaling” 和 “standard_normal_scaling”（默认值：不缩放）

参数

  • dropout_rate – Dropout 正则化参数（默认值：不进行 dropout）

  • network_type – 要使用的网络：离散版本 DeepNPTSNetworkDiscrete 或平滑版本 DeepNPTSNetworkSmooth（默认值：DeepNPTSNetworkDiscrete）

返回值

get_predictor(net: torch.nn.modules.module.Module, device='cpu') → gluonts.torch.model.predictor.PyTorchPredictor[source]#

返回值类型

预测器

train_from(predictor: gluonts.model.predictor.Predictor, training_data: gluonts.dataset.Dataset, validation_data: Optional[gluonts.dataset.Dataset] = None, shuffle_buffer_length: Optional[int] = None, cache_data: bool = False, ckpt_path: Optional[str] = None) → gluonts.torch.model.predictor.PyTorchPredictor[source]#
train_model(training_data: gluonts.dataset.Dataset, validation_data: Optional[gluonts.dataset.Dataset] = None, from_predictor: Optional[gluonts.torch.model.predictor.PyTorchPredictor] = None, shuffle_buffer_length: Optional[int] = None, cache_data: bool = False, ckpt_path: Optional[str] = None, **kwargs) → gluonts.torch.model.estimator.TrainOutput[source]#
class gluonts.torch.PyTorchPredictor(input_names: List[str], prediction_net: torch.nn.modules.module.Module, batch_size: int, prediction_length: int, input_transform: gluonts.transform._base.Transformation, forecast_generator: gluonts.model.forecast_generator.ForecastGenerator = gluonts.model.forecast_generator.SampleForecastGenerator(), output_transform: Optional[Callable[[Dict[str, Any], numpy.ndarray], numpy.ndarray]] = None, lead_time: int = 0, device: Union[str, torch.device] = 'auto')[source]#

继承自: gluonts.model.predictor.RepresentablePredictor

classmethod deserialize(path: pathlib.Path, device: Optional[Union[torch.device, str]] = None) → gluonts.torch.model.predictor.PyTorchPredictor[source]#

从给定路径加载序列化的预测器。

参数

  • path – 序列化预测器文件所在的路径。

  • **kwargs – 可选的上下文/设备参数，用于预测器。如果未传入任何内容，将优先使用 GPU（如果可用），否则使用 CPU。

property network: torch.nn.modules.module.Module#
predict(dataset: gluonts.dataset.Dataset, num_samples: Optional[int] = None) → Iterator[gluonts.model.forecast.Forecast][source]#

计算给定数据集中时间序列的预测结果。此方法未在此抽象类中实现；请使用其中一个子类。:param dataset: 包含要预测的时间序列的数据集。

返回值

预测结果的迭代器，顺序与提供的数据集迭代器相同。

返回值类型

Iterator[gluonts.model.forecast.Forecast]

serialize(path: pathlib.Path) → None[source]#
to(device: Union[str, torch.device]) → gluonts.torch.model.predictor.PyTorchPredictor[source]#
class gluonts.torch.SimpleFeedForwardEstimator(prediction_length: int, context_length: Optional[int] = None, hidden_dimensions: Optional[List[int]] = None, lr: float = 0.001, weight_decay: float = 1e-08, distr_output: gluonts.torch.distributions.output.Output = gluonts.torch.distributions.studentT.StudentTOutput(beta=0.0), batch_norm: bool = False, 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)[source]#

基类: gluonts.torch.model.estimator.PyTorchLightningEstimator

一个用于训练前馈模型进行预测的估计器。

此类使用在 SimpleFeedForwardModel 中定义的模型，并将其封装到 SimpleFeedForwardLightningModule 中用于训练目的：训练使用 PyTorch Lightning 的 pl.Trainer 类执行。

参数

  • prediction_length (int) – 预测范围的长度。

  • context_length – 模型在进行预测之前用作输入的历史时间步长数量（默认值：10 * prediction_length）。

  • hidden_dimensions – 前馈网络中隐藏层的大小 (默认值: [20, 20])。

  • lr – 学习率（默认值：1e-3）。

  • weight_decay – 权重衰减正则化参数（默认值：1e-8）。

  • distr_output – 用于评估观测值和采样预测的分布（默认值：StudentTOutput()）。

  • batch_norm – 是否应用批量归一化。

  • batch_size – 用于训练的批次大小（默认值：32）。

  • num_batches_per_epoch –

    每个训练 epoch 中要处理的批次数

    （默认值：50）。

  • trainer_kwargs – 提供给 pl.Trainer 构造函数的附加参数。

  • train_sampler – 控制训练期间的窗口采样。

  • validation_sampler – 控制验证期间的窗口采样。

create_lightning_module() → lightning.pytorch.core.module.LightningModule[source]#

创建并返回用于训练（即计算损失）的网络。

返回值

根据输入数据计算损失的网络。

返回值类型

pl.LightningModule

create_predictor(transformation: gluonts.transform._base.Transformation, module) → gluonts.torch.model.predictor.PyTorchPredictor[source]#

创建并返回一个预测器对象。

参数

  • transformation – 数据进入模型之前要应用的转换。

  • module – 一个已训练的 pl.LightningModule 对象。

返回值

一个包装了用于推理的 nn.Module 的预测器。

返回值类型

预测器

create_training_data_loader(data: gluonts.dataset.Dataset, module: gluonts.torch.model.simple_feedforward.lightning_module.SimpleFeedForwardLightningModule, shuffle_buffer_length: Optional[int] = None, **kwargs) → Iterable[source]#

创建一个用于训练的数据加载器。

参数

  • data – 用于创建数据加载器的数据集。

  • module – 将接收数据加载器批次的 pl.LightningModule 对象。

返回值

数据加载器，即一个可遍历数据批次的迭代器。

返回值类型

可迭代对象

create_transformation() → gluonts.transform._base.Transformation[source]#

创建并返回训练和推理所需的转换。

返回值

将在训练和推理时逐条应用于数据集的转换。

返回值类型

转换

create_validation_data_loader(data: gluonts.dataset.Dataset, module: gluonts.torch.model.simple_feedforward.lightning_module.SimpleFeedForwardLightningModule, **kwargs) → Iterable[source]#

创建一个用于验证的数据加载器。

参数

  • data – 用于创建数据加载器的数据集。

  • module – 将接收数据加载器批次的 pl.LightningModule 对象。

返回值

数据加载器，即一个可遍历数据批次的迭代器。

返回值类型

可迭代对象

lead_time: int#
prediction_length: int#
class gluonts.torch.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)[source]#

基类: gluonts.torch.model.estimator.PyTorchLightningEstimator

用于训练时间融合 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)。

  • hidden_size – 每层的 RNN 单元数量（默认值：40）。

  • lr – 学习率（默认值：0.001）。

  • batch_size – 用于训练的批次大小（默认值：32）。

  • num_batches_per_epoch (int = 50,) – 每个训练 epoch 要处理的批次数量 (默认值: 50)。

  • trainer_kwargs – 提供给 pl.Trainer 构造函数的附加参数。

  • train_sampler – 控制训练期间的窗口采样。

  • validation_sampler – 控制验证期间的窗口采样。

create_lightning_module() → gluonts.torch.model.tft.lightning_module.TemporalFusionTransformerLightningModule[source]#

创建并返回用于训练（即计算损失）的网络。

返回值

根据输入数据计算损失的网络。

返回值类型

pl.LightningModule

create_predictor(transformation: gluonts.transform._base.Transformation, module: gluonts.torch.model.tft.lightning_module.TemporalFusionTransformerLightningModule) → gluonts.torch.model.predictor.PyTorchPredictor[source]#

创建并返回一个预测器对象。

参数

  • 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[source]#

创建一个用于训练的数据加载器。

参数

  • data – 用于创建数据加载器的数据集。

  • module – 将接收数据加载器批次的 pl.LightningModule 对象。

返回值

数据加载器，即一个可遍历数据批次的迭代器。

返回值类型

可迭代对象

create_transformation() → gluonts.transform._base.Transformation[source]#

创建并返回训练和推理所需的转换。

返回值

将在训练和推理时逐条应用于数据集的转换。

返回值类型

转换

create_validation_data_loader(data: gluonts.dataset.Dataset, module: gluonts.torch.model.tft.lightning_module.TemporalFusionTransformerLightningModule, **kwargs) → Iterable[source]#

创建一个用于验证的数据加载器。

参数

  • data – 用于创建数据加载器的数据集。

  • module – 将接收数据加载器批次的 pl.LightningModule 对象。

返回值

数据加载器，即一个可遍历数据批次的迭代器。

返回值类型

可迭代对象

input_names()[source]#
lead_time: int#
prediction_length: int#
类 gluonts.torch.TiDEEstimator(freq: str, prediction_length: int, context_length: Optional[int] = None, feat_proj_hidden_dim: Optional[int] = None, encoder_hidden_dim: Optional[int] = None, decoder_hidden_dim: Optional[int] = None, temporal_hidden_dim: Optional[int] = None, distr_hidden_dim: Optional[int] = None, num_layers_encoder: Optional[int] = None, num_layers_decoder: Optional[int] = None, decoder_output_dim: Optional[int] = None, dropout_rate: Optional[float] = None, num_feat_dynamic_proj: Optional[int] = None, num_feat_dynamic_real: int = 0, num_feat_static_real: int = 0, num_feat_static_cat: int = 0, cardinality: Optional[List[int]] = None, embedding_dimension: Optional[List[int]] = None, layer_norm: bool = False, lr: float = 0.001, weight_decay: float = 1e-08, patience: int = 10, scaling: Optional[str] = 'mean', distr_output: gluonts.torch.distributions.output.Output = gluonts.torch.distributions.studentT.StudentTOutput(beta=0.0), 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

一个使用 TiDE 模型进行训练的估计器，该模型源自论文 https://arxiv.org/abs/2304.08424 并已扩展用于概率预测。

此类使用 TiDEModel 中定义的模型，并将其封装到 TiDELightningModule 中用于训练目的：训练使用 PyTorch Lightning 的 pl.Trainer 类进行。

参数

  • freq – 用于训练和预测的数据频率。

  • prediction_length (int) – 预测范围的长度。

  • context_length – 预测时间点之前模型作为输入的步数（默认值：prediction_length）。

  • feat_proj_hidden_dim – 特征投影层的大小（默认值：4）。

  • encoder_hidden_dim – 密集编码器层的大小（默认值：4）。

  • decoder_hidden_dim – 密集解码器层的大小（默认值：4）。

  • temporal_hidden_dim – 时间解码器层的大小（默认值：4）。

  • distr_hidden_dim – 分布投影层的大小（默认值：4）。

  • num_layers_encoder – 密集编码器中的层数（默认值：1）。

  • num_layers_decoder – 密集解码器中的层数（默认值：1）。

  • decoder_output_dim – 密集解码器的输出大小（默认值：4）。

  • dropout_rate – Dropout 正则化参数（默认值：0.3）。

  • num_feat_dynamic_proj – 特征投影层的输出大小（默认值：2）。

  • weight_decay – 权重衰减正则化参数（默认值：1e-08）。

  • dropout_rate – Dropout 正则化参数（默认值：0.1）。

  • patience – 学习率调度器的 patience 参数。

  • num_feat_dynamic_real – 数据中动态实值特征的数量（默认值：0）。

  • embedding_dimension – 分类特征嵌入的维度（默认值：[16 for cat in cardinality]）。

  • layer_norm – 是否启用层归一化（默认值：False）。

  • lr – 学习率（默认值：1e-3）。

  • weight_decay – 权重衰减正则化参数（默认值：1e-8）。

  • patience – 学习率调度器的 patience 参数（默认值：10）。

  • distr_output – 用于评估观测值和采样预测的分布（默认值：StudentTOutput()）。

  • scaling – 用于缩放目标值的缩放方法（默认值：mean）。

  • batch_size – 用于训练的批次大小（默认值：32）。

  • default_scale – 如果上下文长度窗口完全未观测到，则应用的默认缩放。如果未设置，则在这种情况下，缩放将是批次中的平均缩放。

  • trainer_kwargs – 提供给 pl.Trainer 构造函数的附加参数。

  • train_sampler – 控制训练期间的窗口采样。

  • validation_sampler – 控制验证期间的窗口采样。

create_lightning_module() → lightning.pytorch.core.module.LightningModule[源代码]#

创建并返回用于训练（即计算损失）的网络。

返回值

根据输入数据计算损失的网络。

返回值类型

pl.LightningModule

create_predictor(transformation: gluonts.transform._base.Transformation, module) → gluonts.torch.model.predictor.PyTorchPredictor[源代码]#

创建并返回一个预测器对象。

参数

  • transformation – 数据进入模型之前要应用的转换。

  • module – 一个已训练的 pl.LightningModule 对象。

返回值

一个包装了用于推理的 nn.Module 的预测器。

返回值类型

预测器

create_training_data_loader(data: gluonts.dataset.Dataset, module: gluonts.torch.model.tide.lightning_module.TiDELightningModule, shuffle_buffer_length: Optional[int] = None, **kwargs) → Iterable[源代码]#

创建一个用于训练的数据加载器。

参数

  • data – 用于创建数据加载器的数据集。

  • module – 将接收数据加载器批次的 pl.LightningModule 对象。

返回值

数据加载器，即一个可遍历数据批次的迭代器。

返回值类型

可迭代对象

create_transformation() → gluonts.transform._base.Transformation[源代码]#

创建并返回训练和推理所需的转换。

返回值

将在训练和推理时逐条应用于数据集的转换。

返回值类型

转换

create_validation_data_loader(data: gluonts.dataset.Dataset, module: gluonts.torch.model.tide.lightning_module.TiDELightningModule, **kwargs) → Iterable[源代码]#

创建一个用于验证的数据加载器。

参数

  • data – 用于创建数据加载器的数据集。

  • module – 将接收数据加载器批次的 pl.LightningModule 对象。

返回值

数据加载器，即一个可遍历数据批次的迭代器。

返回值类型

可迭代对象

lead_time: int#
prediction_length: int#
类 gluonts.torch.WaveNetEstimator(freq: str, prediction_length: int, num_bins: int = 1024, num_residual_channels: int = 24, num_skip_channels: int = 32, dilation_depth: Optional[int] = None, num_stacks: int = 1, temperature: float = 1.0, num_feat_dynamic_real: int = 0, num_feat_static_cat: int = 0, num_feat_static_real: int = 0, cardinality: List[int] = [1], seasonality: Optional[int] = None, embedding_dimension: int = 5, use_log_scale_feature: bool = True, time_features: Optional[List[Callable[[pandas.core.indexes.period.PeriodIndex], numpy.ndarray]]] = None, lr: float = 0.001, weight_decay: float = 1e-08, train_sampler: Optional[gluonts.transform.sampler.InstanceSampler] = None, validation_sampler: Optional[gluonts.transform.sampler.InstanceSampler] = None, batch_size: int = 32, num_batches_per_epoch: int = 50, num_parallel_samples: int = 100, negative_data: bool = False, trainer_kwargs: Optional[Dict[str, Any]] = None)[源代码]#

基类: gluonts.torch.model.estimator.PyTorchLightningEstimator

create_lightning_module() → lightning.pytorch.core.module.LightningModule[源代码]#

创建并返回用于训练（即计算损失）的网络。

返回值

根据输入数据计算损失的网络。

返回值类型

pl.LightningModule

create_predictor(transformation: gluonts.transform._base.Transformation, module: gluonts.torch.model.wavenet.lightning_module.WaveNetLightningModule) → gluonts.torch.model.predictor.PyTorchPredictor[源代码]#

创建并返回一个预测器对象。

参数

  • transformation – 数据进入模型之前要应用的转换。

  • module – 一个已训练的 pl.LightningModule 对象。

返回值

一个包装了用于推理的 nn.Module 的预测器。

返回值类型

预测器

create_training_data_loader(data: gluonts.dataset.Dataset, module: gluonts.torch.model.wavenet.lightning_module.WaveNetLightningModule, shuffle_buffer_length: Optional[int] = None, **kwargs) → Iterable[源代码]#

创建一个用于训练的数据加载器。

参数

  • data – 用于创建数据加载器的数据集。

  • module – 将接收数据加载器批次的 pl.LightningModule 对象。

返回值

数据加载器，即一个可遍历数据批次的迭代器。

返回值类型

可迭代对象

create_transformation() → gluonts.transform._base.Transformation[源代码]#

创建并返回训练和推理所需的转换。

返回值

将在训练和推理时逐条应用于数据集的转换。

返回值类型

转换

create_validation_data_loader(data: gluonts.dataset.Dataset, module: gluonts.torch.model.wavenet.lightning_module.WaveNetLightningModule, **kwargs) → Iterable[源代码]#

创建一个用于验证的数据加载器。

参数

  • data – 用于创建数据加载器的数据集。

  • module – 将接收数据加载器批次的 pl.LightningModule 对象。

返回值

数据加载器，即一个可遍历数据批次的迭代器。

返回值类型

可迭代对象

lead_time: int#
prediction_length: int#

子包#