Transformers 文档
BigBird
并获得增强的文档体验
开始使用
该模型于 2020-07-28 发布，并于 2021-03-30 添加到 Hugging Face Transformers。
BigBird
BigBird 是一个 transformer 模型，能够处理长达 4096 个序列长度，而 BERT 的序列长度为 512。传统的 transformer 模型在处理长输入时存在困难，因为随着序列长度的增加，注意力机制的计算成本会变得非常高。BigBird 通过使用稀疏注意力机制解决了这个问题，这意味着它不会试图一次性关注所有内容。相反，它混合了局部注意力、随机注意力和少量全局 token 来处理整个输入。这种组合使它能够兼顾效率和理解能力。因此，BigBird 非常适合处理涉及长文档的任务，例如问答、摘要和基因组学应用。
您可以在 Google 组织下找到所有原始的 BigBird 检查点。
点击侧边栏的 BigBird 模型，了解更多关于如何将 BigBird 应用于不同语言任务的示例。
下面的示例演示了如何使用 Pipeline、AutoModel 和从命令行预测 [MASK] 标记。
import torch
from transformers import pipeline
pipeline = pipeline(
task="fill-mask",
model="google/bigbird-roberta-base",
dtype=torch.float16,
device=0
)
pipeline("Plants create [MASK] through a process known as photosynthesis.")注意事项
- 由于 BigBird 使用绝对位置嵌入，输入应在右侧进行填充。
- BigBird 支持
original_full和block_sparse注意力。如果输入序列长度小于 1024，建议使用original_full，因为稀疏模式对于较小的输入不会提供太多优势。 - 当前实现使用 3 个块的窗口大小和 2 个全局块，仅支持 ITC 实现，并且不支持
num_random_blocks=0。 - 序列长度必须能被块大小整除。
资源
- 有关其注意力机制的更多详细信息，请阅读 BigBird 博客文章。
BigBirdConfig
class transformers.BigBirdConfig
< source >( vocab_size = 50358 hidden_size = 768 num_hidden_layers = 12 num_attention_heads = 12 intermediate_size = 3072 hidden_act = 'gelu_new' hidden_dropout_prob = 0.1 attention_probs_dropout_prob = 0.1 max_position_embeddings = 4096 type_vocab_size = 2 initializer_range = 0.02 layer_norm_eps = 1e-12 use_cache = True pad_token_id = 0 bos_token_id = 1 eos_token_id = 2 sep_token_id = 66 attention_type = 'block_sparse' use_bias = True rescale_embeddings = False block_size = 64 num_random_blocks = 3 classifier_dropout = None is_decoder = False add_cross_attention = False tie_word_embeddings = True **kwargs )
参数
- vocab_size (
int, optional, defaults to 50358) — BigBird 模型词汇表大小。定义在调用 BigBirdModel 时传入的inputs_ids可以表示的不同 token 的数量。 - hidden_size (
int, optional, defaults to 768) — Transformer encoder 和 pooler 层的维度。 - num_hidden_layers (
int, optional, defaults to 12) — Transformer encoder 中的隐藏层数。 - num_attention_heads (
int, optional, defaults to 12) — Transformer encoder 中每个注意力层的注意力头数量。 - intermediate_size (
int, optional, defaults to 3072) — Transformer encoder 中“中间”层（即前馈层）的维度。 - hidden_act (
strorfunction, optional, defaults to"gelu_new") — Encoder 和 pooler 中的非线性激活函数（函数或字符串）。如果为字符串，支持"gelu"、"relu"、"selu"和"gelu_new"。 - hidden_dropout_prob (
float, optional, defaults to 0.1) — Embeddings、encoder 和 pooler 中所有全连接层的 dropout 概率。 - attention_probs_dropout_prob (
float, optional, defaults to 0.1) — 注意力概率的 dropout 比率。 - max_position_embeddings (
int, optional, defaults to 4096) — 该模型可能使用的最大序列长度。通常将其设置为较大的值以备不时之需（例如，1024、2048 或 4096）。 - type_vocab_size (
int, optional, defaults to 2) — 调用 BigBirdModel 时传入的token_type_ids的词汇表大小。 - initializer_range (
float, optional, defaults to 0.02) — 用于初始化所有权重矩阵的 truncated_normal_initializer 的标准差。 - layer_norm_eps (
float, optional, defaults to 1e-12) — 层归一化层使用的 epsilon。 - is_decoder (
bool, optional, defaults toFalse) — 模型是否用作解码器。如果为False，则模型用作编码器。 - use_cache (
bool, optional, defaults toTrue) — 模型是否应该返回最后的键/值注意力（并非所有模型都使用）。仅当config.is_decoder=True时相关。 - attention_type (
str, optional, defaults to"block_sparse") — 是否使用块稀疏注意力（复杂度为 n）或原始注意力层（复杂度为 n^2）。可能的值为"original_full"和"block_sparse"。 - use_bias (
bool, optional, defaults toTrue) — 是否在查询、键、值中使用偏置。 - rescale_embeddings (
bool, optional, defaults toFalse) — 是否使用 (hidden_size ** 0.5) 对嵌入进行重缩放。 - block_size (
int, optional, defaults to 64) — 每个块的大小。仅当attention_type == "block_sparse"时有用。 - num_random_blocks (
int, optional, defaults to 3) — 每个查询将关注的随机块的数量。仅当attention_type == "block_sparse"时有用。 - classifier_dropout (
float, optional) — 分类头的 dropout 比率。
这是用于存储 BigBirdModel 配置的配置类。它用于根据指定的参数实例化一个 BigBird 模型，定义模型的架构。使用默认值实例化一个配置将产生一个与 BigBird google/bigbird-roberta-base 架构类似的配置。
配置对象继承自 PreTrainedConfig，可用于控制模型输出。有关更多信息，请阅读 PreTrainedConfig 的文档。
示例
>>> from transformers import BigBirdConfig, BigBirdModel
>>> # Initializing a BigBird google/bigbird-roberta-base style configuration
>>> configuration = BigBirdConfig()
>>> # Initializing a model (with random weights) from the google/bigbird-roberta-base style configuration
>>> model = BigBirdModel(configuration)
>>> # Accessing the model configuration
>>> configuration = model.configBigBirdTokenizer
class transformers.BigBirdTokenizer
< source >( vocab: str | dict | list | None = None unk_token = '<unk>' bos_token = '<s>' eos_token = '</s>' pad_token = '<pad>' sep_token = '[SEP]' mask_token = '[MASK]' cls_token = '[CLS]' add_prefix_space = True **kwargs )
参数
- vocab (
str,dictorlist, optional) — 自定义词汇表字典。如果未提供，则从 vocab_file 加载词汇表。 - unk_token (
str, optional, defaults to"<unk>") — 未知标记。无法转换为 ID 的标记将设置为此标记。 - bos_token (
str, optional, defaults to"<s>") — 在预训练期间使用的序列开头标记。可用于序列分类器标记。构建使用特殊标记的序列时，使用的不是此序列开头标记。使用的标记是
cls_token。 - eos_token (
str, optional, defaults to"</s>") — 序列结束标记。 .. note:: 构建使用特殊标记的序列时，使用的不是此序列结束标记。使用的标记是sep_token。 - pad_token (
str, optional, defaults to"<pad>") — 填充标记，例如在批处理不同长度的序列时使用。 - sep_token (
str, optional, defaults to"[SEP]") — 分隔标记，在构建由多个序列组成的序列时使用，例如用于序列分类的两个序列，或用于文本和问题的问答。它也是使用特殊标记构建的序列的最后一个标记。 - mask_token (
str, optional, defaults to"[MASK]") — 掩码标记，用于掩码值。这是训练此模型时使用的掩码语言建模标记。这是模型将尝试预测的标记。 - cls_token (
str, optional, defaults to"[CLS]") — 分类标记，在进行序列分类（对整个序列而不是每个标记进行分类）时使用。它是在使用特殊标记构建的序列的第一个标记。 - add_prefix_space (
bool, optional, defaults toTrue) — 是否添加前导空格。这允许将前导词视为与其他词一样。 - vocab_file (
str, optional) — 包含实例化分词器所需的词汇表的 SentencePiece 文件（通常具有 .spm 扩展名）。 - tokenizer_file (
str, optional) — 包含分词器序列化的分词器 JSON 文件路径。
基于 Unigram 构建一个“快速”的 BigBird 分词器（由 HuggingFace 的 tokenizers 库支持）。此分词器继承自 PreTrainedTokenizerFast，其中包含大部分主要方法。用户应参考此父类以获取有关这些方法的更多信息。
get_special_tokens_mask
< source >( token_ids_0: list[int] token_ids_1: list[int] | None = None already_has_special_tokens: bool = False ) → 一个介于 0 和 1 之间的整数列表
Retrieve sequence ids from a token list that has no special tokens added.
For fast tokenizers, data collators call this with already_has_special_tokens=True to build a mask over an already-formatted sequence. In that case, we compute the mask by checking membership in all_special_ids.
BigBirdTokenizerFast
class transformers.BigBirdTokenizer
< source >( vocab: str | dict | list | None = None unk_token = '<unk>' bos_token = '<s>' eos_token = '</s>' pad_token = '<pad>' sep_token = '[SEP]' mask_token = '[MASK]' cls_token = '[CLS]' add_prefix_space = True **kwargs )
参数
- vocab (
str,dictorlist, optional) — 自定义词汇表字典。如果未提供，则从 vocab_file 加载词汇表。 - unk_token (
str, optional, defaults to"<unk>") — 未知标记。无法转换为 ID 的标记将设置为此标记。 - bos_token (
str, optional, defaults to"<s>") — 在预训练期间使用的序列开头标记。可用于序列分类器标记。构建使用特殊标记的序列时，使用的不是此序列开头标记。使用的标记是
cls_token。 - eos_token (
str, optional, defaults to"</s>") — 序列结束标记。 .. note:: 构建使用特殊标记的序列时，使用的不是此序列结束标记。使用的标记是sep_token。 - pad_token (
str, optional, defaults to"<pad>") — 填充标记，例如在批处理不同长度的序列时使用。 - sep_token (
str, optional, defaults to"[SEP]") — 分隔标记，在构建由多个序列组成的序列时使用，例如用于序列分类的两个序列，或用于文本和问题的问答。它也是使用特殊标记构建的序列的最后一个标记。 - mask_token (
str, optional, defaults to"[MASK]") — 掩码标记，用于掩码值。这是训练此模型时使用的掩码语言建模标记。这是模型将尝试预测的标记。 - cls_token (
str, optional, defaults to"[CLS]") — 分类标记，在进行序列分类（对整个序列而不是每个标记进行分类）时使用。它是在使用特殊标记构建的序列的第一个标记。 - add_prefix_space (
bool, optional, defaults toTrue) — 是否添加前导空格。这允许将前导词视为与其他词一样。 - vocab_file (
str, optional) — 包含实例化分词器所需的词汇表的 SentencePiece 文件（通常具有 .spm 扩展名）。 - tokenizer_file (
str, optional) — 包含分词器序列化的分词器 JSON 文件路径。
基于 Unigram 构建一个“快速”的 BigBird 分词器（由 HuggingFace 的 tokenizers 库支持）。此分词器继承自 PreTrainedTokenizerFast，其中包含大部分主要方法。用户应参考此父类以获取有关这些方法的更多信息。
BigBird 特有的输出
class transformers.models.big_bird.modeling_big_bird.BigBirdForPreTrainingOutput
< source >( loss: torch.FloatTensor | None = None prediction_logits: torch.FloatTensor | None = None seq_relationship_logits: torch.FloatTensor | None = None hidden_states: tuple[torch.FloatTensor] | None = None attentions: tuple[torch.FloatTensor] | None = None )
参数
- loss (
*optional*, 当labels已提供时返回,torch.FloatTensorshape(1,)) — 总损失，为掩码语言建模损失和下一序列预测（分类）损失的总和。 - prediction_logits (
torch.FloatTensorshape(batch_size, sequence_length, config.vocab_size)) — 语言模型头的预测分数（SoftMax 之前的每个词汇标记的分数）。 - seq_relationship_logits (
torch.FloatTensorof shape(batch_size, 2)) — 下一个句子预测（分类）头的预测分数（SoftMax之前的True/False连续性得分）。 - hidden_states (
tuple[torch.FloatTensor] | None.hidden_states, 当传递output_hidden_states=True或config.output_hidden_states=True时返回) — 形状为(batch_size, sequence_length, hidden_size)的torch.FloatTensor的元组（一个用于词嵌入的输出，如果模型有词嵌入层，加上每个层的输出）。模型在每层的输出处的隐藏状态，加上可选的初始词嵌入输出。
- attentions (
tuple[torch.FloatTensor] | None.attentions, 当传递output_attentions=True或config.output_attentions=True时返回) — 形状为(batch_size, num_heads, sequence_length, sequence_length)的torch.FloatTensor元组（每个层一个）。计算自注意力头中加权平均值所用的注意力 softmax 之后的注意力权重。
BigBirdForPreTraining 的输出类型。
BigBirdModel
class transformers.BigBirdModel
< source >( config add_pooling_layer = True )
参数
- config (BigBirdModel) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载模型权重，仅加载配置。请查看 from_pretrained() 方法来加载模型权重。
- add_pooling_layer (
bool, optional, defaults toTrue) — 是否添加池化层
一个不带任何特定头部、仅输出原始隐藏状态的 Big Bird 模型。
此模型继承自 PreTrainedModel。查看其父类文档，了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头等）。
此模型也是一个 PyTorch torch.nn.Module 子类。像普通的 PyTorch Module 一样使用它，并参考 PyTorch 文档了解一般用法和行为的所有相关信息。
forward
< source >( input_ids: torch.LongTensor | None = None attention_mask: torch.FloatTensor | None = None token_type_ids: torch.LongTensor | None = None position_ids: torch.LongTensor | None = None inputs_embeds: torch.FloatTensor | None = None encoder_hidden_states: torch.FloatTensor | None = None encoder_attention_mask: torch.FloatTensor | None = None past_key_values: transformers.cache_utils.Cache | None = None use_cache: bool | None = None output_attentions: bool | None = None output_hidden_states: bool | None = None return_dict: bool | None = None cache_position: torch.Tensor | None = None **kwargs ) → transformers.modeling_outputs.BaseModelOutputWithPoolingAndCrossAttentions 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensorof shape(batch_size, sequence_length), optional) — 词汇表中输入序列 token 的索引。默认情况下将忽略 padding。索引可以使用 AutoTokenizer 获取。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.FloatTensorof shape(batch_size, sequence_length), optional) — 用于避免对 padding token 索引执行 attention 的掩码。掩码值选择在[0, 1]之间：- 1 表示未掩码的 token，
- 0 表示已掩码的 token。
- token_type_ids (
torch.LongTensorof shape(batch_size, sequence_length), optional) — 用于区分输入的第一部分和第二部分的 segment token 索引。索引选择在[0, 1]之间：- 0 对应于句子 A 的 token，
- 1 对应于句子 B 的 token。
- position_ids (
torch.LongTensorof shape(batch_size, sequence_length), optional) — 输入序列 token 在位置词嵌入中的索引。选择范围为[0, config.n_positions - 1]。 - inputs_embeds (
torch.FloatTensorof shape(batch_size, sequence_length, hidden_size), optional) — 可选地，您可以直接传入嵌入表示，而不是传入input_ids。如果您想比模型的内部嵌入查找矩阵更精确地控制如何将input_ids索引转换为关联向量，这将很有用。 - encoder_hidden_states (
torch.FloatTensorof shape(batch_size, sequence_length, hidden_size), optional) — 编码器最后一层输出的隐藏状态序列。当模型配置为解码器时，用于交叉 attention。 - encoder_attention_mask (
torch.FloatTensorof shape(batch_size, sequence_length), optional) — 用于避免对编码器输入的 padding token 索引执行 attention 的掩码。当模型配置为解码器时，此掩码用于交叉 attention。掩码值选择在[0, 1]之间：- 1 表示未掩码的 token，
- 0 表示已掩码的 token。
- past_key_values (
~cache_utils.Cache, optional) — 可用于加速序列解码的预计算隐藏状态（自 attention 块和交叉 attention 块中的 key 和 value）。这通常是由模型在之前的解码阶段返回的past_key_values，当use_cache=True或config.use_cache=True时。只允许输入
Cache实例，请参阅我们的 kv cache 指南。如果未传入past_key_values，则默认初始化DynamicCache。模型将输出与输入相同的 cache 格式。
如果使用了
past_key_values，用户需要只传入未处理的input_ids（即其 past key value 状态未提供给此模型的那些），形状为(batch_size, unprocessed_length)，而不是所有input_ids的形状(batch_size, sequence_length)。 - use_cache (
bool, optional) — 如果设置为True，则返回past_key_values键值状态，并可用于加速解码（请参阅past_key_values）。 - output_attentions (
bool, optional) — 是否返回所有 attention 层的 attention 张量。有关更多详细信息，请参阅返回的张量下的attentions。 - output_hidden_states (
bool, optional) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回的张量下的hidden_states。 - return_dict (
bool, optional) — 是否返回一个 ModelOutput 而不是一个普通的元组。 - cache_position (
torch.Tensorof shape(sequence_length), optional) — 指示输入序列 token 在序列中位置的索引。与position_ids不同，此张量不受 padding 的影响。它用于在正确位置更新 cache 并推断完整序列长度。
返回
transformers.modeling_outputs.BaseModelOutputWithPoolingAndCrossAttentions or tuple(torch.FloatTensor)
根据配置（BigBirdConfig）和输入，可能会包含各种元素的 transformers.modeling_outputs.BaseModelOutputWithPoolingAndCrossAttentions 或 torch.FloatTensor 的元组（如果传递了 return_dict=False 或 config.return_dict=False）。
-
last_hidden_state (
torch.FloatTensor, 形状为(batch_size, sequence_length, hidden_size)) — 模型最后一层输出的隐藏状态序列。 -
pooler_output (
torch.FloatTensor，形状为(batch_size, hidden_size)) — 序列第一个 token（分类 token）在进一步通过用于辅助预训练任务的层后的最后一个隐藏状态。例如，对于 BERT 系列模型，这会返回经过线性层和 tanh 激活函数处理后的分类 token。线性层的权重是通过预训练期间的下一句预测（分类）目标来训练的。 -
hidden_states (
tuple(torch.FloatTensor), optional, 当传递output_hidden_states=True或当config.output_hidden_states=True时返回) —torch.FloatTensor的元组（一个用于嵌入层的输出，如果模型有嵌入层；+一个用于每个层的输出），形状为(batch_size, sequence_length, hidden_size)。模型在每个层输出的隐藏状态以及可选的初始嵌入输出。
-
attentions (
tuple(torch.FloatTensor), optional, 当传递output_attentions=True或当config.output_attentions=True时返回) —torch.FloatTensor的元组（每个层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
-
cross_attentions (
tuple(torch.FloatTensor), optional, returned whenoutput_attentions=Trueandconfig.add_cross_attention=Trueis passed or whenconfig.output_attentions=True) — Tuple oftorch.FloatTensor(one for each layer) of shape(batch_size, num_heads, sequence_length, sequence_length).解码器交叉注意力层的注意力权重，在注意力 softmax 之后，用于计算交叉注意力头中的加权平均。
-
past_key_values (
Cache, optional, 当传递use_cache=True或当config.use_cache=True时返回) — 它是 Cache 实例。更多详情，请参阅我们的 kv cache 指南。Contains pre-computed hidden-states (key and values in the self-attention blocks and optionally if
config.is_encoder_decoder=Truein the cross-attention blocks) that can be used (seepast_key_valuesinput) to speed up sequential decoding.
BigBirdModel 的 forward 方法，重写了 __call__ 特殊方法。
虽然 forward pass 的实现需要在此函数中定义，但你应该在之后调用
Module实例而不是这个，因为前者负责运行预处理和后处理步骤，而后者会静默地忽略它们。
BigBirdForPreTraining
forward
< source >( input_ids: torch.LongTensor | None = None attention_mask: torch.FloatTensor | None = None token_type_ids: torch.LongTensor | None = None position_ids: torch.LongTensor | None = None inputs_embeds: torch.FloatTensor | None = None labels: torch.FloatTensor | None = None next_sentence_label: torch.LongTensor | None = None output_attentions: bool | None = None output_hidden_states: bool | None = None return_dict: bool | None = None **kwargs ) → transformers.models.big_bird.modeling_big_bird.BigBirdForPreTrainingOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor的形状为(batch_size, sequence_length), 可选) — 词汇表中输入序列 token 的索引。默认情况下将忽略填充。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.FloatTensor的形状为(batch_size, sequence_length), 可选) — 用于避免对填充 token 索引执行注意力的掩码。掩码值在[0, 1]中选择：- 1 代表未被掩码的 token，
- 0 代表被掩码的 token。
- token_type_ids (
torch.LongTensor的形状为(batch_size, sequence_length), 可选) — 用于指示输入的第一个和第二个部分的 segment token 索引。索引在[0, 1]中选择：- 0 对应于句子 A token，
- 1 对应于句子 B token。
- position_ids (
torch.LongTensor的形状为(batch_size, sequence_length), 可选) — 在位置嵌入中，每个输入序列 token 的位置索引。选择范围在[0, config.n_positions - 1]。 - inputs_embeds (
torch.FloatTensor的形状为(batch_size, sequence_length, hidden_size), 可选) — 备选地，您可以直接传入嵌入表示而不是传入input_ids。如果您希望对如何将input_ids索引转换为关联向量有更多的控制，而不是使用模型的内部嵌入查找矩阵，这会很有用。 - labels (
torch.LongTensor的形状为(batch_size, sequence_length), 可选) — 用于计算掩码语言模型损失的标签。索引应在[-100, 0, ..., config.vocab_size]中（参见input_ids文档字符串） 索引设置为-100的 token 将被忽略（掩码），仅对标签在[0, ..., config.vocab_size]中的 token 计算损失 - next_sentence_label (
torch.LongTensor的形状为(batch_size,), 可选) — 用于计算下一个句子预测（分类）损失的标签。如果指定，nsp 损失将添加到 masked_lm 损失中。输入应为一个序列对（参见input_ids文档字符串） 索引应在[0, 1]中：- 0 表示句子 B 是句子 A 的延续，
- 1 表示句子 B 是一个随机序列。
- output_attentions (
bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的attentions。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的hidden_states。 - return_dict (
bool, 可选) — 是否返回一个 ModelOutput 而不是一个普通的元组。
返回
transformers.models.big_bird.modeling_big_bird.BigBirdForPreTrainingOutput 或 tuple(torch.FloatTensor)
一个 transformers.models.big_bird.modeling_big_bird.BigBirdForPreTrainingOutput 或 torch.FloatTensor 的元组（如果传入 return_dict=False 或当 config.return_dict=False 时），其中包含根据配置（BigBirdConfig）和输入而定的各种元素。
-
loss (
*可选*, 当提供labels时返回,torch.FloatTensor, 形状为(1,)) — 总损失，是掩码语言建模损失和下一句预测（分类）损失的总和。 -
prediction_logits (
torch.FloatTensor形状为(batch_size, sequence_length, config.vocab_size)) — 语言建模头的预测分数（SoftMax 之前的每个词汇 token 的分数）。 -
seq_relationship_logits (
torch.FloatTensor形状为(batch_size, 2)) — 下一序列预测（分类）头的预测分数（SoftMax 之前的 True/False 延续分数）。 -
hidden_states (
tuple[torch.FloatTensor] | None.hidden_states, 当传递output_hidden_states=True或当config.output_hidden_states=True时返回) —torch.FloatTensor的元组（一个用于嵌入的输出，如果模型有嵌入层，+ 每个层的输出），形状为(batch_size, sequence_length, hidden_size)。模型在每个层输出的隐藏状态以及可选的初始嵌入输出。
-
attentions (
tuple[torch.FloatTensor] | None.attentions, 当传递output_attentions=True或当config.output_attentions=True时返回) —torch.FloatTensor的元组（每个层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
BigBirdForPreTraining 的前向方法，覆盖了 __call__ 特殊方法。
虽然 forward pass 的实现需要在此函数中定义，但你应该在之后调用
Module实例而不是这个，因为前者负责运行预处理和后处理步骤，而后者会静默地忽略它们。
示例
>>> from transformers import AutoTokenizer, BigBirdForPreTraining
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("google/bigbird-roberta-base")
>>> model = BigBirdForPreTraining.from_pretrained("google/bigbird-roberta-base")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")
>>> outputs = model(**inputs)
>>> prediction_logits = outputs.prediction_logits
>>> seq_relationship_logits = outputs.seq_relationship_logitsBigBirdForCausalLM
class transformers.BigBirdForCausalLM
< source >( config model_args: ~utils.generic.ModelArgs | None = None adapter_args: ~utils.generic.AdapterArgs | None = None lora_args: ~utils.generic.LoRAArgs | None = None tokenizer_args: ~utils.generic.TokenizerArgs | None = None dataset_args: ~utils.generic.DatasetArgs | None = None data_args: ~utils.generic.DataArgs | None = None training_args: ~utils.generic.TrainingArgs | None = None generation_args: ~utils.generic.GenerationArgs | None = None vision_tower_args: ~utils.generic.VisionTowerArgs | None = None qlora_args: ~utils.generic.QLoRAArgs | None = None vision_tower_template_args: ~utils.generic.VisionTowerTemplateArgs | None = None video_tower_args: ~utils.generic.VideoTowerArgs | None = None vision_config: ~utils.generic.VisionConfig | None = None video_config: ~utils.generic.VideoConfig | None = None load_dataset: bool | None = None load_data_collator: bool | None = None load_processor: bool | None = None load_lora_adapter: bool | None = None load_adapter: bool | None = None load_qlora_adapter: bool | None = None **kwargs: typing_extensions.Unpack[transformers.modeling_utils.PreTrainedModelKwargs] )
参数
- config (BigBirdForCausalLM) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型相关的权重，仅加载配置。查看 from_pretrained() 方法以加载模型权重。
带有 language modeling 头的 BigBird 模型，用于 CLM 微调。
此模型继承自 PreTrainedModel。查看其父类文档，了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头等）。
此模型也是一个 PyTorch torch.nn.Module 子类。像普通的 PyTorch Module 一样使用它，并参考 PyTorch 文档了解一般用法和行为的所有相关信息。
forward
< source >( input_ids: torch.LongTensor | None = None attention_mask: torch.FloatTensor | None = None token_type_ids: torch.LongTensor | None = None position_ids: torch.LongTensor | None = None inputs_embeds: torch.FloatTensor | None = None encoder_hidden_states: torch.FloatTensor | None = None encoder_attention_mask: torch.FloatTensor | None = None past_key_values: transformers.cache_utils.Cache | None = None labels: torch.LongTensor | None = None use_cache: bool | None = None output_attentions: bool | None = None output_hidden_states: bool | None = None return_dict: bool | None = None cache_position: torch.Tensor | None = None logits_to_keep: int | torch.Tensor = 0 **kwargs ) → transformers.modeling_outputs.CausalLMOutputWithCrossAttentions 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor的形状为(batch_size, sequence_length), 可选) — 词汇表中输入序列 token 的索引。默认情况下将忽略填充。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.FloatTensor的形状为(batch_size, sequence_length), 可选) — 用于避免对填充 token 索引执行注意力的掩码。掩码值在[0, 1]中选择：- 1 代表未被掩码的 token，
- 0 代表被掩码的 token。
- token_type_ids (
torch.LongTensor的形状为(batch_size, sequence_length), 可选) — 用于指示输入的第一个和第二个部分的 segment token 索引。索引在[0, 1]中选择：- 0 对应于句子 A token，
- 1 对应于句子 B token。
- position_ids (
torch.LongTensor的形状为(batch_size, sequence_length), 可选) — 在位置嵌入中，每个输入序列 token 的位置索引。选择范围在[0, config.n_positions - 1]。 - inputs_embeds (
torch.FloatTensor的形状为(batch_size, sequence_length, hidden_size), 可选) — 备选地，您可以直接传入嵌入表示而不是传入input_ids。如果您希望对如何将input_ids索引转换为关联向量有更多的控制，而不是使用模型的内部嵌入查找矩阵，这会很有用。 - 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]:- 1 表示未掩码的标记，
- 0 表示已掩码的标记。
- past_key_values (
~cache_utils.Cache, optional) — 预先计算的隐藏状态（自注意力块和交叉注意力块中的键和值），可用于加速顺序解码。这通常包括当use_cache=True或config.use_cache=True时，模型在先前的解码阶段返回的past_key_values。仅允许输入 Cache 实例，请参阅我们的 kv 缓存指南。如果未传入
past_key_values，则默认初始化 DynamicCache。模型将输出与输入相同的缓存格式。
如果使用
past_key_values，用户应仅输入未处理的input_ids（即没有将其过去键值状态提供给此模型的input_ids），其形状为(batch_size, unprocessed_length)，而不是所有input_ids的形状(batch_size, sequence_length)。 - labels (
torch.LongTensorof shape(batch_size, sequence_length), optional) — 用于计算从左到右语言模型损失（下一个词预测）的标签。索引应在[-100, 0, ..., config.vocab_size]范围内（请参阅input_ids文档字符串）。索引为-100的标记将被忽略（掩码），仅为标签在[0, ..., config.vocab_size]范围内的标记计算损失。 - 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 而不是一个普通元组。 - cache_position (
torch.Tensorof shape(sequence_length), optional) — 描述输入序列标记在序列中位置的索引。与position_ids不同，此张量不受填充影响。它用于在正确的位置更新缓存并推断完整的序列长度。 - logits_to_keep (
Union[int, torch.Tensor], optional, defaults to0) — 如果为int，则计算最后logits_to_keep个标记的 logit。如果为0，则计算所有input_ids的 logit（特殊情况）。仅生成需要最后一个标记的 logit，并且仅为该标记计算 logit 可以节省内存，这对于长序列或大词汇量来说非常重要。如果为torch.Tensor，则必须是 1D 张量，对应于序列长度维度上需要保留的索引。当使用打包张量格式（批次和序列长度的单维度）时，这很有用。
返回
transformers.modeling_outputs.CausalLMOutputWithCrossAttentions or tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.CausalLMOutputWithCrossAttentions 或一个元组（如果传递了 return_dict=False 或当 config.return_dict=False 时）的 torch.FloatTensor，具体取决于配置（BigBirdConfig）和输入。
-
loss (
torch.FloatTensor形状为(1,)，可选，当提供labels时返回) — 语言建模损失（用于下一个 token 预测）。 -
logits (形状为
(batch_size, sequence_length, config.vocab_size)的torch.FloatTensor) — 语言建模头部的预测分数（SoftMax 之前的每个词汇标记的分数）。 -
hidden_states (
tuple(torch.FloatTensor), optional, 当传递output_hidden_states=True或当config.output_hidden_states=True时返回) —torch.FloatTensor的元组（一个用于嵌入层的输出，如果模型有嵌入层；+一个用于每个层的输出），形状为(batch_size, sequence_length, hidden_size)。模型在每个层输出的隐藏状态以及可选的初始嵌入输出。
-
attentions (
tuple(torch.FloatTensor), optional, 当传递output_attentions=True或当config.output_attentions=True时返回) —torch.FloatTensor的元组（每个层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
-
cross_attentions (
tuple(torch.FloatTensor), optional, returned whenoutput_attentions=Trueis passed or whenconfig.output_attentions=True) — Tuple oftorch.FloatTensor(one for each layer) of shape(batch_size, num_heads, sequence_length, sequence_length).注意力 softmax 后的交叉注意力权重，用于计算交叉注意力头中的加权平均。
-
past_key_values (
Cache, optional, 当传递use_cache=True或当config.use_cache=True时返回) — 它是 Cache 实例。更多详情，请参阅我们的 kv cache 指南。包含预先计算的隐藏状态（注意力块中的键和值），可用于（参见
past_key_values输入）加速顺序解码。
BigBirdForCausalLM 的 forward 方法覆盖了 __call__ 特殊方法。
虽然 forward pass 的实现需要在此函数中定义，但你应该在之后调用
Module实例而不是这个，因为前者负责运行预处理和后处理步骤，而后者会静默地忽略它们。
BigBirdForMaskedLM
class transformers.BigBirdForMaskedLM
< source >( config model_args: ~utils.generic.ModelArgs | None = None adapter_args: ~utils.generic.AdapterArgs | None = None lora_args: ~utils.generic.LoRAArgs | None = None tokenizer_args: ~utils.generic.TokenizerArgs | None = None dataset_args: ~utils.generic.DatasetArgs | None = None data_args: ~utils.generic.DataArgs | None = None training_args: ~utils.generic.TrainingArgs | None = None generation_args: ~utils.generic.GenerationArgs | None = None vision_tower_args: ~utils.generic.VisionTowerArgs | None = None qlora_args: ~utils.generic.QLoRAArgs | None = None vision_tower_template_args: ~utils.generic.VisionTowerTemplateArgs | None = None video_tower_args: ~utils.generic.VideoTowerArgs | None = None vision_config: ~utils.generic.VisionConfig | None = None video_config: ~utils.generic.VideoConfig | None = None load_dataset: bool | None = None load_data_collator: bool | None = None load_processor: bool | None = None load_lora_adapter: bool | None = None load_adapter: bool | None = None load_qlora_adapter: bool | None = None **kwargs: typing_extensions.Unpack[transformers.modeling_utils.PreTrainedModelKwargs] )
参数
- config (BigBirdForMaskedLM) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型相关的权重，仅加载配置。请查看
from_pretrained()方法以加载模型权重。
一个顶部带有 语言建模 头部的 Big Bird 模型。
此模型继承自 PreTrainedModel。查看其父类文档，了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头等）。
此模型也是一个 PyTorch torch.nn.Module 子类。像普通的 PyTorch Module 一样使用它，并参考 PyTorch 文档了解一般用法和行为的所有相关信息。
forward
< source >( input_ids: torch.LongTensor | None = None attention_mask: torch.FloatTensor | None = None token_type_ids: torch.LongTensor | None = None position_ids: torch.LongTensor | None = None inputs_embeds: torch.FloatTensor | None = None encoder_hidden_states: torch.FloatTensor | None = None encoder_attention_mask: torch.FloatTensor | None = None labels: torch.LongTensor | None = None output_attentions: bool | None = None output_hidden_states: bool | None = None return_dict: bool | None = None **kwargs ) → transformers.modeling_outputs.MaskedLMOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensorof shape(batch_size, sequence_length), optional) — 词汇表中输入序列标记的索引。默认情况下将忽略填充。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.FloatTensorof shape(batch_size, sequence_length), optional) — 用于避免对填充标记索引执行注意力的掩码。掩码值选择在[0, 1]:- 1 表示未掩码的标记，
- 0 表示已掩码的标记。
- token_type_ids (
torch.LongTensorof shape(batch_size, sequence_length), optional) — 用于指示输入的第一个和第二个部分的句子标记索引。索引选择在[0, 1]:- 0 对应于句子 A 标记，
- 1 对应于句子 B 标记。
- position_ids (
torch.LongTensorof shape(batch_size, sequence_length), optional) — 输入序列标记在位置嵌入中的位置索引。选择范围为[0, config.n_positions - 1]。 - inputs_embeds (
torch.FloatTensorof shape(batch_size, sequence_length, hidden_size), optional) — 可选地，代替传入input_ids，您可以选择直接传入嵌入表示。如果您想比模型内部的嵌入查找矩阵更精确地控制如何将input_ids索引转换为相关的向量，这将非常有用。 - 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]:- 1 表示未掩码的 token，
- 0 表示已掩码的 token。
- labels (
torch.LongTensorof shape(batch_size, sequence_length), optional) — 用于计算掩码语言模型损失的标签。索引应在[-100, 0, ..., config.vocab_size]范围内（参见input_ids文档字符串）。索引设置为-100的 token 被忽略（掩码），损失仅为标签在[0, ..., config.vocab_size]范围内的 token 计算。 - output_attentions (
bool, optional) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参见返回的张量下的attentions。 - output_hidden_states (
bool, optional) — 是否返回所有层的隐藏状态。有关更多详细信息，请参见返回的张量下的hidden_states。 - return_dict (
bool, optional) — 是否返回一个 ModelOutput 而不是一个普通的元组。
返回
transformers.modeling_outputs.MaskedLMOutput 或 tuple(torch.FloatTensor)
根据配置 (BigBirdConfig) 和输入，返回一个 transformers.modeling_outputs.MaskedLMOutput 或一个元组 (如果传递了 return_dict=False 或当 config.return_dict=False 时为 torch.FloatTensor)。
-
loss (形状为
(1,)的torch.FloatTensor，可选，当提供labels时返回) — 掩码语言建模 (MLM) 损失。 -
logits (形状为
(batch_size, sequence_length, config.vocab_size)的torch.FloatTensor) — 语言建模头部的预测分数（SoftMax 之前的每个词汇标记的分数）。 -
hidden_states (
tuple(torch.FloatTensor), optional, 当传递output_hidden_states=True或当config.output_hidden_states=True时返回) —torch.FloatTensor的元组（一个用于嵌入层的输出，如果模型有嵌入层；+一个用于每个层的输出），形状为(batch_size, sequence_length, hidden_size)。模型在每个层输出的隐藏状态以及可选的初始嵌入输出。
-
attentions (
tuple(torch.FloatTensor), optional, 当传递output_attentions=True或当config.output_attentions=True时返回) —torch.FloatTensor的元组（每个层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
BigBirdForMaskedLM 的 forward 方法覆盖了 __call__ 特殊方法。
虽然 forward pass 的实现需要在此函数中定义，但你应该在之后调用
Module实例而不是这个，因为前者负责运行预处理和后处理步骤，而后者会静默地忽略它们。
示例
>>> import torch
>>> from transformers import AutoTokenizer, BigBirdForMaskedLM
>>> from datasets import load_dataset
>>> tokenizer = AutoTokenizer.from_pretrained("google/bigbird-roberta-base")
>>> model = BigBirdForMaskedLM.from_pretrained("google/bigbird-roberta-base")
>>> squad_ds = load_dataset("rajpurkar/squad_v2", split="train")
>>> # select random long article
>>> LONG_ARTICLE_TARGET = squad_ds[81514]["context"]
>>> # select random sentence
>>> LONG_ARTICLE_TARGET[332:398]
'the highest values are very close to the theoretical maximum value'
>>> # add mask_token
>>> LONG_ARTICLE_TO_MASK = LONG_ARTICLE_TARGET.replace("maximum", "[MASK]")
>>> inputs = tokenizer(LONG_ARTICLE_TO_MASK, return_tensors="pt")
>>> # long article input
>>> list(inputs["input_ids"].shape)
[1, 919]
>>> with torch.no_grad():
... logits = model(**inputs).logits
>>> # retrieve index of [MASK]
>>> mask_token_index = (inputs.input_ids == tokenizer.mask_token_id)[0].nonzero(as_tuple=True)[0]
>>> predicted_token_id = logits[0, mask_token_index].argmax(axis=-1)
>>> tokenizer.decode(predicted_token_id)
'maximum'BigBirdForSequenceClassification
class transformers.BigBirdForSequenceClassification
< source >( config model_args: ~utils.generic.ModelArgs | None = None adapter_args: ~utils.generic.AdapterArgs | None = None lora_args: ~utils.generic.LoRAArgs | None = None tokenizer_args: ~utils.generic.TokenizerArgs | None = None dataset_args: ~utils.generic.DatasetArgs | None = None data_args: ~utils.generic.DataArgs | None = None training_args: ~utils.generic.TrainingArgs | None = None generation_args: ~utils.generic.GenerationArgs | None = None vision_tower_args: ~utils.generic.VisionTowerArgs | None = None qlora_args: ~utils.generic.QLoRAArgs | None = None vision_tower_template_args: ~utils.generic.VisionTowerTemplateArgs | None = None video_tower_args: ~utils.generic.VideoTowerArgs | None = None vision_config: ~utils.generic.VisionConfig | None = None video_config: ~utils.generic.VideoConfig | None = None load_dataset: bool | None = None load_data_collator: bool | None = None load_processor: bool | None = None load_lora_adapter: bool | None = None load_adapter: bool | None = None load_qlora_adapter: bool | None = None **kwargs: typing_extensions.Unpack[transformers.modeling_utils.PreTrainedModelKwargs] )
参数
- config (BigBirdForSequenceClassification) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型相关的权重，只会加载配置。请查看 from_pretrained() 方法以加载模型权重。
带有序列分类/回归头（在池化输出之上添加一个线性层）的 BigBird 模型，例如用于 GLUE 任务。
此模型继承自 PreTrainedModel。查看其父类文档，了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头等）。
此模型也是一个 PyTorch torch.nn.Module 子类。像普通的 PyTorch Module 一样使用它，并参考 PyTorch 文档了解一般用法和行为的所有相关信息。
forward
< source >( input_ids: torch.LongTensor | None = None attention_mask: torch.FloatTensor | None = None token_type_ids: torch.LongTensor | None = None position_ids: torch.LongTensor | None = None inputs_embeds: torch.FloatTensor | None = None labels: torch.LongTensor | None = None output_attentions: bool | None = None output_hidden_states: bool | None = None return_dict: bool | None = None **kwargs ) → transformers.modeling_outputs.SequenceClassifierOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensorof shape(batch_size, sequence_length), optional) — 词汇表中输入序列 token 的索引。默认情况下会忽略填充。可以使用 AutoTokenizer 获取索引。有关详细信息，请参见 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.FloatTensorof shape(batch_size, sequence_length), optional) — 避免对填充 token 索引执行注意力的掩码。掩码值选择在[0, 1]:- 1 表示未掩码的 token，
- 0 表示已掩码的 token。
- token_type_ids (
torch.LongTensorof shape(batch_size, sequence_length), optional) — 用于指示输入的第一部分和第二部分的片段 token 索引。索引选择在[0, 1]:- 0 对应于句子 A token，
- 1 对应于句子 B token。
- position_ids (
torch.LongTensorof shape(batch_size, sequence_length), optional) — 位置嵌入中每个输入序列 token 的位置索引。选择范围为[0, config.n_positions - 1]。 - inputs_embeds (
torch.FloatTensorof shape(batch_size, sequence_length, hidden_size), optional) — 可选地，您可以选择直接传递嵌入表示，而不是传递input_ids。如果您希望比模型内部的嵌入查找矩阵更精确地控制如何将input_ids索引转换为相关向量，这将非常有用。 - labels (
torch.LongTensorof shape(batch_size,), optional) — 用于计算序列分类/回归损失的标签。索引应在[0, ..., config.num_labels - 1]范围内。如果config.num_labels == 1，则计算回归损失（均方误差）；如果config.num_labels > 1，则计算分类损失（交叉熵）。 - output_attentions (
bool, optional) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参见返回的张量下的attentions。 - output_hidden_states (
bool, optional) — 是否返回所有层的隐藏状态。有关更多详细信息，请参见返回的张量下的hidden_states。 - return_dict (
bool, optional) — 是否返回一个 ModelOutput 而不是一个普通的元组。
返回
transformers.modeling_outputs.SequenceClassifierOutput 或 tuple(torch.FloatTensor)
根据配置 (BigBirdConfig) 和输入，返回一个 transformers.modeling_outputs.SequenceClassifierOutput 或一个元组 (如果传递了 return_dict=False 或当 config.return_dict=False 时为 torch.FloatTensor)。
-
loss (形状为
(1,)的torch.FloatTensor，可选，当提供labels时返回) — 分类损失（如果 config.num_labels==1，则为回归损失）。 -
logits (形状为
(batch_size, config.num_labels)的torch.FloatTensor) — 分类（如果 config.num_labels==1，则为回归）分数（SoftMax 之前）。 -
hidden_states (
tuple(torch.FloatTensor), optional, 当传递output_hidden_states=True或当config.output_hidden_states=True时返回) —torch.FloatTensor的元组（一个用于嵌入层的输出，如果模型有嵌入层；+一个用于每个层的输出），形状为(batch_size, sequence_length, hidden_size)。模型在每个层输出的隐藏状态以及可选的初始嵌入输出。
-
attentions (
tuple(torch.FloatTensor), optional, 当传递output_attentions=True或当config.output_attentions=True时返回) —torch.FloatTensor的元组（每个层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
BigBirdForSequenceClassification 的 forward 方法覆盖了 __call__ 特殊方法。
虽然 forward pass 的实现需要在此函数中定义，但你应该在之后调用
Module实例而不是这个，因为前者负责运行预处理和后处理步骤，而后者会静默地忽略它们。
示例
>>> import torch
>>> from transformers import AutoTokenizer, BigBirdForSequenceClassification
>>> from datasets import load_dataset
>>> tokenizer = AutoTokenizer.from_pretrained("l-yohai/bigbird-roberta-base-mnli")
>>> model = BigBirdForSequenceClassification.from_pretrained("l-yohai/bigbird-roberta-base-mnli")
>>> squad_ds = load_dataset("rajpurkar/squad_v2", split="train")
>>> LONG_ARTICLE = squad_ds[81514]["context"]
>>> inputs = tokenizer(LONG_ARTICLE, return_tensors="pt")
>>> # long input article
>>> list(inputs["input_ids"].shape)
[1, 919]
>>> with torch.no_grad():
... logits = model(**inputs).logits
>>> predicted_class_id = logits.argmax().item()
>>> model.config.id2label[predicted_class_id]
'LABEL_0'BigBirdForMultipleChoice
class transformers.BigBirdForMultipleChoice
< source >( config model_args: ~utils.generic.ModelArgs | None = None adapter_args: ~utils.generic.AdapterArgs | None = None lora_args: ~utils.generic.LoRAArgs | None = None tokenizer_args: ~utils.generic.TokenizerArgs | None = None dataset_args: ~utils.generic.DatasetArgs | None = None data_args: ~utils.generic.DataArgs | None = None training_args: ~utils.generic.TrainingArgs | None = None generation_args: ~utils.generic.GenerationArgs | None = None vision_tower_args: ~utils.generic.VisionTowerArgs | None = None qlora_args: ~utils.generic.QLoRAArgs | None = None vision_tower_template_args: ~utils.generic.VisionTowerTemplateArgs | None = None video_tower_args: ~utils.generic.VideoTowerArgs | None = None vision_config: ~utils.generic.VisionConfig | None = None video_config: ~utils.generic.VideoConfig | None = None load_dataset: bool | None = None load_data_collator: bool | None = None load_processor: bool | None = None load_lora_adapter: bool | None = None load_adapter: bool | None = None load_qlora_adapter: bool | None = None **kwargs: typing_extensions.Unpack[transformers.modeling_utils.PreTrainedModelKwargs] )
参数
- config (BigBirdForMultipleChoice) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型相关的权重，只会加载配置。请查看 from_pretrained() 方法以加载模型权重。
带有多个选择分类头（在池化输出之上添加一个线性层和 softmax）的 Big Bird 模型，例如用于 RocStories/SWAG 任务。
此模型继承自 PreTrainedModel。查看其父类文档，了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头等）。
此模型也是一个 PyTorch torch.nn.Module 子类。像普通的 PyTorch Module 一样使用它，并参考 PyTorch 文档了解一般用法和行为的所有相关信息。
forward
< source >( input_ids: torch.LongTensor | None = None attention_mask: torch.FloatTensor | None = None token_type_ids: torch.LongTensor | None = None position_ids: torch.LongTensor | None = None inputs_embeds: torch.FloatTensor | None = None labels: torch.LongTensor | None = None output_attentions: bool | None = None output_hidden_states: bool | None = None return_dict: bool | None = None **kwargs ) → transformers.modeling_outputs.MultipleChoiceModelOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensorof shape(batch_size, num_choices, sequence_length)) — 输入序列 token 在词汇表中的索引。索引可以通过 AutoTokenizer 获取。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.FloatTensorof shape(batch_size, sequence_length), optional) — 忽略 padding token 索引进行 attention 的掩码。掩码值选择在[0, 1]:- 1 表示未掩码的 token，
- 0 表示已掩码的 token。
- token_type_ids (
torch.LongTensorof shape(batch_size, num_choices, sequence_length), optional) — 用于指示输入第一部分和第二部分的 segment token 索引。索引选择在[0, 1]:- 0 对应于*句子 A* token，
- 1 对应于*句子 B* token。
- position_ids (
torch.LongTensorof shape(batch_size, num_choices, sequence_length), optional) — 输入序列 token 在 position embeddings 中的位置索引。选择范围为[0, config.max_position_embeddings - 1]。 - inputs_embeds (
torch.FloatTensorof shape(batch_size, num_choices, sequence_length, hidden_size), optional) — 可选地，您可以选择直接传递嵌入表示，而不是传递input_ids。如果您希望对如何将 input_ids 索引转换为相关向量的控制程度超过模型内部的嵌入查找矩阵，这将非常有用。 - labels (
torch.LongTensorof shape(batch_size,), optional) — 用于计算多项选择分类损失的标签。索引应在[0, ..., num_choices-1]之间，其中num_choices是输入张量第二维的大小。（参见上面的input_ids） - output_attentions (
bool, optional) — 是否返回所有 attention 层的 attentions 张量。更多详情请参阅返回张量下的attentions。 - output_hidden_states (
bool, optional) — 是否返回所有层的 hidden states。更多详情请参阅返回张量下的hidden_states。 - return_dict (
bool, optional) — 是否返回 ModelOutput 而不是普通元组。
返回
transformers.modeling_outputs.MultipleChoiceModelOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.MultipleChoiceModelOutput 或一个 torch.FloatTensor 元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），具体内容取决于配置（BigBirdConfig）和输入。
-
loss (形状为 (1,) 的
torch.FloatTensor，可选，当提供labels时返回) — 分类损失。 -
logits (形状为
(batch_size, num_choices)的torch.FloatTensor) — num_choices 是输入张量的第二维大小。（请参阅上面的 input_ids）。分类分数（SoftMax 之前）。
-
hidden_states (
tuple(torch.FloatTensor), optional, 当传递output_hidden_states=True或当config.output_hidden_states=True时返回) —torch.FloatTensor的元组（一个用于嵌入层的输出，如果模型有嵌入层；+一个用于每个层的输出），形状为(batch_size, sequence_length, hidden_size)。模型在每个层输出的隐藏状态以及可选的初始嵌入输出。
-
attentions (
tuple(torch.FloatTensor), optional, 当传递output_attentions=True或当config.output_attentions=True时返回) —torch.FloatTensor的元组（每个层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
BigBirdForMultipleChoice 的 forward 方法重写了 __call__ 特殊方法。
虽然 forward pass 的实现需要在此函数中定义，但你应该在之后调用
Module实例而不是这个，因为前者负责运行预处理和后处理步骤，而后者会静默地忽略它们。
示例
>>> from transformers import AutoTokenizer, BigBirdForMultipleChoice
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("google/bigbird-roberta-base")
>>> model = BigBirdForMultipleChoice.from_pretrained("google/bigbird-roberta-base")
>>> prompt = "In Italy, pizza served in formal settings, such as at a restaurant, is presented unsliced."
>>> choice0 = "It is eaten with a fork and a knife."
>>> choice1 = "It is eaten while held in the hand."
>>> labels = torch.tensor(0).unsqueeze(0) # choice0 is correct (according to Wikipedia ;)), batch size 1
>>> encoding = tokenizer([prompt, prompt], [choice0, choice1], return_tensors="pt", padding=True)
>>> outputs = model(**{k: v.unsqueeze(0) for k, v in encoding.items()}, labels=labels) # batch size is 1
>>> # the linear classifier still needs to be trained
>>> loss = outputs.loss
>>> logits = outputs.logitsBigBirdForTokenClassification
class transformers.BigBirdForTokenClassification
< source >( config model_args: ~utils.generic.ModelArgs | None = None adapter_args: ~utils.generic.AdapterArgs | None = None lora_args: ~utils.generic.LoRAArgs | None = None tokenizer_args: ~utils.generic.TokenizerArgs | None = None dataset_args: ~utils.generic.DatasetArgs | None = None data_args: ~utils.generic.DataArgs | None = None training_args: ~utils.generic.TrainingArgs | None = None generation_args: ~utils.generic.GenerationArgs | None = None vision_tower_args: ~utils.generic.VisionTowerArgs | None = None qlora_args: ~utils.generic.QLoRAArgs | None = None vision_tower_template_args: ~utils.generic.VisionTowerTemplateArgs | None = None video_tower_args: ~utils.generic.VideoTowerArgs | None = None vision_config: ~utils.generic.VisionConfig | None = None video_config: ~utils.generic.VideoConfig | None = None load_dataset: bool | None = None load_data_collator: bool | None = None load_processor: bool | None = None load_lora_adapter: bool | None = None load_adapter: bool | None = None load_qlora_adapter: bool | None = None **kwargs: typing_extensions.Unpack[transformers.modeling_utils.PreTrainedModelKwargs] )
参数
- config (BigBirdForTokenClassification) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型相关的权重，只加载配置。请查看 from_pretrained() 方法来加载模型权重。
带有 token 分类头的 Big Bird transformer（在 hidden-states 输出之上添加一个线性层），例如用于命名实体识别（NER）任务。
此模型继承自 PreTrainedModel。查看其父类文档，了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头等）。
此模型也是一个 PyTorch torch.nn.Module 子类。像普通的 PyTorch Module 一样使用它，并参考 PyTorch 文档了解一般用法和行为的所有相关信息。
forward
< source >( input_ids: torch.LongTensor | None = None attention_mask: torch.FloatTensor | None = None token_type_ids: torch.LongTensor | None = None position_ids: torch.LongTensor | None = None inputs_embeds: torch.FloatTensor | None = None labels: torch.LongTensor | None = None output_attentions: bool | None = None output_hidden_states: bool | None = None return_dict: bool | None = None **kwargs ) → transformers.modeling_outputs.TokenClassifierOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensorof shape(batch_size, sequence_length), optional) — 输入序列 token 在词汇表中的索引。默认情况下将忽略 padding。索引可以通过 AutoTokenizer 获取。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.FloatTensorof shape(batch_size, sequence_length), optional) — 忽略 padding token 索引进行 attention 的掩码。掩码值选择在[0, 1]:- 1 表示未掩码的 token，
- 0 表示已掩码的 token。
- token_type_ids (
torch.LongTensorof shape(batch_size, sequence_length), optional) — 用于指示输入第一部分和第二部分的 segment token 索引。索引选择在[0, 1]:- 0 对应于*句子 A* token，
- 1 对应于*句子 B* token。
- position_ids (
torch.LongTensorof shape(batch_size, sequence_length), optional) — 输入序列 token 在 position embeddings 中的位置索引。选择范围为[0, config.n_positions - 1]。 - inputs_embeds (
torch.FloatTensorof shape(batch_size, sequence_length, hidden_size), optional) — 可选地，您可以选择直接传递嵌入表示，而不是传递input_ids。如果您希望对如何将input_ids索引转换为相关向量的控制程度超过模型内部的嵌入查找矩阵，这将非常有用。 - labels (
torch.LongTensorof shape(batch_size, sequence_length), optional) — 用于计算 token 分类损失的标签。索引应在[0, ..., config.num_labels - 1]之间。 - output_attentions (
bool, optional) — 是否返回所有 attention 层的 attentions 张量。更多详情请参阅返回张量下的attentions。 - output_hidden_states (
bool, optional) — 是否返回所有层的隐藏状态。更多细节请参见返回张量下的hidden_states。 - return_dict (
bool, optional) — 是否返回一个 ModelOutput 而不是一个普通的元组。
返回
transformers.modeling_outputs.TokenClassifierOutput 或 tuple(torch.FloatTensor)
A transformers.modeling_outputs.TokenClassifierOutput or a tuple of torch.FloatTensor (if return_dict=False is passed or when config.return_dict=False) comprising various elements depending on the configuration (BigBirdConfig) and inputs。
-
loss (形状为
(1,)的torch.FloatTensor，可选，当提供labels时返回) — 分类损失。 -
logits (形状为
(batch_size, sequence_length, config.num_labels)的torch.FloatTensor) — 分类分数（SoftMax 之前）。 -
hidden_states (
tuple(torch.FloatTensor), optional, 当传递output_hidden_states=True或当config.output_hidden_states=True时返回) —torch.FloatTensor的元组（一个用于嵌入层的输出，如果模型有嵌入层；+一个用于每个层的输出），形状为(batch_size, sequence_length, hidden_size)。模型在每个层输出的隐藏状态以及可选的初始嵌入输出。
-
attentions (
tuple(torch.FloatTensor), optional, 当传递output_attentions=True或当config.output_attentions=True时返回) —torch.FloatTensor的元组（每个层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
The BigBirdForTokenClassification forward method, overrides the __call__ special method。
虽然 forward pass 的实现需要在此函数中定义，但你应该在之后调用
Module实例而不是这个，因为前者负责运行预处理和后处理步骤，而后者会静默地忽略它们。
示例
>>> from transformers import AutoTokenizer, BigBirdForTokenClassification
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("google/bigbird-roberta-base")
>>> model = BigBirdForTokenClassification.from_pretrained("google/bigbird-roberta-base")
>>> inputs = tokenizer(
... "HuggingFace is a company based in Paris and New York", add_special_tokens=False, return_tensors="pt"
... )
>>> with torch.no_grad():
... logits = model(**inputs).logits
>>> predicted_token_class_ids = logits.argmax(-1)
>>> # Note that tokens are classified rather then input words which means that
>>> # there might be more predicted token classes than words.
>>> # Multiple token classes might account for the same word
>>> predicted_tokens_classes = [model.config.id2label[t.item()] for t in predicted_token_class_ids[0]]
>>> predicted_tokens_classes
...
>>> labels = predicted_token_class_ids
>>> loss = model(**inputs, labels=labels).loss
>>> round(loss.item(), 2)
...BigBirdForQuestionAnswering
class transformers.BigBirdForQuestionAnswering
< source >( config add_pooling_layer = False )
参数
- config (BigBirdForQuestionAnswering) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型相关的权重，仅加载配置。请查看 from_pretrained() 方法来加载模型权重。
- add_pooling_layer (
bool, optional, defaults toTrue) — 是否添加一个池化层
The Big Bird transformer with a span classification head on top for extractive question-answering tasks like SQuAD (a linear layer on top of the hidden-states output to compute span start logits and span end logits)。
此模型继承自 PreTrainedModel。查看其父类文档，了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头等）。
此模型也是一个 PyTorch torch.nn.Module 子类。像普通的 PyTorch Module 一样使用它，并参考 PyTorch 文档了解一般用法和行为的所有相关信息。
forward
< source >( input_ids: torch.LongTensor | None = None attention_mask: torch.FloatTensor | None = None question_lengths: torch.LongTensor | None = None token_type_ids: torch.LongTensor | None = None position_ids: torch.LongTensor | None = None inputs_embeds: torch.FloatTensor | None = None start_positions: torch.LongTensor | None = None end_positions: torch.LongTensor | None = None output_attentions: bool | None = None output_hidden_states: bool | None = None return_dict: bool | None = None **kwargs ) → transformers.models.big_bird.modeling_big_bird.BigBirdForQuestionAnsweringModelOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensorof shape(batch_size, sequence_length), optional) — 词汇表中输入序列 token 的索引。默认情况下将忽略填充。可以使用 AutoTokenizer 获取索引。有关详细信息，请参见 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.FloatTensorof shape(batch_size, sequence_length), optional) — 避免对填充 token 索引执行注意力的掩码。掩码值选择在[0, 1]中：- 1 表示未掩码的 token，
- 0 表示已掩码的 token。
- question_lengths (
torch.LongTensorof shape(batch_size, 1), optional) — batch 中问题的长度。 - token_type_ids (
torch.LongTensorof shape(batch_size, sequence_length), optional) — 用于指示输入的第一和第二部分的段 token 索引。索引选择在[0, 1]中：- 0 对应于句子 A token，
- 1 对应于句子 B token。
- position_ids (
torch.LongTensorof shape(batch_size, sequence_length), optional) — 输入序列 token 在位置嵌入中的索引。选择范围在[0, config.n_positions - 1]。 - inputs_embeds (
torch.FloatTensorof shape(batch_size, sequence_length, hidden_size), optional) — 可选地，您可以选择直接传入嵌入表示，而不是传入input_ids。这对于想要比模型内部嵌入查找矩阵更好地控制如何将input_ids索引转换为相关向量很有用。 - start_positions (
torch.LongTensorof shape(batch_size,), optional) — 用于计算 token 分类损失的标记跨度的起始位置（索引）的标签。位置被限制在序列长度（sequence_length）内。不考虑序列外的任何位置来计算损失。 - end_positions (
torch.LongTensorof shape(batch_size,), optional) — 用于计算 token 分类损失的标记跨度的结束位置（索引）的标签。位置被限制在序列长度（sequence_length）内。不考虑序列外的任何位置来计算损失。 - output_attentions (
bool, optional) — 是否返回所有注意力层的注意力张量。更多细节请参见返回张量下的attentions。 - output_hidden_states (
bool, optional) — 是否返回所有层的隐藏状态。更多细节请参见返回张量下的hidden_states。 - return_dict (
bool, optional) — 是否返回一个 ModelOutput 而不是一个普通的元组。
返回
transformers.models.big_bird.modeling_big_bird.BigBirdForQuestionAnsweringModelOutput 或 tuple(torch.FloatTensor)
A transformers.models.big_bird.modeling_big_bird.BigBirdForQuestionAnsweringModelOutput 或 a tuple of torch.FloatTensor (if return_dict=False is passed or when config.return_dict=False) comprising various elements depending on the configuration (BigBirdConfig) and inputs。
-
loss (
torch.FloatTensorof shape(1,), 可选, 当提供labels时返回) — 总范围提取损失是起始位置和结束位置的交叉熵之和。 -
start_logits (
torch.FloatTensor | None.start_logitsof shape(batch_size, sequence_length), defaults toNone) — Span 起始得分（SoftMax 之前）。 -
end_logits (
torch.FloatTensor | None.end_logitsof shape(batch_size, sequence_length), defaults toNone) — Span 结束得分（SoftMax 之前）。 -
pooler_output (
torch.FloatTensorof shape(batch_size, 1)) — 来自 BigBigModel 的池化输出 -
hidden_states (
tuple[torch.FloatTensor] | None.hidden_states, 当传递output_hidden_states=True或当config.output_hidden_states=True时返回) —torch.FloatTensor的元组（一个用于嵌入的输出，如果模型有嵌入层，+ 每个层的输出），形状为(batch_size, sequence_length, hidden_size)。模型在每个层输出的隐藏状态以及可选的初始嵌入输出。
-
attentions (
tuple[torch.FloatTensor] | None.attentions, 当传递output_attentions=True或当config.output_attentions=True时返回) —torch.FloatTensor的元组（每个层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
The BigBirdForQuestionAnswering forward method, overrides the __call__ special method。
虽然 forward pass 的实现需要在此函数中定义，但你应该在之后调用
Module实例而不是这个，因为前者负责运行预处理和后处理步骤，而后者会静默地忽略它们。
示例
>>> import torch
>>> from transformers import AutoTokenizer, BigBirdForQuestionAnswering
>>> from datasets import load_dataset
>>> tokenizer = AutoTokenizer.from_pretrained("google/bigbird-roberta-base")
>>> model = BigBirdForQuestionAnswering.from_pretrained("google/bigbird-roberta-base")
>>> squad_ds = load_dataset("rajpurkar/squad_v2", split="train")
>>> # select random article and question
>>> LONG_ARTICLE = squad_ds[81514]["context"]
>>> QUESTION = squad_ds[81514]["question"]
>>> QUESTION
'During daytime how high can the temperatures reach?'
>>> inputs = tokenizer(QUESTION, LONG_ARTICLE, return_tensors="pt")
>>> # long article and question input
>>> list(inputs["input_ids"].shape)
[1, 929]
>>> with torch.no_grad():
... outputs = model(**inputs)
>>> answer_start_index = outputs.start_logits.argmax()
>>> answer_end_index = outputs.end_logits.argmax()
>>> predict_answer_token_ids = inputs.input_ids[0, answer_start_index : answer_end_index + 1]
>>> predict_answer_token = tokenizer.decode(predict_answer_token_ids)