Hugging Face's logo

Transformers 文档

Informer

Hugging Face's logo
加入 Hugging Face 社区

并获得增强的文档体验

开始使用

Informer

概述

Informer 模型在 Informer: Beyond Efficient Transformer for Long Sequence Time-Series Forecasting 中提出，作者是 Haoyi Zhou、Shanghang Zhang、Jieqi Peng、Shuai Zhang、Jianxin Li、Hui Xiong 和 Wancai Zhang。

该方法引入了一种概率注意力机制，用于选择“活跃”查询而不是“懒惰”查询，并提供了一个稀疏 Transformer，从而减轻了 vanilla attention 的二次计算和内存需求。

该论文的摘要如下：

许多现实世界的应用需要预测长序列时间序列，例如电力消耗计划。长序列时间序列预测 (LSTF) 要求模型具有较高的预测能力，即有效地捕获输出和输入之间精确的远程依赖耦合的能力。最近的研究表明，Transformer 有潜力提高预测能力。然而，Transformer 存在几个严重的问题，阻碍了其直接应用于 LSTF，包括二次时间复杂度、高内存使用以及编码器-解码器架构的固有局限性。为了解决这些问题，我们为 LSTF 设计了一个高效的基于 Transformer 的模型，名为 Informer，具有三个独特的特点：（i）ProbSparse 自注意力机制，在时间复杂度和内存使用方面实现了 O(L logL)，并且在序列的依赖对齐方面具有可比的性能。（ii）自注意力蒸馏通过将级联层输入减半来突出主导注意力，并有效地处理极端长输入序列。（iii）生成式解码器，虽然概念上很简单，但以一次前向操作而不是逐步方式预测长时序序列，这大大提高了长序列预测的推理速度。在四个大型数据集上的广泛实验表明，Informer 明显优于现有方法，并为 LSTF 问题提供了新的解决方案。

此模型由 elisim 和 kashif 贡献。原始代码可以在 这里 找到。

资源

以下是官方 Hugging Face 和社区（🌎 表示）资源的列表，可帮助您入门。如果您有兴趣提交资源以包含在此处，请随时打开 Pull Request，我们将对其进行审核！资源最好能展示一些新的东西，而不是重复现有的资源。

InformerConfig

class transformers.InformerConfig

< >

( prediction_length: Optional = None context_length: Optional = None distribution_output: str = 'student_t' loss: str = 'nll' input_size: int = 1 lags_sequence: List = None scaling: Union = 'mean' num_dynamic_real_features: int = 0 num_static_real_features: int = 0 num_static_categorical_features: int = 0 num_time_features: int = 0 cardinality: Optional = None embedding_dimension: Optional = None d_model: int = 64 encoder_ffn_dim: int = 32 decoder_ffn_dim: int = 32 encoder_attention_heads: int = 2 decoder_attention_heads: int = 2 encoder_layers: int = 2 decoder_layers: int = 2 is_encoder_decoder: bool = True activation_function: str = 'gelu' dropout: float = 0.05 encoder_layerdrop: float = 0.1 decoder_layerdrop: float = 0.1 attention_dropout: float = 0.1 activation_dropout: float = 0.1 num_parallel_samples: int = 100 init_std: float = 0.02 use_cache = True attention_type: str = 'prob' sampling_factor: int = 5 distil: bool = True **kwargs )

参数

  • prediction_length (int) — 解码器的预测长度。换句话说，模型的预测范围。此值通常由数据集决定，我们建议根据数据集进行适当设置。
  • context_length (int, optional, defaults to prediction_length) — 编码器的上下文长度。如果为 None，上下文长度将与 prediction_length 相同。
  • distribution_output (string, optional, defaults to "student_t") — 模型的分布发射头。可以是 “student_t”、“normal” 或 “negative_binomial”。
  • loss (string, optional, defaults to "nll") — 模型对应于 distribution_output 头的损失函数。对于参数分布，它是负对数似然 (nll) - 目前是唯一支持的损失函数。
  • input_size (int, optional, defaults to 1) — 目标变量的大小，对于单变量目标，默认值为 1。对于多变量目标，则 > 1。
  • scaling (string or bool, optional defaults to "mean") — 是否通过 “mean” 缩放器、“std” 缩放器或在 None 的情况下不使用缩放器来缩放输入目标。如果为 True，则缩放器设置为 “mean”。
  • lags_sequence (list[int], optional, defaults to [1, 2, 3, 4, 5, 6, 7]) — 输入时间序列作为协变量的滞后项，通常由数据的频率决定。默认为 [1, 2, 3, 4, 5, 6, 7]，但我们建议根据数据集进行适当更改。
  • num_time_features (int, optional, defaults to 0) — 输入时间序列中时间特征的数量。
  • num_dynamic_real_features (int, optional, defaults to 0) — 动态实值特征的数量。
  • num_static_categorical_features (int, optional, defaults to 0) — 静态类别特征的数量。
  • num_static_real_features (int, optional, defaults to 0) — 静态实值特征的数量。
  • cardinality (list[int], optional) — 每个静态类别特征的基数（不同值的数量）。应为整数列表，其长度与 num_static_categorical_features 相同。如果 num_static_categorical_features > 0，则不能为 None。
  • embedding_dimension (list[int], optional) — 每个静态类别特征的嵌入维度。应为整数列表，其长度与 num_static_categorical_features 相同。如果 num_static_categorical_features > 0，则不能为 None。
  • d_model (int, optional, defaults to 64) — Transformer 层的维度。
  • encoder_layers (int, optional, defaults to 2) — 编码器层数。
  • decoder_layers (int, optional, defaults to 2) — 解码器层数。
  • encoder_attention_heads (int, optional, defaults to 2) — Transformer 编码器中每个注意力层的注意力头数。
  • decoder_attention_heads (int, optional, defaults to 2) — Transformer 解码器中每个注意力层的注意力头数。
  • encoder_ffn_dim (int, optional, defaults to 32) — 编码器中 “中间” 层（通常称为前馈层）的维度。
  • decoder_ffn_dim (int, optional, defaults to 32) — 解码器中 “中间” 层（通常称为前馈层）的维度。
  • activation_function (str or function, optional, defaults to "gelu") — 编码器和解码器中的非线性激活函数（函数或字符串）。如果为字符串，则支持 "gelu" 和 "relu"。
  • dropout (float, optional, defaults to 0.1) — 编码器和解码器中所有全连接层的 dropout 概率。
  • encoder_layerdrop (float, optional, defaults to 0.1) — 每个编码器层的注意力和全连接层的 dropout 概率。
  • decoder_layerdrop (float, optional, defaults to 0.1) — 每个解码器层的注意力和全连接层的 dropout 概率。
  • attention_dropout (float, optional, defaults to 0.1) — 注意力概率的 dropout 概率。
  • activation_dropout (float, optional, defaults to 0.1) — 前馈网络的两个层之间使用的 dropout 概率。
  • num_parallel_samples (int, 可选, 默认为 100) — 用于推理的每个时间步并行生成的样本数。
  • init_std (float, 可选, 默认为 0.02) — 截断正态权重初始化分布的标准差。
  • use_cache (bool, 可选, 默认为 True) — 是否使用过去的键/值注意力机制（如果模型适用）来加速解码。
  • attention_type (str, 可选, 默认为 “prob”) — 编码器中使用的注意力类型。可以设置为 “prob”（Informer 的 ProbAttention）或 “full”（原始 Transformer 的标准自注意力机制）。
  • sampling_factor (int, 可选, 默认为 5) — ProbSparse 采样因子（仅当 attention_type=“prob” 时生效）。它用于控制缩减的查询矩阵 (Q_reduce) 输入长度。
  • distil (bool, 可选, 默认为 True) — 是否在编码器中使用蒸馏。

这是用于存储 InformerModel 配置的配置类。它用于根据指定的参数实例化 Informer 模型，定义模型架构。使用默认值实例化配置将产生与 Informer huggingface/informer-tourism-monthly 架构类似的配置。

配置对象继承自 PretrainedConfig，可用于控制模型输出。有关更多信息，请阅读 PretrainedConfig 的文档。

示例

>>> from transformers import InformerConfig, InformerModel

>>> # Initializing an Informer configuration with 12 time steps for prediction
>>> configuration = InformerConfig(prediction_length=12)

>>> # Randomly initializing a model (with random weights) from the configuration
>>> model = InformerModel(configuration)

>>> # Accessing the model configuration
>>> configuration = model.config

InformerModel

class transformers.InformerModel

< >

( config: InformerConfig )

参数

  • config (TimeSeriesTransformerConfig) — 带有模型所有参数的模型配置类。使用配置文件初始化不会加载与模型关联的权重，仅加载配置。查看 from_pretrained() 方法以加载模型权重。

裸 Informer 模型输出原始隐藏状态，顶部没有任何特定的头部。此模型继承自 PreTrainedModel。查看超类文档，了解库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、剪枝头等）。

此模型也是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档，了解与通用用法和行为相关的所有事项。

forward

< >

( past_values: Tensor past_time_features: Tensor past_observed_mask: Tensor static_categorical_features: Optional = None static_real_features: Optional = None future_values: Optional = None future_time_features: Optional = None decoder_attention_mask: Optional = None head_mask: Optional = None decoder_head_mask: Optional = None cross_attn_head_mask: Optional = None encoder_outputs: Optional = None past_key_values: Optional = None output_hidden_states: Optional = None output_attentions: Optional = None use_cache: Optional = None return_dict: Optional = None ) → transformers.modeling_outputs.Seq2SeqTSModelOutput 或 tuple(torch.FloatTensor)

参数

  • past_values (torch.FloatTensor，形状为 (batch_size, sequence_length) 或 (batch_size, sequence_length, input_size)) — 时间序列的过去值，用作预测未来的上下文。此张量的序列大小必须大于模型的 context_length，因为模型将使用更大的尺寸来构建滞后特征，即从过去添加的额外值，以用作“额外上下文”。

    此处的 sequence_length 等于 config.context_length + max(config.lags_sequence)，如果没有配置 lags_sequence，则等于 config.context_length + 7（因为默认情况下，config.lags_sequence 中最大的回溯索引为 7）。属性 _past_length 返回过去值的实际长度。

    past_values 是 Transformer 编码器的输入（带有可选的附加特征，例如 static_categorical_features、static_real_features、past_time_features 和滞后）。

    可选地，缺失值需要用零替换，并通过 past_observed_mask 指示。

    对于多元时间序列，需要 input_size > 1 维度，它对应于每个时间步时间序列中的变量数量。

  • past_time_features (torch.FloatTensor，形状为 (batch_size, sequence_length, num_features)) — 必需的时间特征，模型内部会将其添加到 past_values。这些可能是诸如“月份”、“日期”等，编码为向量（例如傅里叶特征）。这些也可能是所谓的“年龄”特征，基本上可以帮助模型了解时间序列的“生命周期”。年龄特征对于遥远的过去时间步具有较小的值，并且随着我们接近当前时间步而单调增加。节假日特征也是时间特征的一个很好的例子。

    这些特征充当输入的“位置编码”。因此，与 BERT 等模型相反，BERT 的位置编码是从头开始作为模型参数在内部学习的，时间序列 Transformer 需要提供额外的时间特征。时间序列 Transformer 仅学习 static_categorical_features 的附加嵌入。

    其他动态实值协变量可以连接到此张量，但需要注意的是，这些特征必须在预测时已知。

    此处的 num_features 等于 config.num_time_features+config.num_dynamic_real_features`。

  • past_observed_mask (torch.BoolTensor，形状为 (batch_size, sequence_length) 或 (batch_size, sequence_length, input_size), 可选) — 布尔掩码，用于指示哪些 past_values 是观测到的，哪些是缺失的。掩码值在 [0, 1] 中选择：

    • 1 表示 已观测 的值，
    • 0 表示 缺失 的值（即被零替换的 NaN）。
  • static_categorical_features (torch.LongTensor，形状为 (batch_size, number of static categorical features), 可选) — 可选的静态类别特征，模型将学习其嵌入，并将其添加到时间序列的值中。

    静态类别特征是在所有时间步都具有相同值的特征（随时间静态）。

    时间序列 ID 是静态类别特征的典型示例。

  • static_real_features (torch.FloatTensor，形状为 (batch_size, number of static real features), 可选) — 可选的静态实值特征，模型将添加到时间序列的值中。

    静态实值特征是在所有时间步都具有相同值的特征（随时间静态）。

    促销信息是静态实值特征的典型示例。

  • future_values (torch.FloatTensor，形状为 (batch_size, prediction_length) 或 (batch_size, prediction_length, input_size), 可选) — 时间序列的未来值，用作模型的标签。future_values 是 Transformer 在训练期间需要学习输出的内容，给定 past_values。

    此处的序列长度等于 prediction_length。

    有关详细信息，请参阅演示 notebook 和代码片段。

    可选地，在训练期间，任何缺失值都需要用零替换，并通过 future_observed_mask 指示。

    对于多元时间序列，需要 input_size > 1 维度，它对应于每个时间步时间序列中的变量数量。

  • future_time_features (torch.FloatTensor，形状为 (batch_size, prediction_length, num_features)) — 预测窗口所需的必要时间特征，模型内部会将其添加到 future_values。这些可能是诸如“月份”、“日期”等，编码为向量（例如傅里叶特征）。这些也可能是所谓的“年龄”特征，基本上可以帮助模型了解时间序列的“生命周期”。年龄特征对于遥远的过去时间步具有较小的值，并且随着我们接近当前时间步而单调增加。节假日特征也是时间特征的一个很好的例子。

    这些特征充当输入的“位置编码”。因此，与 BERT 等模型相反，BERT 的位置编码是从头开始作为模型参数在内部学习的，时间序列 Transformer 需要提供额外的时间特征。时间序列 Transformer 仅学习 static_categorical_features 的附加嵌入。

    其他动态实值协变量可以连接到此张量，但需要注意的是，这些特征必须在预测时已知。

    此处的 num_features 等于 config.num_time_features+config.num_dynamic_real_features`。

  • future_observed_mask (torch.BoolTensor，形状为 (batch_size, sequence_length) 或 (batch_size, sequence_length, input_size), 可选) — 布尔掩码，用于指示哪些 future_values 是观测到的，哪些是缺失的。掩码值在 [0, 1] 中选择：

    • 1 表示 已观测 的值，
    • 0 表示 缺失 的值（即被零替换的 NaN）。

    此掩码用于过滤掉最终损失计算中的缺失值。

  • attention_mask (torch.Tensor of shape (batch_size, sequence_length), optional) — 用于避免在某些 token 索引上执行 attention 的 Mask。 Mask 值在 [0, 1] 中选择：

    • 1 表示 token 未被 mask，
    • 0 表示 token 已被 mask。

    什么是 attention mask？

  • decoder_attention_mask (torch.LongTensor of shape (batch_size, target_sequence_length), optional) — 用于避免在某些 token 索引上执行 attention 的 Mask。 默认情况下，将使用因果 mask，以确保模型只能查看先前的输入以预测未来。
  • head_mask (torch.Tensor of shape (encoder_layers, encoder_attention_heads), optional) — 用于 nullify encoder 中 attention 模块的选定 head 的 Mask。 Mask 值在 [0, 1] 中选择：

    • 1 表示 head 未被 mask，
    • 0 表示 head 已被 mask。
  • decoder_head_mask (torch.Tensor of shape (decoder_layers, decoder_attention_heads), optional) — 用于 nullify decoder 中 attention 模块的选定 head 的 Mask。 Mask 值在 [0, 1] 中选择：

    • 1 表示 head 未被 mask，
    • 0 表示 head 已被 mask。
  • cross_attn_head_mask (torch.Tensor of shape (decoder_layers, decoder_attention_heads), optional) — 用于 nullify cross-attention 模块的选定 head 的 Mask。 Mask 值在 [0, 1] 中选择：

    • 1 表示 head 未被 mask，
    • 0 表示 head 已被 mask。
  • encoder_outputs (tuple(tuple(torch.FloatTensor), optional) — 由 last_hidden_state、hidden_states (optional) 和 attentions (optional) 组成的元组。last_hidden_state 的形状为 (batch_size, sequence_length, hidden_size) (optional)，是 encoder 最后一层的输出处的 hidden-states 序列。在 decoder 的 cross-attention 中使用。
  • past_key_values (tuple(tuple(torch.FloatTensor)), optional, 当传递 use_cache=True 或当 config.use_cache=True 时返回) — 长度为 config.n_layers 的 tuple(tuple(torch.FloatTensor)) 元组，其中每个元组有 2 个形状为 (batch_size, num_heads, sequence_length, embed_size_per_head) 的 tensor 和 2 个形状为 (batch_size, num_heads, encoder_sequence_length, embed_size_per_head) 的附加 tensor。

    包含预先计算的 hidden-states (self-attention 块和 cross-attention 块中的 key 和 values)，可以用于 (参见 past_key_values 输入) 加速顺序解码。

    如果使用 past_key_values，则用户可以选择仅输入最后 decoder_input_ids (那些没有将其过去的 key value 状态提供给此模型的) 形状为 (batch_size, 1)，而不是所有形状为 (batch_size, sequence_length) 的 decoder_input_ids。

  • inputs_embeds (torch.FloatTensor of shape (batch_size, sequence_length, hidden_size), optional) — （可选）您可以选择直接传递嵌入表示，而不是传递 input_ids。 如果您希望比模型的内部嵌入查找矩阵更精细地控制如何将 input_ids 索引转换为关联的向量，这将非常有用。
  • use_cache (bool, optional) — 如果设置为 True，则返回 past_key_values 键值状态，并且可以用于加速解码 (参见 past_key_values)。
  • output_attentions (bool, optional) — 是否返回所有 attention 层的 attentions tensors。 有关更多详细信息，请参见返回的 tensors 下的 attentions。
  • output_hidden_states (bool, optional) — 是否返回所有层的 hidden states。 有关更多详细信息，请参见返回的 tensors 下的 hidden_states。
  • return_dict (bool, optional) — 是否返回 ModelOutput 而不是普通的元组。

返回值

transformers.modeling_outputs.Seq2SeqTSModelOutput 或 tuple(torch.FloatTensor)

一个 transformers.modeling_outputs.Seq2SeqTSModelOutput 或一个 torch.FloatTensor 元组 (如果传递了 return_dict=False 或当 config.return_dict=False 时)，其中包含各种元素，具体取决于配置 (InformerConfig) 和输入。

  • last_hidden_state (torch.FloatTensor of shape (batch_size, sequence_length, hidden_size)) — 模型 decoder 最后一层的输出处的 hidden-states 序列。

    如果使用 past_key_values，则仅输出形状为 (batch_size, 1, hidden_size) 的序列的最后一个 hidden-state。

  • past_key_values (tuple(tuple(torch.FloatTensor)), optional, 当传递 use_cache=True 或当 config.use_cache=True 时返回) — 长度为 config.n_layers 的 tuple(tuple(torch.FloatTensor)) 元组，其中每个元组有 2 个形状为 (batch_size, num_heads, sequence_length, embed_size_per_head) 的 tensor 和 2 个形状为 (batch_size, num_heads, encoder_sequence_length, embed_size_per_head) 的附加 tensor。

    包含预先计算的 hidden-states (self-attention 块和 cross-attention 块中的 key 和 values)，可以用于 (参见 past_key_values 输入) 加速顺序解码。

  • decoder_hidden_states (tuple(torch.FloatTensor), optional, 当传递 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — torch.FloatTensor 元组 (如果模型有嵌入层，则为嵌入输出的元组 + 每个层的输出的元组)，形状为 (batch_size, sequence_length, hidden_size)。

    decoder 在每一层输出处的 Hidden-states，加上可选的初始嵌入输出。

  • decoder_attentions (tuple(torch.FloatTensor), optional, 当传递 output_attentions=True 或当 config.output_attentions=True 时返回) — torch.FloatTensor 元组 (每层一个)，形状为 (batch_size, num_heads, sequence_length, sequence_length)。

    decoder 的 attentions 权重，在 attention softmax 之后，用于计算 self-attention head 中的加权平均值。

  • cross_attentions (tuple(torch.FloatTensor), optional, 当传递 output_attentions=True 或当 config.output_attentions=True 时返回) — torch.FloatTensor 元组 (每层一个)，形状为 (batch_size, num_heads, sequence_length, sequence_length)。

    decoder 的 cross-attention 层的 attentions 权重，在 attention softmax 之后，用于计算 cross-attention head 中的加权平均值。

  • encoder_last_hidden_state (torch.FloatTensor of shape (batch_size, sequence_length, hidden_size), optional) — 模型 encoder 最后一层的输出处的 hidden-states 序列。

  • encoder_hidden_states (tuple(torch.FloatTensor), optional, 当传递 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — torch.FloatTensor 元组 (如果模型有嵌入层，则为嵌入输出的元组 + 每个层的输出的元组)，形状为 (batch_size, sequence_length, hidden_size)。

    encoder 在每一层输出处的 Hidden-states，加上可选的初始嵌入输出。

  • encoder_attentions (tuple(torch.FloatTensor), optional, 当传递 output_attentions=True 或当 config.output_attentions=True 时返回) — torch.FloatTensor 元组 (每层一个)，形状为 (batch_size, num_heads, sequence_length, sequence_length)。

    encoder 的 attentions 权重，在 attention softmax 之后，用于计算 self-attention head 中的加权平均值。

  • loc (torch.FloatTensor of shape (batch_size,) or (batch_size, input_size), optional) — 每个时间序列上下文窗口的 Shift 值，用于使模型输入具有相同的大小，然后用于移回原始大小。

  • scale (torch.FloatTensor of shape (batch_size,) or (batch_size, input_size), optional) — 每个时间序列上下文窗口的 Scaling 值，用于使模型输入具有相同的大小，然后用于重新缩放回原始大小。

  • static_features (torch.FloatTensor of shape (batch_size, feature size), optional) — 批次中每个时间序列的静态特征，在推理时复制到 covariates。

InformerModel forward 方法，覆盖了 __call__ 特殊方法。

尽管 forward pass 的配方需要在该函数内定义，但应该在此之后调用 Module 实例，而不是此函数，因为前者负责运行预处理和后处理步骤，而后者会静默地忽略它们。

示例

>>> from huggingface_hub import hf_hub_download
>>> import torch
>>> from transformers import InformerModel

>>> file = hf_hub_download(
...     repo_id="hf-internal-testing/tourism-monthly-batch", filename="train-batch.pt", repo_type="dataset"
... )
>>> batch = torch.load(file)

>>> model = InformerModel.from_pretrained("huggingface/informer-tourism-monthly")

>>> # during training, one provides both past and future values
>>> # as well as possible additional features
>>> outputs = model(
...     past_values=batch["past_values"],
...     past_time_features=batch["past_time_features"],
...     past_observed_mask=batch["past_observed_mask"],
...     static_categorical_features=batch["static_categorical_features"],
...     static_real_features=batch["static_real_features"],
...     future_values=batch["future_values"],
...     future_time_features=batch["future_time_features"],
... )

>>> last_hidden_state = outputs.last_hidden_state

InformerForPrediction

class transformers.InformerForPrediction

< >

( config: InformerConfig )

参数

  • config (TimeSeriesTransformerConfig) — 带有模型所有参数的模型配置类。 使用配置文件初始化不会加载与模型关联的权重，仅加载配置。 查看 from_pretrained() 方法以加载模型权重。

带有分布头的 Informer 模型，用于时间序列预测。 此模型继承自 PreTrainedModel。 查看超类文档，了解库为其所有模型实现的通用方法 (例如下载或保存、调整输入嵌入大小、剪枝 head 等)。

此模型也是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档，了解与通用用法和行为相关的所有事项。

forward

< >

( past_values: Tensor past_time_features: Tensor past_observed_mask: Tensor static_categorical_features: Optional = None static_real_features: Optional = None future_values: Optional = None future_time_features: Optional = None future_observed_mask: Optional = None decoder_attention_mask: Optional = None head_mask: Optional = None decoder_head_mask: Optional = None cross_attn_head_mask: Optional = None encoder_outputs: Optional = None past_key_values: Optional = None output_hidden_states: Optional = None output_attentions: Optional = None use_cache: Optional = None return_dict: Optional = None ) → transformers.modeling_outputs.Seq2SeqTSModelOutput or tuple(torch.FloatTensor)

参数

  • past_values (torch.FloatTensor of shape (batch_size, sequence_length) or (batch_size, sequence_length, input_size)) — 时间序列的过去值，用作预测未来的上下文。 此 tensor 的序列大小必须大于模型的 context_length，因为模型将使用更大的大小来构建滞后特征，即从过去添加的附加值，以用作“额外上下文”。

    此处的 sequence_length 等于 config.context_length + max(config.lags_sequence)，如果未配置 lags_sequence，则等于 config.context_length + 7 (因为默认情况下，config.lags_sequence 中最大的回顾索引为 7)。 属性 _past_length 返回过去值的实际长度。

    past_values 是 Transformer encoder 获取的输入 (带有可选的附加特征，例如 static_categorical_features、static_real_features、past_time_features 和滞后)。

    可选地，缺失值需要替换为零，并通过 past_observed_mask 指示。

    对于多元时间序列，需要 input_size > 1 维度，并且对应于每个时间步的时间序列中的变量数。

  • past_time_features (torch.FloatTensor of shape (batch_size, sequence_length, num_features)) — 所需的时间特征，模型将在内部将其添加到 past_values。 这些可能是诸如“一年中的月份”、“月份中的日期”之类的东西，编码为向量 (例如，作为傅里叶特征)。 这些也可能是所谓的“年龄”特征，它们基本上帮助模型了解时间序列“处于生命中的哪个阶段”。 年龄特征对于遥远的过去时间步具有小值，并且随着我们越来越接近当前时间步而单调增加。 假日特征也是时间特征的一个很好的例子。

    这些特征充当输入的“位置编码”。 因此，与像 BERT 这样的模型相反，在 BERT 中，位置编码是从头开始在内部作为模型的参数学习的，时间序列 Transformer 需要提供附加的时间特征。 时间序列 Transformer 仅学习 static_categorical_features 的附加嵌入。

    附加的动态实值 covariates 可以连接到此 tensor，但需要注意的是，这些特征必须在预测时已知。

    此处的 num_features 等于 config.num_time_features+config.num_dynamic_real_features`。

  • past_observed_mask (torch.BoolTensor of shape (batch_size, sequence_length) or (batch_size, sequence_length, input_size), optional) — 布尔 mask，用于指示哪些 past_values 被观察到，哪些缺失。 Mask 值在 [0, 1] 中选择：

    • 1 表示值是被观察到的，
    • 0 表示值是缺失的 (即，被零替换的 NaN)。
  • static_categorical_features (torch.LongTensor of shape (batch_size, number of static categorical features), optional) — 可选的静态分类特征，模型将为其学习嵌入，并将其添加到时间序列的值中。

    静态分类特征是在所有时间步都具有相同值的特征 (静态的，随时间不变)。

    时间序列 ID 是静态分类特征的典型示例。

  • static_real_features (torch.FloatTensor of shape (batch_size, number of static real features), optional) — 可选的静态实值特征，模型会将其添加到时间序列的值中。

    静态实值特征是指在所有时间步都具有相同值的特征（在时间上是静态的）。

    促销信息是静态实值特征的典型示例。

  • future_values (torch.FloatTensor of shape (batch_size, prediction_length) or (batch_size, prediction_length, input_size), optional) — 时间序列的未来值，作为模型的标签。 future_values 是 Transformer 在训练期间学习输出的内容，给定 past_values。

    这里的序列长度等于 prediction_length。

    有关详细信息，请参阅演示笔记本和代码片段。

    可选地，在训练期间，任何缺失值都需要替换为零，并通过 future_observed_mask 指示。

    对于多元时间序列，需要 input_size > 1 维度，并且对应于每个时间步的时间序列中的变量数量。

  • future_time_features (torch.FloatTensor of shape (batch_size, prediction_length, num_features)) — 预测窗口所需的时间特征，模型内部会将其添加到 future_values 中。 这些可以是诸如“一年中的月份”、“月份中的日期”等，编码为向量（例如傅里叶特征）。 这些也可以是所谓的“年龄”特征，它们基本上帮助模型了解时间序列的“生命周期”。 年龄特征对于遥远的过去时间步具有小值，并且随着我们越来越接近当前时间步而单调增加。 节假日特征也是时间特征的一个很好的例子。

    这些特征充当输入的“位置编码”。 因此，与 BERT 这样的模型相反，BERT 的位置编码是从头开始作为模型的参数内部学习的，时间序列 Transformer 需要提供额外的时间特征。 时间序列 Transformer 仅学习 static_categorical_features 的附加嵌入。

    附加的动态实值协变量可以连接到此张量，但需要注意的是，这些特征必须在预测时已知。

    这里的 num_features 等于 config.num_time_features+config.num_dynamic_real_features`。

  • future_observed_mask (torch.BoolTensor of shape (batch_size, sequence_length) or (batch_size, sequence_length, input_size), optional) — 布尔掩码，用于指示哪些 future_values 是被观察到的，哪些是缺失的。 掩码值在 [0, 1] 中选择：

    • 1 表示 已观察到 的值，
    • 0 表示 缺失 的值（即被零替换的 NaN）。

    此掩码用于过滤掉最终损失计算中的缺失值。

  • attention_mask (torch.Tensor of shape (batch_size, sequence_length), optional) — 掩码，用于避免对某些 token 索引执行注意力。 掩码值在 [0, 1] 中选择：

    • 1 表示 未被掩码 的 token，
    • 0 表示 已被掩码 的 token。

    什么是注意力掩码？

  • decoder_attention_mask (torch.LongTensor of shape (batch_size, target_sequence_length), optional) — 掩码，用于避免对某些 token 索引执行注意力。 默认情况下，将使用因果掩码，以确保模型只能查看之前的输入以预测未来。
  • head_mask (torch.Tensor of shape (encoder_layers, encoder_attention_heads), optional) — 掩码，用于使编码器中注意力模块的选定 head 失效。 掩码值在 [0, 1] 中选择：

    • 1 表示 head 未被掩码，
    • 0 表示 head 已被掩码。
  • decoder_head_mask (torch.Tensor of shape (decoder_layers, decoder_attention_heads), optional) — 掩码，用于使解码器中注意力模块的选定 head 失效。 掩码值在 [0, 1] 中选择：

    • 1 表示 head 未被掩码，
    • 0 表示 head 已被掩码。
  • cross_attn_head_mask (torch.Tensor of shape (decoder_layers, decoder_attention_heads), optional) — 掩码，用于使交叉注意力模块的选定 head 失效。 掩码值在 [0, 1] 中选择：

    • 1 表示 head 未被掩码，
    • 0 表示 head 已被掩码。
  • encoder_outputs (tuple(tuple(torch.FloatTensor), optional) — 元组由 last_hidden_state、hidden_states (optional) 和 attentions (optional) 组成。 形状为 (batch_size, sequence_length, hidden_size) (optional) 的 last_hidden_state 是编码器最后一层的输出处的隐藏状态序列。 在解码器的交叉注意力中使用。
  • past_key_values (tuple(tuple(torch.FloatTensor)), optional, returned when use_cache=True is passed or when config.use_cache=True) — 长度为 config.n_layers 的 tuple(tuple(torch.FloatTensor)) 元组，其中每个元组具有 2 个形状为 (batch_size, num_heads, sequence_length, embed_size_per_head) 的张量和 2 个形状为 (batch_size, num_heads, encoder_sequence_length, embed_size_per_head) 的附加张量。

    包含预先计算的隐藏状态（自注意力模块和交叉注意力模块中的键和值），这些状态可用于（参见 past_key_values 输入）加速顺序解码。

    如果使用 past_key_values，则用户可以选择仅输入形状为 (batch_size, 1) 的最后一个 decoder_input_ids（那些没有将其过去的键值状态提供给此模型的），而不是形状为 (batch_size, sequence_length) 的所有 decoder_input_ids。

  • inputs_embeds (torch.FloatTensor of shape (batch_size, sequence_length, hidden_size), optional) — 可选地，您可以选择直接传递嵌入表示，而不是传递 input_ids。 如果您希望比模型的内部嵌入查找矩阵更精细地控制如何将 input_ids 索引转换为关联的向量，这将非常有用。
  • use_cache (bool, optional) — 如果设置为 True，则返回 past_key_values 键值状态，并且可以用于加速解码（请参阅 past_key_values）。
  • output_attentions (bool, optional) — 是否返回所有注意力层的注意力张量。 有关更多详细信息，请参阅返回张量下的 attentions。
  • output_hidden_states (bool, optional) — 是否返回所有层的隐藏状态。 有关更多详细信息，请参阅返回张量下的 hidden_states。
  • return_dict (bool, optional) — 是否返回 ModelOutput 而不是普通元组。

返回值

transformers.modeling_outputs.Seq2SeqTSModelOutput 或 tuple(torch.FloatTensor)

一个 transformers.modeling_outputs.Seq2SeqTSModelOutput 或一个 torch.FloatTensor 元组 (如果传递了 return_dict=False 或当 config.return_dict=False 时)，其中包含各种元素，具体取决于配置 (InformerConfig) 和输入。

  • last_hidden_state (torch.FloatTensor of shape (batch_size, sequence_length, hidden_size)) — 模型 decoder 最后一层的输出处的 hidden-states 序列。

    如果使用 past_key_values，则仅输出形状为 (batch_size, 1, hidden_size) 的序列的最后一个 hidden-state。

  • past_key_values (tuple(tuple(torch.FloatTensor)), optional, 当传递 use_cache=True 或当 config.use_cache=True 时返回) — 长度为 config.n_layers 的 tuple(tuple(torch.FloatTensor)) 元组，其中每个元组有 2 个形状为 (batch_size, num_heads, sequence_length, embed_size_per_head) 的 tensor 和 2 个形状为 (batch_size, num_heads, encoder_sequence_length, embed_size_per_head) 的附加 tensor。

    包含预先计算的 hidden-states (self-attention 块和 cross-attention 块中的 key 和 values)，可以用于 (参见 past_key_values 输入) 加速顺序解码。

  • decoder_hidden_states (tuple(torch.FloatTensor), optional, 当传递 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — torch.FloatTensor 元组 (如果模型有嵌入层，则为嵌入输出的元组 + 每个层的输出的元组)，形状为 (batch_size, sequence_length, hidden_size)。

    decoder 在每一层输出处的 Hidden-states，加上可选的初始嵌入输出。

  • decoder_attentions (tuple(torch.FloatTensor), optional, 当传递 output_attentions=True 或当 config.output_attentions=True 时返回) — torch.FloatTensor 元组 (每层一个)，形状为 (batch_size, num_heads, sequence_length, sequence_length)。

    decoder 的 attentions 权重，在 attention softmax 之后，用于计算 self-attention head 中的加权平均值。

  • cross_attentions (tuple(torch.FloatTensor), optional, 当传递 output_attentions=True 或当 config.output_attentions=True 时返回) — torch.FloatTensor 元组 (每层一个)，形状为 (batch_size, num_heads, sequence_length, sequence_length)。

    decoder 的 cross-attention 层的 attentions 权重，在 attention softmax 之后，用于计算 cross-attention head 中的加权平均值。

  • encoder_last_hidden_state (torch.FloatTensor of shape (batch_size, sequence_length, hidden_size), optional) — 模型 encoder 最后一层的输出处的 hidden-states 序列。

  • encoder_hidden_states (tuple(torch.FloatTensor), optional, 当传递 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — torch.FloatTensor 元组 (如果模型有嵌入层，则为嵌入输出的元组 + 每个层的输出的元组)，形状为 (batch_size, sequence_length, hidden_size)。

    encoder 在每一层输出处的 Hidden-states，加上可选的初始嵌入输出。

  • encoder_attentions (tuple(torch.FloatTensor), optional, 当传递 output_attentions=True 或当 config.output_attentions=True 时返回) — torch.FloatTensor 元组 (每层一个)，形状为 (batch_size, num_heads, sequence_length, sequence_length)。

    encoder 的 attentions 权重，在 attention softmax 之后，用于计算 self-attention head 中的加权平均值。

  • loc (torch.FloatTensor of shape (batch_size,) or (batch_size, input_size), optional) — 每个时间序列上下文窗口的 Shift 值，用于使模型输入具有相同的大小，然后用于移回原始大小。

  • scale (torch.FloatTensor of shape (batch_size,) or (batch_size, input_size), optional) — 每个时间序列上下文窗口的 Scaling 值，用于使模型输入具有相同的大小，然后用于重新缩放回原始大小。

  • static_features (torch.FloatTensor of shape (batch_size, feature size), optional) — 批次中每个时间序列的静态特征，在推理时复制到 covariates。

InformerForPrediction 的 forward 方法覆盖了 __call__ 特殊方法。

尽管 forward pass 的配方需要在该函数内定义，但应该在此之后调用 Module 实例，而不是此函数，因为前者负责运行预处理和后处理步骤，而后者会静默地忽略它们。

示例

>>> from huggingface_hub import hf_hub_download
>>> import torch
>>> from transformers import InformerForPrediction

>>> file = hf_hub_download(
...     repo_id="hf-internal-testing/tourism-monthly-batch", filename="train-batch.pt", repo_type="dataset"
... )
>>> batch = torch.load(file)

>>> model = InformerForPrediction.from_pretrained(
...     "huggingface/informer-tourism-monthly"
... )

>>> # during training, one provides both past and future values
>>> # as well as possible additional features
>>> outputs = model(
...     past_values=batch["past_values"],
...     past_time_features=batch["past_time_features"],
...     past_observed_mask=batch["past_observed_mask"],
...     static_categorical_features=batch["static_categorical_features"],
...     static_real_features=batch["static_real_features"],
...     future_values=batch["future_values"],
...     future_time_features=batch["future_time_features"],
... )

>>> loss = outputs.loss
>>> loss.backward()

>>> # during inference, one only provides past values
>>> # as well as possible additional features
>>> # the model autoregressively generates future values
>>> outputs = model.generate(
...     past_values=batch["past_values"],
...     past_time_features=batch["past_time_features"],
...     past_observed_mask=batch["past_observed_mask"],
...     static_categorical_features=batch["static_categorical_features"],
...     static_real_features=batch["static_real_features"],
...     future_time_features=batch["future_time_features"],
... )

>>> mean_prediction = outputs.sequences.mean(dim=1)
< > 在 GitHub 上更新

←Autoformer PatchTSMixer→