BigBirdPegasus
概述
BigBird 模型由 Zaheer、Manzil 和 Guruganesh、Guru、Dubey、Kumar Avinava、Ainslie、Joshua、Alberti、Chris、Ontanon、Santiago、Pham、Philip、Ravula、Anirudh、Wang、Qifan 和 Yang、Li 等人在 Big Bird: Transformers for Longer Sequences 中提出。BigBird 是一种基于稀疏注意力的 Transformer，它将 BERT 等基于 Transformer 的模型扩展到更长的序列。除了稀疏注意力之外，BigBird 还将全局注意力和随机注意力应用于输入序列。从理论上讲，已证明应用稀疏、全局和随机注意力可以近似全注意力，同时在计算上对于更长的序列效率更高。由于能够处理更长的上下文，与 BERT 或 RoBERTa 相比，BigBird 在各种长文档 NLP 任务（如问答和摘要）上表现出改进的性能。
论文的摘要如下：
基于 Transformer 的模型（如 BERT）一直是 NLP 最成功的深度学习模型之一。不幸的是，它们的核心理念之一是由于其全注意力机制，对序列长度的二次依赖（主要在内存方面）。为了解决这个问题，我们提出了 BigBird，一种稀疏注意力机制，它将这种二次依赖关系降低到线性。我们表明 BigBird 是序列函数的通用逼近器，并且是图灵完备的，从而保留了二次全注意力模型的这些属性。在此过程中，我们的理论分析揭示了作为稀疏注意力机制一部分的 O(1) 全局令牌（如 CLS）的一些优势。所提出的稀疏注意力可以处理长达之前使用类似硬件所能实现的 8 倍的序列。由于能够处理更长的上下文，BigBird 极大地提高了各种 NLP 任务（如问答和摘要）的性能。我们还提出了对基因组数据的全新应用。
原始代码可以在这里找到 这里.
使用技巧
- 有关 BigBird 的注意力机制如何工作的详细解释，请参阅 这篇博文.
- BigBird 有 2 种实现：**original_full** 和 **block_sparse**。对于序列长度 < 1024，建议使用 **original_full**，因为使用 **block_sparse** 注意力没有任何好处。
- 当前代码使用 3 个块的窗口大小和 2 个全局块。
- 序列长度必须能被块大小整除。
- 当前实现仅支持 **ITC**。
- 当前实现不支持 **num_random_blocks = 0**。
- BigBirdPegasus 使用 PegasusTokenizer.
- BigBird 是一个具有绝对位置嵌入的模型，因此通常建议在右侧而不是左侧填充输入。
资源
BigBirdPegasusConfig
class transformers.BigBirdPegasusConfig
< 源代码 >( vocab_size = 96103 max_position_embeddings = 4096 encoder_layers = 16 encoder_ffn_dim = 4096 encoder_attention_heads = 16 decoder_layers = 16 decoder_ffn_dim = 4096 decoder_attention_heads = 16 encoder_layerdrop = 0.0 decoder_layerdrop = 0.0 use_cache = True is_encoder_decoder = True activation_function = 'gelu_new' d_model = 1024 dropout = 0.1 attention_dropout = 0.0 activation_dropout = 0.0 init_std = 0.02 decoder_start_token_id = 2 classifier_dropout = 0.0 scale_embedding = True pad_token_id = 0 bos_token_id = 2 eos_token_id = 1 attention_type = 'block_sparse' block_size = 64 num_random_blocks = 3 use_bias = False **kwargs )
参数
- vocab_size (
int, 可选, 默认值为 96103) — BigBirdPegasus 模型的词汇量大小。定义了调用 BigBirdPegasusModel 时，可以通过inputs_ids表示的不同标记数量。 - d_model (
int, 可选, 默认值为 1024) — 各层和池化层的维度。 - encoder_layers (
int, 可选, 默认值为 16) — 编码器层数。 - decoder_layers (
int, 可选, 默认值为 16) — 解码器层数。 - encoder_attention_heads (
int, 可选, 默认值为 16) — Transformer 编码器中每个注意力层的注意力头数量。 - decoder_attention_heads (
int, 可选, 默认值为 16) — Transformer 解码器中每个注意力层的注意力头数量。 - decoder_ffn_dim (
int, 可选, 默认值为 4096) — 解码器中“中间”（通常称为前馈）层的维度。 - encoder_ffn_dim (
int, 可选, 默认值为 4096) — 解码器中“中间”（通常称为前馈）层的维度。 - activation_function (
str或function, 可选, 默认值为"gelu_new") — 编码器和池化器中的非线性激活函数 (函数或字符串)。 如果为字符串，则支持"gelu"、"relu"、"silu"和"gelu_new"。 - dropout (
float, 可选, 默认值为 0.1) — 嵌入、编码器和池化器中所有全连接层的 dropout 概率。 - attention_dropout (
float, 可选, 默认值为 0.0) — 注意力概率的 dropout 比例。 - activation_dropout (
float, 可选, 默认值为 0.0) — 全连接层内部激活的 dropout 比例。 - classifier_dropout (
float, 可选, 默认值为 0.0) — 分类器的 dropout 比例。 - max_position_embeddings (
int, 可选, 默认值为 4096) — 此模型可能使用的最大序列长度。 通常将其设置为一个较大的值以防万一 (例如，1024 或 2048 或 4096)。 - init_std (
float, 可选, 默认值为 0.02) — 初始化所有权重矩阵的截断正态分布初始化器的标准差。 - encoder_layerdrop (
float, 可选, 默认值为 0.0) — 编码器的 LayerDrop 概率。 有关更多详细信息，请参见 [LayerDrop 论文](see https://arxiv.org/abs/1909.11556)。 - decoder_layerdrop (
float, 可选, 默认值为 0.0) — 解码器的 LayerDrop 概率。 有关更多详细信息，请参见 [LayerDrop 论文](see https://arxiv.org/abs/1909.11556)。 - use_cache (
bool, 可选, 默认值为True) — 模型是否应该返回最后的键/值注意力 (并非所有模型都使用此功能)。 - block_size (
int, 可选, 默认为 64) — 每个块的大小。仅在attention_type == "block_sparse"时有用。 - num_random_blocks (
int, 可选, 默认为 3) — 每个查询将要关注的随机块的数量。仅在attention_type == "block_sparse"时有用。 - scale_embeddings (
bool, 可选, 默认为True) — 是否用 (hidden_size ** 0.5) 对嵌入进行重新缩放。
这是一个配置类，用于存储 BigBirdPegasusModel 的配置。它用于根据指定的参数实例化 BigBirdPegasus 模型，定义模型架构。使用默认值实例化配置将产生与 BigBirdPegasus google/bigbird-pegasus-large-arxiv 架构类似的配置。
配置对象继承自 PretrainedConfig，可用于控制模型输出。阅读 PretrainedConfig 的文档以获取更多信息。
示例
>>> from transformers import BigBirdPegasusConfig, BigBirdPegasusModel
>>> # Initializing a BigBirdPegasus bigbird-pegasus-base style configuration
>>> configuration = BigBirdPegasusConfig()
>>> # Initializing a model (with random weights) from the bigbird-pegasus-base style configuration
>>> model = BigBirdPegasusModel(configuration)
>>> # Accessing the model configuration
>>> configuration = model.configBigBirdPegasusModel
class transformers.BigBirdPegasusModel
< 源代码 >( config: BigBirdPegasusConfig )
参数
- config (BigBirdPegasusConfig) — 包含模型所有参数的模型配置类。用配置文件初始化不会加载与模型关联的权重，仅加载配置。查看 from_pretrained() 方法以加载模型权重。
裸 BigBirdPegasus 模型，输出原始隐藏状态，没有任何特定的头部。此模型继承自 PreTrainedModel。查看超类文档，了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小等）。
此模型也是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档，了解与一般使用和行为相关的所有事宜。
正向传播
< 源代码 >( input_ids: LongTensor = None attention_mask: Optional = None decoder_input_ids: 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 inputs_embeds: Optional = None decoder_inputs_embeds: Optional = None use_cache: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → transformers.modeling_outputs.Seq2SeqModelOutput or tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor形状为(batch_size, sequence_length)) — 词汇表中输入序列标记的索引。如果您提供填充，默认情况下将忽略填充。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensor形状为(batch_size, sequence_length), 可选) — 掩码，以避免对填充标记索引执行注意力。在[0, 1]中选择掩码值：- 1 用于未被掩码的标记，
- 0 用于被掩码的标记。
- decoder_input_ids (
torch.LongTensor形状为(batch_size, target_sequence_length), 可选) — 用于翻译和摘要训练。默认情况下，模型将通过将input_ids向右移动来创建此张量，遵循论文。 - decoder_attention_mask (
torch.LongTensor形状为(batch_size, target_sequence_length), 可选) — 默认行为：生成一个忽略decoder_input_ids中填充标记的张量。因果掩码默认情况下也会被使用。如果要更改填充行为，您应该阅读
modeling_bigbird_pegasus._prepare_decoder_attention_mask并根据您的需要进行修改。有关默认策略的更多信息，请参阅 论文 中的图 1。 - decoder_head_mask (
torch.Tensor形状为(num_layers, num_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(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索引转换为关联向量有更多控制，这将很有用。 - decoder_inputs_embeds (
torch.FloatTensor形状为(batch_size, target_sequence_length, hidden_size)，可选) — 可选地，您可以选择直接传递嵌入表示，而不是传递decoder_input_ids。如果使用past_key_values，可以选择仅输入最后一个decoder_inputs_embeds（参见past_key_values）。如果您想对模型内部嵌入查找矩阵如何将decoder_input_ids索引转换为关联向量有更多控制，这将很有用。如果
decoder_input_ids和decoder_inputs_embeds都未设置，decoder_inputs_embeds将取inputs_embeds的值。 - 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.Seq2SeqModelOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.Seq2SeqModelOutput 或 torch.FloatTensor 的元组（如果传递了 return_dict=False 或 config.return_dict=False），包含根据配置 (BigBirdPegasusConfig) 和输入的不同元素。
-
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)元组，每个元组包含 2 个形状为(batch_size, num_heads, sequence_length, embed_size_per_head)的张量，以及 2 个形状为(batch_size, num_heads, encoder_sequence_length, embed_size_per_head)的附加张量。包含预先计算的隐藏状态（自注意力块和交叉注意力块中的键和值），这些隐藏状态可用于（参见
past_key_values输入）加速顺序解码。 -
decoder_hidden_states (
tuple(torch.FloatTensor)，可选，在传递output_hidden_states=True或config.output_hidden_states=True时返回) —torch.FloatTensor的元组（如果模型具有嵌入层，则对于嵌入的输出，+ 每个层的输出）形状为(batch_size, sequence_length, hidden_size)。每个层的解码器输出处的隐藏状态，加上可选的初始嵌入输出。
-
decoder_attentions (
tuple(torch.FloatTensor)，可选，在传递output_attentions=True或config.output_attentions=True时返回) —torch.FloatTensor的元组（每个层一个）形状为(batch_size, num_heads, sequence_length, sequence_length)。解码器的注意力权重，在注意力 softmax 之后，用于计算自注意力头中的加权平均值。
-
cross_attentions (
tuple(torch.FloatTensor)，可选，在传递output_attentions=True或config.output_attentions=True时返回) —torch.FloatTensor的元组（每个层一个）形状为(batch_size, num_heads, sequence_length, sequence_length)。解码器交叉注意力层的注意力权重，在注意力 softmax 之后，用于计算交叉注意力头中的加权平均值。
-
encoder_last_hidden_state (
torch.FloatTensor形状为(batch_size, sequence_length, hidden_size)，可选) — 模型编码器最后一层的输出处的隐藏状态序列。 -
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 之后，用于计算自注意力头中的加权平均值。
The BigBirdPegasusModel 正向方法，覆盖了 __call__ 特殊方法。
虽然正向传递的配方需要在此函数内定义，但应该在之后调用 Module 实例，而不是此函数，因为前者负责运行预处理和后处理步骤，而后者则静默地忽略它们。
示例
>>> from transformers import AutoTokenizer, BigBirdPegasusModel
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("google/bigbird-pegasus-large-arxiv")
>>> model = BigBirdPegasusModel.from_pretrained("google/bigbird-pegasus-large-arxiv")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")
>>> outputs = model(**inputs)
>>> last_hidden_states = outputs.last_hidden_stateBigBirdPegasusForConditionalGeneration
class transformers.BigBirdPegasusForConditionalGeneration
< source >( config: BigBirdPegasusConfig )
参数
- config (BigBirdPegasusConfig) — 模型配置类，包含模型的所有参数。用配置文件初始化不会加载与模型相关的权重，只会加载配置。查看 from_pretrained() 方法来加载模型权重。
带有语言建模头的 BigBirdPegasus 模型。 可用于摘要。 此模型继承自 PreTrainedModel。 查看超类文档以了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小等）。
此模型也是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档，了解与一般使用和行为相关的所有事宜。
正向传播
< source >( input_ids: LongTensor = None attention_mask: Optional = None decoder_input_ids: 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 inputs_embeds: Optional = None decoder_inputs_embeds: Optional = None labels: Optional = None use_cache: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → transformers.modeling_outputs.Seq2SeqLMOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor形状为(batch_size, sequence_length)) — 输入序列标记在词汇表中的索引。 默认情况下，如果您提供填充，填充将被忽略。可以使用 AutoTokenizer 获取索引。 查看 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call() 以了解更多信息。
- attention_mask (
torch.Tensor形状为(batch_size, sequence_length)，可选) — 用于避免对填充标记索引执行注意的掩码。 掩码值选择在[0, 1]中：- 1 表示未屏蔽的标记，
- 0 表示屏蔽的标记。
- decoder_input_ids (
torch.LongTensor形状为(batch_size, target_sequence_length)，可选) — 为翻译和摘要训练提供。 默认情况下，模型将通过将input_ids向右移动来创建此张量，遵循论文。 - decoder_attention_mask (
torch.LongTensor形状为(batch_size, target_sequence_length)，可选) — 默认行为：生成一个忽略decoder_input_ids中填充标记的张量。 因果掩码也会默认使用。如果您想更改填充行为，您应该阅读
modeling_bigbird_pegasus._prepare_decoder_attention_mask并根据您的需要修改。 有关默认策略的更多信息，请参见 论文 中的图表 1。 - decoder_head_mask (
torch.Tensor形状为(num_layers, num_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，用户可以选择仅输入形状为(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索引转换为相关的向量，而不是模型的内部嵌入查找矩阵，这将非常有用。 - decoder_inputs_embeds (
torch.FloatTensor形状为(batch_size, target_sequence_length, hidden_size), 可选) — 可选地，您也可以选择直接传递嵌入式表示，而不是传递decoder_input_ids。如果使用past_key_values，可以选择只输入最后一个decoder_inputs_embeds（参见past_key_values）。如果您想要更多地控制如何将decoder_input_ids索引转换为相关的向量，而不是模型的内部嵌入查找矩阵，这将非常有用。如果
decoder_input_ids和decoder_inputs_embeds均未设置，则decoder_inputs_embeds将采用inputs_embeds的值。 - use_cache (
bool, 可选) — 如果设置为True，则会返回past_key_values键值状态，可用于加速解码（参见past_key_values）。 - output_attentions (
bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参见返回张量下的attentions。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参见返回张量下的hidden_states。 - return_dict (
bool, 可选) — 是否返回 ModelOutput 而不是普通元组。 - labels (
torch.LongTensor形状为(batch_size, sequence_length)，可选) — 用于计算掩码语言建模损失的标签。索引应在[0, ..., config.vocab_size]或 -100 之间（参见input_ids文档字符串）。索引设置为-100的标记将被忽略（掩码），损失仅针对标签在[0, ..., config.vocab_size]之间的标记计算。
返回
transformers.modeling_outputs.Seq2SeqLMOutput 或 tuple(torch.FloatTensor)
A transformers.modeling_outputs.Seq2SeqLMOutput 或一个 torch.FloatTensor 元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），包含取决于配置 (BigBirdPegasusConfig) 和输入的各种元素。
-
loss (
torch.FloatTensor形状为(1,)，可选，当提供labels时返回) — 语言建模损失。 -
logits (
torch.FloatTensor形状为(batch_size, sequence_length, config.vocab_size)) — 语言建模头的预测分数（SoftMax 之前的每个词汇标记的分数）。 -
past_key_values (
tuple(tuple(torch.FloatTensor))，可选，在传递use_cache=True或config.use_cache=True时返回) — 长度为config.n_layers的tuple(torch.FloatTensor)元组，每个元组包含 2 个形状为(batch_size, num_heads, sequence_length, embed_size_per_head)的张量，以及 2 个形状为(batch_size, num_heads, encoder_sequence_length, embed_size_per_head)的附加张量。包含预先计算的隐藏状态（自注意力块和交叉注意力块中的键和值），这些隐藏状态可用于（参见
past_key_values输入）加速顺序解码。 -
decoder_hidden_states (
tuple(torch.FloatTensor)，可选，在传递output_hidden_states=True或config.output_hidden_states=True时返回) —torch.FloatTensor的元组（如果模型具有嵌入层，则对于嵌入的输出，+ 每个层的输出）形状为(batch_size, sequence_length, hidden_size)。解码器在每层输出处的隐藏状态，以及初始嵌入输出。
-
decoder_attentions (
tuple(torch.FloatTensor)，可选，在传递output_attentions=True或config.output_attentions=True时返回) —torch.FloatTensor的元组（每个层一个）形状为(batch_size, num_heads, sequence_length, sequence_length)。解码器的注意力权重，在注意力 softmax 之后，用于计算自注意力头中的加权平均值。
-
cross_attentions (
tuple(torch.FloatTensor)，可选，在传递output_attentions=True或config.output_attentions=True时返回) —torch.FloatTensor的元组（每个层一个）形状为(batch_size, num_heads, sequence_length, sequence_length)。解码器交叉注意力层的注意力权重，在注意力 softmax 之后，用于计算交叉注意力头中的加权平均值。
-
encoder_last_hidden_state (
torch.FloatTensor形状为(batch_size, sequence_length, hidden_size)，可选) — 模型编码器最后一层的输出处的隐藏状态序列。 -
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 之后，用于计算自注意力头中的加权平均值。
The BigBirdPegasusForConditionalGeneration 前向方法，覆盖 __call__ 特殊方法。
虽然正向传递的配方需要在此函数内定义，但应该在之后调用 Module 实例，而不是此函数，因为前者负责运行预处理和后处理步骤，而后者则静默地忽略它们。
摘要示例
>>> from transformers import AutoTokenizer, BigBirdPegasusForConditionalGeneration
>>> model = BigBirdPegasusForConditionalGeneration.from_pretrained("google/bigbird-pegasus-large-arxiv")
>>> tokenizer = AutoTokenizer.from_pretrained("google/bigbird-pegasus-large-arxiv")
>>> ARTICLE_TO_SUMMARIZE = (
... "The dominant sequence transduction models are based on complex recurrent or convolutional neural "
... "networks in an encoder-decoder configuration. The best performing models also connect the encoder "
... "and decoder through an attention mechanism. We propose a new simple network architecture, the Transformer, "
... "based solely on attention mechanisms, dispensing with recurrence and convolutions entirely. "
... "Experiments on two machine translation tasks show these models to be superior in quality "
... "while being more parallelizable and requiring significantly less time to train."
... )
>>> inputs = tokenizer([ARTICLE_TO_SUMMARIZE], max_length=4096, return_tensors="pt", truncation=True)
>>> # Generate Summary
>>> summary_ids = model.generate(inputs["input_ids"], num_beams=4, max_length=15)
>>> tokenizer.batch_decode(summary_ids, skip_special_tokens=True, clean_up_tokenization_spaces=False)[0]
'dominant sequence models are based on recurrent or convolutional neural networks .'BigBirdPegasusForSequenceClassification
class transformers.BigBirdPegasusForSequenceClassification
< source >( config: BigBirdPegasusConfig **kwargs )
参数
- config (BigBirdPegasusConfig) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型关联的权重，仅加载配置。查看 from_pretrained() 方法来加载模型权重。
BigBirdPegasus 模型，顶部带有序列分类/头（池化输出之上的线性层），例如用于 GLUE 任务。
该模型继承自 PreTrainedModel。查看超类文档以了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入的大小等）。
此模型也是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档，了解与一般使用和行为相关的所有事宜。
正向传播
< source >( input_ids: LongTensor = None attention_mask: Optional = None decoder_input_ids: 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 inputs_embeds: Optional = None decoder_inputs_embeds: Optional = None labels: Optional = None use_cache: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → transformers.modeling_outputs.Seq2SeqSequenceClassifierOutput or tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor形状为(batch_size, sequence_length)) — 输入序列标记在词汇表中的索引。如果您提供填充，默认情况下将忽略填充。可以使用 AutoTokenizer 获取索引。查看 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call() 以了解详细信息。
- attention_mask (
torch.Tensor形状为(batch_size, sequence_length), 可选) — 掩码以避免对填充令牌索引执行注意力。掩码值在[0, 1]中选择：- 1 表示未被掩码的令牌，
- 0 表示被掩码的令牌。
- decoder_input_ids (
torch.LongTensor形状为(batch_size, target_sequence_length), 可选) — 用于翻译和摘要训练。默认情况下，模型将通过将input_ids向右移动来创建此张量，遵循论文。 - decoder_attention_mask (
torch.LongTensor形状为(batch_size, target_sequence_length), 可选) — 默认行为：生成一个忽略decoder_input_ids中填充令牌的张量。因果掩码也将默认使用。如果您想更改填充行为，您应该阅读
modeling_bigbird_pegasus._prepare_decoder_attention_mask并修改以满足您的需求。有关默认策略的更多信息，请参见 论文 中的图 1。 - decoder_head_mask (
torch.Tensor形状为(num_layers, num_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(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，用户可以选择仅输入形状为(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索引转换为关联向量比模型的内部嵌入查找矩阵具有更多控制权，这将很有用。 - decoder_inputs_embeds (
torch.FloatTensor形状为(batch_size, target_sequence_length, hidden_size), 可选) — 可选地，而不是传递decoder_input_ids，您可以选择直接传递嵌入表示。如果使用past_key_values，可以选择仅输入最后一个decoder_inputs_embeds（参见past_key_values）。如果您希望对如何将decoder_input_ids索引转换为关联向量比模型的内部嵌入查找矩阵具有更多控制权，这将很有用。如果
decoder_input_ids和decoder_inputs_embeds都未设置，则decoder_inputs_embeds将取inputs_embeds的值。 - use_cache (
bool, 可选) — 如果设置为True，则返回past_key_values键值状态，可用于加速解码（参见past_key_values）。 - output_attentions (
bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量中的attentions。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量中的hidden_states。 - return_dict (
bool, 可选) — 是否返回一个 ModelOutput 而不是一个简单的元组。 - labels (
torch.LongTensor形状为(batch_size,)，可选) — 用于计算序列分类/回归损失的标签。索引应在[0, ..., config.num_labels - 1]中。如果config.num_labels > 1，则计算分类损失（交叉熵）。
返回
transformers.modeling_outputs.Seq2SeqSequenceClassifierOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.Seq2SeqSequenceClassifierOutput 或者一个 torch.FloatTensor 的元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），包括根据配置 (BigBirdPegasusConfig) 和输入的不同元素。
-
loss (
torch.FloatTensor形状为(1,)，可选，在提供label时返回) — 分类（或如果 config.num_labels==1 则为回归）损失。 -
logits (
torch.FloatTensor形状为(batch_size, config.num_labels)) — 分类（或如果 config.num_labels==1 则为回归）分数（在 SoftMax 之前）。 -
past_key_values (
tuple(tuple(torch.FloatTensor))，可选，在传递use_cache=True或config.use_cache=True时返回) — 长度为config.n_layers的tuple(torch.FloatTensor)元组，每个元组包含 2 个形状为(batch_size, num_heads, sequence_length, embed_size_per_head)的张量，以及 2 个形状为(batch_size, num_heads, encoder_sequence_length, embed_size_per_head)的附加张量。包含预先计算的隐藏状态（自注意力块和交叉注意力块中的键和值），这些隐藏状态可用于（参见
past_key_values输入）加速顺序解码。 -
decoder_hidden_states (
tuple(torch.FloatTensor)，可选，在传递output_hidden_states=True或config.output_hidden_states=True时返回) —torch.FloatTensor的元组（如果模型具有嵌入层，则对于嵌入的输出，+ 每个层的输出）形状为(batch_size, sequence_length, hidden_size)。解码器在每层输出处的隐藏状态，以及初始嵌入输出。
-
decoder_attentions (
tuple(torch.FloatTensor)，可选，在传递output_attentions=True或config.output_attentions=True时返回) —torch.FloatTensor的元组（每个层一个）形状为(batch_size, num_heads, sequence_length, sequence_length)。解码器的注意力权重，在注意力 softmax 之后，用于计算自注意力头中的加权平均值。
-
cross_attentions (
tuple(torch.FloatTensor)，可选，在传递output_attentions=True或config.output_attentions=True时返回) —torch.FloatTensor的元组（每个层一个）形状为(batch_size, num_heads, sequence_length, sequence_length)。解码器交叉注意力层的注意力权重，在注意力 softmax 之后，用于计算交叉注意力头中的加权平均值。
-
encoder_last_hidden_state (
torch.FloatTensor形状为(batch_size, sequence_length, hidden_size)，可选) — 模型编码器最后一层的输出处的隐藏状态序列。 -
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 之后，用于计算自注意力头中的加权平均值。
The BigBirdPegasusForSequenceClassification 前向方法，覆盖 __call__ 特殊方法。
虽然正向传递的配方需要在此函数内定义，但应该在之后调用 Module 实例，而不是此函数，因为前者负责运行预处理和后处理步骤，而后者则静默地忽略它们。
单标签分类示例
>>> import torch
>>> from transformers import AutoTokenizer, BigBirdPegasusForSequenceClassification
>>> tokenizer = AutoTokenizer.from_pretrained("google/bigbird-pegasus-large-arxiv")
>>> model = BigBirdPegasusForSequenceClassification.from_pretrained("google/bigbird-pegasus-large-arxiv")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")
>>> with torch.no_grad():
... logits = model(**inputs).logits
>>> predicted_class_id = logits.argmax().item()
>>> # To train a model on `num_labels` classes, you can pass `num_labels=num_labels` to `.from_pretrained(...)`
>>> num_labels = len(model.config.id2label)
>>> model = BigBirdPegasusForSequenceClassification.from_pretrained("google/bigbird-pegasus-large-arxiv", num_labels=num_labels)
>>> labels = torch.tensor([1])
>>> loss = model(**inputs, labels=labels).loss多标签分类示例
>>> import torch
>>> from transformers import AutoTokenizer, BigBirdPegasusForSequenceClassification
>>> tokenizer = AutoTokenizer.from_pretrained("google/bigbird-pegasus-large-arxiv")
>>> model = BigBirdPegasusForSequenceClassification.from_pretrained("google/bigbird-pegasus-large-arxiv", problem_type="multi_label_classification")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")
>>> with torch.no_grad():
... logits = model(**inputs).logits
>>> predicted_class_ids = torch.arange(0, logits.shape[-1])[torch.sigmoid(logits).squeeze(dim=0) > 0.5]
>>> # To train a model on `num_labels` classes, you can pass `num_labels=num_labels` to `.from_pretrained(...)`
>>> num_labels = len(model.config.id2label)
>>> model = BigBirdPegasusForSequenceClassification.from_pretrained(
... "google/bigbird-pegasus-large-arxiv", num_labels=num_labels, problem_type="multi_label_classification"
... )
>>> labels = torch.sum(
... torch.nn.functional.one_hot(predicted_class_ids[None, :].clone(), num_classes=num_labels), dim=1
... ).to(torch.float)
>>> loss = model(**inputs, labels=labels).lossBigBirdPegasusForQuestionAnswering
class transformers.BigBirdPegasusForQuestionAnswering
< 源代码 >( config )
参数
- config (BigBirdPegasusConfig) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型关联的权重，只会加载配置。查看 from_pretrained() 方法来加载模型权重。
BigBirdPegasus 模型，顶部有一个跨度分类头，用于 SQuAD 等提取式问答任务（隐藏状态输出顶部的线性层，用于计算span start logits 和 span end logits）。
该模型继承自 PreTrainedModel。查看超类文档以了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入的大小等）。
此模型也是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档，了解与一般使用和行为相关的所有事宜。
正向传播
< 源代码 >( input_ids: Tensor = None attention_mask: Optional = None decoder_input_ids: 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 start_positions: Optional = None end_positions: Optional = None inputs_embeds: Optional = None decoder_inputs_embeds: Optional = None use_cache: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → transformers.modeling_outputs.Seq2SeqQuestionAnsweringModelOutput or tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor形状为(batch_size, sequence_length)) — 词汇表中输入序列标记的索引。如果您提供填充，默认情况下将忽略填充。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensor形状为(batch_size, sequence_length), 可选) — 用于避免对填充标记索引执行注意的掩码。在[0, 1]中选择掩码值：- 1 用于未掩码的标记，
- 0 用于掩码的标记。
- decoder_input_ids (
torch.LongTensor形状为(batch_size, target_sequence_length), 可选) — 提供用于翻译和摘要训练。默认情况下，模型将通过将input_ids向右移动来创建此张量，遵循论文。 - decoder_attention_mask (
torch.LongTensor形状为(batch_size, target_sequence_length), 可选) — 默认行为：生成一个忽略decoder_input_ids中的填充标记的张量。因果掩码也将默认使用。如果您想更改填充行为，您应该阅读
modeling_bigbird_pegasus._prepare_decoder_attention_mask并根据您的需求进行修改。有关默认策略的更多信息，请参阅 论文 中的图 1。 - decoder_head_mask (
torch.Tensor形状为(num_layers, num_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，用户可以选择仅输入形状为(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索引转换为关联的向量，这将非常有用。 - decoder_inputs_embeds (
torch.FloatTensor形状为(batch_size, target_sequence_length, hidden_size)，可选) — 可选地，您可以选择直接传递嵌入表示，而不是传递decoder_input_ids。 如果使用past_key_values，则可以选择仅输入最后一个decoder_inputs_embeds（请参阅past_key_values）。如果您希望比模型的内部嵌入查找矩阵更精确地控制如何将decoder_input_ids索引转换为关联的向量，这将非常有用。如果
decoder_input_ids和decoder_inputs_embeds都未设置，则decoder_inputs_embeds将采用inputs_embeds的值。 - use_cache (
bool，可选) — 如果设置为True，将返回past_key_values键值状态，可用于加速解码（请参阅past_key_values）。 - output_attentions (
bool，可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量中的attentions。 - output_hidden_states (
bool，可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量中的hidden_states。 - return_dict (
bool，可选) — 是否返回 ModelOutput 而不是普通元组。 - start_positions (
torch.LongTensor形状为(batch_size,)，可选) — 用于计算标记分类损失的标记跨度的起始位置（索引）的标签。位置被钳制到序列的长度（sequence_length）。序列之外的位置不会被考虑用于计算损失。 - end_positions (
torch.LongTensor形状为(batch_size,)，可选) — 用于计算标记分类损失的标记跨度的结束位置（索引）的标签。位置被钳制到序列的长度（sequence_length）。序列之外的位置不会被考虑用于计算损失。
返回
transformers.modeling_outputs.Seq2SeqQuestionAnsweringModelOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.Seq2SeqQuestionAnsweringModelOutput 或一个 torch.FloatTensor 元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），包括根据配置 (BigBirdPegasusConfig) 和输入的不同元素。
-
loss (
torch.FloatTensor形状为(1,)，可选，在提供labels时返回) — 总跨度提取损失是起始和结束位置的交叉熵之和。 -
start_logits (
torch.FloatTensor形状为(batch_size, sequence_length)) — 跨度起始分数（在 SoftMax 之前）。 -
end_logits (
torch.FloatTensor形状为(batch_size, sequence_length)) — 跨度结束分数（在 SoftMax 之前）。 -
past_key_values (
tuple(tuple(torch.FloatTensor))，可选，在传递use_cache=True或config.use_cache=True时返回) — 长度为config.n_layers的tuple(torch.FloatTensor)元组，每个元组包含 2 个形状为(batch_size, num_heads, sequence_length, embed_size_per_head)的张量，以及 2 个形状为(batch_size, num_heads, encoder_sequence_length, embed_size_per_head)的附加张量。包含预先计算的隐藏状态（自注意力块和交叉注意力块中的键和值），这些隐藏状态可用于（参见
past_key_values输入）加速顺序解码。 -
decoder_hidden_states (
tuple(torch.FloatTensor)，可选，在传递output_hidden_states=True或config.output_hidden_states=True时返回) —torch.FloatTensor的元组（如果模型具有嵌入层，则对于嵌入的输出，+ 每个层的输出）形状为(batch_size, sequence_length, hidden_size)。解码器在每层输出处的隐藏状态，以及初始嵌入输出。
-
decoder_attentions (
tuple(torch.FloatTensor)，可选，在传递output_attentions=True或config.output_attentions=True时返回) —torch.FloatTensor的元组（每个层一个）形状为(batch_size, num_heads, sequence_length, sequence_length)。解码器的注意力权重，在注意力 softmax 之后，用于计算自注意力头中的加权平均值。
-
cross_attentions (
tuple(torch.FloatTensor)，可选，在传递output_attentions=True或config.output_attentions=True时返回) —torch.FloatTensor的元组（每个层一个）形状为(batch_size, num_heads, sequence_length, sequence_length)。解码器交叉注意力层的注意力权重，在注意力 softmax 之后，用于计算交叉注意力头中的加权平均值。
-
encoder_last_hidden_state (
torch.FloatTensor形状为(batch_size, sequence_length, hidden_size)，可选) — 模型编码器最后一层的输出处的隐藏状态序列。 -
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 之后，用于计算自注意力头中的加权平均值。
The BigBirdPegasusForQuestionAnswering 正向方法，覆盖了 __call__ 特殊方法。
虽然正向传递的配方需要在此函数内定义，但应该在之后调用 Module 实例，而不是此函数，因为前者负责运行预处理和后处理步骤，而后者则静默地忽略它们。
示例
>>> from transformers import AutoTokenizer, BigBirdPegasusForQuestionAnswering
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("google/bigbird-pegasus-large-arxiv")
>>> model = BigBirdPegasusForQuestionAnswering.from_pretrained("google/bigbird-pegasus-large-arxiv")
>>> question, text = "Who was Jim Henson?", "Jim Henson was a nice puppet"
>>> inputs = tokenizer(question, text, return_tensors="pt")
>>> with torch.no_grad():
... outputs = model(**inputs)
>>> answer_start_index = outputs.start_logits.argmax()
>>> answer_end_index = outputs.end_logits.argmax()
>>> predict_answer_tokens = inputs.input_ids[0, answer_start_index : answer_end_index + 1]
>>> # target is "nice puppet"
>>> target_start_index = torch.tensor([14])
>>> target_end_index = torch.tensor([15])
>>> outputs = model(**inputs, start_positions=target_start_index, end_positions=target_end_index)
>>> loss = outputs.lossBigBirdPegasusForCausalLM
正向传播
< source >( input_ids: LongTensor = None attention_mask: Optional = None encoder_hidden_states: Optional = None encoder_attention_mask: Optional = None head_mask: Optional = None cross_attn_head_mask: Optional = None past_key_values: Optional = None inputs_embeds: Optional = None labels: Optional = None use_cache: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → transformers.modeling_outputs.CausalLMOutputWithCrossAttentions or tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensorof shape(batch_size, sequence_length)) — 词汇表中输入序列标记的索引。如果您提供填充，默认情况下将忽略填充。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call() 。
- attention_mask (
torch.Tensorof shape(batch_size, sequence_length), optional) — 避免对填充标记索引执行注意力的掩码。掩码值在[0, 1]中选择：- 1 表示未屏蔽的标记，
- 0 表示屏蔽的标记。
- encoder_hidden_states (
torch.FloatTensorof shape(batch_size, sequence_length, hidden_size), optional) — 编码器最后一层的输出处的隐藏状态序列。如果模型配置为解码器，则用于交叉注意。 - encoder_attention_mask (
torch.FloatTensorof shape(batch_size, sequence_length), optional) — 避免对编码器输入的填充标记索引执行注意力的掩码。如果模型配置为解码器，则此掩码用于交叉注意。掩码值在[0, 1]中选择： - head_mask (
torch.Tensorof shape(decoder_layers, decoder_attention_heads), optional) — 掩盖注意力模块中选定头的掩码。掩码值在[0, 1]中选择：- 1 表示未屏蔽的头，
- 0 表示屏蔽的头。
- cross_attn_head_mask (
torch.Tensorof shape(decoder_layers, decoder_attention_heads), optional) — 掩盖交叉注意力模块中选定头的掩码。掩码值在[0, 1]中选择：- 1 表示未屏蔽的头，
- 0 表示屏蔽的头。
- past_key_values (
tuple(tuple(torch.FloatTensor)), 可选, 在传入 `use_cache=True` 或 `config.use_cache=True` 时返回) — 长度为 `config.n_layers` 的 `tuple(torch.FloatTensor)` 元组，每个元组包含 2 个形状为 `(batch_size, num_heads, sequence_length, embed_size_per_head)` 的张量以及 2 个形状为 `(batch_size, num_heads, encoder_sequence_length, embed_size_per_head)` 的额外张量。当模型在序列到序列模型中用作解码器时，只需要这两个额外的张量。包含预先计算的隐藏状态（自注意力块和交叉注意力块中的键和值），可用于（参见 `past_key_values` 输入）加速顺序解码。
如果使用 `past_key_values`，用户可以选择仅输入最后 `decoder_input_ids`（形状为 `(batch_size, 1)`，这些 `decoder_input_ids` 未提供其过去的键值状态）而不是所有 `decoder_input_ids`（形状为 `(batch_size, sequence_length)`）。
- labels (
torch.LongTensor形状为 `(batch_size, sequence_length)`，可选) — 用于计算掩码语言建模损失的标签。索引应在 `[0, ..., config.vocab_size]` 或 -100 中（参见 `input_ids` 文档字符串）。索引设置为 `-100` 的令牌将被忽略（掩码），仅针对标签在 `[0, ..., config.vocab_size]` 中的令牌计算损失。 - use_cache (
bool, 可选) — 如果设置为 `True`，则返回 `past_key_values` 键值状态，可用于加速解码（参见 `past_key_values`）。- 1 表示未掩码的令牌，
- 0 表示掩码的令牌。
- output_attentions (
bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参见返回张量下的 `attentions`。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参见返回张量下的 `hidden_states`。 - return_dict (
bool, 可选) — 是否返回 ModelOutput 而不是普通元组。
返回
transformers.modeling_outputs.CausalLMOutputWithCrossAttentions 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.CausalLMOutputWithCrossAttentions 或一个 `torch.FloatTensor` 元组（如果传入 `return_dict=False` 或 `config.return_dict=False`），包含根据配置 (BigBirdPegasusConfig) 和输入而异的各种元素。
-
loss (
torch.FloatTensor形状为 `(1,)`，可选，在提供 `labels` 时返回) — 语言建模损失（用于下一个令牌预测）。 -
logits (
torch.FloatTensor形状为(batch_size, sequence_length, config.vocab_size)) — 语言建模头的预测分数（SoftMax 之前的每个词汇标记的分数）。 -
hidden_states (
tuple(torch.FloatTensor), 可选, 在传入 `output_hidden_states=True` 或 `config.output_hidden_states=True` 时返回) — `torch.FloatTensor` 元组（一个用于嵌入的输出，如果模型具有嵌入层，则加一个用于每一层的输出），形状为 `(batch_size, sequence_length, hidden_size)`。模型在每一层输出处的隐藏状态加上可选的初始嵌入输出。
-
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 后的交叉注意力权重，用于计算交叉注意力头中的加权平均值。
-
past_key_values (
tuple(tuple(torch.FloatTensor)), 可选, 在传入 `use_cache=True` 或 `config.use_cache=True` 时返回) — 长度为 `config.n_layers` 的 `torch.FloatTensor` 元组元组，每个元组包含自注意力和交叉注意力层的缓存键值状态（如果模型在编码器-解码器设置中使用）。仅在 `config.is_decoder = True` 时相关。包含预先计算的隐藏状态（注意力块中的键和值），可用于（参见 `past_key_values` 输入）加速顺序解码。
示例
>>> from transformers import AutoTokenizer, BigBirdPegasusForCausalLM
>>> tokenizer = AutoTokenizer.from_pretrained("google/bigbird-pegasus-large-arxiv")
>>> model = BigBirdPegasusForCausalLM.from_pretrained(
... "google/bigbird-pegasus-large-arxiv", add_cross_attention=False
... )
>>> assert model.config.is_decoder, f"{model.__class__} has to be configured as a decoder."
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")
>>> outputs = model(**inputs)
>>> logits = outputs.logits