Autoformer
概述
Autoformer 模型由吴海旭、徐杰辉、王建民、龙明盛在 Autoformer: 用于长期序列预测的自相关分解 Transformer 中提出。
该模型将 Transformer 增强为一种深度分解架构，可以在预测过程中逐步分解趋势和季节性成分。
论文摘要如下：
扩展预测时间是实际应用中的关键需求，例如极端天气预警和长期能源消耗规划。本文研究了时间序列的长期预测问题。先前的基于 Transformer 的模型采用各种自注意力机制来发现长期依赖关系。然而，长期未来的复杂时间模式阻碍了模型找到可靠的依赖关系。此外，Transformer 必须采用点式自注意力的稀疏版本来提高长序列效率，导致信息利用瓶颈。超越 Transformer，我们设计了 Autoformer 作为一种新颖的分解架构，并具有自动相关机制。我们打破了序列分解的预处理惯例，并将其革新为深度模型的基本内部模块。这种设计赋予 Autoformer 复杂时间序列的渐进分解能力。此外，受随机过程理论的启发，我们基于序列周期性设计了自动相关机制，该机制在子序列级别进行依赖关系发现和表示聚合。自动相关在效率和准确性方面均优于自注意力。在长期预测中，Autoformer 实现了最先进的准确率，在六个基准测试中相对提高了 38%，涵盖五个实际应用：能源、交通、经济、天气和疾病。
该模型由 elisim 和 kashif 贡献。原始代码可以在这里找到 here。
资源
官方 Hugging Face 和社区（🌎 表示）资源列表，帮助您入门。如果您有兴趣提交要包含在此处的资源，请随时打开拉取请求，我们会进行审核！理想情况下，该资源应展示一些新内容，而不是重复现有资源。
- 查看 HuggingFace 博客中的 Autoformer 博客文章：是的，Transformer 对时间序列预测有效（+ Autoformer）
AutoformerConfig
类 transformers.AutoformerConfig
< 源代码 >( prediction_length: 可选 = None context_length: 可选 = None distribution_output: str = 'student_t' loss: str = 'nll' input_size: int = 1 lags_sequence: 列表 = [1, 2, 3, 4, 5, 6, 7] scaling: bool = True num_time_features: int = 0 num_dynamic_real_features: int = 0 num_static_categorical_features: int = 0 num_static_real_features: int = 0 cardinality: 可选 = None embedding_dimension: 可选 = None d_model: int = 64 encoder_attention_heads: int = 2 decoder_attention_heads: int = 2 encoder_layers: int = 2 decoder_layers: int = 2 encoder_ffn_dim: int = 32 decoder_ffn_dim: int = 32 activation_function: str = 'gelu' dropout: float = 0.1 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: bool = True is_encoder_decoder = True label_length: int = 10 moving_average: int = 25 autocorrelation_factor: int = 3 **kwargs )
参数
- prediction_length (
int) — 解码器的预测长度。换句话说，模型的预测范围。 - context_length (
int, 可选, 默认为prediction_length) — 编码器的上下文长度。如果未设置，上下文长度将与prediction_length相同。 - distribution_output (
string，可选，默认为"student_t") — 模型的分布发射头。可以是“student_t”、“normal”或“negative_binomial”。 - loss (
string，可选，默认为"nll") — 与distribution_output头相对应的模型的损失函数。对于参数分布，它是负对数似然（nll）——目前是唯一支持的。 - input_size (
int，可选，默认为 1) — 目标变量的大小，对于单变量目标，默认为 1。如果是多变量目标，则 > 1。 - lags_sequence (
list[int]，可选，默认为[1, 2, 3, 4, 5, 6, 7]) — 输入时间序列的滞后作为协变量，通常由频率决定。默认为[1, 2, 3, 4, 5, 6, 7]。 - scaling (
bool，可选，默认为True) — 是否缩放输入目标。 - 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。 - 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 概率。 - attention_dropout (
float，可选，默认为 0.1) — 注意力概率的丢弃概率。 - activation_dropout (
float，可选，默认为 0.1) — 前馈网络两层之间使用的丢弃概率。 - num_parallel_samples (
int，可选，默认为 100) — 推理每个时间步并行生成的样本数。 - init_std (
float，可选，默认为 0.02) — 截断正态权重初始化分布的标准差。 - use_cache (
bool，可选，默认为True) — 是否使用过去的键/值注意力（如果适用于模型）来加速解码。 - label_length (
int，可选，默认为 10) — Autoformer 解码器的起始标记长度，用于直接多步预测（即非自回归生成）。 - moving_average (
int，可选，默认为 25) — 移动平均的窗口大小。在实践中，它是分解层中 AvgPool1d 的核大小。 - autocorrelation_factor (
int，可选，默认为 3) — “注意力”（即自相关机制）因子，用于查找前 k 个自相关延迟。论文建议将其设置为 1 到 5 之间的数字。
这是一个配置类，用于存储 AutoformerModel 的配置。它用于根据指定的参数实例化 Autoformer 模型，定义模型架构。使用默认值实例化配置将产生与 Autoformer huggingface/autoformer-tourism-monthly 架构类似的配置。
配置对象继承自 PretrainedConfig，可用于控制模型输出。阅读 PretrainedConfig 中的文档以获取更多信息。
>>> from transformers import AutoformerConfig, AutoformerModel
>>> # Initializing a default Autoformer configuration
>>> configuration = AutoformerConfig()
>>> # Randomly initializing a model (with random weights) from the configuration
>>> model = AutoformerModel(configuration)
>>> # Accessing the model configuration
>>> configuration = model.configAutoformerModel
类 transformers.AutoformerModel
< 源代码 >( config: AutoformerConfig )
参数
- config (AutoformerConfig) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型相关的权重，仅加载配置。查看 from_pretrained() 方法以加载模型权重。
基本的 Autoformer 模型，输出原始隐藏状态，没有任何特定的头部。此模型继承自 PreTrainedModel。查看超类文档以了解库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头部等）。
此模型也是 PyTorch torch.nn.Module 的子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档了解与一般用法和行为相关的所有事项。
forward
< 源代码 >( past_values: 张量 past_time_features: 张量 past_observed_mask: 张量 static_categorical_features: 可选 static_real_features: 可选 future_values: 可选 future_time_features: 可选 decoder_attention_mask: 可选 head_mask: 可选 decoder_head_mask: 可选 cross_attn_head_mask: 可选 encoder_outputs: 可选 past_key_values: 可选 output_hidden_states: 可选 output_attentions: 可选 use_cache: 可选 return_dict: 可选 ) → transformers.models.autoformer.modeling_autoformer.AutoformerModelOutput 或 tuple(torch.FloatTensor)
参数
- past_values (
torch.FloatTensor形状为(batch_size, sequence_length)) — 时间序列的过去值，作为预测未来的上下文。这些值可能包含滞后值，即为了提供“额外上下文”而添加的过去附加值。past_values是 Transformer 编码器作为输入获得的内容（以及可选的附加特征，例如static_categorical_features、static_real_features、past_time_features）。此处的序列长度等于
context_length+max(config.lags_sequence)。缺失值需要替换为零。
- past_time_features (
torch.FloatTensor形状为(batch_size, sequence_length, num_features)，可选) — 可选的时间特征，模型会在内部将其添加到past_values中。这些可能是“一年中的月份”、“一个月中的日期”等编码为向量的特征（例如作为傅里叶特征）。这些也可能是所谓的“年龄”特征，基本上可以帮助模型了解时间序列处于“生命中的哪个阶段”。年龄特征对于较远的过去时间步长具有较小的值，并且随着我们越接近当前时间步长而单调递增。这些特征用作输入的“位置编码”。因此，与 BERT 等模型相反，BERT 中的位置编码是从头开始作为模型的参数学习的，时间序列 Transformer 需要提供额外的时间特征。
Autoformer 仅为
static_categorical_features学习额外的嵌入。 - past_observed_mask (
torch.BoolTensor形状为(batch_size, sequence_length)，可选) — 布尔掩码，用于指示哪些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)) — 时间序列的未来值，作为模型的标签。给定past_values，Transformer 需要学习输出future_values。详情请参阅演示笔记本和代码片段。
缺失值需要用零替换。
- future_time_features (
torch.FloatTensor形状为(batch_size, prediction_length, num_features), 可选) — 可选的时间特征，模型会在内部将其添加到future_values中。这些特征可以是“一年中的月份”、“一个月中的日期”等编码为向量的特征（例如傅里叶特征）。这些也可以是所谓的“年龄”特征，它帮助模型了解时间序列处于“生命中的哪个阶段”。年龄特征在较远的过去时间步长具有较小的值，并随着我们越来越接近当前时间步长而单调递增。这些特征充当输入的“位置编码”。因此，与 BERT 等模型不同，BERT 的位置编码是从头开始作为模型的参数学习的，时间序列 Transformer 需要提供额外的特征。
Autoformer 仅为
static_categorical_features学习额外的嵌入。 - 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，则用户可以选择仅输入形状为(batch_size, 1)的最后一个decoder_input_ids（这些decoder_input_ids未向此模型提供其过去的键值状态），而不是形状为(batch_size, sequence_length)的所有decoder_input_ids。 - 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.models.autoformer.modeling_autoformer.AutoformerModelOutput 或 tuple(torch.FloatTensor)
一个 transformers.models.autoformer.modeling_autoformer.AutoformerModelOutput 或 torch.FloatTensor 的元组（如果传递了 return_dict=False 或 config.return_dict=False），包含取决于配置 (AutoformerConfig) 和输入的各种元素。
-
last_hidden_state (
torch.FloatTensor形状为(batch_size, sequence_length, hidden_size)) — 模型解码器最后一层输出处的隐藏状态序列。如果使用
past_key_values，则仅输出形状为(batch_size, 1, hidden_size)的序列的最后一个隐藏状态。 -
trend (
torch.FloatTensor形状为(batch_size, sequence_length, 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)，可选) — 批次中每个时间序列的静态特征，在推理时复制到协变量中。
AutoformerModel 正向方法覆盖了 __call__ 特殊方法。
尽管正向传递的配方需要在此函数中定义，但之后应该调用 Module 实例而不是此函数，因为前者负责运行预处理和后处理步骤，而后者则默默地忽略它们。
示例
>>> from huggingface_hub import hf_hub_download
>>> import torch
>>> from transformers import AutoformerModel
>>> file = hf_hub_download(
... repo_id="hf-internal-testing/tourism-monthly-batch", filename="train-batch.pt", repo_type="dataset"
... )
>>> batch = torch.load(file)
>>> model = AutoformerModel.from_pretrained("huggingface/autoformer-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"],
... future_values=batch["future_values"],
... future_time_features=batch["future_time_features"],
... )
>>> last_hidden_state = outputs.last_hidden_stateAutoformerForPrediction
类 transformers.AutoformerForPrediction
< 源代码 >( config: AutoformerConfig )
参数
- config (AutoformerConfig) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型关联的权重，仅加载配置。查看 from_pretrained() 方法来加载模型权重。
顶部带有分布式头的 Autoformer 模型，用于时间序列预测。此模型继承自 PreTrainedModel。查看超类文档以了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入的大小、修剪注意力头等）。
此模型也是 PyTorch torch.nn.Module 的子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档了解与一般用法和行为相关的所有事项。
forward
< 源代码 >( past_values: 张量 past_time_features: 张量 past_observed_mask: 张量 static_categorical_features: 可选 = None static_real_features: 可选 = None future_values: 可选 = None future_time_features: 可选 = None future_observed_mask: 可选 = None decoder_attention_mask: 可选 = None head_mask: 可选 = None decoder_head_mask: 可选 = None cross_attn_head_mask: 可选 = None encoder_outputs: 可选 = None past_key_values: 可选 = None output_hidden_states: 可选 = None output_attentions: 可选 = None use_cache: 可选 = None return_dict: 可选 = None ) → transformers.modeling_outputs.Seq2SeqTSPredictionOutput 或 tuple(torch.FloatTensor)
参数
- past_values (
torch.FloatTensor形状为(batch_size, sequence_length)) — 时间序列的过去值，作为预测未来的上下文。这些值可能包含滞后值，即为了提供“额外上下文”而添加的过去附加值。past_values是 Transformer 编码器作为输入获得的内容（以及可选的附加特征，例如static_categorical_features、static_real_features、past_time_features）。此处的序列长度等于
context_length+max(config.lags_sequence)。缺失值需要替换为零。
- past_time_features (
torch.FloatTensor形状为(batch_size, sequence_length, num_features)，可选) — 可选的时间特征，模型将在内部将其添加到past_values中。这些可能是诸如“一年中的月份”、“一个月中的日期”等作为向量编码的内容（例如作为傅里叶特征）。这些也可能是所谓的“年龄”特征，它基本上可以帮助模型了解时间序列“生命中的哪个阶段”。年龄特征对于遥远的过去时间步长具有较小的值，并且随着我们越来越接近当前时间步长而单调递增。这些特征充当输入的“位置编码”。因此，与 BERT 等模型相反，BERT 中的位置编码是从头开始作为模型的参数学习的，时间序列 Transformer 需要提供额外的时间特征。
Autoformer 仅学习
static_categorical_features的额外嵌入。 - past_observed_mask (
torch.BoolTensor形状为(batch_size, sequence_length)，可选) — 布尔掩码，用于指示哪些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)) — 时间序列的未来值，作为模型的标签。给定past_values，future_values是 Transformer 需要学习输出的内容。有关详细信息，请参阅演示笔记本和代码片段。
缺失值需要替换为零。
- future_time_features (
torch.FloatTensor形状为(batch_size, prediction_length, 特征数量)，可选) — 可选的时间特征，模型将在内部将其添加到future_values中。这些可以是作为向量编码的“一年中的月份”、“一个月中的日期”等（例如作为傅里叶特征）。这些也可以是所谓的“年龄”特征，这些特征基本上可以帮助模型了解时间序列的“生命中的哪个阶段”。年龄特征对于遥远的过去时间步长具有较小的值，并且随着我们越来越接近当前时间步长而单调递增。这些特征充当输入的“位置编码”。因此，与 BERT 等模型不同，BERT 中的位置编码是从头开始作为模型的参数学习的，而时间序列 Transformer 需要提供额外的特征。
Autoformer 只学习
static_categorical_features的额外嵌入。 - 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(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（其过去键值状态未提供给此模型）的形状为(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.Seq2SeqTSPredictionOutput 或 tuple(torch.FloatTensor)
transformers.modeling_outputs.Seq2SeqTSPredictionOutput 或 torch.FloatTensor 的元组（如果传递了 return_dict=False 或 config.return_dict=False），包含取决于配置（AutoformerConfig）和输入的各种元素。
-
loss (
torch.FloatTensor形状为(1,)，可选，当提供future_values时返回) — 分布式损失。 -
params (
torch.FloatTensor形状为(batch_size, num_samples, num_params)) — 所选分布的参数。 -
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)，可选) — 批次中每个时间序列的静态特征，在推理时复制到协变量中。
AutoformerForPrediction 的前向方法，覆盖了 __call__ 特殊方法。
尽管正向传递的配方需要在此函数中定义，但之后应该调用 Module 实例而不是此函数，因为前者负责运行预处理和后处理步骤，而后者则默默地忽略它们。
示例
>>> from huggingface_hub import hf_hub_download
>>> import torch
>>> from transformers import AutoformerForPrediction
>>> file = hf_hub_download(
... repo_id="hf-internal-testing/tourism-monthly-batch", filename="train-batch.pt", repo_type="dataset"
... )
>>> batch = torch.load(file)
>>> model = AutoformerForPrediction.from_pretrained("huggingface/autoformer-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"],
... 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"],
... future_time_features=batch["future_time_features"],
... )
>>> mean_prediction = outputs.sequences.mean(dim=1)AutoformerForPrediction 也可以使用 static_real_features。为此，请根据数据集中此类特征的数量在 AutoformerConfig 中设置 num_static_real_features（对于 tourism_monthly 数据集，它
等于 1），初始化模型并按如下所示调用
>>> from huggingface_hub import hf_hub_download
>>> import torch
>>> from transformers import AutoformerConfig, AutoformerForPrediction
>>> file = hf_hub_download(
... repo_id="hf-internal-testing/tourism-monthly-batch", filename="train-batch.pt", repo_type="dataset"
... )
>>> batch = torch.load(file)
>>> # check number of static real features
>>> num_static_real_features = batch["static_real_features"].shape[-1]
>>> # load configuration of pretrained model and override num_static_real_features
>>> configuration = AutoformerConfig.from_pretrained(
... "huggingface/autoformer-tourism-monthly",
... num_static_real_features=num_static_real_features,
... )
>>> # we also need to update feature_size as it is not recalculated
>>> configuration.feature_size += num_static_real_features
>>> model = AutoformerForPrediction(configuration)
>>> 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"],
... )