Hugging Face 的 LOGO

Transformers 文档

Informer 模型

Hugging Face's logo
加入 Hugging Face 社区

并获得增强的文档体验

开始使用

Informer 模型

PyTorch

概述

Informer 模型由 Haoyi Zhou、Shanghang Zhang、Jieqi Peng、Shuai Zhang、Jianxin Li、Hui Xiong 和 Wancai Zhang 在 Informer: 超越高效 Transformer 的长序列时间序列预测 中提出。

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

论文摘要如下：

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

该模型由 elisim 和 kashif 贡献。原始代码可在 此处 找到。

资源

官方 Hugging Face 和社区 (🌎 表示) 资源列表，可帮助您入门。如果您有兴趣提交资源以包含在此处，请随时打开拉取请求，我们将对其进行审核！理想情况下，资源应展示新内容，而不是重复现有资源。

InformerConfig

class transformers.InformerConfig

< >

( prediction_length: typing.Optional[int] = None context_length: typing.Optional[int] = None distribution_output: str = 'student_t' loss: str = 'nll' input_size: int = 1 lags_sequence: typing.Optional[list[int]] = None scaling: typing.Union[str, bool, NoneType] = '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: typing.Optional[list[int]] = None embedding_dimension: typing.Optional[list[int]] = 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, 可选, 默认为 prediction_length) — 编码器的上下文长度。如果为 None，上下文长度将与 prediction_length 相同。
  • distribution_output (string, 可选, 默认为 "student_t") — 模型的分发输出头。可以是“student_t”、“normal”或“negative_binomial”。
  • loss (string, 可选, 默认为 "nll") — 与 distribution_output 头对应的模型损失函数。对于参数分布，它是负对数似然 (nll) - 目前是唯一支持的。
  • input_size (int, 可选, 默认为 1) — 目标变量的大小，对于单变量目标，默认为 1。对于多变量目标，将大于 1。
  • scaling (string 或 bool, 可选, 默认为 "mean") — 是否通过“均值”缩放器、“标准差”缩放器或不使用缩放器（如果为 None）来缩放输入目标。如果为 True，则缩放器设置为“均值”。
  • lags_sequence (list[int], 可选, 默认为 [1, 2, 3, 4, 5, 6, 7]) — 输入时间序列的滞后项作为协变量，通常由数据频率决定。默认为 [1, 2, 3, 4, 5, 6, 7]，但我们建议根据数据集进行适当更改。
  • num_time_features (int, 可选, 默认为 0) — 输入时间序列中的时间特征数量。
  • num_dynamic_real_features (int, 可选, 默认为 0) — 动态实值特征的数量。
  • num_static_categorical_features (int, 可选, 默认为 0) — 静态分类特征的数量。
  • num_static_real_features (int, 可选, 默认为 0) — 静态实值特征的数量。
  • cardinality (list[int], 可选) — 每个静态分类特征的基数（不同值的数量）。应为整数列表，其长度与 num_static_categorical_features 相同。如果 num_static_categorical_features 大于 0，则不能为 None。
  • embedding_dimension (list[int], 可选) — 每个静态分类特征的嵌入维度。应为整数列表，其长度与 num_static_categorical_features 相同。如果 num_static_categorical_features 大于 0，则不能为 None。
  • d_model (int, 可选, 默认为 64) — Transformer 层的维度。
  • encoder_layers (int, 可选, 默认为 2) — 编码器层数。
  • decoder_layers (int, 可选, 默认为 2) — 解码器层数。
  • encoder_attention_heads (int, 可选, 默认为 2) — Transformer 编码器中每个注意力层的注意力头数量。
  • decoder_attention_heads (int, 可选, 默认为 2) — Transformer 解码器中每个注意力层的注意力头数量。
  • encoder_ffn_dim (int, 可选, 默认为 32) — 编码器中“中间”（通常称为前馈）层的维度。
  • decoder_ffn_dim (int, 可选, 默认为 32) — 解码器中“中间”（通常称为前馈）层的维度。
  • activation_function (str 或 function, 可选, 默认为 "gelu") — 编码器和解码器中的非线性激活函数（函数或字符串）。如果为字符串，则支持 "gelu" 和 "relu"。
  • dropout (float, 可选, 默认为 0.1) — 编码器和解码器中所有全连接层的 dropout 概率。
  • encoder_layerdrop (float, 可选, 默认为 0.1) — 每个编码器层中注意力层和全连接层的 dropout 概率。
  • decoder_layerdrop (float, 可选, 默认为 0.1) — 每个解码器层中注意力层和全连接层的 dropout 概率。
  • attention_dropout (float, 可选, 默认为 0.1) — 注意力概率的 dropout 概率。
  • activation_dropout (float, 可选, 默认为 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 (InformerConfig) — 包含模型所有参数的模型配置类。用配置文件初始化不加载与模型关联的权重，只加载配置。请查看 from_pretrained() 方法来加载模型权重。

裸 Informer 模型，输出原始隐藏状态，不带任何特定头。

该模型继承自 PreTrainedModel。请查看超类文档，了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头等）。

该模型也是 PyTorch torch.nn.Module 子类。请将其用作常规 PyTorch 模块，并参考 PyTorch 文档中所有与通用用法和行为相关的内容。

前向传播

< >

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

参数

  • past_values (形状为 (batch_size, sequence_length) 或 (batch_size, sequence_length, input_size) 的 torch.FloatTensor) — 时间序列的过去值，作为预测未来的上下文。此张量的序列大小必须大于模型的 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 (形状为 (batch_size, sequence_length, num_features) 的 torch.FloatTensor) — 所需的时间特征，模型将在内部添加到 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, 静态分类特征的数量)，可选) — 可选的静态分类特征，模型将为其学习嵌入，并将其添加到时间序列的值中。

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

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

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

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

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

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

    这里的序列长度等于 prediction_length。

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

    可选地，在训练期间，任何缺失值都需要用零替换，并通过 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`。

  • decoder_attention_mask (torch.LongTensor，形状为 (batch_size, target_sequence_length)，可选) — 用于避免对特定标记索引执行注意力的掩码。默认情况下，将使用因果掩码，以确保模型只能查看先前的输入以预测未来。
  • head_mask (torch.Tensor，形状为 (num_heads,) 或 (num_layers, num_heads)，可选) — 用于使自注意力模块的选定头部无效的掩码。掩码值选自 [0, 1]：

    • 1 表示头部未被遮蔽，
    • 0 表示头部被遮蔽。
  • decoder_head_mask (torch.Tensor，形状为 (decoder_layers, decoder_attention_heads)，可选) — 用于使解码器中注意力模块的选定头部无效的掩码。掩码值选自 [0, 1]：

    • 1 表示头部未被遮蔽，
    • 0 表示头部被遮蔽。
  • cross_attn_head_mask (torch.Tensor，形状为 (decoder_layers, decoder_attention_heads)，可选) — 用于使交叉注意力模块的选定头部无效的掩码。掩码值选自 [0, 1]：

    • 1 表示头部未被遮蔽，
    • 0 表示头部被遮蔽。
  • encoder_outputs (tuple(tuple(torch.FloatTensor)，可选) — 元组包含 last_hidden_state、hidden_states (可选) 和 attentions (可选) last_hidden_state，形状为 (batch_size, sequence_length, hidden_size) (可选)，是编码器最后一层输出的隐藏状态序列。在解码器的交叉注意力中使用。
  • past_key_values (list[torch.FloatTensor]，可选) — 预计算的隐藏状态（自注意力块和交叉注意力块中的键和值），可用于加速顺序解码。这通常包括模型在解码前一阶段返回的 past_key_values，当 use_cache=True 或 config.use_cache=True 时。

    允许两种格式：

    • 一个 Cache 实例，详见我们的 kv 缓存指南；
    • 长度为 config.n_layers 的 tuple(torch.FloatTensor) 元组，每个元组包含 2 个形状为 (batch_size, num_heads, sequence_length, embed_size_per_head) 的张量。这也被称为传统缓存格式。

    模型将输出与输入相同的缓存格式。如果未传入 past_key_values，则将返回传统缓存格式。

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

  • output_hidden_states (bool，可选) — 是否返回所有层的隐藏状态。更多详情请参阅返回张量下的 hidden_states。
  • output_attentions (bool，可选) — 是否返回所有注意力层的注意力张量。更多详情请参阅返回张量下的 attentions。
  • use_cache (bool，可选) — 如果设置为 True，则返回 past_key_values 键值状态，可用于加速解码（参见 past_key_values）。
  • return_dict (bool，可选) — 是否返回 ModelOutput 而不是普通元组。
  • cache_position (torch.LongTensor，形状为 (sequence_length)，可选) — 指示输入序列标记在序列中位置的索引。与 position_ids 相反，此张量不受填充影响。它用于在正确位置更新缓存并推断完整的序列长度。

返回

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，形状为 (batch_size, sequence_length, hidden_size)) — 模型解码器最后一层输出的隐藏状态序列。

    如果使用了 past_key_values，则只输出形状为 (batch_size, 1, hidden_size) 的序列的最后一个隐藏状态。

  • past_key_values (EncoderDecoderCache，可选，当传入 use_cache=True 或 config.use_cache=True 时返回) — 这是一个 EncoderDecoderCache 实例。更多详情请参见我们的 kv 缓存指南。

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

  • decoder_hidden_states (tuple(torch.FloatTensor)，可选，当传入 output_hidden_states=True 或 config.output_hidden_states=True 时返回) — torch.FloatTensor 的元组（如果模型有嵌入层，则一个用于嵌入输出，加上一个用于每个层的输出），形状为 (batch_size, sequence_length, hidden_size)。

    解码器在每个层输出的隐藏状态，加上可选的初始嵌入输出。

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

    解码器的注意力权重，在注意力 softmax 之后，用于计算自注意力头中的加权平均。

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

    解码器交叉注意力层的注意力权重，在注意力 softmax 之后，用于计算交叉注意力头中的加权平均。

  • encoder_last_hidden_state (torch.FloatTensor，形状为 (batch_size, sequence_length, hidden_size)，可选) — 模型编码器最后一层输出的隐藏状态序列。

  • encoder_hidden_states (tuple(torch.FloatTensor)，可选，当传入 output_hidden_states=True 或 config.output_hidden_states=True 时返回) — torch.FloatTensor 的元组（如果模型有嵌入层，则一个用于嵌入输出，加上一个用于每个层的输出），形状为 (batch_size, sequence_length, hidden_size)。

    编码器在每个层输出的隐藏状态，加上可选的初始嵌入输出。

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

    编码器的注意力权重，在注意力 softmax 之后，用于计算自注意力头中的加权平均。

  • loc (torch.FloatTensor，形状为 (batch_size,) 或 (batch_size, input_size)，可选) — 每个时间序列上下文窗口的偏移值，用于使模型输入具有相同量级，然后用于移回原始量级。

  • scale (torch.FloatTensor，形状为 (batch_size,) 或 (batch_size, input_size)，可选) — 每个时间序列上下文窗口的缩放值，用于使模型输入具有相同量级，然后用于缩放回原始量级。

  • static_features (torch.FloatTensor，形状为 (batch_size, feature size)，可选) — 批次中每个时间序列的静态特征，在推理时复制到协变量。

InformerModel 的前向传播方法，覆盖了 __call__ 特殊方法。

尽管前向传播的配方需要在此函数中定义，但在此之后应调用 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 (InformerConfig) — 包含模型所有参数的模型配置类。使用配置文件初始化并不会加载与模型相关的权重，只加载配置。请查看 from_pretrained() 方法以加载模型权重。

具有预测分布头部的 Informer 模型，用于时间序列预测。

该模型继承自 PreTrainedModel。请查看超类文档，了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头等）。

该模型也是 PyTorch torch.nn.Module 子类。请将其用作常规 PyTorch 模块，并参考 PyTorch 文档中所有与通用用法和行为相关的内容。

前向传播

 < >

( past_values: Tensor past_time_features: Tensor past_observed_mask: Tensor static_categorical_features: typing.Optional[torch.Tensor] = None static_real_features: typing.Optional[torch.Tensor] = None future_values: typing.Optional[torch.Tensor] = None future_time_features: typing.Optional[torch.Tensor] = None future_observed_mask: typing.Optional[torch.Tensor] = None decoder_attention_mask: typing.Optional[torch.LongTensor] = None head_mask: typing.Optional[torch.Tensor] = None decoder_head_mask: typing.Optional[torch.Tensor] = None cross_attn_head_mask: typing.Optional[torch.Tensor] = None encoder_outputs: typing.Optional[list[torch.FloatTensor]] = None past_key_values: typing.Optional[list[torch.FloatTensor]] = None output_hidden_states: typing.Optional[bool] = None output_attentions: typing.Optional[bool] = None use_cache: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None cache_position: typing.Optional[torch.LongTensor] = 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, 静态分类特征的数量)，可选) — 可选的静态分类特征，模型将为其学习嵌入，并将其添加到时间序列的值中。

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

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

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

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

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

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

    这里的序列长度等于 prediction_length。

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

    可选地，在训练期间，任何缺失值都需要用零替换，并通过 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）。

    此掩码用于过滤掉缺失值以进行最终损失计算。

  • decoder_attention_mask (torch.LongTensor，形状为 (batch_size, target_sequence_length)，可选) — 用于避免对特定标记索引执行注意力的掩码。默认情况下，将使用因果掩码，以确保模型只能查看先前的输入以预测未来。
  • head_mask (torch.Tensor，形状为 (num_heads,) 或 (num_layers, num_heads)，可选) — 用于使自注意力模块的选定头部无效的掩码。掩码值选自 [0, 1]：

    • 1 表示头部未被遮蔽，
    • 0 表示头部被遮蔽。
  • decoder_head_mask (torch.Tensor，形状为 (decoder_layers, decoder_attention_heads)，可选) — 用于使解码器中注意力模块的选定头部无效的掩码。掩码值选自 [0, 1]：

    • 1 表示头部未被遮蔽，
    • 0 表示头部被遮蔽。
  • cross_attn_head_mask (torch.Tensor，形状为 (decoder_layers, decoder_attention_heads)，可选) — 用于使交叉注意力模块的选定头部无效的掩码。掩码值选自 [0, 1]：

    • 1 表示头部未被遮蔽，
    • 0 表示头部被遮蔽。
  • encoder_outputs (tuple(tuple(torch.FloatTensor)，可选) — 元组包含 last_hidden_state、hidden_states (可选) 和 attentions (可选) last_hidden_state，形状为 (batch_size, sequence_length, hidden_size) (可选)，是编码器最后一层输出的隐藏状态序列。在解码器的交叉注意力中使用。
  • past_key_values (list[torch.FloatTensor]，可选) — 预计算的隐藏状态（自注意力块和交叉注意力块中的键和值），可用于加速顺序解码。这通常包括模型在解码前一阶段返回的 past_key_values，当 use_cache=True 或 config.use_cache=True 时。

    允许两种格式：

    • 一个 Cache 实例，详见我们的 kv 缓存指南；
    • 长度为 config.n_layers 的 tuple(torch.FloatTensor) 元组，每个元组包含 2 个形状为 (batch_size, num_heads, sequence_length, embed_size_per_head) 的张量。这也被称为传统缓存格式。

    模型将输出与输入相同的缓存格式。如果未传入 past_key_values，则将返回传统缓存格式。

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

  • output_hidden_states (bool，可选) — 是否返回所有层的隐藏状态。更多详情请参阅返回张量下的 hidden_states。
  • output_attentions (bool，可选) — 是否返回所有注意力层的注意力张量。更多详情请参阅返回张量下的 attentions。
  • use_cache (bool，可选) — 如果设置为 True，则返回 past_key_values 键值状态，可用于加速解码（参见 past_key_values）。
  • return_dict (bool，可选) — 是否返回 ModelOutput 而不是普通元组。
  • cache_position (torch.LongTensor，形状为 (sequence_length)，可选) — 指示输入序列标记在序列中位置的索引。与 position_ids 相反，此张量不受填充影响。它用于在正确位置更新缓存并推断完整的序列长度。

返回

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，形状为 (batch_size, sequence_length, hidden_size)) — 模型解码器最后一层输出的隐藏状态序列。

    如果使用了 past_key_values，则只输出形状为 (batch_size, 1, hidden_size) 的序列的最后一个隐藏状态。

  • past_key_values (EncoderDecoderCache，可选，当传入 use_cache=True 或 config.use_cache=True 时返回) — 这是一个 EncoderDecoderCache 实例。更多详情请参见我们的 kv 缓存指南。

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

  • decoder_hidden_states (tuple(torch.FloatTensor)，可选，当传入 output_hidden_states=True 或 config.output_hidden_states=True 时返回) — torch.FloatTensor 的元组（如果模型有嵌入层，则一个用于嵌入输出，加上一个用于每个层的输出），形状为 (batch_size, sequence_length, hidden_size)。

    解码器在每个层输出的隐藏状态，加上可选的初始嵌入输出。

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

    解码器的注意力权重，在注意力 softmax 之后，用于计算自注意力头中的加权平均。

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

    解码器交叉注意力层的注意力权重，在注意力 softmax 之后，用于计算交叉注意力头中的加权平均。

  • encoder_last_hidden_state (torch.FloatTensor，形状为 (batch_size, sequence_length, hidden_size)，可选) — 模型编码器最后一层输出的隐藏状态序列。

  • encoder_hidden_states (tuple(torch.FloatTensor)，可选，当传入 output_hidden_states=True 或 config.output_hidden_states=True 时返回) — torch.FloatTensor 的元组（如果模型有嵌入层，则一个用于嵌入输出，加上一个用于每个层的输出），形状为 (batch_size, sequence_length, hidden_size)。

    编码器在每个层输出的隐藏状态，加上可选的初始嵌入输出。

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

    编码器的注意力权重，在注意力 softmax 之后，用于计算自注意力头中的加权平均。

  • loc (torch.FloatTensor，形状为 (batch_size,) 或 (batch_size, input_size)，可选) — 每个时间序列上下文窗口的偏移值，用于使模型输入具有相同量级，然后用于移回原始量级。

  • scale (torch.FloatTensor，形状为 (batch_size,) 或 (batch_size, input_size)，可选) — 每个时间序列上下文窗口的缩放值，用于使模型输入具有相同量级，然后用于缩放回原始量级。

  • static_features (torch.FloatTensor，形状为 (batch_size, feature size)，可选) — 批次中每个时间序列的静态特征，在推理时复制到协变量。

InformerForPrediction 的前向传播方法，覆盖了 __call__ 特殊方法。

尽管前向传播的配方需要在此函数中定义，但在此之后应调用 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→