Transformers 文档

信息来源

Transformers

加入 Hugging Face 社区

并获得增强版文档体验

协作模型、数据集和空间

加速推理，体验更快的示例

切换文档主题

开始使用

Informer

概述

Informer 模型由周昊毅、张善航、彭洁琪、张帅、李建新、熊辉和张万才在 Informer: Beyond Efficient Transformer for Long Sequence Time-Series Forecasting 中提出。

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

论文摘要如下：

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

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

资源

以下列出了官方 Hugging Face 和社区（由 🌎 表示）资源，可以帮助您入门。如果您有兴趣提交资源以供在此处列出，请随时打开一个 Pull Request，我们将对其进行审核！资源理想情况下应该展示一些新内容，而不是重复现有资源。

在 HuggingFace 博客中查看 Informer 博客文章：使用 Informer 进行多元概率时间序列预测

InformerConfig

class transformers.InformerConfig

< 源代码 >

( prediction_length: 可选 = None context_length: 可选 = None distribution_output: str = 'student_t' loss: str = 'nll' input_size: int = 1 lags_sequence: 列表 = None scaling: 联合 = '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: 可选 = None embedding_dimension: 可选 = 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") — 是否通过“mean”缩放器、 “std”缩放器或 None 进行缩放器来缩放输入目标。如果为 True，缩放器将设置为“mean”。
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 编码器中每个注意力层的注意力头的数量。
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) — 编码器和解码器中所有全连接层的丢弃概率。
encoder_layerdrop (float, optional, defaults to 0.1) — 每个编码器层的注意力和全连接层的丢弃概率。
decoder_layerdrop (float, optional, defaults to 0.1) — 每个解码器层的注意力和全连接层的丢弃概率。
attention_dropout (float, optional, defaults to 0.1) — 注意力概率的丢弃概率。
activation_dropout (float, optional, defaults to 0.1) — 前馈网络两层之间使用的丢弃概率。
num_parallel_samples (int, optional, defaults to 100) — 每个推理时间步长并行生成的样本数。
init_std (float, optional, defaults to 0.02) — 截断正态权重初始化分布的标准差。
attention_type (str, 可选, 默认为“prob”) — 编码器中使用的注意力机制。可以设置为“prob” (Informer 的 ProbAttention) 或“full” (vanilla 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。

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

可选地，在训练期间，任何缺失值都需要用零替换并通过 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 形状为 (batch_size, sequence_length)，可选) — 掩码，避免对某些标记索引执行注意力。掩码值在 [0, 1] 中选择：
- 1 表示 未掩盖 的标记，
- 0 表示掩盖的标记。
什么是注意力掩码？
decoder_attention_mask (torch.LongTensor 形状为 (batch_size, target_sequence_length)，可选) — 掩码，避免对某些标记索引执行注意力。默认情况下，将使用因果掩码，以确保模型只能查看前面的输入以预测未来。
head_mask (torch.Tensor 形状为 (encoder_layers, encoder_attention_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 (tuple(tuple(torch.FloatTensor))，可选，当传入 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) 的张量）和 2 个形状为 (batch_size, num_heads, encoder_sequence_length, embed_size_per_head) 的附加张量。

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

如果使用 past_key_values，用户可以选择仅输入最后 decoder_input_ids（这些 ID 没有提供给此模型的过去键值状态）形状为 (batch_size, 1)，而不是所有 decoder_input_ids 形状为 (batch_size, sequence_length)。
inputs_embeds (torch.FloatTensor 形状为 (batch_size, sequence_length, hidden_size)，可选) — 可选地，您可以选择直接传入嵌入表示，而不是传入 input_ids。如果您想比模型的内部嵌入查找矩阵更能控制如何将 input_ids 索引转换为关联向量，这将很有用。
use_cache (bool, 可选) — 如果设置为 True，则返回 past_key_values 键值状态，可用于加速解码（参见 past_key_values）。
output_attentions (bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量中的 attentions。
output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量中的 hidden_states。
return_dict (bool, 可选) — 是否返回一个 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，形状为 (batch_size, sequence_length, hidden_size)) — 模型解码器最后一层的输出处的隐藏状态序列。

如果使用 past_key_values，则仅输出形状为 (batch_size, 1, hidden_size) 的序列的最后一个隐藏状态。
past_key_values (tuple(tuple(torch.FloatTensor)), 可选, 在传递 use_cache=True 或当 config.use_cache=True 时返回) — 长度为 config.n_layers 的 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 输入）加速顺序解码。
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

< source >

( config: InformerConfig )

参数

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

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

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

forward

< source >

( 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 或 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。

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

可选地，在训练期间，任何缺失值都需要用零替换并通过 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 形状为 (batch_size, sequence_length), 可选) — 用于避免对某些标记索引执行注意力的掩码。掩码值选择在 [0, 1] 中：
- 1 表示未屏蔽的标记，
- 0 表示屏蔽的标记。
什么是注意力掩码？
decoder_attention_mask (torch.LongTensor 形状为 (batch_size, target_sequence_length), 可选) — 用于避免对某些标记索引执行注意力的掩码。默认情况下，将使用因果掩码，以确保模型只能查看先前输入以预测未来。
head_mask (torch.Tensor 形状为 (encoder_layers, encoder_attention_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 (tuple(tuple(torch.FloatTensor)), *可选*, 当传递 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) 的张量和 2 个形状为 (batch_size, num_heads, encoder_sequence_length, embed_size_per_head) 的附加张量。

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

如果使用 past_key_values，用户可以选择只输入最后一个 decoder_input_ids（那些没有提供给该模型的过去键值状态的 decoder_input_ids），形状为 (batch_size, 1)，而不是所有 decoder_input_ids，形状为 (batch_size, sequence_length)。
inputs_embeds (torch.FloatTensor 形状为 (batch_size, sequence_length, hidden_size), *可选*) — 可选地，您可以选择直接传递嵌入表示，而不是传递 input_ids。如果您想要比模型的内部嵌入查找矩阵更好地控制如何将 input_ids 索引转换为相关向量，这将很有用。
use_cache (bool, *可选*) — 如果设置为 True，将返回 past_key_values 键值状态，可用于加速解码（参见 past_key_values）。
output_attentions (bool, *可选*) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量中的 attentions。
output_hidden_states (bool, *可选*) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量中的 hidden_states。
return_dict (bool, *可选*) — 是否返回 ModelOutput 而不是普通元组。

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

last_hidden_state (torch.FloatTensor，形状为 (batch_size, sequence_length, hidden_size)) — 模型解码器最后一层的输出处的隐藏状态序列。

如果使用 past_key_values，则仅输出形状为 (batch_size, 1, hidden_size) 的序列的最后一个隐藏状态。
past_key_values (tuple(tuple(torch.FloatTensor)), 可选, 在传递 use_cache=True 或当 config.use_cache=True 时返回) — 长度为 config.n_layers 的 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 输入）加速顺序解码。
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), 可选) — 一批中每个时间序列的静态特征，在推理时复制到协变量中。

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

示例

>>> 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→