gluonts.torch.model.deepar.module 模块#

class gluonts.torch.model.deepar.module.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)[source]#

基类: torch.nn.modules.module.Module

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

注意：此模型的代码与 SageMaker 的 DeepAR 预测算法 的实现无关。

参数

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

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

参数

  • 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[source]#
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[source]#
output_distribution(params, scale=None, trailing_n=None) → torch.distributions.distribution.Distribution[source]#

实例化输出分布。

参数

  • params – 分布参数的元组。

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

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

返回

模型的输出分布。

返回类型

torch.distributions.Distribution

post_process_samples(samples: torch.Tensor) → torch.Tensor[source]#

对生成的样本强制实施特定领域约束的方法。例如，我们可以强制预测值为非负。 :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][source]#
scaler: Scaler#
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]][source]#

将底层 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 的输出状态

返回类型

元组