Hugging Face 的 LOGO

Transformers 文档

Autoformer

Hugging Face's logo
加入 Hugging Face 社区

并获得增强的文档体验

开始使用

Autoformer

PyTorch

概述

Autoformer 模型由 Haixu Wu、Jiehui Xu、Jianmin Wang、Mingsheng Long 在 Autoformer: Decomposition Transformers with Auto-Correlation for Long-Term Series Forecasting 中提出。

该模型将 Transformer 增强为一种深度分解架构，可以在预测过程中逐步分解趋势和季节性成分。

论文摘要如下：

延长预测时间是实际应用的关键需求，例如极端天气预警和长期能源消耗规划。本文研究了时间序列的长期预测问题。现有的基于 Transformer 的模型采用各种自注意力机制来发现长程依赖关系。然而，长期未来复杂的时序模式阻碍了模型发现可靠的依赖关系。此外，Transformer 为了提高长序列的效率，必须采用点式自注意力的稀疏版本，导致信息利用瓶颈。超越 Transformer，我们将 Autoformer 设计为一种新颖的具有自相关机制的分解架构。我们打破了序列分解的预处理惯例，并将其创新为深度模型的基本内部模块。这种设计使 Autoformer 具备了处理复杂时间序列的渐进分解能力。此外，受随机过程理论的启发，我们设计了基于序列周期性的自相关机制，该机制在子序列级别进行依赖关系发现和表示聚合。自相关在效率和准确性方面均优于自注意力。在长期预测中，Autoformer 取得了最先进的准确性，在六个基准上相对提高了 38%，涵盖了五种实际应用：能源、交通、经济、天气和疾病。

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

资源

Hugging Face 官方和社区（以🌎表示）资源列表，帮助您快速入门。如果您有兴趣提交资源以供此处收录，请随时打开 Pull Request，我们将对其进行审查！资源应理想地展示一些新内容，而不是重复现有资源。

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: list = [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[list[int]] = None embedding_dimension: typing.Optional[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, 可选, 默认为 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。
  • 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) — 是否使用过去的键/值注意力（如果适用于模型）以加快解码速度。
  • 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.config

AutoformerModel

class transformers.AutoformerModel

< >

( config: AutoformerConfig )

参数

  • config (AutoformerConfig) — 模型配置类，包含模型的所有参数。使用配置文件进行初始化不会加载与模型相关的权重，只加载配置。请查阅 from_pretrained() 方法以加载模型权重。

裸 Autoformer 模型，输出原始隐藏状态，顶部没有任何特定头。

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

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

forward

< >

( 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 ) → 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 (形状为 (batch_size, number of static real features) 的 torch.FloatTensor, 可选) — 可选的静态实值特征，模型将添加到时间序列的值中。

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

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

  • future_values (形状为 (batch_size, prediction_length) 的 torch.FloatTensor) — 时间序列的未来值，用作模型的标签。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 的额外嵌入。

  • 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，用户可以选择仅输入最后一个 input_ids（那些没有将其过去的键值状态提供给此模型的）的形状 (batch_size, 1)，而不是所有 input_ids 的形状 (batch_size, sequence_length)。

  • output_hidden_states (bool，可选) — 是否返回所有层的隐藏状态。有关详细信息，请参阅返回张量下的 hidden_states。
  • output_attentions (bool，可选) — 是否返回所有注意力层的注意力张量。有关详细信息，请参阅返回张量下的 attentions。
  • use_cache (bool，可选) — 如果设置为 True，将返回 past_key_values 键值状态，并可用于加速解码（参见 past_key_values）。
  • 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)，可选，默认为 None) — 模型编码器最后一层输出的隐藏状态序列。

  • 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)，可选) — 批次中每个时间序列的静态特征，在推理时复制到协变量中。

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

The AutoformerModel forward 方法，覆盖了 __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_state

AutoformerForPrediction

class transformers.AutoformerForPrediction

< >

( config: AutoformerConfig )

参数

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

Autoformer 模型，顶部带有一个分布头，用于时间序列预测。

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

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

forward

< >

( 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 ) → transformers.modeling_outputs.Seq2SeqTSPredictionOutput or 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)) — 时间序列的未来值，作为模型的标签。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 的额外嵌入。

  • 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，用户可以选择仅输入最后一个 input_ids（那些没有将其过去的键值状态提供给此模型的）的形状 (batch_size, 1)，而不是所有 input_ids 的形状 (batch_size, sequence_length)。

  • output_hidden_states (bool，可选) — 是否返回所有层的隐藏状态。有关详细信息，请参阅返回张量下的 hidden_states。
  • output_attentions (bool，可选) — 是否返回所有注意力层的注意力张量。有关详细信息，请参阅返回张量下的 attentions。
  • use_cache (bool，可选) — 如果设置为 True，将返回 past_key_values 键值状态，并可用于加速解码（参见 past_key_values）。
  • 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 (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)，可选) — 批次中每个时间序列的静态特征，在推理时复制到协变量。

The AutoformerForPrediction forward 方法，覆盖了 __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。为此，根据数据集中此类特征的数量（对于 tourism_monthly 数据集，它

等于 1），在 AutoformerConfig 中设置 num_static_real_features，初始化模型并按如下方式调用

>>> 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"],
... )
< > 在 GitHub 上更新

←Trajectory Transformer Informer→