Transformers 文档
时间序列 Transformer
并获得增强的文档体验
开始使用
时间序列 Transformer
概述
时间序列 Transformer 模型是一个用于时间序列预测的普通编码器-解码器 Transformer。此模型由 kashif 贡献。
使用技巧
- 与库中的其他模型类似,TimeSeriesTransformerModel 是没有顶部的原始 Transformer,而 TimeSeriesTransformerForPrediction 在前者之上添加了一个分布头,可用于时间序列预测。请注意,这是一个所谓的概率预测模型,而不是点预测模型。这意味着模型学习一个分布,可以从中采样。模型不直接输出值。
- 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 嵌入,如果您的时间序列是关于鞋子销售的)。请注意,这些特征需要对所有数据点(也包括未来的数据点)都已知。
- 该模型使用“教师强制”进行训练,类似于 Transformer 用于机器翻译的训练方式。这意味着,在训练期间,将
future_values
向右移动一个位置作为解码器的输入,并在前面加上past_values
的最后一个值。在每个时间步,模型需要预测下一个目标。因此,训练设置类似于用于语言的 GPT 模型,除了没有decoder_start_token_id
的概念(我们只使用上下文的最后一个值作为解码器的初始输入)。 - 在推理时,我们将
past_values
的最终值作为输入提供给解码器。接下来,我们可以从模型中采样以在下一个时间步进行预测,然后将其输入到解码器以进行下一个预测(也称为自回归生成)。
资源
官方 Hugging Face 和社区(用 🌎 表示)资源的列表,以帮助您入门。如果您有兴趣提交资源以包含在此处,请随时打开拉取请求,我们将对其进行审查!该资源应理想地展示一些新内容,而不是重复现有资源。
- 查看 HuggingFace 博客中的时间序列 Transformer 博客文章:使用 🤗 Transformers 进行概率时间序列预测
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: list = [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[list[int]] = None embedding_dimension: typing.Optional[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"
) — 是否通过“均值”缩放器、“标准差”缩放器或不使用缩放器(如果为None
)来缩放输入目标。如果为True
,则缩放器设置为“均值”。 - 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 文档以了解与通用用法和行为相关的所有事项。
前向传播
< 源 >( 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 cache_position: typing.Optional[torch.LongTensor] = 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 (形状为
(batch_size, sequence_length)
或(batch_size, sequence_length, input_size)
的torch.BoolTensor
,可选) — 布尔掩码,指示哪些past_values
被观察到,哪些缺失。掩码值选自[0, 1]
:- 1 表示值被**观察到**,
- 0 表示值**缺失**(即被零替换的 NaNs)。
- 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
。 - decoder_attention_mask (形状为
(batch_size, target_sequence_length)
的torch.LongTensor
,可选) — 掩码,用于避免对某些词元索引执行注意力。默认情况下,将使用因果掩码,以确保模型只能查看先前的输入才能预测未来。 - head_mask (形状为
(num_heads,)
或(num_layers, num_heads)
的torch.Tensor
,可选) — 用于使自注意力模块的选定头部无效的掩码。掩码值选自[0, 1]
:- 1 表示头部**未被掩码**,
- 0 表示头部**被掩码**。
- decoder_head_mask (形状为
(decoder_layers, decoder_attention_heads)
的torch.Tensor
,可选) — 用于使解码器中注意力模块的选定头部无效的掩码。掩码值选自[0, 1]
:- 1 表示头部**未被掩码**,
- 0 表示头部**被掩码**。
- cross_attn_head_mask (形状为
(decoder_layers, decoder_attention_heads)
的torch.Tensor
,可选) — 用于使交叉注意力模块的选定头部无效的掩码。掩码值选自[0, 1]
:- 1 表示头部**未被掩码**,
- 0 表示头部**被掩码**。
- encoder_outputs (
tuple(tuple(torch.FloatTensor)
,可选) — 元组包含last_hidden_state
、hidden_states
(可选)和attentions
(可选)。形状为(batch_size, sequence_length, hidden_size)
的last_hidden_state
(可选)是编码器最后一层输出的隐藏状态序列。用于解码器的交叉注意力。 - past_key_values (
list[torch.FloatTensor]
, 可选) — 预计算的隐藏状态(自注意力块和交叉注意力块中的键和值),可用于加速序列解码。这通常包含模型在解码的先前阶段返回的past_key_values
,当use_cache=True
或config.use_cache=True
时。允许两种格式:
- Cache 实例,详见我们的 kv cache 指南;
- 长度为
config.n_layers
的tuple(torch.FloatTensor)
元组,每个元组包含 2 个形状为(batch_size, num_heads, sequence_length, embed_size_per_head)
的张量。这也称为传统缓存格式。
模型将输出与输入相同的缓存格式。如果未传入
past_key_values
,将返回传统缓存格式。如果使用
past_key_values
,用户可以选择只输入形状为(batch_size, 1)
的最后一个input_ids
(那些没有将其过去的键值状态提供给此模型的),而不是形状为(batch_size, sequence_length)
的所有input_ids
。 - output_hidden_states (
bool
,可选) — 是否返回所有层的隐藏状态。有关更多详细信息,请参阅返回张量下的hidden_states
。 - output_attentions (
bool
,可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息,请参阅返回张量下的attentions
。 - use_cache (
bool
,可选) — 如果设置为True
,则返回past_key_values
键值状态,可用于加速解码(参见past_key_values
)。 - return_dict (
bool
,可选) — 是否返回 ModelOutput 而不是普通元组。 - cache_position (形状为
(sequence_length)
的torch.LongTensor
,可选) — 描述输入序列词元在序列中位置的索引。与position_ids
不同,此张量不受填充影响。它用于在正确位置更新缓存并推断完整序列长度。
返回
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 (
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 (形状为
(batch_size,)
或(batch_size, input_size)
的torch.FloatTensor
,可选) — 每个时间序列上下文窗口的平移值,用于使模型输入具有相同的大小,然后用于将其平移回原始大小。 -
scale (形状为
(batch_size,)
或(batch_size, input_size)
的torch.FloatTensor
,可选) — 每个时间序列上下文窗口的缩放值,用于使模型输入具有相同的大小,然后用于将其缩放回原始大小。 -
static_features (
torch.FloatTensor
,形状为(batch_size, feature size)
,可选) — 批次中每个时间序列的静态特征,在推理时复制到协变量。
TimeSeriesTransformerModel 的 forward 方法,重写了 __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() 方法来加载模型权重。
具有分布头的时间序列 Transformer 模型,用于时间序列预测。
该模型继承自 PreTrainedModel。请查看超类文档,了解库为所有模型实现的通用方法(例如下载或保存、调整输入嵌入大小、修剪头部等)。
该模型也是 PyTorch torch.nn.Module 的子类。请将其作为常规 PyTorch 模块使用,并参考 PyTorch 文档以了解与通用用法和行为相关的所有事项。
前向传播
< 来源 >( 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 cache_position: typing.Optional[torch.LongTensor] = 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 表示值**缺失**(即被零替换的 NaNs)。
- 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 (形状为
(batch_size, sequence_length)
或(batch_size, sequence_length, input_size)
的torch.BoolTensor
,可选) — 布尔掩码,指示哪些future_values
被观察到,哪些缺失。掩码值选自[0, 1]
:- 1 表示值被**观察到**,
- 0 表示值**缺失**(即被零替换的 NaNs)。
此掩码用于过滤掉缺失值以进行最终损失计算。
- decoder_attention_mask (形状为
(batch_size, target_sequence_length)
的torch.LongTensor
,可选) — 掩码,用于避免对某些词元索引执行注意力。默认情况下,将使用因果掩码,以确保模型只能查看先前的输入才能预测未来。 - head_mask (形状为
(num_heads,)
或(num_layers, num_heads)
的torch.Tensor
,可选) — 用于使自注意力模块的选定头部无效的掩码。掩码值选自[0, 1]
:- 1 表示头部**未被掩码**,
- 0 表示头部**被掩码**。
- decoder_head_mask (形状为
(decoder_layers, decoder_attention_heads)
的torch.Tensor
,可选) — 用于使解码器中注意力模块的选定头部无效的掩码。掩码值选自[0, 1]
:- 1 表示头部**未被掩码**,
- 0 表示头部**被掩码**。
- cross_attn_head_mask (形状为
(decoder_layers, decoder_attention_heads)
的torch.Tensor
,可选) — 用于使交叉注意力模块的选定头部无效的掩码。掩码值选自[0, 1]
:- 1 表示头部**未被掩码**,
- 0 表示头部**被掩码**。
- encoder_outputs (
tuple(tuple(torch.FloatTensor)
,可选) — 元组包含last_hidden_state
、hidden_states
(可选)和attentions
(可选)。形状为(batch_size, sequence_length, hidden_size)
的last_hidden_state
(可选)是编码器最后一层输出的隐藏状态序列。用于解码器的交叉注意力。 - 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
,用户可以选择只输入形状为(batch_size, 1)
的最后一个input_ids
(那些没有将其过去的键值状态提供给此模型的),而不是形状为(batch_size, sequence_length)
的所有input_ids
。 - output_hidden_states (
bool
,可选) — 是否返回所有层的隐藏状态。有关更多详细信息,请参阅返回张量下的hidden_states
。 - output_attentions (
bool
,可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息,请参阅返回张量下的attentions
。 - use_cache (
bool
,可选) — 如果设置为True
,则返回past_key_values
键值状态,可用于加速解码(参见past_key_values
)。 - return_dict (
bool
,可选) — 是否返回 ModelOutput 而不是普通元组。 - cache_position (形状为
(sequence_length)
的torch.LongTensor
,可选) — 描述输入序列词元在序列中位置的索引。与position_ids
不同,此张量不受填充影响。它用于在正确位置更新缓存并推断完整序列长度。
返回
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 (
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 (形状为
(batch_size,)
或(batch_size, input_size)
的torch.FloatTensor
,可选) — 每个时间序列上下文窗口的平移值,用于使模型输入具有相同的大小,然后用于将其平移回原始大小。 -
scale (形状为
(batch_size,)
或(batch_size, input_size)
的torch.FloatTensor
,可选) — 每个时间序列上下文窗口的缩放值,用于使模型输入具有相同的大小,然后用于将其缩放回原始大小。 -
static_features (
torch.FloatTensor
,形状为(batch_size, feature size)
,可选) — 批次中每个时间序列的静态特征,在推理时复制到协变量。
TimeSeriesTransformerForPrediction 的 forward 方法,重写了 __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)