Transformers 4.37 中文文档(九十七)(4)https://developer.aliyun.com/article/1564057
InformerModel
class transformers.InformerModel
( config: InformerConfig ) • 1
参数
config
(TimeSeriesTransformerConfig)- 具有模型所有参数的模型配置类。使用配置文件初始化不会加载与模型关联的权重,只加载配置。查看 from_pretrained()方法以加载模型权重。
裸 Informer 模型输出原始隐藏状态,没有特定的头部。此模型继承自 PreTrainedModel。检查超类文档以获取库为所有模型实现的通用方法(如下载或保存、调整输入嵌入、修剪头等)。
该模型还是一个 PyTorch torch.nn.Module子类。将其用作常规 PyTorch 模块,并参考 PyTorch 文档以获取有关一般用法和行为的所有信息。
前进
( 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 ) → export const metadata = 'undefined';transformers.modeling_outputs.Seq2SeqTSModelOutput or tuple(torch.FloatTensor) • 1
参数
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]
之间:
- 对于被观察到的数值,
- 对于
missing
的值为 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)
或(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 表示
缺失
的值(即被零替换的 NaN)。
- 此掩码用于过滤出最终损失计算中的缺失值。
attention_mask
(形状为(batch_size, sequence_length)
的torch.Tensor
,可选)— 用于避免在某些标记索引上执行注意力的掩码。掩码值选定在[0, 1]
之间:
- 1 表示标记
未被掩码
, - 0 表示
被掩码
的标记。
- 什么是注意力掩码?
decoder_attention_mask
(形状为(batch_size, target_sequence_length)
的torch.LongTensor
,可选)— 用于避免在某些标记索引上执行注意力的掩码。默认情况下,将使用因果掩码,以确保模型只能查看以前的输入以预测未来。head_mask
(形状为(encoder_layers, encoder_attention_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
(可选)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
的元组,每个元组有 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
,用户可以选择仅输入形状为(batch_size, 1)
的最后decoder_input_ids
(即那些没有将它们的过去键值状态提供给此模型的输入)而不是形状为(batch_size, sequence_length)
的所有decoder_input_ids
。inputs_embeds
(torch.FloatTensor
,形状为(batch_size, sequence_length, hidden_size)
,optional) — 可选地,可以直接传递嵌入表示,而不是传递input_ids
。如果您想要更多控制如何将input_ids
索引转换为相关向量,而不是使用模型的内部嵌入查找矩阵,则这很有用。use_cache
(bool
, optional) — 如果设置为True
,则返回past_key_values
键值状态,可用于加速解码(参见past_key_values
)。output_attentions
(bool
, optional) — 是否返回所有注意力层的注意力张量。有关更多详细信息,请参见返回张量下的attentions
。output_hidden_states
(bool
, optional) — 是否返回所有层的隐藏状态。有关更多详细信息,请参见返回张量下的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
)包含各种元素,取决于配置(InformerConfig)和输入。
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))
, optional, 当传递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)
, optional, 当传递output_hidden_states=True
或config.output_hidden_states=True
时返回) — 形状为(batch_size, sequence_length, hidden_size)
的torch.FloatTensor
元组(如果模型有嵌入层,则为嵌入的输出+每层的输出)。
解码器在每一层输出处的隐藏状态,以及可选的初始嵌入输出。decoder_attentions
(tuple(torch.FloatTensor)
, optional, 当传递output_attentions=True
或config.output_attentions=True
时返回) — 形状为(batch_size, num_heads, sequence_length, sequence_length)
的torch.FloatTensor
元组(每层一个)。
解码器的注意力权重,在注意力 softmax 之后,用于计算自注意力头中的加权平均值。cross_attentions
(tuple(torch.FloatTensor)
, optional, 当传递output_attentions=True
或config.output_attentions=True
时返回) — 形状为(batch_size, num_heads, sequence_length, sequence_length)
的torch.FloatTensor
元组(每层一个)。
解码器的交叉注意力层的注意力权重,在注意力 softmax 之后,用于计算交叉注意力头中的加权平均值。encoder_last_hidden_state
(torch.FloatTensor
of shape(batch_size, sequence_length, hidden_size)
, optional) — 模型编码器最后一层的隐藏状态序列。encoder_hidden_states
(tuple(torch.FloatTensor)
, optional, 当传递output_hidden_states=True
或config.output_hidden_states=True
时返回) — 形状为(batch_size, sequence_length, hidden_size)
的torch.FloatTensor
元组(如果模型有嵌入层,则为嵌入输出的输出+每层的输出)。
每层编码器的隐藏状态以及可选的初始嵌入输出。encoder_attentions
(tuple(torch.FloatTensor)
, optional, 当传递output_attentions=True
或config.output_attentions=True
时返回) — 形状为(batch_size, num_heads, sequence_length, sequence_length)
的torch.FloatTensor
元组(每层一个)。
编码器的注意力权重,在注意力 softmax 之后,用于计算自注意力头中的加权平均值。loc
(torch.FloatTensor
of shape(batch_size,)
or(batch_size, input_size)
, optional) — 用于给模型输入相同数量级的每个时间序列上下文窗口的偏移值,然后用于将其偏移回原始数量级。scale
(torch.FloatTensor
of shape(batch_size,)
or(batch_size, input_size)
, optional) — 用于给模型输入相同数量级的每个时间序列上下文窗口的缩放值,然后用于将其重新缩放回原始数量级。static_features
(torch.FloatTensor
of shape(batch_size, feature size)
, optional) — 每个时间序列在批处理中的静态特征,在推断时被复制到协变量中。
InformerModel 的前向方法,覆盖了__call__
特殊方法。
虽然前向传递的步骤需要在此函数内定义,但应该在此之后调用Module
实例,而不是在此处调用,因为前者负责运行预处理和后处理步骤,而后者则默默地忽略它们。
示例:
>>> from huggingface_hub import hf_hub_download >>> import torch >>> from transformers import InformerModel >>> file = hf_hub_download( ... repo_id="hf-internal-testing/tourism-monthly-batch", filename="train-batch.pt", repo_type="dataset" ... ) >>> batch = torch.load(file) >>> model = InformerModel.from_pretrained("huggingface/informer-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 • 1 • 2 • 3 • 4 • 5 • 6 • 7 • 8 • 9 • 10 • 11 • 12 • 13 • 14 • 15 • 16 • 17 • 18 • 19 • 20 • 21 • 22 • 23 • 24
InformerForPrediction
class transformers.InformerForPrediction
( config: InformerConfig ) • 1
参数
config
(TimeSeriesTransformerConfig) — 具有模型所有参数的模型配置类。使用配置文件初始化不会加载与模型相关的权重,只加载配置。查看 from_pretrained()方法以加载模型权重。
Informer 模型在时间序列预测的顶部具有分布头。该模型继承自 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 ) → export const metadata = 'undefined';transformers.modeling_outputs.Seq2SeqTSModelOutput or tuple(torch.FloatTensor) • 1
参数
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]
之间:
- 对于
observed
的值为 1, - 对于
missing
的值为 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)
或(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 表示
observed
的值, - 0 表示
missing
的值(即被零替换的 NaN)。
- 此掩码用于过滤出最终损失计算中的缺失值。
attention_mask
(形状为(batch_size, sequence_length)
的torch.Tensor
,可选)- 用于避免对某些标记索引执行注意力的掩码。掩码值选在[0, 1]
之间:
- 1 表示未被
masked
的标记, - 0 表示被
masked
的标记。
- 什么是注意力掩码?
decoder_attention_mask
(形状为(batch_size, target_sequence_length)
的torch.LongTensor
,可选)- 用于避免对某些标记索引执行注意力的掩码。默认情况下,将使用因果掩码,以确保模型只能查看以前的输入以预测未来。head_mask
(形状为(encoder_layers, encoder_attention_heads)
的torch.Tensor
,可选)- 用于将编码器中注意力模块的选定头部置零的掩码。掩码值选在[0, 1]
之间:
- 1 表示头部未被
masked
, - 0 表示头部被
masked
。
decoder_head_mask
(形状为(decoder_layers, decoder_attention_heads)
的torch.Tensor
,可选)- 用于将解码器中注意力模块的选定头部置零的掩码。掩码值选在[0, 1]
之间:
- 1 表示头部未被
masked
, - 0 表示头部被
masked
。
cross_attn_head_mask
(形状为(decoder_layers, decoder_attention_heads)
的torch.Tensor
,可选)- 用于将交叉注意力模块的选定头部置零的掩码。掩码值选在[0, 1]
之间:
- 1 表示头部未被
masked
, - 0 表示头部被
masked
。
encoder_outputs
(元组(元组(torch.FloatTensor
), 可选)- 元组由last_hidden_state
、hidden_states
(可选)和attentions
(可选)组成,last_hidden_state
的形状为(batch_size, sequence_length, hidden_size)
(可选)是编码器最后一层的隐藏状态的序列。用于解码器的交叉注意力。past_key_values
(tuple(tuple(torch.FloatTensor))
, optional, 当传递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
,用户可以选择仅输入形状为(batch_size, 1)
的最后一个decoder_input_ids
(这些没有将它们的过去键值状态提供给此模型)而不是形状为(batch_size, sequence_length)
的所有decoder_input_ids
。inputs_embeds
(torch.FloatTensor
,形状为(batch_size, sequence_length, hidden_size)
,optional) — 可选地,可以直接传递嵌入表示,而不是传递input_ids
。如果您想要更多控制如何将input_ids
索引转换为相关向量,而不是模型的内部嵌入查找矩阵,则这很有用。use_cache
(bool
,optional) — 如果设置为True
,则返回past_key_values
键值状态,并可用于加速解码(参见past_key_values
)。output_attentions
(bool
,optional) — 是否返回所有注意力层的注意力张量。有关更多详细信息,请参阅返回张量下的attentions
。output_hidden_states
(bool
,optional) — 是否返回所有层的隐藏状态。有关更多详细信息,请参阅返回张量下的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
)包含根据配置(InformerConfig)和输入的不同元素。
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))
, optional, 当传递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)
的张量。
包含预先计算的隐藏状态(自注意力块和交叉注意力块中的键和值),可用于加速顺序解码。decoder_hidden_states
(tuple(torch.FloatTensor)
, optional, 当传递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
时返回)- 形状为(batch_size, num_heads, sequence_length, sequence_length)
的torch.FloatTensor
元组(每层一个)。
解码器的注意力权重,在注意力 softmax 之后,用于计算自注意力头中的加权平均值。cross_attentions
(tuple(torch.FloatTensor)
,可选,当传递output_attentions=True
或config.output_attentions=True
时返回)- 形状为(batch_size, num_heads, sequence_length, sequence_length)
的torch.FloatTensor
元组(每层一个)。
解码器的交叉注意力层的注意力权重,在注意力 softmax 之后,用于计算交叉注意力头中的加权平均值。encoder_last_hidden_state
(形状为(batch_size, sequence_length, hidden_size)
的torch.FloatTensor
,可选)- 模型编码器最后一层的隐藏状态序列。encoder_hidden_states
(tuple(torch.FloatTensor)
,可选,当传递output_hidden_states=True
或config.output_hidden_states=True
时返回)- 形状为(batch_size, sequence_length, hidden_size)
的torch.FloatTensor
元组(如果模型有嵌入层,则为嵌入的输出+每层的输出)。
编码器在每一层输出的隐藏状态,以及可选的初始嵌入输出。encoder_attentions
(tuple(torch.FloatTensor)
,可选,当传递output_attentions=True
或config.output_attentions=True
时返回)- 形状为(batch_size, num_heads, sequence_length, sequence_length)
的torch.FloatTensor
元组(每层一个)。
编码器的注意力权重,在注意力 softmax 之后,用于计算自注意力头中的加权平均值。loc
(形状为(batch_size,)
或(batch_size, input_size)
的torch.FloatTensor
,可选)- 每个时间序列上下文窗口的偏移值,用于给模型输入相同数量级的值,然后用于将其偏移回原始数量级。scale
(形状为(batch_size,)
或(batch_size, input_size)
的torch.FloatTensor
,可选)- 每个时间序列上下文窗口的缩放值,用于给模型输入相同数量级的值,然后用于将其重新缩放回原始数量级。static_features
(形状为(batch_size, feature size)
的torch.FloatTensor
,可选)- 批处理中每个时间序列的静态特征,在推断时复制到协变量中。
InformerForPrediction 的前向方法,覆盖了__call__
特殊方法。
虽然前向传递的步骤需要在这个函数内定义,但应该在此之后调用Module
实例,而不是这个函数,因为前者会负责运行前后处理步骤,而后者会默默地忽略它们。
示例:
>>> from huggingface_hub import hf_hub_download >>> import torch >>> from transformers import InformerForPrediction >>> file = hf_hub_download( ... repo_id="hf-internal-testing/tourism-monthly-batch", filename="train-batch.pt", repo_type="dataset" ... ) >>> batch = torch.load(file) >>> model = InformerForPrediction.from_pretrained( ... "huggingface/informer-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) • 1 • 2 • 3 • 4 • 5 • 6 • 7 • 8 • 9 • 10 • 11 • 12 • 13 • 14 • 15 • 16 • 17 • 18 • 19 • 20 • 21 • 22 • 23 • 24 • 25 • 26 • 27 • 28 • 29 • 30 • 31 • 32 • 33 • 34 • 35 • 36 • 37 • 38 • 39 • 40 • 41
ce_length)的
torch.FloatTensor`元组(每层一个)。
编码器的注意力权重,在注意力 softmax 之后,用于计算自注意力头中的加权平均值。 • 1
loc
(形状为(batch_size,)
或(batch_size, input_size)
的torch.FloatTensor
,可选)- 每个时间序列上下文窗口的偏移值,用于给模型输入相同数量级的值,然后用于将其偏移回原始数量级。scale
(形状为(batch_size,)
或(batch_size, input_size)
的torch.FloatTensor
,可选)- 每个时间序列上下文窗口的缩放值,用于给模型输入相同数量级的值,然后用于将其重新缩放回原始数量级。static_features
(形状为(batch_size, feature size)
的torch.FloatTensor
,可选)- 批处理中每个时间序列的静态特征,在推断时复制到协变量中。
InformerForPrediction 的前向方法,覆盖了__call__
特殊方法。
虽然前向传递的步骤需要在这个函数内定义,但应该在此之后调用Module
实例,而不是这个函数,因为前者会负责运行前后处理步骤,而后者会默默地忽略它们。
示例:
>>> from huggingface_hub import hf_hub_download >>> import torch >>> from transformers import InformerForPrediction >>> file = hf_hub_download( ... repo_id="hf-internal-testing/tourism-monthly-batch", filename="train-batch.pt", repo_type="dataset" ... ) >>> batch = torch.load(file) >>> model = InformerForPrediction.from_pretrained( ... "huggingface/informer-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) • 1 • 2 • 3 • 4 • 5 • 6 • 7 • 8 • 9 • 10 • 11 • 12 • 13 • 14 • 15 • 16 • 17 • 18 • 19 • 20 • 21 • 22 • 23 • 24 • 25 • 26 • 27 • 28 • 29 • 30 • 31 • 32 • 33 • 34 • 35 • 36 • 37 • 38 • 39 • 40 • 41