gluonts.torch.model.deepar 包

class gluonts.torch.model.deepar.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)

继承自: gluonts.torch.model.estimator.PyTorchLightningEstimator

用于训练 DeepAR 模型（如 [SFG17] 中所述）的 Estimator 类。

该类使用了在 DeepARModel 中定义的模型，并将其封装为 DeepARLightningModule 以用于训练；训练通过 PyTorch Lightning 的 pl.Trainer 类进行。

注意： 此模型的代码与 SageMaker 的 DeepAR Forecasting Algorithm 背后的实现无关。

参数

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

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

• context_length – 计算预测之前用于展开 RNN 的步数（默认：None，此时 context_length = prediction_length）。

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

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

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

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

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

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

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

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

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

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

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

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

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

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

• lags_seq – 用作 RNN 输入的滞后目标值的索引（默认：None，此时将根据 freq 自动确定）。

• time_features – 时间特征列表，来自 gluonts.time_feature，用作 RNN 的输入，以及提供的数据（默认：None，此时将根据 freq 自动确定）。

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

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

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

• trainer_kwargs – 构建 pl.Trainer 时提供的附加参数。

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

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

• nonnegative_pred_samples – 最终的预测样本是否应该是非负的？如果是，则应用激活函数以确保非负。注意，这仅应用于最终样本，在训练期间不应用。

create_lightning_module() → gluonts.torch.model.deepar.lightning_module.DeepARLightningModule

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

返回

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

返回类型

pl.LightningModule

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

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

参数

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

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

返回

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

返回类型

预测器

create_training_data_loader(data: gluonts.dataset.Dataset, module: gluonts.torch.model.deepar.lightning_module.DeepARLightningModule, 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.deepar.lightning_module.DeepARLightningModule, **kwargs) → Iterable

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

参数

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

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

返回

数据加载器，即数据批次的迭代器。

返回类型

Iterable

classmethod derive_auto_fields(train_iter)

lead_time: int

prediction_length: int

class gluonts.torch.model.deepar.DeepARLightningModule(model_kwargs: dict, lr: float = 0.001, weight_decay: float = 1e-08, patience: int = 10)

继承自: lightning.pytorch.core.module.LightningModule

一个 pl.LightningModule 类，可用于使用 PyTorch Lightning 训练 DeepARModel。

这是 DeepARModel 对象（封装）的薄层，暴露了评估训练和验证损失的方法。

参数

• model_kwargs – 构建要训练的 DeepARModel 的关键字参数。

• loss – 用于训练的损失函数。

• lr – 学习率。

• weight_decay – 权重衰减正则化参数。

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

configure_optimizers()

返回要使用的优化器。

forward(*args, **kwargs)

与 torch.nn.Module.forward() 相同。

参数

• *args – 任何你决定传递给 forward 方法的参数。

• **kwargs – 关键字参数也是可能的。

返回

你的模型输出

training_step(batch, batch_idx: int)

执行训练步骤。

validation_step(batch, batch_idx: int)

执行验证步骤。

class gluonts.torch.model.deepar.DeepARModel(freq: str, context_length: int, prediction_length: int, num_feat_dynamic_real: int = 1, num_feat_static_real: int = 1, num_feat_static_cat: int = 1, cardinality: List[int] = [1], embedding_dimension: Optional[List[int]] = None, num_layers: int = 2, hidden_size: int = 40, dropout_rate: float = 0.1, distr_output: gluonts.torch.distributions.distribution_output.DistributionOutput = gluonts.torch.distributions.studentT.StudentTOutput(beta=0.0), lags_seq: Optional[List[int]] = None, scaling: bool = True, default_scale: Optional[float] = None, num_parallel_samples: int = 100, nonnegative_pred_samples: bool = False)

继承自: torch.nn.modules.module.Module

实现 DeepAR 模型（参见 [SFG17]）的模块。

注意： 此模型的代码与 SageMaker 的 DeepAR Forecasting Algorithm 背后的实现无关。

参数

• freq – 指示要处理数据的采样频率的字符串。

• context_length – 预测日期之前 RNN 展开的长度。

• prediction_length – 要预测的时间点数量。

• num_feat_dynamic_real – 将提供给 forward 的动态实数特征数量。

• num_feat_static_real – 将提供给 forward 的静态实数特征数量。

• num_feat_static_cat – 将提供给 forward 的静态分类特征数量。

• cardinality – 基数列表，每个静态分类特征一个。

• embedding_dimension – 嵌入空间的维度，每个静态分类特征一个。

• num_layers – RNN 中的层数。

• hidden_size – RNN 中隐藏层的大小。

• dropout_rate – 训练时应用的 Dropout 比率。

• distr_output – 模型在每个时间步输出的分布类型

• lags_seq – RNN 接收作为输入的滞后观测值的索引。例如，[1] 表示 RNN 只接收时间 t-1 的观测值来生成时间 t 的输出；而 [1, 25] 表示 RNN 接收时间 t-1 和 t-25 的观测值作为输入。

• scaling – 是否对观测值（目标）应用均值缩放。

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

• num_parallel_samples – 在预测时间范围内展开 RNN 时要生成的样本数量。

• nonnegative_pred_samples – 最终的预测样本是否应该是非负的？如果是，则应用激活函数以确保非负。注意，这仅应用于最终样本，在训练期间不应用。

describe_inputs(batch_size=1) → gluonts.model.inputs.InputSpec

forward(feat_static_cat: torch.Tensor, feat_static_real: torch.Tensor, past_time_feat: torch.Tensor, past_target: torch.Tensor, past_observed_values: torch.Tensor, future_time_feat: torch.Tensor, num_parallel_samples: Optional[int] = None) → torch.Tensor

在输入数据上调用模型，并生成未来的样本输出。

参数

• feat_static_cat – 静态分类特征张量，形状：(batch_size, num_feat_static_cat)。

• feat_static_real – 静态实数特征张量，形状：(batch_size, num_feat_static_real)。

• past_time_feat – 过去动态实数特征张量，形状：(batch_size, past_length, num_feat_dynamic_real)。

• past_target – 过去目标值张量，形状：(batch_size, past_length)。

• past_observed_values – 观测值指示器张量，形状：(batch_size, past_length)。

• future_time_feat – （可选）未来动态实数特征张量，形状：(batch_size, prediction_length, num_feat_dynamic_real)。

• num_parallel_samples – 生成多少未来样本。默认情况下，使用 self.num_parallel_samples。

log_prob(feat_static_cat: torch.Tensor, feat_static_real: torch.Tensor, past_time_feat: torch.Tensor, past_target: torch.Tensor, past_observed_values: torch.Tensor, future_time_feat: torch.Tensor, future_target: torch.Tensor) → torch.Tensor

loss(feat_static_cat: torch.Tensor, feat_static_real: torch.Tensor, past_time_feat: torch.Tensor, past_target: torch.Tensor, past_observed_values: torch.Tensor, future_time_feat: torch.Tensor, future_target: torch.Tensor, future_observed_values: torch.Tensor, future_only: bool = False, aggregate_by=<built-in method mean of type object>) → torch.Tensor

output_distribution(params, scale=None, trailing_n=None) → torch.distributions.distribution.Distribution

实例化输出分布。

参数

• params – 分布参数的元组。

• scale – （可选）缩放张量。

• trailing_n – 如果设置，则仅为最后 trailing_n 个时间点创建输出分布。

返回

模型的输出分布。

返回类型

torch.distributions.Distribution

post_process_samples(samples: torch.Tensor) → torch.Tensor

用于对生成的样本强制执行特定领域约束的方法。例如，我们可以强制预测值为非负数。:param samples: 样本张量

返回类型

形状相同的处理后样本张量。

prepare_rnn_input(feat_static_cat: torch.Tensor, feat_static_real: torch.Tensor, past_time_feat: torch.Tensor, past_target: torch.Tensor, past_observed_values: torch.Tensor, future_time_feat: torch.Tensor, future_target: Optional[torch.Tensor] = None) → Tuple[torch.Tensor, torch.Tensor, torch.Tensor]

training: bool

unroll_lagged_rnn(feat_static_cat: torch.Tensor, feat_static_real: torch.Tensor, past_time_feat: torch.Tensor, past_target: torch.Tensor, past_observed_values: torch.Tensor, future_time_feat: torch.Tensor, future_target: Optional[torch.Tensor] = None) → Tuple[Tuple[torch.Tensor, ...], torch.Tensor, torch.Tensor, torch.Tensor, Tuple[torch.Tensor, torch.Tensor]]

将底层 RNN 应用于提供的目标数据和协变量。

参数

• feat_static_cat – 静态分类特征张量，形状：(batch_size, num_feat_static_cat)。

• feat_static_real – 静态实数特征张量，形状：(batch_size, num_feat_static_real)。

• past_time_feat – 过去动态实数特征张量，形状：(batch_size, past_length, num_feat_dynamic_real)。

• past_target – 过去目标值张量，形状：(batch_size, past_length)。

• past_observed_values – 观测值指示器张量，形状：(batch_size, past_length)。

• future_time_feat – 未来动态实数特征张量，形状：(batch_size, prediction_length, num_feat_dynamic_real)。

• future_target – （可选）未来目标值张量，形状：(batch_size, prediction_length)。

返回

一个元组，包含按此顺序： - 输出分布的参数 - 应用于目标的缩放因子 - RNN 的原始输出 - RNN 的静态输入 - RNN 的输出状态

返回类型

Tuple

子模块

• gluonts.torch.model.deepar.estimator 模块
• gluonts.torch.model.deepar.lightning_module 模块
• gluonts.torch.model.deepar.module 模块