Hugging Face的标志

Transformers 文档

时间序列Transformer

Hugging Face's logo
加入Hugging Face社区

并获得增强型文档体验

入门

时间序列Transformer

概览

时间序列Transformer模型是一个用于时间序列预测的普通编码器-解码器Transformer。这个模型是由kashif贡献的。

使用技巧

  • 与库中的其他模型类似，TimeSeriesTransformerModel 是没有头部结构的原始Transformer，而TimeSeriesTransformerForPrediction 在前者之上添加了一个分布式头部，可用于时间序列预测。请注意，这是一个所谓的概率预测模型，而不是点预测模型。这意味着模型学习一个分布，从中可以进行采样。模型不会直接输出值。
  • TimeSeriesTransformerForPrediction 由两个模块组成：编码器，它将一段长度为context_length 的时间序列值作为输入（称为past_values），以及解码器，它预测未来一段长度为prediction_length 的时间序列值（称为future_values）。在训练过程中，需要向模型提供（past_values 和 future_values）对。
  • 除了原始的 (past_values 和 future_values) 之外，通常还会向模型提供其他特征。这些特征可能是以下几种：
    • past_time_features: 时间特征，模型会将其添加到 past_values 中。这些特征作为 Transformer 编码器的“位置编码”。示例包括作为标量值的“月份中的日期”，“年份中的月份”等（然后将它们堆叠在一起形成一个向量）。例如，如果给定时间序列值是在 8 月 11 日获得的，那么时间特征向量可以是 [11, 8]（11 表示“月份中的日期”，8 表示“年份中的月份”）。
    • future_time_features: 时间特征，模型会将其添加到 future_values 中。这些特征作为 Transformer 解码器的“位置编码”。示例包括作为标量值的“月份中的日期”，“年份中的月份”等（然后将它们堆叠在一起形成一个向量）。例如，如果给定时间序列值是在 8 月 11 日获得的，那么时间特征向量可以是 [11, 8]（11 表示“月份中的日期”，8 表示“年份中的月份”）。
    • static_categorical_features: 随时间推移保持不变的类别特征（即，对于所有 past_values 和 future_values 都具有相同的值）。这里的一个例子是标识给定时间序列的商店 ID 或区域 ID。请注意，这些特征需要在所有数据点（包括未来数据点）中已知。
    • static_real_features: 随时间推移保持不变的实值特征（即，对于所有 past_values 和 future_values 都具有相同的值）。这里的一个例子是拥有时间序列值的商品的图像表示（例如，如果您拥有关于鞋子销售的时间序列，那么“鞋子”图片的ResNet嵌入）。请注意，这些特征需要在所有数据点（包括未来数据点）中已知。
  • 模型使用“教师强迫”进行训练，类似于 Transformer 用于机器翻译的方式。这意味着在训练过程中，将 future_values 向右移动一位作为解码器的输入，并用 past_values 的最后一个值作为前缀。在每个时间步长，模型需要预测下一个目标。因此，训练设置类似于用于语言的 GPT 模型，只是没有 decoder_start_token_id 的概念（我们只是使用上下文的最后一个值作为解码器的初始输入）。
  • 在推理时，我们将 past_values 的最终值作为解码器的输入。接下来，我们可以从模型中采样，以在下一个时间步长进行预测，然后将其输入解码器以进行下一个预测（也称为自回归生成）。

资源

以下列出了官方的Hugging Face和社区（用🌎标识）资源，可以帮助您入门。如果您想提交一个要包含在列表中的资源，请随时打开一个Pull Request，我们将对其进行审查！该资源应理想地演示一些新内容，而不是重复现有资源。

TimeSeriesTransformerConfig

class transformers.TimeSeriesTransformerConfig

< >

( prediction_length: Optional = None context_length: Optional = None distribution_output: str = 'student_t' loss: str = 'nll' input_size: int = 1 lags_sequence: List = [1, 2, 3, 4, 5, 6, 7] scaling: Union = 'mean' num_dynamic_real_features: int = 0 num_static_categorical_features: int = 0 num_static_real_features: int = 0 num_time_features: int = 0 cardinality: Optional = None embedding_dimension: Optional = None 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' d_model: int = 64 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 = 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) — 解码器层的数量。
  • 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) — 编码器和解码器中所有全连接层的丢弃概率。
  • 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) — 每个推理时间步并行生成的样本数量。
  • use_cache (bool, 可选, 默认值为 True) — 是否使用过去的键/值注意力（如果模型适用）来加速解码。

    示例 -

这是用于存储 TimeSeriesTransformerModel 配置的配置类。它用于根据指定的参数实例化时间序列 Transformer 模型，定义模型架构。使用默认值实例化配置将生成与时间序列 Transformer huggingface/time-series-transformer-tourism-monthly 架构类似的配置。

配置对象继承自 PretrainedConfig 可用于控制模型输出。阅读 PretrainedConfig 的文档以获取更多信息。

>>> from transformers import TimeSeriesTransformerConfig, TimeSeriesTransformerModel

>>> # Initializing a Time Series Transformer configuration with 12 time steps for prediction
>>> configuration = TimeSeriesTransformerConfig(prediction_length=12)

>>> # Randomly initializing a model (with random weights) from the configuration
>>> model = TimeSeriesTransformerModel(configuration)

>>> # Accessing the model configuration
>>> configuration = model.config

TimeSeriesTransformerModel

class transformers.TimeSeriesTransformerModel

< >

( config: TimeSeriesTransformerConfig )

参数

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

裸时间序列 Transformer 模型，输出原始隐藏状态，没有任何特定头部。此模型继承自 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 (形状为 (batch_size, sequence_length) 或 (batch_size, sequence_length, input_size) 的 torch.FloatTensor) — 时间序列的过去值，作为预测未来的上下文。此张量的序列大小必须大于模型的 context_length，因为模型将使用更大的尺寸来构建滞后特征，即从过去添加的附加值，以作为“额外上下文”。

    这里的 sequence_length 等于 config.context_length + max(config.lags_sequence)，如果未配置 lags_sequence，则等于 config.context_length + 7（因为默认情况下，config.lags_sequence 中最大的回溯索引为 7）。属性 _past_length 返回过去的实际长度。

    past_values 是 Transformer 编码器作为输入获得的内容（带有可选的附加特征，如 static_categorical_features、static_real_features、past_time_features 和滞后）。

    可选地，需要使用零替换缺失值，并通过 past_observed_mask 指示。

    对于多元时间序列，需要 input_size > 1 维度，对应于每个时间步长时间序列中的变量数量。

  • past_time_features (形状为 (batch_size, sequence_length, num_features) 的 torch.FloatTensor) — 模型将在内部添加到 past_values 中的必需时间特征。这些可能是像“一年中的月份”、“一个月中的哪一天”等，以向量形式编码（例如，作为傅里叶特征）。这些也可以是所谓的“年龄”特征，它基本上帮助模型知道时间序列“处于生命中的哪个阶段”。年龄特征对于遥远的过去时间步长具有较小的值，并且随着我们越接近当前时间步长而单调递增。节日特征也是时间特征的一个很好的例子。

    这些特征充当输入的“位置编码”。因此，与 BERT 等模型相反，BERT 在内部从头开始学习位置编码作为模型的参数，时间序列 Transformer 需要提供额外的时间特征。时间序列 Transformer 仅针对 static_categorical_features 学习额外的嵌入。

    可以将额外的动态实际协变量连接到此张量，但前提是这些特征在预测时必须已知。

    这里的 num_features 等于 config.num_time_features+config.num_dynamic_real_features`。

  • past_observed_mask (形状为 (batch_size, sequence_length) 或 (batch_size, sequence_length, input_size) 的 torch.BoolTensor，可选) — 布尔掩码，指示哪些 past_values 被观测到，哪些缺失。掩码值选择在 [0, 1] 中：

    • 1 表示被观测到的值，
    • 0 表示被缺失的值（即被零替换的 NaN）。
  • static_categorical_features (形状为 (batch_size, 静态分类特征的数量) 的 torch.LongTensor，可选) — 模型将为其学习嵌入的可选静态分类特征，它将添加到时间序列的值中。

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

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

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

    静态实际特征是指对所有时间步长具有相同值的特征（随时间保持静态）。

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

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

    这里的序列长度等于 prediction_length。

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

    可选地，在训练期间，任何缺失值都需要使用零替换，并通过 future_observed_mask 指示。

    对于多元时间序列，需要 input_size > 1 维度，对应于每个时间步长时间序列中的变量数量。

  • future_time_features (形状为 (batch_size, prediction_length, num_features) 的 torch.FloatTensor) — 模型将在内部添加到 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), 可选) — 掩码以避免对某些 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), 可选) — 掩码以使编码器中注意力模块的选定头部无效。掩码值选取 [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（那些没有将其过去的键值状态提供给该模型的）形状为 (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 时），包含根据配置 (TimeSeriesTransformerConfig) 和输入的不同元素。

  • 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) 元组，每个元组具有形状为 (batch_size, num_heads, sequence_length, embed_size_per_head)) 的 2 个张量和 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), 可选) — 批次中每个时间序列的静态特征，这些特征在推理时复制到协变量。

该 TimeSeriesTransformerModel 正向方法覆盖了 __call__ 特殊方法。

尽管正向传递的配方需要在此函数中定义，但之后应该调用 Module 实例，而不是此函数，因为前者负责运行前处理和后处理步骤，而后者则默默地忽略它们。

示例

>>> from huggingface_hub import hf_hub_download
>>> import torch
>>> from transformers import TimeSeriesTransformerModel

>>> file = hf_hub_download(
...     repo_id="hf-internal-testing/tourism-monthly-batch", filename="train-batch.pt", repo_type="dataset"
... )
>>> batch = torch.load(file)

>>> model = TimeSeriesTransformerModel.from_pretrained("huggingface/time-series-transformer-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

TimeSeriesTransformerForPrediction

class transformers.TimeSeriesTransformerForPrediction

< >

( config: TimeSeriesTransformerConfig )

参数

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

具有用于时间序列预测的分布式头的 Time Series Transformer 模型。该模型继承自 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 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, 静态分类特征数量)，可选) — 模型将学习嵌入的可选静态分类特征，它将添加到时间序列的值中。

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

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

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

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

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

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

    此处的序列长度等于 prediction_length。

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

    可选地，在训练期间，任何缺失值都需要用零替换，并通过 future_observed_mask 指示。

    对于多元时间序列，需要 input_size > 1 维度，并且对应于每个时间步长中时间序列中变量的数量。

  • future_time_features (torch.FloatTensor 形状为 (batch_size, prediction_length, num_features)) — 预测窗口所需的时序特征，模型将在内部将这些特征添加到 future_values 中。这些可能是“年中的月份”、“月中的日期”等作为向量编码的特征（例如，作为傅里叶特征）。这些特征也可以是所谓的“年龄”特征，这些特征基本上可以帮助模型了解时间序列“在生命中的哪个阶段”。年龄特征对于遥远的过去时间步长具有较小的值，并且随着我们越来越接近当前时间步长而单调递增。假日特征也是时序特征的一个很好的例子。

    这些特征充当输入的“位置编码”。因此，与 BERT 等模型不同，BERT 在内部从头开始学习位置编码作为模型的参数，时间序列 Transformer 需要提供额外的时序特征。时间序列 Transformer 仅学习 static_categorical_features 的额外嵌入。

    可以将额外的动态实值协变量连接到此张量，但前提是必须在预测时知道这些特征。

    此处的 num_features 等于 config.num_time_features+config.num_dynamic_real_features`。

  • future_observed_mask (torch.BoolTensor 形状为 (batch_size, sequence_length) 或 (batch_size, sequence_length, input_size)，可选) — 布尔掩码，用于指示哪些 future_values 被观察到，哪些是缺失的。掩码值选择在 [0, 1] 中：

    • 1 表示观察到的值，
    • 0 表示缺失的值（即用零替换的 NaN）。

    此掩码用于过滤掉最终损失计算中缺失的值。

  • 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)) 元组，每个元组包含两个形状为 (batch_size, num_heads, sequence_length, embed_size_per_head) 的张量，以及两个形状为 (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 (形状为 (batch_size, sequence_length, hidden_size) 的 torch.FloatTensor, 可选) — 可选地，您可以选择直接传递嵌入表示，而不是传递 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 时），包含根据配置 (TimeSeriesTransformerConfig) 和输入的不同元素。

  • 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) 元组，每个元组具有形状为 (batch_size, num_heads, sequence_length, embed_size_per_head)) 的 2 个张量和 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), 可选) — 批次中每个时间序列的静态特征，这些特征在推理时复制到协变量。

该 TimeSeriesTransformerForPrediction 正向方法覆盖了 __call__ 特殊方法。

尽管正向传递的配方需要在此函数中定义，但之后应该调用 Module 实例，而不是此函数，因为前者负责运行前处理和后处理步骤，而后者则默默地忽略它们。

示例

>>> from huggingface_hub import hf_hub_download
>>> import torch
>>> from transformers import TimeSeriesTransformerForPrediction

>>> file = hf_hub_download(
...     repo_id="hf-internal-testing/tourism-monthly-batch", filename="train-batch.pt", repo_type="dataset"
... )
>>> batch = torch.load(file)

>>> model = TimeSeriesTransformerForPrediction.from_pretrained(
...     "huggingface/time-series-transformer-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 上更新

←PatchTST Graphormer→