Hugging Face's logo

Transformers 文档

时间序列 Transformer

Hugging Face's logo
加入 Hugging Face 社区

并获取增强的文档体验

开始使用

时间序列 Transformer

PyTorch

概述

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

使用技巧

  • 与库中的其他模型类似，TimeSeriesTransformerModel 是原始的 Transformer，顶部没有任何 head，而 TimeSeriesTransformerForPrediction 在前者之上添加了一个分布 head，可用于时间序列预测。请注意，这是一个所谓的概率预测模型，而不是点预测模型。这意味着模型学习一个分布，可以从中采样。模型不会直接输出值。
  • TimeSeriesTransformerForPrediction 由 2 个模块组成：一个编码器，它以 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 嵌入）。请注意，这些特征需要为所有数据点（也包括未来的数据点）已知。
  • 该模型使用“teacher-forcing”进行训练，类似于 Transformer 如何用于机器翻译的训练方式。这意味着，在训练期间，将 future_values 向右移动一个位置作为解码器的输入，并在前面加上 past_values 的最后一个值。在每个时间步，模型都需要预测下一个目标。因此，训练的设置类似于用于语言的 GPT 模型，只是没有 decoder_start_token_id 的概念（我们只是使用上下文的最后一个值作为解码器的初始输入）。
  • 在推理时，我们将 past_values 的最终值作为解码器的输入。接下来，我们可以从模型中采样以预测下一个时间步，然后将其馈送到解码器，以便进行下一个预测（也称为自回归生成）。

资源

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

TimeSeriesTransformerConfig

class transformers.TimeSeriesTransformerConfig

< >

( 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: typing.Union[str, bool, NoneType] = '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: typing.Optional[typing.List[int]] = None embedding_dimension: typing.Optional[typing.List[int]] = 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) — 解码器层数。
  • 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) — 是否使用过去的键/值注意力（如果适用于模型）来加速解码。
  • 示例 —

这是配置类，用于存储 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: 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.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 (torch.BoolTensor, 形状为 (batch_size, sequence_length) 或 (batch_size, sequence_length, input_size), 可选) — 布尔掩码，用于指示哪些 past_values 是被观察到的，哪些是缺失的。 掩码值选自 [0, 1]：

    • 1 表示值是被观察到的，
    • 0 表示值是缺失的 (即已被零替换的 NaN)。
  • static_categorical_features (torch.LongTensor, 形状为 (batch_size, number of static categorical features), 可选) — 可选的静态类别特征，模型将为其学习嵌入，并将其添加到时间序列的值中。

    静态类别特征是在所有时间步都具有相同值的特征（在时间上是静态的）。

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

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

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

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

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

    这里的序列长度等于 prediction_length。

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

    可选地，在训练期间，任何缺失值都需要替换为零，并通过 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), 可选) — 掩码，用于避免对某些 token 索引执行 attention。 掩码值选自 [0, 1]：

    • 1 表示 token 是未被掩码的，
    • 0 表示 token 是被掩码的。

    什么是 attention 掩码？

  • decoder_attention_mask (torch.LongTensor, 形状为 (batch_size, target_sequence_length), 可选) — 掩码，用于避免对某些 token 索引执行 attention。 默认情况下，将使用因果掩码，以确保模型只能查看先前的输入以预测未来。
  • head_mask (torch.Tensor, 形状为 (encoder_layers, encoder_attention_heads), 可选) — 掩码，用于使 encoder 中 attention 模块的选定 head 失效。 掩码值选自 [0, 1]：

    • 1 表示 head 是未被掩码的，
    • 0 表示 head 是被掩码的。
  • decoder_head_mask (torch.Tensor, 形状为 (decoder_layers, decoder_attention_heads), 可选) — 掩码，用于使 decoder 中 attention 模块的选定 head 失效。 掩码值选自 [0, 1]：

    • 1 表示 head 是未被掩码的，
    • 0 表示 head 是被掩码的。
  • cross_attn_head_mask (torch.Tensor, 形状为 (decoder_layers, decoder_attention_heads), 可选) — 掩码，用于使 cross-attention 模块的选定 head 失效。 掩码值选自 [0, 1]：

    • 1 表示 head 是未被掩码的，
    • 0 表示 head 是被掩码的。
  • encoder_outputs (tuple(tuple(torch.FloatTensor), 可选) — 元组由 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)) 元组，其中每个元组具有 2 个形状为 (batch_size, num_heads, sequence_length, embed_size_per_head) 的张量，以及 2 个形状为 (batch_size, num_heads, encoder_sequence_length, embed_size_per_head) 的附加张量。

    包含预先计算的 hidden-states（self-attention 块和 cross-attention 块中的键和值），可以用于（参见 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, 可选) — 是否返回所有 attention 层的 attentions 张量。 有关更多详细信息，请参阅返回的张量下的 attentions。
  • output_hidden_states (bool, 可选) — 是否返回所有层的 hidden states。 有关更多详细信息，请参阅返回的张量下的 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)) — 模型 decoder 的最后一层输出的 hidden-states 序列。

    如果使用 past_key_values，则仅输出形状为 (batch_size, 1, hidden_size) 的序列的最后一个 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) 的附加张量。

    包含预先计算的 hidden-states（self-attention 块和 cross-attention 块中的键和值），可以用于（参见 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 在每一层输出的 Hidden-states，加上可选的初始嵌入输出。

  • decoder_attentions (tuple(torch.FloatTensor), 可选, 当传递 output_attentions=True 或当 config.output_attentions=True 时返回) — torch.FloatTensor 的元组（每层一个），形状为 (batch_size, num_heads, sequence_length, sequence_length)。

    decoder 的 attentions 权重，在 attention softmax 之后，用于计算 self-attention head 中的加权平均值。

  • cross_attentions (tuple(torch.FloatTensor), 可选, 当传递 output_attentions=True 或当 config.output_attentions=True 时返回) — torch.FloatTensor 的元组（每层一个），形状为 (batch_size, num_heads, sequence_length, sequence_length)。

    decoder 的 cross-attention 层的 attentions 权重，在 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 的元组（如果模型具有嵌入层，则为嵌入输出一个，+ 每层输出一个），形状为 (batch_size, sequence_length, hidden_size)。

    encoder 在每一层输出的 Hidden-states，加上可选的初始嵌入输出。

  • encoder_attentions (tuple(torch.FloatTensor), 可选, 当传递 output_attentions=True 或当 config.output_attentions=True 时返回) — torch.FloatTensor 的元组（每层一个），形状为 (batch_size, num_heads, sequence_length, sequence_length)。

    encoder 的 attentions 权重，在 attention softmax 之后，用于计算 self-attention head 中的加权平均值。

  • 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 forward 方法，覆盖了 __call__ 特殊方法。

尽管 forward 传递的配方需要在该函数中定义，但应该在之后调用 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: 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.Seq2SeqTSModelOutput or 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 的位置编码是从头开始作为模型的参数在内部学习的，而 Time Series Transformer 需要提供额外的时间特征。 Time Series Transformer 仅学习 static_categorical_features 的额外嵌入。

    附加的动态实值协变量可以连接到此张量，但需要注意的是，这些特征必须在预测时已知。

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

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

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

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

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

  • static_real_features (torch.FloatTensor，形状为 (batch_size, number of static real features), 可选) — 可选的静态实值特征，模型会将其添加到时间序列的值中。

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

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

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

    此处的序列长度等于 prediction_length。

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

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

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

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

    这些特征充当输入的“位置编码”。 因此，与 BERT 等模型相反，BERT 的位置编码是从头开始作为模型的参数在内部学习的，而 Time Series Transformer 需要提供额外的时间特征。 Time Series 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), 可选) — 掩码，用于使编码器中注意力模块的选定 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，则用户可以选择仅输入最后一次的 decoder_input_ids（那些没有将其过去键值状态提供给此模型的），形状为 (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_values 键值状态，并且可以用于加速解码（请参阅 past_key_values）。
  • output_attentions (bool, 可选) — 是否返回所有注意力层的注意力张量。 有关更多详细信息，请参见返回张量下的 attentions。
  • output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。 有关更多详细信息，请参见返回张量下的 hidden_states。
  • return_dict (bool, optional) — 是否返回 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)) — 模型 decoder 的最后一层输出的 hidden-states 序列。

    如果使用 past_key_values，则仅输出形状为 (batch_size, 1, hidden_size) 的序列的最后一个 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) 的附加张量。

    包含预先计算的 hidden-states（self-attention 块和 cross-attention 块中的键和值），可以用于（参见 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 在每一层输出的 Hidden-states，加上可选的初始嵌入输出。

  • decoder_attentions (tuple(torch.FloatTensor), 可选, 当传递 output_attentions=True 或当 config.output_attentions=True 时返回) — torch.FloatTensor 的元组（每层一个），形状为 (batch_size, num_heads, sequence_length, sequence_length)。

    decoder 的 attentions 权重，在 attention softmax 之后，用于计算 self-attention head 中的加权平均值。

  • cross_attentions (tuple(torch.FloatTensor), 可选, 当传递 output_attentions=True 或当 config.output_attentions=True 时返回) — torch.FloatTensor 的元组（每层一个），形状为 (batch_size, num_heads, sequence_length, sequence_length)。

    decoder 的 cross-attention 层的 attentions 权重，在 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 的元组（如果模型具有嵌入层，则为嵌入输出一个，+ 每层输出一个），形状为 (batch_size, sequence_length, hidden_size)。

    encoder 在每一层输出的 Hidden-states，加上可选的初始嵌入输出。

  • encoder_attentions (tuple(torch.FloatTensor), 可选, 当传递 output_attentions=True 或当 config.output_attentions=True 时返回) — torch.FloatTensor 的元组（每层一个），形状为 (batch_size, num_heads, sequence_length, sequence_length)。

    encoder 的 attentions 权重，在 attention softmax 之后，用于计算 self-attention head 中的加权平均值。

  • 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 的 forward 方法，覆盖了 __call__ 特殊方法。

尽管 forward 传递的配方需要在该函数中定义，但应该在之后调用 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)
< > 更新 on GitHub

←PatchTST Graphormer→