Transformers 文档
Autoformer
并获得增强的文档体验
开始
Autoformer
概览
Autoformer 模型在 Autoformer: Decomposition Transformers with Auto-Correlation for Long-Term Series Forecasting 中被 Haixu Wu, Jiehui Xu, Jianmin Wang, Mingsheng Long 提出。
该模型将 Transformer 扩展为深度分解架构，可以在预测过程中逐步分解趋势和季节性成分。
论文摘要如下
扩展预测时间是实际应用的关键需求，例如极端天气预警和长期能源消耗规划。本文研究了时间序列的长期预测问题。先前的基于 Transformer 的模型采用各种自注意力机制来发现长距离依赖关系。然而，长期未来的复杂时间模式阻碍了模型找到可靠的依赖关系。此外，为了提高长序列效率，Transformer 必须采用点状自注意力的稀疏版本，从而导致信息利用瓶颈。超越 Transformer，我们设计了 Autoformer，这是一种具有自相关机制的新型分解架构。我们打破了序列分解的预处理惯例，并将其改造为深度模型的基本内部模块。这种设计使 Autoformer 具备了复杂时间序列的渐进分解能力。更进一步，受到随机过程理论的启发，我们基于序列周期性设计了自相关机制，该机制在子序列级别进行依赖关系发现和表示聚合。自相关在效率和准确性方面均优于自注意力。在长期预测中，Autoformer 取得了最先进的准确率，在六个基准测试中相对改进了 38%，涵盖了五个实际应用：能源、交通、经济、天气和疾病。
该模型由 elisim 和 kashif 贡献。原始代码可以在这里找到。
资源
以下是 Hugging Face 官方和社区 (🌎 指示) 资源列表，可帮助您入门。如果您有兴趣提交资源并将其包含在此处，请随时打开 Pull Request，我们将进行审核！理想情况下，资源应展示一些新内容，而不是重复现有资源。
- 查看 HuggingFace 博客中关于 Autoformer 的博文： 是的，Transformers 在时间序列预测中非常有效 (+ Autoformer)
AutoformerConfig
class transformers.AutoformerConfig
< 源码 >( 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.List[int] = [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: typing.Optional[typing.List[int]] = None embedding_dimension: typing.Optional[typing.List[int]] = 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, optional, defaults toprediction_length) — 编码器的上下文长度。如果未设置，上下文长度将与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。 - lags_sequence (
list[int], optional, defaults to[1, 2, 3, 4, 5, 6, 7]) — 输入时间序列作为协变量的滞后值，通常由频率决定。默认为[1, 2, 3, 4, 5, 6, 7]。 - scaling (
bool, optional defaults toTrue) — 是否缩放输入目标。 - 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, 可选, 默认为 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) — 是否使用过去的键/值注意力（如果模型适用）来加速解码。 - label_length (
int, 可选, 默认为 10) — Autoformer 解码器的起始标记长度，用于直接多步预测（即非自回归生成）。 - moving_average (
int, 可选, 默认为 25) — 移动平均窗口大小。实际上，它是 Decomposition Layer 中 AvgPool1d 的内核大小。 - autocorrelation_factor (
int, 可选, 默认为 3) — “注意力”（即 AutoCorrelation 机制）因子，用于查找前 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
class transformers.AutoformerModel
< source >( config: AutoformerConfig )
参数
- config (AutoformerConfig) — 带有模型所有参数的模型配置类。使用配置文件初始化不会加载与模型关联的权重，仅加载配置。查看 from_pretrained() 方法以加载模型权重。
裸 Autoformer 模型输出原始隐藏状态，顶部没有任何特定的 head。此模型继承自 PreTrainedModel。查看超类文档，了解库为其所有模型实现的通用方法（例如，下载或保存、调整输入嵌入大小、剪枝 head 等）。
此模型也是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参阅 PyTorch 文档以了解与常规用法和行为相关的所有事项。
forward
< source >( 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[typing.List[torch.FloatTensor]] = None past_key_values: typing.Optional[typing.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 ) → transformers.models.autoformer.modeling_autoformer.AutoformerModelOutput 或 tuple(torch.FloatTensor)
参数
- past_values (形状为
(batch_size, sequence_length)的torch.FloatTensor) — 时间序列的过去值，用作预测未来的上下文。这些值可能包含滞后项，即为了充当“额外上下文”而添加的来自过去的附加值。past_values是 Transformer 编码器接收的输入（带有可选的附加特征，例如static_categorical_features、static_real_features、past_time_features）。此处的序列长度等于
context_length+max(config.lags_sequence)。缺失值需要用零替换。
- past_time_features (形状为
(batch_size, sequence_length, num_features)的torch.FloatTensor, 可选) — 可选的时间特征，模型内部会将其添加到past_values。这些可以是诸如“一年中的月份”、“月份中的日期”等，编码为向量（例如，作为傅里叶特征）。这些也可以是所谓的“年龄”特征，它基本上帮助模型知道时间序列“处于生命周期的哪个阶段”。年龄特征对于遥远过去的时间步长具有小值，并且随着我们越来越接近当前时间步长而单调增加。这些特征充当输入的“位置编码”。因此，与像 BERT 这样的模型相反，BERT 的位置编码是从头开始作为模型的参数在内部学习的，时间序列 Transformer 需要提供额外的时间特征。
Autoformer 仅学习
static_categorical_features的附加嵌入。 - past_observed_mask (形状为
(batch_size, sequence_length)的torch.BoolTensor, 可选) — 布尔掩码，指示哪些past_values是观察到的，哪些是缺失的。掩码值在[0, 1]中选择：- 1 表示观察到的值，
- 0 表示缺失的值（即被零替换的 NaN）。
- static_categorical_features (形状为
(batch_size, number of static categorical features)的torch.LongTensor, 可选) — 可选的静态分类特征，模型将为其学习嵌入，并将其添加到时间序列的值中。静态分类特征是对于所有时间步长都具有相同值的特征（随时间静态）。
时间序列 ID 是静态分类特征的典型示例。
- static_real_features (
torch.FloatTensor，形状为(batch_size, number of static real features)，可选) — 可选的静态实值特征，模型会将其添加到时间序列的值中。静态实值特征是指在所有时间步都具有相同值的特征（随时间静态不变）。
促销信息是静态实值特征的典型示例。
- future_values (
torch.FloatTensor，形状为(batch_size, prediction_length)) — 时间序列的未来值，作为模型的标签。future_values是 Transformer 需要学习输出的内容，给定past_values。有关详细信息，请参阅演示 notebook 和代码片段。
缺失值需要替换为零。
- 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)，可选) — 用于避免对某些 token 索引执行 attention 的掩码。掩码值在[0, 1]中选择：- 1 表示 token 未被掩盖，
- 0 表示 token 被掩盖。
- decoder_attention_mask (
torch.LongTensor，形状为(batch_size, target_sequence_length)，可选) — 用于避免对某些 token 索引执行 attention 的掩码。默认情况下，将使用因果掩码，以确保模型只能查看先前的输入以预测未来。 - head_mask (
torch.Tensor，形状为(encoder_layers, encoder_attention_heads)，可选) — 用于 nullify encoder 中 attention 模块的选定 head 的掩码。掩码值在[0, 1]中选择：- 1 表示 head 未被掩盖，
- 0 表示 head 被掩盖。
- decoder_head_mask (
torch.Tensor，形状为(decoder_layers, decoder_attention_heads)，可选) — 用于 nullify decoder 中 attention 模块的选定 head 的掩码。掩码值在[0, 1]中选择：- 1 表示 head 未被掩盖，
- 0 表示 head 被掩盖。
- cross_attn_head_mask (
torch.Tensor，形状为(decoder_layers, decoder_attention_heads)，可选) — 用于 nullify cross-attention 模块的选定 head 的掩码。掩码值在[0, 1]中选择：- 1 表示 head 未被掩盖，
- 0 表示 head 被掩盖。
- encoder_outputs (
tuple(tuple(torch.FloatTensor)，可选) — Tuple 由last_hidden_state、hidden_states(可选) 和attentions(可选) 组成。last_hidden_state的形状为(batch_size, sequence_length, hidden_size)(可选)，是 encoder 最后一层输出的 hidden-states 序列。在 decoder 的 cross-attention 中使用。 - past_key_values (
tuple(tuple(torch.FloatTensor))，可选，当传递use_cache=True或config.use_cache=True时返回) — 长度为config.n_layers的tuple(tuple(torch.FloatTensor))的元组，每个 tuple 具有 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（那些没有将其 past key value states 提供给此模型的）的形状为(batch_size, 1)，而不是所有形状为(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_valueskey value states，并可用于加速解码（请参阅past_key_values）。 - output_attentions (
bool，可选) — 是否返回所有 attention 层的 attention tensors。有关更多详细信息，请参阅返回 tensors 下的attentions。 - output_hidden_states (
bool，可选) — 是否返回所有层的 hidden states。有关更多详细信息，请参阅返回 tensors 下的hidden_states。 - return_dict (
bool，可选) — 是否返回 ModelOutput 而不是普通的 tuple。
返回
transformers.models.autoformer.modeling_autoformer.AutoformerModelOutput 或 tuple(torch.FloatTensor)
一个 transformers.models.autoformer.modeling_autoformer.AutoformerModelOutput 或一个 torch.FloatTensor 的 tuple（如果传递了 return_dict=False 或当 config.return_dict=False 时），其中包含各种元素，具体取决于配置 (AutoformerConfig) 和输入。
-
last_hidden_state (
torch.FloatTensor，形状为(batch_size, sequence_length, hidden_size)) — 模型 decoder 的最后一层输出的 hidden-states 序列。如果使用了
past_key_values，则仅输出形状为(batch_size, 1, hidden_size)的序列的最后一个 hidden-state。 -
trend (
torch.FloatTensor，形状为(batch_size, sequence_length, hidden_size)) — 每个时间序列的趋势 tensor。 -
past_key_values (
tuple(tuple(torch.FloatTensor))，可选，当传递use_cache=True或config.use_cache=True时返回) — 长度为config.n_layers的tuple(tuple(torch.FloatTensor))的元组，每个 tuple 具有 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)，可选，当传递output_hidden_states=True或config.output_hidden_states=True时返回) —torch.FloatTensor的 tuple（如果模型具有嵌入层，则为嵌入输出一个，+ 每层输出一个），形状为(batch_size, sequence_length, hidden_size)。decoder 在每层输出的 Hidden-states 加上可选的初始嵌入输出。
-
decoder_attentions (
tuple(torch.FloatTensor)，可选，当传递output_attentions=True或config.output_attentions=True时返回) —torch.FloatTensor的 tuple（每层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。decoder 的 Attention 权重，在 attention softmax 之后，用于计算 self-attention head 中的加权平均值。
-
cross_attentions (
tuple(torch.FloatTensor)，可选，当传递output_attentions=True或config.output_attentions=True时返回) —torch.FloatTensor的 tuple（每层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。decoder 的 cross-attention 层的 Attention 权重，在 attention softmax 之后，用于计算 cross-attention head 中的加权平均值。
-
encoder_last_hidden_state (
torch.FloatTensor，形状为(batch_size, sequence_length, hidden_size)，可选) — 模型 encoder 的最后一层输出的 hidden-states 序列。 -
encoder_hidden_states (
tuple(torch.FloatTensor)，可选，当传递output_hidden_states=True或config.output_hidden_states=True时返回) —torch.FloatTensor的 tuple（如果模型具有嵌入层，则为嵌入输出一个，+ 每层输出一个），形状为(batch_size, sequence_length, hidden_size)。encoder 在每层输出的 Hidden-states 加上可选的初始嵌入输出。
-
encoder_attentions (
tuple(torch.FloatTensor)，可选，当传递output_attentions=True或config.output_attentions=True时返回) —torch.FloatTensor的 tuple（每层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。encoder 的 Attention 权重，在 attention softmax 之后，用于计算 self-attention head 中的加权平均值。
-
loc (
torch.FloatTensor，形状为(batch_size,)或(batch_size, input_size)，可选) — 每个时间序列上下文窗口的 Shift 值，用于使模型输入具有相同的幅度，然后用于移回原始幅度。 -
scale (
torch.FloatTensor，形状为(batch_size,)或(batch_size, input_size)，可选) — 每个时间序列上下文窗口的 Scaling 值，用于使模型输入具有相同的幅度，然后用于重新缩放回原始幅度。 -
static_features: (
torch.FloatTensor，形状为(batch_size, feature size)，可选) — 批次中每个时间序列的静态特征，在推理时复制到协变量。
AutoformerModel forward 方法，覆盖了 __call__ 特殊方法。
虽然 forward pass 的配方需要在该函数中定义，但应在此之后调用 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
class transformers.AutoformerForPrediction
< source >( config: AutoformerConfig )
参数
- config (AutoformerConfig) — 具有模型所有参数的模型配置类。使用配置文件初始化不会加载与模型关联的权重，仅加载配置。查看 from_pretrained() 方法以加载模型权重。
带有分布头的 Autoformer 模型，用于时间序列预测。该模型继承自 PreTrainedModel。查看超类文档，了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、剪枝 head 等）。
此模型也是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参阅 PyTorch 文档以了解与常规用法和行为相关的所有事项。
forward
< source >( 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[typing.List[torch.FloatTensor]] = None past_key_values: typing.Optional[typing.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 ) → 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, 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)) — 时间序列的未来值，用作模型的标签。future_values是 Transformer 需要学习输出的内容，给定past_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)，可选) — 掩码，用于避免对某些 token 索引执行注意力。 在[0, 1]中选择的掩码值：- 1 表示 未被掩码 的 token，
- 0 表示 已被掩码 的 token。
- decoder_attention_mask (
torch.LongTensor，形状为(batch_size, target_sequence_length)，可选) — 掩码，用于避免对某些 token 索引执行注意力。 默认情况下，将使用因果掩码，以确保模型只能查看之前的输入来预测未来。 - head_mask (
torch.Tensor，形状为(encoder_layers, encoder_attention_heads)，可选) — 掩码，用于使编码器中注意力模块的选定 head 失效。 在[0, 1]中选择的掩码值：- 1 表示 head 未被掩码，
- 0 表示 head 已被掩码。
- decoder_head_mask (
torch.Tensor，形状为(decoder_layers, decoder_attention_heads)，可选) — 掩码，用于使解码器中注意力模块的选定 head 失效。 在[0, 1]中选择的掩码值：- 1 表示 head 未被掩码，
- 0 表示 head 已被掩码。
- cross_attn_head_mask (
torch.Tensor，形状为(decoder_layers, decoder_attention_heads)，可选) — 掩码，用于使交叉注意力模块的选定 head 失效。 在[0, 1]中选择的掩码值：- 1 表示 head 未被掩码，
- 0 表示 head 已被掩码。
- encoder_outputs (
tuple(tuple(torch.FloatTensor)，可选) — 元组由last_hidden_state、hidden_states(可选) 和attentions(可选) 组成。 形状为(batch_size, sequence_length, hidden_size)(可选) 的last_hidden_state是编码器最后一层输出的隐藏状态序列。 在解码器的交叉注意力中使用。 - 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（那些没有将其过去键值状态提供给此模型的），而不是形状为(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.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(tuple(torch.FloatTensor))的元组，每个 tuple 具有 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)，可选，当传递output_hidden_states=True或config.output_hidden_states=True时返回) —torch.FloatTensor的 tuple（如果模型具有嵌入层，则为嵌入输出一个，+ 每层输出一个），形状为(batch_size, sequence_length, hidden_size)。解码器在每一层输出的隐藏状态以及初始嵌入输出。
-
decoder_attentions (
tuple(torch.FloatTensor)，可选，当传递output_attentions=True或config.output_attentions=True时返回) —torch.FloatTensor的 tuple（每层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。decoder 的 Attention 权重，在 attention softmax 之后，用于计算 self-attention head 中的加权平均值。
-
cross_attentions (
tuple(torch.FloatTensor)，可选，当传递output_attentions=True或config.output_attentions=True时返回) —torch.FloatTensor的 tuple（每层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。decoder 的 cross-attention 层的 Attention 权重，在 attention softmax 之后，用于计算 cross-attention head 中的加权平均值。
-
encoder_last_hidden_state (
torch.FloatTensor，形状为(batch_size, sequence_length, hidden_size)，可选) — 模型 encoder 的最后一层输出的 hidden-states 序列。 -
encoder_hidden_states (
tuple(torch.FloatTensor)，可选，当传递output_hidden_states=True或config.output_hidden_states=True时返回) —torch.FloatTensor的 tuple（如果模型具有嵌入层，则为嵌入输出一个，+ 每层输出一个），形状为(batch_size, sequence_length, hidden_size)。编码器在每一层输出的隐藏状态以及初始嵌入输出。
-
encoder_attentions (
tuple(torch.FloatTensor)，可选，当传递output_attentions=True或config.output_attentions=True时返回) —torch.FloatTensor的 tuple（每层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。encoder 的 Attention 权重，在 attention softmax 之后，用于计算 self-attention head 中的加权平均值。
-
loc (
torch.FloatTensor，形状为(batch_size,)或(batch_size, input_size)，可选) — 每个时间序列上下文窗口的 Shift 值，用于使模型输入具有相同的幅度，然后用于移回原始幅度。 -
scale (
torch.FloatTensor，形状为(batch_size,)或(batch_size, input_size)，可选) — 每个时间序列上下文窗口的 Scaling 值，用于使模型输入具有相同的幅度，然后用于重新缩放回原始幅度。 -
static_features (
torch.FloatTensor，形状为(batch_size, feature size)，可选) — 批次中每个时间序列的静态特征，在推理时复制到协变量。
The AutoformerForPrediction forward 方法，覆盖了 __call__ 特殊方法。
虽然 forward pass 的配方需要在该函数中定义，但应在此之后调用 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"],
... )