Transformers 文档
BERT
并获得增强的文档体验
开始使用
BERT
BERT 是一种双向 Transformer 模型，通过对无标签文本进行预训练，用于预测句子中被遮蔽的词元以及判断一个句子是否紧跟在另一个句子之后。其主要思想是通过随机遮蔽一些词元，模型可以在左右两侧的文本上进行训练，从而获得更全面的理解。BERT 也非常通用，因为其学习到的语言表征可以通过微调额外的层或头部来适应其他 NLP 任务。
您可以在 BERT 集合中找到所有原始 BERT 检查点。
点击右侧边栏中的 BERT 模型，获取更多如何将 BERT 应用于不同语言任务的示例。
下面的示例演示了如何使用 Pipeline、AutoModel 和命令行预测 [MASK] 词元。
import torch
from transformers import pipeline
pipeline = pipeline(
task="fill-mask",
model="google-bert/bert-base-uncased",
torch_dtype=torch.float16,
device=0
)
pipeline("Plants create [MASK] through a process known as photosynthesis.")注意事项
- 输入应在右侧进行填充，因为 BERT 使用绝对位置嵌入。
BertConfig
class transformers.BertConfig
< source >( vocab_size = 30522 hidden_size = 768 num_hidden_layers = 12 num_attention_heads = 12 intermediate_size = 3072 hidden_act = 'gelu' hidden_dropout_prob = 0.1 attention_probs_dropout_prob = 0.1 max_position_embeddings = 512 type_vocab_size = 2 initializer_range = 0.02 layer_norm_eps = 1e-12 pad_token_id = 0 position_embedding_type = 'absolute' use_cache = True classifier_dropout = None **kwargs )
参数
- vocab_size (
int, 可选, 默认为 30522) — BERT 模型的词汇量大小。定义了调用 BertModel 或 TFBertModel 时传递的inputs_ids可以表示的不同词元数量。 - hidden_size (
int, 可选, 默认为 768) — 编码器层和池化层的维度。 - num_hidden_layers (
int, 可选, 默认为 12) — Transformer 编码器中的隐藏层数量。 - num_attention_heads (
int, 可选, 默认为 12) — Transformer 编码器中每个注意力层的注意力头数量。 - intermediate_size (
int, 可选, 默认为 3072) — Transformer 编码器中“中间”（通常称为前馈）层的维度。 - hidden_act (
str或Callable, 可选, 默认为"gelu") — 编码器和池化器中的非线性激活函数（函数或字符串）。如果是字符串，支持"gelu"、"relu"、"silu"和"gelu_new"。 - hidden_dropout_prob (
float, 可选, 默认为 0.1) — 嵌入层、编码器和池化器中所有全连接层的 dropout 概率。 - attention_probs_dropout_prob (
float, 可选, 默认为 0.1) — 注意力概率的 dropout 比率。 - max_position_embeddings (
int, 可选, 默认为 512) — 此模型可能使用的最大序列长度。通常为了以防万一，将其设置为较大的值（例如 512 或 1024 或 2048）。 - type_vocab_size (
int, 可选, 默认为 2) — 调用 BertModel 或 TFBertModel 时传递的token_type_ids的词汇量大小。 - initializer_range (
float, 可选, 默认为 0.02) — 用于初始化所有权重矩阵的截断正态初始化器的标准差。 - layer_norm_eps (
float, 可选, 默认为 1e-12) — 层归一化层使用的 epsilon 值。 - position_embedding_type (
str, 可选, 默认为"absolute") — 位置嵌入类型。选择"absolute"、"relative_key"、"relative_key_query"之一。对于位置嵌入，使用"absolute"。有关"relative_key"的更多信息，请参阅 《带有相对位置表示的自注意力》（Shaw 等人）。有关"relative_key_query"的更多信息，请参阅 《通过更好的相对位置嵌入改进 Transformer 模型》（Huang 等人）中的方法 4。 - is_decoder (
bool, 可选, 默认为False) — 模型是否用作解码器。如果为False，模型则用作编码器。 - use_cache (
bool, 可选, 默认为True) — 模型是否应该返回最后一个键/值注意力（并非所有模型都使用）。仅在config.is_decoder=True时相关。 - classifier_dropout (
float, 可选) — 分类头部的 dropout 比率。
这是用于存储 BertModel 或 TFBertModel 配置的配置类。它用于根据指定参数实例化 BERT 模型，定义模型架构。使用默认值实例化配置将生成与 BERT google-bert/bert-base-uncased 架构类似的配置。
配置对象继承自 PretrainedConfig，可用于控制模型输出。有关更多信息，请阅读 PretrainedConfig 的文档。
示例
>>> from transformers import BertConfig, BertModel
>>> # Initializing a BERT google-bert/bert-base-uncased style configuration
>>> configuration = BertConfig()
>>> # Initializing a model (with random weights) from the google-bert/bert-base-uncased style configuration
>>> model = BertModel(configuration)
>>> # Accessing the model configuration
>>> configuration = model.configBertTokenizer
class transformers.BertTokenizer
< source >( vocab_file do_lower_case = True do_basic_tokenize = True never_split = None unk_token = '[UNK]' sep_token = '[SEP]' pad_token = '[PAD]' cls_token = '[CLS]' mask_token = '[MASK]' tokenize_chinese_chars = True strip_accents = None clean_up_tokenization_spaces = True **kwargs )
参数
- vocab_file (
str) — 包含词汇表的文件。 - do_lower_case (
bool, 可选, 默认为True) — 标记化时是否将输入转换为小写。 - do_basic_tokenize (
bool, 可选, 默认为True) — 在 WordPiece 之前是否进行基本分词。 - never_split (
Iterable, 可选) — 标记化过程中永不拆分的标记集合。仅当do_basic_tokenize=True时有效。 - unk_token (
str, 可选, 默认为"[UNK]") — 未知标记。不在词汇表中的标记不能转换为 ID，而是设置为此标记。 - sep_token (
str, 可选, 默认为"[SEP]") — 分隔符标记，用于从多个序列构建序列时，例如用于序列分类的两个序列或用于问答的文本和问题。它也用作使用特殊标记构建的序列的最后一个标记。 - pad_token (
str, 可选, 默认为"[PAD]") — 用于填充的标记，例如在批处理不同长度的序列时。 - cls_token (
str, 可选, 默认为"[CLS]") — 分类器标记，用于序列分类（整个序列的分类而非逐标记分类）时。使用特殊标记构建序列时，它是序列的第一个标记。 - mask_token (
str, 可选, 默认为"[MASK]") — 用于掩码值的标记。这是使用掩码语言建模训练此模型时使用的标记。这是模型将尝试预测的标记。 - tokenize_chinese_chars (
bool, 可选, 默认为True) — 是否对中文字符进行分词。对于日语，这可能需要停用（请参阅此问题）。
- strip_accents (
bool, 可选) — 是否去除所有重音。如果未指定此选项，则将由lowercase的值决定（如原始 BERT 中所示）。 - clean_up_tokenization_spaces (
bool, 可选, 默认为True) — 解码后是否清理空格，清理包括移除可能存在的额外空格等人工痕迹。
构建 BERT 分词器。基于 WordPiece。
此分词器继承自 PreTrainedTokenizer，其中包含了大部分主要方法。用户应参考此超类以获取有关这些方法的更多信息。
build_inputs_with_special_tokens
< 源 >( token_ids_0: list token_ids_1: typing.Optional[list[int]] = None ) → List[int]
通过连接和添加特殊标记，从一个序列或一对序列构建用于序列分类任务的模型输入。BERT 序列的格式如下：
- 单个序列：
[CLS] X [SEP] - 序列对：
[CLS] A [SEP] B [SEP]
get_special_tokens_mask
< 源 >( token_ids_0: list token_ids_1: typing.Optional[list[int]] = None already_has_special_tokens: bool = False ) → List[int]
从没有添加特殊标记的标记列表中检索序列ID。此方法在使用分词器prepare_for_model方法添加特殊标记时调用。
create_token_type_ids_from_sequences
< 源 >( token_ids_0: list token_ids_1: typing.Optional[list[int]] = None ) → list[int]
创建与传入序列对应的标记类型 ID。什么是标记类型 ID？
如果模型有特殊的构建方式，应在子类中重写此方法。
BertTokenizerFast
class transformers.BertTokenizerFast
< 源 >( vocab_file = None tokenizer_file = None do_lower_case = True unk_token = '[UNK]' sep_token = '[SEP]' pad_token = '[PAD]' cls_token = '[CLS]' mask_token = '[MASK]' tokenize_chinese_chars = True strip_accents = None **kwargs )
参数
- vocab_file (
str) — 包含词汇表的文件。 - do_lower_case (
bool, 可选, 默认为True) — 标记化时是否将输入转换为小写。 - unk_token (
str, 可选, 默认为"[UNK]") — 未知标记。不在词汇表中的标记不能转换为 ID，而是设置为此标记。 - sep_token (
str, 可选, 默认为"[SEP]") — 分隔符标记，用于从多个序列构建序列时，例如用于序列分类的两个序列或用于问答的文本和问题。它也用作使用特殊标记构建的序列的最后一个标记。 - pad_token (
str, 可选, 默认为"[PAD]") — 用于填充的标记，例如在批处理不同长度的序列时。 - cls_token (
str, 可选, 默认为"[CLS]") — 分类器标记，用于序列分类（整个序列的分类而非逐标记分类）时。使用特殊标记构建序列时，它是序列的第一个标记。 - mask_token (
str, 可选, 默认为"[MASK]") — 用于掩码值的标记。这是使用掩码语言建模训练此模型时使用的标记。这是模型将尝试预测的标记。 - clean_text (
bool, 可选, 默认为True) — 在标记化之前是否通过删除任何控制字符并将所有空白替换为经典空白来清理文本。 - tokenize_chinese_chars (
bool, 可选, 默认为True) — 是否对中文字符进行分词。对于日语，这可能需要停用（请参阅此问题）。 - strip_accents (
bool, 可选) — 是否去除所有重音。如果未指定此选项，则将由lowercase的值决定（如原始 BERT 中所示）。 - wordpieces_prefix (
str, 可选, 默认为"##") — 子词的前缀。
构建一个“快速”BERT 分词器（由 HuggingFace 的 tokenizers 库支持）。基于 WordPiece。
此分词器继承自 PreTrainedTokenizerFast，其中包含了大部分主要方法。用户应参考此超类以获取有关这些方法的更多信息。
BertModel
class transformers.BertModel
< 源 >( config add_pooling_layer = True )
参数
- config (BertModel) — 模型配置类，包含模型的所有参数。用配置文件初始化不会加载与模型相关的权重，只加载配置。请查看 from_pretrained() 方法来加载模型权重。
- add_pooling_layer (
bool, 可选, 默认为True) — 是否添加池化层
该模型可以作为编码器（仅有自注意力机制）或解码器，在这种情况下，在自注意力层之间添加一个交叉注意力层，遵循 Ashish Vaswani、Noam Shazeer、Niki Parmar、Jakob Uszkoreit、Llion Jones、Aidan N. Gomez、Lukasz Kaiser 和 Illia Polosukhin 在 Attention is all you need 中描述的架构。
要作为解码器，模型需要使用 is_decoder 参数设置为 True 的配置进行初始化。要在 Seq2Seq 模型中使用，模型需要使用 is_decoder 参数和 add_cross_attention 都设置为 True 进行初始化；此时，前向传播需要 encoder_hidden_states 作为输入。
此模型继承自 PreTrainedModel。请查看超类文档，了解该库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头部等）。
此模型也是 PyTorch torch.nn.Module 子类。将其作为常规 PyTorch 模块使用，并参考 PyTorch 文档中所有与通用用法和行为相关的事项。
前向
< 源 >( input_ids: typing.Optional[torch.Tensor] = None attention_mask: typing.Optional[torch.Tensor] = None token_type_ids: typing.Optional[torch.Tensor] = None position_ids: typing.Optional[torch.Tensor] = None head_mask: typing.Optional[torch.Tensor] = None inputs_embeds: typing.Optional[torch.Tensor] = None encoder_hidden_states: typing.Optional[torch.Tensor] = None encoder_attention_mask: typing.Optional[torch.Tensor] = None past_key_values: typing.Optional[list[torch.FloatTensor]] = None use_cache: typing.Optional[bool] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.modeling_outputs.BaseModelOutputWithPoolingAndCrossAttentions 或 tuple(torch.FloatTensor)
参数
- input_ids (形状为
(batch_size, sequence_length)的torch.Tensor, 可选) — 词汇表中输入序列标记的索引。默认情况下会忽略填充。可以使用 AutoTokenizer 获取索引。有关详细信息，请参见 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (形状为
(batch_size, sequence_length)的torch.Tensor, 可选) — 掩码，用于避免在填充标记索引上执行注意力。掩码值选择在[0, 1]之间：- 1 表示未被掩码的标记，
- 0 表示被掩码的标记。
- token_type_ids (形状为
(batch_size, sequence_length)的torch.Tensor, 可选) — 段标记索引，用于指示输入的第一个和第二个部分。索引选择在[0, 1]之间：- 0 对应于 句子 A 标记，
- 1 对应于 句子 B 标记。
- position_ids (形状为
(batch_size, sequence_length)的torch.Tensor, 可选) — 每个输入序列标记在位置嵌入中的位置索引。选择范围为[0, config.n_positions - 1]。 - head_mask (形状为
(num_heads,)或(num_layers, num_heads)的torch.Tensor, 可选) — 用于使自注意力模块的选定头部无效的掩码。掩码值选择在[0, 1]之间：- 1 表示头部未被掩码，
- 0 表示头部被掩码。
- inputs_embeds (形状为
(batch_size, sequence_length, hidden_size)的torch.Tensor, 可选) — 可选地，您可以直接传入嵌入表示，而不是传入input_ids。如果您希望对input_ids索引如何转换为相关向量有比模型内部嵌入查找矩阵更多的控制，这将很有用。 - encoder_hidden_states (形状为
(batch_size, sequence_length, hidden_size)的torch.Tensor, 可选) — 编码器最后一层输出的隐藏状态序列。如果模型配置为解码器，则用于交叉注意力。 - encoder_attention_mask (形状为
(batch_size, sequence_length)的torch.Tensor, 可选) — 掩码，用于避免在编码器输入中的填充标记索引上执行注意力。如果模型配置为解码器，则此掩码用于交叉注意力。掩码值选择在[0, 1]之间：- 1 表示未被掩码的标记，
- 0 表示被掩码的标记。
- past_key_values (
list[torch.FloatTensor], 可选) — 预先计算的隐藏状态（自注意力块和交叉注意力块中的键和值），可用于加速顺序解码。这通常包括模型在解码上一阶段返回的past_key_values，当use_cache=True或config.use_cache=True时。允许两种格式：
- 一个 Cache 实例，请参阅我们的 kv 缓存指南；
- 长度为
config.n_layers的tuple(torch.FloatTensor)元组，每个元组包含两个形状为(batch_size, num_heads, sequence_length, embed_size_per_head)的张量）。这也称为旧版缓存格式。
模型将输出与作为输入馈入的缓存格式相同的缓存格式。如果未传入
past_key_values，则将返回旧版缓存格式。如果使用
past_key_values，用户可以选择只输入形状为(batch_size, 1)的最后一个input_ids（那些没有将其过去的键值状态提供给此模型的输入），而不是形状为(batch_size, sequence_length)的所有input_ids。 - 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.BaseModelOutputWithPoolingAndCrossAttentions 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.BaseModelOutputWithPoolingAndCrossAttentions 对象或一个 torch.FloatTensor 元组（如果传入 return_dict=False 或 config.return_dict=False），包含根据配置 (BertConfig) 和输入的不同元素。
-
last_hidden_state (
torch.FloatTensor, 形状为(batch_size, sequence_length, hidden_size)) — 模型最后一层输出的隐藏状态序列。 -
pooler_output (
torch.FloatTensor形状为(batch_size, hidden_size)) — 序列第一个 token（分类 token）经过用于辅助预训练任务的层进一步处理后的最后一层隐藏状态。例如，对于 BERT 系列模型，这会返回分类 token 经过线性层和 tanh 激活函数处理后的结果。线性层权重在预训练期间通过下一句预测（分类）目标进行训练。 -
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.add_cross_attention=True或config.output_attentions=True时返回) —torch.FloatTensor元组（每个层一个）形状为(batch_size, num_heads, sequence_length, sequence_length)。解码器交叉注意力层的注意力权重，在注意力 softmax 之后，用于计算交叉注意力头中的加权平均。
-
past_key_values (
Cache, 可选, 当传入use_cache=True或config.use_cache=True时返回) — 这是一个 Cache 实例。更多详情，请参阅我们的 kv cache 指南。包含预计算的隐藏状态（自注意力块中的键和值，如果
config.is_encoder_decoder=True，则可选地包含交叉注意力块中的键和值），可用于加速序列解码（参见past_key_values输入）。
BertModel 的 forward 方法，重写了 __call__ 特殊方法。
尽管前向传播的实现需要在该函数中定义，但之后应该调用 Module 实例而不是这个函数，因为前者负责运行预处理和后处理步骤，而后者会默默地忽略它们。
BertForPreTraining
class transformers.BertForPreTraining
< 来源 >( config )
参数
- config (BertForPreTraining) — 模型的配置类，包含模型的所有参数。使用配置文件初始化并不会加载与模型相关的权重，只加载配置。请查看 from_pretrained() 方法来加载模型权重。
Bert 模型在预训练期间在顶部带有两个头：一个 masked language modeling（掩码语言建模）头和一个 next sentence prediction (classification)（下一句预测（分类））头。
此模型继承自 PreTrainedModel。请查看超类文档，了解该库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头部等）。
此模型也是 PyTorch torch.nn.Module 子类。将其作为常规 PyTorch 模块使用，并参考 PyTorch 文档中所有与通用用法和行为相关的事项。
前向
< 来源 >( input_ids: typing.Optional[torch.Tensor] = None attention_mask: typing.Optional[torch.Tensor] = None token_type_ids: typing.Optional[torch.Tensor] = None position_ids: typing.Optional[torch.Tensor] = None head_mask: typing.Optional[torch.Tensor] = None inputs_embeds: typing.Optional[torch.Tensor] = None labels: typing.Optional[torch.Tensor] = None next_sentence_label: typing.Optional[torch.Tensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.models.bert.modeling_bert.BertForPreTrainingOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.Tensor形状为(batch_size, sequence_length), 可选) — 词汇表中输入序列 token 的索引。默认情况下会忽略填充。索引可以使用 AutoTokenizer 获取。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensor形状为(batch_size, sequence_length), 可选) — 掩码，用于避免对填充 token 索引执行注意力。掩码值选择在[0, 1]之间：- 1 表示 未被掩码 的 token，
- 0 表示 被掩码 的 token。
- token_type_ids (
torch.Tensor形状为(batch_size, sequence_length), 可选) — 段落 token 索引，用于指示输入的第一个和第二个部分。索引选择在[0, 1]之间：- 0 对应于 句子 A token，
- 1 对应于 句子 B token。
- position_ids (
torch.Tensor形状为(batch_size, sequence_length), 可选) — 每个输入序列 token 在位置嵌入中的位置索引。选择范围为[0, config.n_positions - 1]。 - head_mask (
torch.Tensor形状为(num_heads,)或(num_layers, num_heads), 可选) — 掩码，用于使自注意力模块的选定头无效。掩码值选择在[0, 1]之间：- 1 表示头 未被掩码，
- 0 表示头 被掩码。
- inputs_embeds (
torch.Tensor形状为(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,), 可选) — 用于计算下一序列预测（分类）损失的标签。输入应为序列对（参见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.bert.modeling_bert.BertForPreTrainingOutput 或 tuple(torch.FloatTensor)
一个 transformers.models.bert.modeling_bert.BertForPreTrainingOutput 对象或一个 torch.FloatTensor 元组（如果传入 return_dict=False 或 config.return_dict=False），包含根据配置 (BertConfig) 和输入的不同元素。
-
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], 可选, 当传入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 后的注意力权重，用于计算自注意力头中的加权平均值。
BertForPreTraining 的 forward 方法，重写了 __call__ 特殊方法。
尽管前向传播的实现需要在该函数中定义，但之后应该调用 Module 实例而不是这个函数，因为前者负责运行预处理和后处理步骤，而后者会默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, BertForPreTraining
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("google-bert/bert-base-uncased")
>>> model = BertForPreTraining.from_pretrained("google-bert/bert-base-uncased")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")
>>> outputs = model(**inputs)
>>> prediction_logits = outputs.prediction_logits
>>> seq_relationship_logits = outputs.seq_relationship_logitsBertLMHeadModel
class transformers.BertLMHeadModel
< 来源 >( config )
参数
- config (BertLMHeadModel) — 模型的配置类，包含模型的所有参数。使用配置文件初始化并不会加载与模型相关的权重，只加载配置。请查看 from_pretrained() 方法来加载模型权重。
Bert 模型顶部带有一个用于 CLM 微调的 language modeling 头。
此模型继承自 PreTrainedModel。请查看超类文档，了解该库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头部等）。
此模型也是 PyTorch torch.nn.Module 子类。将其作为常规 PyTorch 模块使用，并参考 PyTorch 文档中所有与通用用法和行为相关的事项。
前向
< 来源 >( input_ids: typing.Optional[torch.Tensor] = None attention_mask: typing.Optional[torch.Tensor] = None token_type_ids: typing.Optional[torch.Tensor] = None position_ids: typing.Optional[torch.Tensor] = None head_mask: typing.Optional[torch.Tensor] = None inputs_embeds: typing.Optional[torch.Tensor] = None encoder_hidden_states: typing.Optional[torch.Tensor] = None encoder_attention_mask: typing.Optional[torch.Tensor] = None labels: typing.Optional[torch.Tensor] = None past_key_values: typing.Optional[list[torch.Tensor]] = None use_cache: typing.Optional[bool] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None **loss_kwargs ) → transformers.modeling_outputs.CausalLMOutputWithCrossAttentions 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.Tensor形状为(batch_size, sequence_length), 可选) — 词汇表中输入序列 token 的索引。默认情况下会忽略填充。索引可以使用 AutoTokenizer 获取。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensor形状为(batch_size, sequence_length), 可选) — 掩码，用于避免对填充 token 索引执行注意力。掩码值选择在[0, 1]之间：- 1 表示 未被掩码 的 token，
- 0 表示 被掩码 的 token。
- token_type_ids (
torch.Tensor形状为(batch_size, sequence_length), 可选) — 段落 token 索引，用于指示输入的第一个和第二个部分。索引选择在[0, 1]之间：- 0 对应于 句子 A token，
- 1 对应于 句子 B token。
- position_ids (
torch.Tensor形状为(batch_size, sequence_length), 可选) — 每个输入序列 token 在位置嵌入中的位置索引。选择范围为[0, config.n_positions - 1]。 - head_mask (
torch.Tensor形状为(num_heads,)或(num_layers, num_heads), 可选) — 掩码，用于使自注意力模块的选定头无效。掩码值选择在[0, 1]之间：- 1 表示头 未被掩码，
- 0 表示头 被掩码。
- inputs_embeds (
torch.Tensor形状为(batch_size, sequence_length, hidden_size), 可选) — 可选地，您可以直接传递嵌入表示，而不是传递input_ids。如果您希望对input_ids索引如何转换为相关向量有更多控制，而不是模型内部的嵌入查找矩阵，这会很有用。 - encoder_hidden_states (
torch.Tensor形状为(batch_size, sequence_length, hidden_size), 可选) — 编码器最后一层输出的隐藏状态序列。如果模型配置为解码器，则用于交叉注意力。 - encoder_attention_mask (
torch.Tensor形状为(batch_size, sequence_length), 可选) — 掩码，用于避免对编码器输入的填充 token 索引执行注意力。如果模型配置为解码器，则此掩码用于交叉注意力。掩码值选择在[0, 1]之间：- 1 表示 未被掩码 的 token，
- 0 表示 被掩码 的 token。
- labels (
torch.LongTensor形状为(batch_size, sequence_length), 可选) — 用于计算从左到右语言建模损失（下一词预测）的标签。索引应在[-100, 0, ..., config.vocab_size]范围内（参见input_ids文档字符串）。索引设置为-100的 token 将被忽略（掩码），损失只为标签在[0, ..., config.vocab_size]范围内的 token 计算。 - past_key_values (
list[torch.Tensor], 可选) — 预计算的隐藏状态（自注意力块和交叉注意力块中的键和值），可用于加速序列解码。这通常包括模型在解码上一阶段返回的past_key_values，当use_cache=True或config.use_cache=True时。允许两种格式：
- 一个 Cache 实例，请参阅我们的 kv cache 指南；
- 一个
config.n_layers长度的tuple(torch.FloatTensor)元组，每个元组包含两个形状为(batch_size, num_heads, sequence_length, embed_size_per_head)的张量。这也被称为传统缓存格式。
模型将输出与输入相同格式的缓存。如果未传入
past_key_values，则将返回传统缓存格式。如果使用
past_key_values，用户可以可选地只输入最后input_ids（那些没有将过去的键值状态提供给该模型的输入）形状为(batch_size, 1)，而不是所有input_ids形状为(batch_size, sequence_length)。 - 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.CausalLMOutputWithCrossAttentions 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.CausalLMOutputWithCrossAttentions 对象或一个 torch.FloatTensor 元组（如果传入 return_dict=False 或 config.return_dict=False），包含根据配置 (BertConfig) 和输入的不同元素。
-
loss (
torch.FloatTensor形状为(1,)，可选，当提供labels时返回) — 语言建模损失（用于下一个 token 预测）。 -
logits (形状为
(batch_size, sequence_length, config.vocab_size)的torch.FloatTensor) — 语言建模头部的预测分数（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 (
Cache, 可选, 当传入use_cache=True或config.use_cache=True时返回) — 这是一个 Cache 实例。更多详情，请参阅我们的 kv cache 指南。包含预先计算的隐藏状态（注意力块中的键和值），可用于（参见
past_key_values输入）加速顺序解码。
BertLMHeadModel 的 forward 方法，重写了 __call__ 特殊方法。
尽管前向传播的实现需要在该函数中定义，但之后应该调用 Module 实例而不是这个函数，因为前者负责运行预处理和后处理步骤，而后者会默默地忽略它们。
示例
>>> import torch
>>> from transformers import AutoTokenizer, BertLMHeadModel
>>> tokenizer = AutoTokenizer.from_pretrained("google-bert/bert-base-uncased")
>>> model = BertLMHeadModel.from_pretrained("google-bert/bert-base-uncased")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")
>>> outputs = model(**inputs, labels=inputs["input_ids"])
>>> loss = outputs.loss
>>> logits = outputs.logitsBertForMaskedLM
class transformers.BertForMaskedLM
< 来源 >( config )
参数
- config (BertForMaskedLM) — 模型的配置类，包含模型的所有参数。使用配置文件初始化并不会加载与模型相关的权重，只加载配置。请查看 from_pretrained() 方法来加载模型权重。
Bert 模型顶部带有一个 language modeling 头。
此模型继承自 PreTrainedModel。请查看超类文档，了解该库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头部等）。
此模型也是 PyTorch torch.nn.Module 子类。将其作为常规 PyTorch 模块使用，并参考 PyTorch 文档中所有与通用用法和行为相关的事项。
前向
< 来源 >( input_ids: typing.Optional[torch.Tensor] = None attention_mask: typing.Optional[torch.Tensor] = None token_type_ids: typing.Optional[torch.Tensor] = None position_ids: typing.Optional[torch.Tensor] = None head_mask: typing.Optional[torch.Tensor] = None inputs_embeds: typing.Optional[torch.Tensor] = None encoder_hidden_states: typing.Optional[torch.Tensor] = None encoder_attention_mask: typing.Optional[torch.Tensor] = None labels: typing.Optional[torch.Tensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.modeling_outputs.MaskedLMOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.Tensor形状为(batch_size, sequence_length), 可选) — 词汇表中输入序列 token 的索引。默认情况下会忽略填充。索引可以使用 AutoTokenizer 获取。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensor形状为(batch_size, sequence_length), 可选) — 掩码，用于避免对填充 token 索引执行注意力。掩码值选择在[0, 1]之间：- 1 表示 未被掩码 的 token，
- 0 表示 被掩码 的 token。
- token_type_ids (
torch.Tensor形状为(batch_size, sequence_length), 可选) — 段落 token 索引，用于指示输入的第一个和第二个部分。索引选择在[0, 1]之间：- 0 对应于 句子 A token，
- 1 对应于 句子 B token。
- position_ids (
torch.Tensor，形状为(batch_size, sequence_length)，可选) — 每个输入序列令牌在位置嵌入中的位置索引。选择范围为[0, config.n_positions - 1]。 - head_mask (
torch.Tensor，形状为(num_heads,)或(num_layers, num_heads)，可选) — 用于使自注意力模块的选定头部无效的掩码。掩码值选择范围为[0, 1]：- 1 表示头部未被掩码，
- 0 表示头部被掩码。
- inputs_embeds (
torch.Tensor，形状为(batch_size, sequence_length, hidden_size)，可选) — 可选地，你可以选择直接传入嵌入表示，而不是传入input_ids。如果你想对如何将input_ids索引转换为相关向量拥有比模型内部嵌入查找矩阵更多的控制权，这将非常有用。 - encoder_hidden_states (
torch.Tensor，形状为(batch_size, sequence_length, hidden_size)，可选) — 编码器最后一层输出的隐藏状态序列。如果模型被配置为解码器，则用于交叉注意力。 - encoder_attention_mask (
torch.Tensor，形状为(batch_size, sequence_length)，可选) — 避免在编码器输入中对填充令牌索引执行注意力的掩码。如果模型被配置为解码器，则此掩码用于交叉注意力。掩码值选择范围为[0, 1]：- 1 表示令牌未被掩码，
- 0 表示令牌被掩码。
- labels (
torch.LongTensor，形状为(batch_size, sequence_length)，可选) — 用于计算掩码语言模型损失的标签。索引应在[-100, 0, ..., config.vocab_size]范围内（参见input_ids文档字符串）。索引设置为-100的令牌将被忽略（掩码），损失仅针对标签在[0, ..., config.vocab_size]范围内的令牌计算。 - output_attentions (
bool，可选) — 是否返回所有注意力层的注意力张量。更多详细信息请参见返回张量中的attentions。 - output_hidden_states (
bool，可选) — 是否返回所有层的隐藏状态。更多详细信息请参见返回张量中的hidden_states。 - return_dict (
bool，可选) — 是否返回 ModelOutput 而不是普通的元组。
返回
transformers.modeling_outputs.MaskedLMOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.MaskedLMOutput 或 torch.FloatTensor 元组（如果传入 return_dict=False 或 config.return_dict=False），包含根据配置（BertConfig）和输入的不同元素。
-
loss (形状为
(1,)的torch.FloatTensor，可选，当提供labels时返回) — 掩码语言建模 (MLM) 损失。 -
logits (形状为
(batch_size, sequence_length, config.vocab_size)的torch.FloatTensor) — 语言建模头部的预测分数（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 后的注意力权重，用于计算自注意力头中的加权平均值。
此 BertForMaskedLM 的前向方法，覆盖了 __call__ 特殊方法。
尽管前向传播的实现需要在该函数中定义，但之后应该调用 Module 实例而不是这个函数，因为前者负责运行预处理和后处理步骤，而后者会默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, BertForMaskedLM
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("google-bert/bert-base-uncased")
>>> model = BertForMaskedLM.from_pretrained("google-bert/bert-base-uncased")
>>> inputs = tokenizer("The capital of France is <mask>.", return_tensors="pt")
>>> 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)
...
>>> labels = tokenizer("The capital of France is Paris.", return_tensors="pt")["input_ids"]
>>> # mask labels of non-<mask> tokens
>>> labels = torch.where(inputs.input_ids == tokenizer.mask_token_id, labels, -100)
>>> outputs = model(**inputs, labels=labels)
>>> round(outputs.loss.item(), 2)
...BertForNextSentencePrediction
class transformers.BertForNextSentencePrediction
< source >( config )
参数
- config (BertForNextSentencePrediction) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型相关的权重，只会加载配置。要加载模型权重，请查看 from_pretrained() 方法。
Bert 模型，顶部带有 下一个句子预测（分类） 头。
此模型继承自 PreTrainedModel。请查看超类文档，了解该库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头部等）。
此模型也是 PyTorch torch.nn.Module 子类。将其作为常规 PyTorch 模块使用，并参考 PyTorch 文档中所有与通用用法和行为相关的事项。
前向
< source >( input_ids: typing.Optional[torch.Tensor] = None attention_mask: typing.Optional[torch.Tensor] = None token_type_ids: typing.Optional[torch.Tensor] = None position_ids: typing.Optional[torch.Tensor] = None head_mask: typing.Optional[torch.Tensor] = None inputs_embeds: typing.Optional[torch.Tensor] = None labels: typing.Optional[torch.Tensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None **kwargs ) → transformers.modeling_outputs.NextSentencePredictorOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.Tensor，形状为(batch_size, sequence_length)，可选) — 词汇表中输入序列令牌的索引。默认情况下将忽略填充。索引可以使用 AutoTokenizer 获取。有关详细信息，请参见 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensor，形状为(batch_size, sequence_length)，可选) — 避免对填充令牌索引执行注意力的掩码。掩码值选择范围为[0, 1]：- 1 表示令牌未被掩码，
- 0 表示令牌被掩码。
- token_type_ids (
torch.Tensor，形状为(batch_size, sequence_length)，可选) — 分段令牌索引，用于指示输入的第一个和第二个部分。索引选择范围为[0, 1]：- 0 对应于一个句子 A 令牌，
- 1 对应于一个句子 B 令牌。
- position_ids (
torch.Tensor，形状为(batch_size, sequence_length)，可选) — 每个输入序列令牌在位置嵌入中的位置索引。选择范围为[0, config.n_positions - 1]。 - head_mask (
torch.Tensor，形状为(num_heads,)或(num_layers, num_heads)，可选) — 用于使自注意力模块的选定头部无效的掩码。掩码值选择范围为[0, 1]：- 1 表示头部未被掩码，
- 0 表示头部被掩码。
- inputs_embeds (
torch.Tensor，形状为(batch_size, sequence_length, hidden_size)，可选) — 可选地，你可以选择直接传入嵌入表示，而不是传入input_ids。如果你想对如何将input_ids索引转换为相关向量拥有比模型内部嵌入查找矩阵更多的控制权，这将非常有用。 - labels (
torch.LongTensor，形状为(batch_size,)，可选) — 用于计算下一个序列预测（分类）损失的标签。输入应该是一个序列对（参见input_ids文档字符串）。索引应在[0, 1]范围内：- 0 表示序列 B 是序列 A 的延续，
- 1 表示序列 B 是一个随机序列。
- output_attentions (
bool，可选) — 是否返回所有注意力层的注意力张量。更多详细信息请参见返回张量中的attentions。 - output_hidden_states (
bool，可选) — 是否返回所有层的隐藏状态。更多详细信息请参见返回张量中的hidden_states。 - return_dict (
bool，可选) — 是否返回 ModelOutput 而不是普通的元组。
返回
transformers.modeling_outputs.NextSentencePredictorOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.NextSentencePredictorOutput 或 torch.FloatTensor 元组（如果传入 return_dict=False 或 config.return_dict=False），包含根据配置（BertConfig）和输入的不同元素。
-
loss (
torch.FloatTensor，形状为(1,)，可选，当提供next_sentence_label时返回) — 下一个序列预测（分类）损失。 -
logits (
torch.FloatTensor，形状为(batch_size, 2)) — 下一个序列预测（分类）头的预测分数（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 后的注意力权重，用于计算自注意力头中的加权平均值。
此 BertForNextSentencePrediction 的前向方法，覆盖了 __call__ 特殊方法。
尽管前向传播的实现需要在该函数中定义，但之后应该调用 Module 实例而不是这个函数，因为前者负责运行预处理和后处理步骤，而后者会默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, BertForNextSentencePrediction
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("google-bert/bert-base-uncased")
>>> model = BertForNextSentencePrediction.from_pretrained("google-bert/bert-base-uncased")
>>> prompt = "In Italy, pizza served in formal settings, such as at a restaurant, is presented unsliced."
>>> next_sentence = "The sky is blue due to the shorter wavelength of blue light."
>>> encoding = tokenizer(prompt, next_sentence, return_tensors="pt")
>>> outputs = model(**encoding, labels=torch.LongTensor([1]))
>>> logits = outputs.logits
>>> assert logits[0, 0] < logits[0, 1] # next sentence was randomBertForSequenceClassification
class transformers.BertForSequenceClassification
< source >( config )
参数
- config (BertForSequenceClassification) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型相关的权重，只会加载配置。要加载模型权重，请查看 from_pretrained() 方法。
Bert 模型转换器，顶部带有一个序列分类/回归头（在池化输出之上有一个线性层），例如用于 GLUE 任务。
此模型继承自 PreTrainedModel。请查看超类文档，了解该库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头部等）。
此模型也是 PyTorch torch.nn.Module 子类。将其作为常规 PyTorch 模块使用，并参考 PyTorch 文档中所有与通用用法和行为相关的事项。
前向
< source >( input_ids: typing.Optional[torch.Tensor] = None attention_mask: typing.Optional[torch.Tensor] = None token_type_ids: typing.Optional[torch.Tensor] = None position_ids: typing.Optional[torch.Tensor] = None head_mask: typing.Optional[torch.Tensor] = None inputs_embeds: typing.Optional[torch.Tensor] = None labels: typing.Optional[torch.Tensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.modeling_outputs.SequenceClassifierOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.Tensor，形状为(batch_size, sequence_length)，可选) — 词汇表中输入序列令牌的索引。默认情况下将忽略填充。索引可以使用 AutoTokenizer 获取。有关详细信息，请参见 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensor，形状为(batch_size, sequence_length)，可选) — 避免对填充令牌索引执行注意力的掩码。掩码值选择范围为[0, 1]：- 1 表示令牌未被掩码，
- 0 表示令牌被掩码。
- token_type_ids (
torch.Tensor，形状为(batch_size, sequence_length)，可选) — 分段令牌索引，用于指示输入的第一个和第二个部分。索引选择范围为[0, 1]：- 0 对应于一个句子 A 令牌，
- 1 对应于一个句子 B 令牌。
- position_ids (
torch.Tensor，形状为(batch_size, sequence_length)，可选) — 每个输入序列令牌在位置嵌入中的位置索引。选择范围为[0, config.n_positions - 1]。 - head_mask (
torch.Tensor，形状为(num_heads,)或(num_layers, num_heads)，可选) — 用于使自注意力模块的选定头部无效的掩码。掩码值选择范围为[0, 1]：- 1 表示头部未被掩码，
- 0 表示头部被掩码。
- inputs_embeds (
torch.Tensor，形状为(batch_size, sequence_length, hidden_size)，可选) — 可选地，你可以选择直接传入嵌入表示，而不是传入input_ids。如果你想对如何将input_ids索引转换为相关向量拥有比模型内部嵌入查找矩阵更多的控制权，这将非常有用。 - labels (
torch.LongTensor，形状为(batch_size,)，可选) — 用于计算序列分类/回归损失的标签。索引应在[0, ..., config.num_labels - 1]范围内。如果config.num_labels == 1，则计算回归损失（均方损失）；如果config.num_labels > 1，则计算分类损失（交叉熵）。 - output_attentions (
bool，可选) — 是否返回所有注意力层的注意力张量。更多详细信息请参见返回张量中的attentions。 - output_hidden_states (
bool，可选) — 是否返回所有层的隐藏状态。更多详细信息请参见返回张量中的hidden_states。 - return_dict (
bool，可选) — 是否返回 ModelOutput 而不是普通的元组。
返回
transformers.modeling_outputs.SequenceClassifierOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.SequenceClassifierOutput 或 torch.FloatTensor 元组（如果传入 return_dict=False 或 config.return_dict=False），包含根据配置（BertConfig）和输入的不同元素。
-
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), 可选, 当传入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 后的注意力权重，用于计算自注意力头中的加权平均值。
此 BertForSequenceClassification 的前向方法，覆盖了 __call__ 特殊方法。
尽管前向传播的实现需要在该函数中定义，但之后应该调用 Module 实例而不是这个函数，因为前者负责运行预处理和后处理步骤，而后者会默默地忽略它们。
单标签分类示例
>>> import torch
>>> from transformers import AutoTokenizer, BertForSequenceClassification
>>> tokenizer = AutoTokenizer.from_pretrained("google-bert/bert-base-uncased")
>>> model = BertForSequenceClassification.from_pretrained("google-bert/bert-base-uncased")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")
>>> with torch.no_grad():
... logits = model(**inputs).logits
>>> predicted_class_id = logits.argmax().item()
>>> model.config.id2label[predicted_class_id]
...
>>> # 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 = BertForSequenceClassification.from_pretrained("google-bert/bert-base-uncased", num_labels=num_labels)
>>> labels = torch.tensor([1])
>>> loss = model(**inputs, labels=labels).loss
>>> round(loss.item(), 2)
...多标签分类示例
>>> import torch
>>> from transformers import AutoTokenizer, BertForSequenceClassification
>>> tokenizer = AutoTokenizer.from_pretrained("google-bert/bert-base-uncased")
>>> model = BertForSequenceClassification.from_pretrained("google-bert/bert-base-uncased", 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 = BertForSequenceClassification.from_pretrained(
... "google-bert/bert-base-uncased", 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).lossBertForMultipleChoice
class transformers.BertForMultipleChoice
< source >( config )
参数
- config (BertForMultipleChoice) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型相关的权重，只会加载配置。要加载模型权重，请查看 from_pretrained() 方法。
Bert 模型，顶部带有多个选择分类头（在池化输出之上有一个线性层和 softmax），例如用于 RocStories/SWAG 任务。
此模型继承自 PreTrainedModel。请查看超类文档，了解该库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头部等）。
此模型也是 PyTorch torch.nn.Module 子类。将其作为常规 PyTorch 模块使用，并参考 PyTorch 文档中所有与通用用法和行为相关的事项。
前向
< source >( input_ids: typing.Optional[torch.Tensor] = None attention_mask: typing.Optional[torch.Tensor] = None token_type_ids: typing.Optional[torch.Tensor] = None position_ids: typing.Optional[torch.Tensor] = None head_mask: typing.Optional[torch.Tensor] = None inputs_embeds: typing.Optional[torch.Tensor] = None labels: typing.Optional[torch.Tensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.modeling_outputs.MultipleChoiceModelOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor，形状为(batch_size, num_choices, sequence_length)) — 词汇表中输入序列令牌的索引。索引可以使用 AutoTokenizer 获取。有关详细信息，请参见 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensor，形状为(batch_size, sequence_length)，可选) — 避免对填充令牌索引执行注意力的掩码。掩码值选择范围为[0, 1]：- 1 表示令牌未被掩码，
- 0 表示令牌被掩码。
- token_type_ids (
torch.LongTensor，形状为(batch_size, num_choices, sequence_length)，可选) — 分段令牌索引，用于指示输入的第一个和第二个部分。索引选择范围为[0, 1]：- 0 对应于一个句子 A 令牌，
- 1 对应于一个句子 B 令牌。
- position_ids (
torch.LongTensor，形状为(batch_size, num_choices, sequence_length)，可选) — 每个输入序列令牌在位置嵌入中的位置索引。选择范围为[0, config.max_position_embeddings - 1]。 - head_mask (
torch.Tensor，形状为(num_heads,)或(num_layers, num_heads)，可选) — 用于使自注意力模块的选定头部无效的掩码。掩码值选择范围为[0, 1]：- 1 表示头部未被掩码，
- 0 表示头部被掩码。
- inputs_embeds (
torch.FloatTensor，形状为(batch_size, num_choices, sequence_length, hidden_size)，可选) — 可选地，你可以选择直接传入嵌入表示，而不是传入input_ids。如果你想对如何将input_ids索引转换为相关向量拥有比模型内部嵌入查找矩阵更多的控制权，这将非常有用。 - labels (
torch.LongTensor，形状为(batch_size,)，可选) — 用于计算多项选择分类损失的标签。索引应在[0, ..., num_choices-1]范围内，其中num_choices是输入张量第二维的大小。（参见上面的input_ids） - output_attentions (
bool，可选) — 是否返回所有注意力层的注意力张量。更多详细信息请参见返回张量中的attentions。 - output_hidden_states (
bool，可选) — 是否返回所有层的隐藏状态。更多详细信息请参见返回张量中的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），包含取决于配置 (BertConfig) 和输入的各种元素。
-
loss (形状为 (1,) 的
torch.FloatTensor，可选，当提供labels时返回) — 分类损失。 -
logits (形状为
(batch_size, num_choices)的torch.FloatTensor) — num_choices 是输入张量的第二维大小。（请参阅上面的 input_ids）。分类分数（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 后的注意力权重，用于计算自注意力头中的加权平均值。
BertForMultipleChoice 的 forward 方法，覆盖了 __call__ 特殊方法。
尽管前向传播的实现需要在该函数中定义，但之后应该调用 Module 实例而不是这个函数，因为前者负责运行预处理和后处理步骤，而后者会默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, BertForMultipleChoice
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("google-bert/bert-base-uncased")
>>> model = BertForMultipleChoice.from_pretrained("google-bert/bert-base-uncased")
>>> 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.logitsBertForTokenClassification
class transformers.BertForTokenClassification
< source >( config )
参数
- config (BertForTokenClassification) — 模型的配置类，包含模型的所有参数。使用配置文件初始化时不会加载与模型关联的权重，只会加载配置。要加载模型权重，请查看 from_pretrained() 方法。
带有令牌分类头（在隐藏状态输出之上的一层线性层）的 Bert transformer，例如用于命名实体识别（NER）任务。
此模型继承自 PreTrainedModel。请查看超类文档，了解该库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头部等）。
此模型也是 PyTorch torch.nn.Module 子类。将其作为常规 PyTorch 模块使用，并参考 PyTorch 文档中所有与通用用法和行为相关的事项。
前向
< source >( input_ids: typing.Optional[torch.Tensor] = None attention_mask: typing.Optional[torch.Tensor] = None token_type_ids: typing.Optional[torch.Tensor] = None position_ids: typing.Optional[torch.Tensor] = None head_mask: typing.Optional[torch.Tensor] = None inputs_embeds: typing.Optional[torch.Tensor] = None labels: typing.Optional[torch.Tensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.modeling_outputs.TokenClassifierOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (形状为
(batch_size, sequence_length)的torch.Tensor，可选) — 词汇表中输入序列令牌的索引。默认情况下将忽略填充。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.__call__()。
- attention_mask (形状为
(batch_size, sequence_length)的torch.Tensor，可选) — 避免对填充令牌索引执行注意力的掩码。掩码值在[0, 1]中选择：- 1 表示**未被掩码**的令牌，
- 0 表示**被掩码**的令牌。
- token_type_ids (形状为
(batch_size, sequence_length)的torch.Tensor，可选) — 分段令牌索引，用于指示输入的第一部分和第二部分。索引在[0, 1]中选择：- 0 对应于*句子 A* 令牌，
- 1 对应于*句子 B* 令牌。
- position_ids (形状为
(batch_size, sequence_length)的torch.Tensor，可选) — 每个输入序列令牌在位置嵌入中的位置索引。选择范围为[0, config.n_positions - 1]。 - head_mask (形状为
(num_heads,)或(num_layers, num_heads)的torch.Tensor，可选) — 用于使自注意力模块的选定头部无效的掩码。掩码值在[0, 1]中选择：- 1 表示头部**未被掩码**，
- 0 表示头部**被掩码**。
- inputs_embeds (形状为
(batch_size, sequence_length, hidden_size)的torch.Tensor，可选) — 可选地，您可以选择直接传递嵌入表示，而不是传递input_ids。如果您希望对如何将input_ids索引转换为关联向量有比模型内部嵌入查找矩阵更多的控制，这会很有用。 - labels (形状为
(batch_size, sequence_length)的torch.LongTensor，可选) — 用于计算令牌分类损失的标签。索引应在[0, ..., config.num_labels - 1]之间。 - output_attentions (
bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的attentions。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的hidden_states。 - return_dict (
bool, 可选) — 是否返回 ModelOutput 对象而非普通元组。
返回
transformers.modeling_outputs.TokenClassifierOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.TokenClassifierOutput 对象或一个 torch.FloatTensor 元组（如果传入 return_dict=False 或 config.return_dict=False），包含取决于配置 (BertConfig) 和输入的各种元素。
-
loss (形状为
(1,)的torch.FloatTensor，可选，当提供labels时返回) — 分类损失。 -
logits (形状为
(batch_size, sequence_length, config.num_labels)的torch.FloatTensor) — 分类分数（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 后的注意力权重，用于计算自注意力头中的加权平均值。
BertForTokenClassification 的 forward 方法，覆盖了 __call__ 特殊方法。
尽管前向传播的实现需要在该函数中定义，但之后应该调用 Module 实例而不是这个函数，因为前者负责运行预处理和后处理步骤，而后者会默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, BertForTokenClassification
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("google-bert/bert-base-uncased")
>>> model = BertForTokenClassification.from_pretrained("google-bert/bert-base-uncased")
>>> 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)
...BertForQuestionAnswering
class transformers.BertForQuestionAnswering
< source >( config )
参数
- config (BertForQuestionAnswering) — 模型的配置类，包含模型的所有参数。使用配置文件初始化时不会加载与模型关联的权重，只会加载配置。要加载模型权重，请查看 from_pretrained() 方法。
带有跨度分类头（在隐藏状态输出之上的一层线性层，用于计算 span start logits 和 span end logits）的 Bert transformer，用于 SQuAD 等抽取式问答任务。
此模型继承自 PreTrainedModel。请查看超类文档，了解该库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头部等）。
此模型也是 PyTorch torch.nn.Module 子类。将其作为常规 PyTorch 模块使用，并参考 PyTorch 文档中所有与通用用法和行为相关的事项。
前向
< source >( input_ids: typing.Optional[torch.Tensor] = None attention_mask: typing.Optional[torch.Tensor] = None token_type_ids: typing.Optional[torch.Tensor] = None position_ids: typing.Optional[torch.Tensor] = None head_mask: typing.Optional[torch.Tensor] = None inputs_embeds: typing.Optional[torch.Tensor] = None start_positions: typing.Optional[torch.Tensor] = None end_positions: typing.Optional[torch.Tensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.modeling_outputs.QuestionAnsweringModelOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (形状为
(batch_size, sequence_length)的torch.Tensor，可选) — 词汇表中输入序列令牌的索引。默认情况下将忽略填充。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.__call__()。
- attention_mask (形状为
(batch_size, sequence_length)的torch.Tensor，可选) — 避免对填充令牌索引执行注意力的掩码。掩码值在[0, 1]中选择：- 1 表示**未被掩码**的令牌，
- 0 表示**被掩码**的令牌。
- token_type_ids (形状为
(batch_size, sequence_length)的torch.Tensor，可选) — 分段令牌索引，用于指示输入的第一部分和第二部分。索引在[0, 1]中选择：- 0 对应于*句子 A* 令牌，
- 1 对应于*句子 B* 令牌。
- position_ids (形状为
(batch_size, sequence_length)的torch.Tensor，可选) — 每个输入序列令牌在位置嵌入中的位置索引。选择范围为[0, config.n_positions - 1]。 - head_mask (形状为
(num_heads,)或(num_layers, num_heads)的torch.Tensor，可选) — 用于使自注意力模块的选定头部无效的掩码。掩码值在[0, 1]中选择：- 1 表示头部**未被掩码**，
- 0 表示头部**被掩码**。
- inputs_embeds (形状为
(batch_size, sequence_length, hidden_size)的torch.Tensor，可选) — 可选地，您可以选择直接传递嵌入表示，而不是传递input_ids。如果您希望对如何将input_ids索引转换为关联向量有比模型内部嵌入查找矩阵更多的控制，这会很有用。 - start_positions (形状为
(batch_size,)的torch.Tensor，可选) — 用于计算令牌分类损失的标记跨度起始位置（索引）的标签。位置将被钳制到序列的长度（sequence_length）。序列外的位置不计入损失计算。 - end_positions (形状为
(batch_size,)的torch.Tensor，可选) — 用于计算令牌分类损失的标记跨度结束位置（索引）的标签。位置将被钳制到序列的长度（sequence_length）。序列外的位置不计入损失计算。 - output_attentions (
bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的attentions。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的hidden_states。 - return_dict (
bool, 可选) — 是否返回 ModelOutput 对象而非普通元组。
返回
transformers.modeling_outputs.QuestionAnsweringModelOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.QuestionAnsweringModelOutput 对象或一个 torch.FloatTensor 元组（如果传入 return_dict=False 或 config.return_dict=False），包含取决于配置 (BertConfig) 和输入的各种元素。
-
loss (
torch.FloatTensorof shape(1,), 可选, 当提供labels时返回) — 总范围提取损失是起始位置和结束位置的交叉熵之和。 -
start_logits (
torch.FloatTensorof shape(batch_size, sequence_length)) — 范围起始分数（SoftMax 之前）。 -
end_logits (
torch.FloatTensorof shape(batch_size, sequence_length)) — 范围结束分数（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 后的注意力权重，用于计算自注意力头中的加权平均值。
BertForQuestionAnswering 的 forward 方法，覆盖了 __call__ 特殊方法。
尽管前向传播的实现需要在该函数中定义，但之后应该调用 Module 实例而不是这个函数，因为前者负责运行预处理和后处理步骤，而后者会默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, BertForQuestionAnswering
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("google-bert/bert-base-uncased")
>>> model = BertForQuestionAnswering.from_pretrained("google-bert/bert-base-uncased")
>>> 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]
>>> tokenizer.decode(predict_answer_tokens, skip_special_tokens=True)
...
>>> # 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.loss
>>> round(loss.item(), 2)
...TFBertTokenizer
class transformers.TFBertTokenizer
< source >( vocab_list: list do_lower_case: bool cls_token_id: typing.Optional[int] = None sep_token_id: typing.Optional[int] = None pad_token_id: typing.Optional[int] = None padding: str = 'longest' truncation: bool = True max_length: int = 512 pad_to_multiple_of: typing.Optional[int] = None return_token_type_ids: bool = True return_attention_mask: bool = True use_fast_bert_tokenizer: bool = True **tokenizer_kwargs )
参数
- vocab_list (
list) — 包含词汇表的列表。 - do_lower_case (
bool, 可选, 默认为True) — 分词时是否将输入转换为小写。 - cls_token_id (
str, 可选, 默认为"[CLS]") — 用于序列分类（对整个序列而非每个令牌进行分类）的分类器令牌。当与特殊令牌一起构建时，它是序列的第一个令牌。 - sep_token_id (
str, 可选, 默认为"[SEP]") — 分隔符令牌，用于从多个序列构建序列时，例如用于序列分类的两个序列，或用于问答的文本和问题。它也用作与特殊令牌一起构建的序列的最后一个令牌。 - pad_token_id (
str, 可选, 默认为"[PAD]") — 用于填充的令牌，例如在批处理不同长度的序列时。 - padding (
str, 默认为"longest") — 要使用的填充类型。可以是"longest"，仅填充到批次中最长的样本，也可以是"max_length"，将所有输入填充到分词器支持的最大长度。 - truncation (
bool, 可选, 默认为True) — 是否将序列截断到最大长度。 - max_length (
int, 可选, 默认为512) — 序列的最大长度，用于填充（如果padding为 “max_length”）和/或截断（如果truncation为True）。 - pad_to_multiple_of (
int, 可选, 默认为None) — 如果设置，序列将填充到此值的倍数。 - return_token_type_ids (
bool, 可选, 默认为True) — 是否返回 token_type_ids。 - return_attention_mask (
bool, 可选, 默认为True) — 是否返回 attention_mask。 - use_fast_bert_tokenizer (
bool, 可选, 默认为True) — 如果为 True，将使用 Tensorflow Text 中的 FastBertTokenizer 类。如果为 False，将使用 BertTokenizer 类。BertTokenizer 支持一些附加选项，但速度较慢，无法导出到 TFLite。
这是一个用于 BERT 的图内分词器。它应与其他分词器类似地初始化，使用 from_pretrained() 方法。它也可以使用 from_tokenizer() 方法初始化，该方法从现有标准分词器对象导入设置。
与 Hugging Face 的其他分词器不同，图内分词器实际上是 Keras 层，旨在在模型被调用时运行，而不是在预处理期间运行。因此，它们比标准分词器类的选项更有限。当您想要创建一个直接从 tf.string 输入到输出的端到端模型时，它们最有用。
from_pretrained
< source >( pretrained_model_name_or_path: typing.Union[str, os.PathLike] *init_inputs **kwargs )
从预训练分词器实例化一个 TFBertTokenizer。
from_tokenizer
< source >( tokenizer: PreTrainedTokenizerBase **kwargs )
从现有 Tokenizer 初始化 TFBertTokenizer。
TFBertModel
class transformers.TFBertModel
< source >( config: BertConfig add_pooling_layer: bool = True *inputs **kwargs )
参数
- config (BertConfig) — 包含模型所有参数的模型配置类。用配置文件初始化不会加载与模型相关的权重，只加载配置。请查看 from_pretrained() 方法来加载模型权重。
原始的 Bert 模型 transformer，输出原始的隐藏状态，没有顶部任何特定的头部。
此模型继承自 TFPreTrainedModel。请查阅超类文档，了解库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头部等）。
此模型也是 keras.Model 子类。将其作为常规的 TF 2.0 Keras 模型使用，并参考 TF 2.0 文档了解所有与通用用法和行为相关的事项。
transformers 中的 TensorFlow 模型和层接受两种输入格式
- 所有输入作为关键字参数（如 PyTorch 模型），或
- 所有输入作为第一个位置参数中的列表、元组或字典。
支持第二种格式的原因是，Keras 方法在将输入传递给模型和层时更喜欢这种格式。由于这种支持，当使用 model.fit() 等方法时，一切都应该“正常工作”——只需以 model.fit() 支持的任何格式传递输入和标签即可！但是，如果您想在 Keras 方法（如 fit() 和 predict()）之外使用第二种格式，例如在使用 Keras Functional API 创建自己的层或模型时，有三种可能性可以用来在第一个位置参数中收集所有输入张量。
- 只有一个
input_ids的单个张量，没有其他：model(input_ids) - 长度可变的列表，包含一个或多个输入张量，按文档字符串中给出的顺序：
model([input_ids, attention_mask])或model([input_ids, attention_mask, token_type_ids]) - 一个字典，其中包含一个或多个与文档字符串中给出的输入名称关联的输入张量：
model({"input_ids": input_ids, "token_type_ids": token_type_ids})
请注意，当使用子类化创建模型和层时，您无需担心这些，因为您可以像对待任何其他 Python 函数一样传递输入！
调用
< source >( input_ids: TFModelInputType | None = None attention_mask: np.ndarray | tf.Tensor | None = None token_type_ids: np.ndarray | tf.Tensor | None = None position_ids: np.ndarray | tf.Tensor | None = None head_mask: np.ndarray | tf.Tensor | None = None inputs_embeds: np.ndarray | tf.Tensor | None = None encoder_hidden_states: np.ndarray | tf.Tensor | None = None encoder_attention_mask: np.ndarray | tf.Tensor | None = None past_key_values: Optional[tuple[tuple[Union[np.ndarray, tf.Tensor]]]] = None use_cache: Optional[bool] = None output_attentions: Optional[bool] = None output_hidden_states: Optional[bool] = None return_dict: Optional[bool] = None training: Optional[bool] = False ) → transformers.modeling_tf_outputs.TFBaseModelOutputWithPoolingAndCrossAttentions 或 tuple(tf.Tensor)
参数
- input_ids (
np.ndarray,tf.Tensor,list[tf.Tensor]`dict[str, tf.Tensor]或dict[str, np.ndarray]，并且每个示例必须具有形状(batch_size, sequence_length)) — 词汇表中输入序列标记的索引。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.call() 和 PreTrainedTokenizer.encode()。
- attention_mask (
np.ndarray或tf.Tensor，形状为(batch_size, sequence_length)，可选) — 用于避免对填充标记索引执行注意力操作的掩码。掩码值选择范围为[0, 1]：- 1 表示未被掩盖的标记，
- 0 表示被掩盖的标记。
- token_type_ids (
np.ndarray或tf.Tensor，形状为(batch_size, sequence_length)，可选) — 分段标记索引，用于指示输入的第一个和第二个部分。索引选择范围为[0, 1]：- 0 对应于句子 A 标记，
- 1 对应于句子 B 标记。
- position_ids (
np.ndarray或tf.Tensor，形状为(batch_size, sequence_length)，可选) — 每个输入序列标记在位置嵌入中的位置索引。选择范围为[0, config.max_position_embeddings - 1]。 - head_mask (
np.ndarray或tf.Tensor，形状为(num_heads,)或(num_layers, num_heads)，可选) — 用于使自注意力模块的选定头部无效的掩码。掩码值选择范围为[0, 1]：- 1 表示头部未被掩盖，
- 0 表示头部被掩盖。
- inputs_embeds (
np.ndarray或tf.Tensor，形状为(batch_size, sequence_length, hidden_size)，可选) — 可选地，您可以选择直接传递嵌入表示，而不是传递input_ids。如果您希望对如何将input_ids索引转换为关联向量有比模型内部嵌入查找矩阵更多的控制，这会很有用。 - output_attentions (
bool，可选) — 是否返回所有注意力层的注意力张量。更多详情请参见返回张量中的attentions。此参数只能在即时模式下使用，在图模式下将使用配置中的值。 - output_hidden_states (
bool，可选) — 是否返回所有层的隐藏状态。更多详情请参见返回张量中的hidden_states。此参数只能在即时模式下使用，在图模式下将使用配置中的值。 - return_dict (
bool，可选) — 是否返回 ModelOutput 而不是纯元组。此参数可在即时模式下使用，在图模式下该值将始终设置为 True。 - training (
bool，可选，默认为False) — 是否在训练模式下使用模型（某些模块，如 Dropout 模块在训练和评估之间的行为不同）。 - encoder_hidden_states (
tf.Tensor，形状为(batch_size, sequence_length, hidden_size)，可选) — 编码器最后一层输出的隐藏状态序列。如果模型被配置为解码器，则用于交叉注意力。 - encoder_attention_mask (
tf.Tensor，形状为(batch_size, sequence_length)，可选) — 用于避免对编码器输入的填充标记索引执行注意力操作的掩码。如果模型被配置为解码器，则此掩码用于交叉注意力。掩码值选择范围为[0, 1]：- 1 表示未被掩盖的标记，
- 0 表示被掩盖的标记。
- past_key_values (
tuple[tuple[tf.Tensor]]，长度为config.n_layers) — 包含预先计算的注意力块的键和值隐藏状态。可用于加速解码。如果使用past_key_values，用户可以可选地只输入形状为(batch_size, 1)的最后decoder_input_ids（那些没有将其过去的键值状态提供给此模型的），而不是形状为(batch_size, sequence_length)的所有decoder_input_ids。 - use_cache (
bool，可选，默认为True) — 如果设置为True，则返回past_key_values键值状态，可用于加速解码（参见past_key_values）。在训练期间设置为False，在生成期间设置为True。
返回
transformers.modeling_tf_outputs.TFBaseModelOutputWithPoolingAndCrossAttentions 或 tuple(tf.Tensor)
一个 transformers.modeling_tf_outputs.TFBaseModelOutputWithPoolingAndCrossAttentions 或一个 tf.Tensor 元组（如果传递 return_dict=False 或 config.return_dict=False 时），包含根据配置 (BertConfig) 和输入的不同元素。
-
last_hidden_state (
tf.Tensorof shape(batch_size, sequence_length, hidden_size)) — 模型最后一层输出的隐藏状态序列。 -
pooler_output (
tf.Tensor，形状为(batch_size, hidden_size)) — 序列第一个标记（分类标记）的最后一层隐藏状态，经线性层和 Tanh 激活函数进一步处理。线性层权重在预训练期间通过下一个句子预测（分类）目标进行训练。此输出通常不是输入语义内容的良好摘要，通常最好对整个输入序列的隐藏状态进行平均或池化。
-
past_key_values (
list[tf.Tensor]，可选，当传递use_cache=True或config.use_cache=True时返回) — 长度为config.n_layers的tf.Tensor列表，每个张量形状为(2, batch_size, num_heads, sequence_length, embed_size_per_head))。包含预先计算的隐藏状态（注意力块中的键和值），可用于（参见
past_key_values输入）加速顺序解码。 -
hidden_states (
tuple(tf.Tensor)，可选，当传递output_hidden_states=True或config.output_hidden_states=True时返回) —tf.Tensor元组（一个用于嵌入输出 + 每个层的一个输出），形状为(batch_size, sequence_length, hidden_size)。模型在每个层输出的隐藏状态加上初始嵌入输出。
-
attentions (
tuple(tf.Tensor)，可选，当传递output_attentions=True或config.output_attentions=True时返回) —tf.Tensor元组（每个层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
-
cross_attentions (
tuple(tf.Tensor)，可选，当传递output_attentions=True或config.output_attentions=True时返回) —tf.Tensor元组（每个层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。解码器交叉注意力层的注意力权重，在注意力 softmax 之后，用于计算交叉注意力头中的加权平均。
TFBertModel 的前向方法，重写了 __call__ 特殊方法。
尽管前向传播的实现需要在该函数中定义，但之后应该调用 Module 实例而不是这个函数，因为前者负责运行预处理和后处理步骤，而后者会默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, TFBertModel
>>> import tensorflow as tf
>>> tokenizer = AutoTokenizer.from_pretrained("google-bert/bert-base-uncased")
>>> model = TFBertModel.from_pretrained("google-bert/bert-base-uncased")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="tf")
>>> outputs = model(inputs)
>>> last_hidden_states = outputs.last_hidden_stateTFBertForPreTraining
class transformers.TFBertForPreTraining
< source >( config: BertConfig *inputs **kwargs )
参数
- config (BertConfig) — 包含模型所有参数的模型配置类。用配置文件初始化不会加载与模型相关的权重，只加载配置。请查看 from_pretrained() 方法来加载模型权重。
Bert 模型在预训练期间在顶部带有两个头：一个 masked language modeling（掩码语言建模）头和一个 next sentence prediction (classification)（下一句预测（分类））头。
此模型继承自 TFPreTrainedModel。请查阅超类文档，了解库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头部等）。
此模型也是 keras.Model 子类。将其作为常规的 TF 2.0 Keras 模型使用，并参考 TF 2.0 文档了解所有与通用用法和行为相关的事项。
transformers 中的 TensorFlow 模型和层接受两种输入格式
- 所有输入作为关键字参数（如 PyTorch 模型），或
- 所有输入作为第一个位置参数中的列表、元组或字典。
支持第二种格式的原因是，Keras 方法在将输入传递给模型和层时更喜欢这种格式。由于这种支持，当使用 model.fit() 等方法时，一切都应该“正常工作”——只需以 model.fit() 支持的任何格式传递输入和标签即可！但是，如果您想在 Keras 方法（如 fit() 和 predict()）之外使用第二种格式，例如在使用 Keras Functional API 创建自己的层或模型时，有三种可能性可以用来在第一个位置参数中收集所有输入张量。
- 只有一个
input_ids的单个张量，没有其他：model(input_ids) - 长度可变的列表，包含一个或多个输入张量，按文档字符串中给出的顺序：
model([input_ids, attention_mask])或model([input_ids, attention_mask, token_type_ids]) - 一个字典，其中包含一个或多个与文档字符串中给出的输入名称关联的输入张量：
model({"input_ids": input_ids, "token_type_ids": token_type_ids})
请注意，当使用子类化创建模型和层时，您无需担心这些，因为您可以像对待任何其他 Python 函数一样传递输入！
调用
< source >( input_ids: TFModelInputType | None = None attention_mask: np.ndarray | tf.Tensor | None = None token_type_ids: np.ndarray | tf.Tensor | None = None position_ids: np.ndarray | tf.Tensor | None = None head_mask: np.ndarray | tf.Tensor | None = None inputs_embeds: np.ndarray | tf.Tensor | None = None output_attentions: Optional[bool] = None output_hidden_states: Optional[bool] = None return_dict: Optional[bool] = None labels: np.ndarray | tf.Tensor | None = None next_sentence_label: np.ndarray | tf.Tensor | None = None training: Optional[bool] = False ) → transformers.models.bert.modeling_tf_bert.TFBertForPreTrainingOutput 或 tuple(tf.Tensor)
参数
- input_ids (
np.ndarray,tf.Tensor,list[tf.Tensor]`dict[str, tf.Tensor]或dict[str, np.ndarray]，并且每个示例必须具有形状(batch_size, sequence_length)) — 词汇表中输入序列标记的索引。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.call() 和 PreTrainedTokenizer.encode()。
- attention_mask (
np.ndarray或tf.Tensor，形状为(batch_size, sequence_length)，可选) — 用于避免对填充标记索引执行注意力操作的掩码。掩码值选择范围为[0, 1]：- 1 表示未被掩盖的标记，
- 0 表示被掩盖的标记。
- token_type_ids (
np.ndarray或tf.Tensor，形状为(batch_size, sequence_length)，可选) — 分段标记索引，用于指示输入的第一个和第二个部分。索引选择范围为[0, 1]：- 0 对应于句子 A 标记，
- 1 对应于句子 B 标记。
- position_ids (
np.ndarray或tf.Tensor，形状为(batch_size, sequence_length)，可选) — 每个输入序列标记在位置嵌入中的位置索引。选择范围为[0, config.max_position_embeddings - 1]。 - head_mask (
np.ndarray或tf.Tensor，形状为(num_heads,)或(num_layers, num_heads)，可选) — 用于使自注意力模块的选定头部无效的掩码。掩码值选择范围为[0, 1]：- 1 表示头部未被掩盖，
- 0 表示头部被掩盖。
- inputs_embeds (
np.ndarray或tf.Tensor，形状为(batch_size, sequence_length, hidden_size)，可选) — 可选地，您可以选择直接传递嵌入表示，而不是传递input_ids。如果您希望对如何将input_ids索引转换为关联向量有比模型内部嵌入查找矩阵更多的控制，这会很有用。 - output_attentions (
bool，可选) — 是否返回所有注意力层的注意力张量。更多详情请参见返回张量中的attentions。此参数只能在即时模式下使用，在图模式下将使用配置中的值。 - output_hidden_states (
bool，可选) — 是否返回所有层的隐藏状态。更多详情请参见返回张量中的hidden_states。此参数只能在即时模式下使用，在图模式下将使用配置中的值。 - return_dict (
bool，可选) — 是否返回 ModelOutput 而不是纯元组。此参数可在即时模式下使用，在图模式下该值将始终设置为 True。 - training (
bool，可选，默认为False) — 是否在训练模式下使用模型（某些模块，如 Dropout 模块在训练和评估之间的行为不同）。 - labels (
tf.Tensor，形状为(batch_size, sequence_length)，可选) — 用于计算掩码语言建模损失的标签。索引应在[-100, 0, ..., config.vocab_size]范围内（参见input_ids文档字符串）。索引设置为-100的标记将被忽略（掩码），损失仅针对标签在[0, ..., config.vocab_size]范围内的标记计算。 - next_sentence_label (
tf.Tensor，形状为(batch_size,)，可选) — 用于计算下一个序列预测（分类）损失的标签。输入应为序列对（参见input_ids文档字符串）。索引应在[0, 1]范围内：- 0 表示序列 B 是序列 A 的延续，
- 1 表示序列 B 是一个随机序列。
- kwargs (
dict[str, any]，可选，默认为{}) — 用于隐藏已弃用的旧参数。
返回
transformers.models.bert.modeling_tf_bert.TFBertForPreTrainingOutput 或 tuple(tf.Tensor)
一个 transformers.models.bert.modeling_tf_bert.TFBertForPreTrainingOutput 或一个 tf.Tensor 元组（如果传递 return_dict=False 或 config.return_dict=False 时），包含根据配置 (BertConfig) 和输入的不同元素。
-
prediction_logits (
tf.Tensor，形状为(batch_size, sequence_length, config.vocab_size)) — 语言模型头部的预测分数（SoftMax 之前的每个词汇标记的分数）。 -
seq_relationship_logits (
tf.Tensor，形状为(batch_size, 2)) — 下一个序列预测（分类）头部的预测分数（SoftMax 之前的 True/False 延续分数）。 -
hidden_states (
tuple(tf.Tensor)，可选，当传递output_hidden_states=True或config.output_hidden_states=True时返回) —tf.Tensor元组（一个用于嵌入输出 + 每个层的一个输出），形状为(batch_size, sequence_length, hidden_size)。模型在每个层输出的隐藏状态加上初始嵌入输出。
-
attentions (
tuple(tf.Tensor)，可选，当传递output_attentions=True或config.output_attentions=True时返回) —tf.Tensor元组（每个层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
TFBertForPreTraining 的前向方法，重写了 __call__ 特殊方法。
尽管前向传播的实现需要在该函数中定义，但之后应该调用 Module 实例而不是这个函数，因为前者负责运行预处理和后处理步骤，而后者会默默地忽略它们。
示例
>>> import tensorflow as tf
>>> from transformers import AutoTokenizer, TFBertForPreTraining
>>> tokenizer = AutoTokenizer.from_pretrained("google-bert/bert-base-uncased")
>>> model = TFBertForPreTraining.from_pretrained("google-bert/bert-base-uncased")
>>> input_ids = tokenizer("Hello, my dog is cute", add_special_tokens=True, return_tensors="tf")
>>> # Batch size 1
>>> outputs = model(input_ids)
>>> prediction_logits, seq_relationship_logits = outputs[:2]TFBertModelLMHeadModel
调用
< 源 >( input_ids: TFModelInputType | None = None attention_mask: np.ndarray | tf.Tensor | None = None token_type_ids: np.ndarray | tf.Tensor | None = None position_ids: np.ndarray | tf.Tensor | None = None head_mask: np.ndarray | tf.Tensor | None = None inputs_embeds: np.ndarray | tf.Tensor | None = None encoder_hidden_states: np.ndarray | tf.Tensor | None = None encoder_attention_mask: np.ndarray | tf.Tensor | None = None past_key_values: Optional[tuple[tuple[Union[np.ndarray, tf.Tensor]]]] = None use_cache: Optional[bool] = None output_attentions: Optional[bool] = None output_hidden_states: Optional[bool] = None return_dict: Optional[bool] = None labels: np.ndarray | tf.Tensor | None = None training: Optional[bool] = False **kwargs ) → transformers.modeling_tf_outputs.TFCausalLMOutputWithCrossAttentions 或 tuple(tf.Tensor)
返回
transformers.modeling_tf_outputs.TFCausalLMOutputWithCrossAttentions 或 tuple(tf.Tensor)
一个 transformers.modeling_tf_outputs.TFCausalLMOutputWithCrossAttentions 或一个 tf.Tensor 元组（如果传入 return_dict=False 或 config.return_dict=False），包含根据配置（BertConfig）和输入的不同元素。
-
loss (形状为
(n,)的tf.Tensor，可选，其中n是非掩码标签的数量，当提供了labels时返回) — 语言建模损失（用于下一标记预测）。 -
logits (
tf.Tensorof shape(batch_size, sequence_length, config.vocab_size)) — 语言模型头部的预测分数（SoftMax 之前每个词汇标记的分数）。 -
hidden_states (
tuple(tf.Tensor)，可选，当传递output_hidden_states=True或config.output_hidden_states=True时返回) —tf.Tensor元组（一个用于嵌入输出 + 每个层的一个输出），形状为(batch_size, sequence_length, hidden_size)。模型在每个层输出的隐藏状态加上初始嵌入输出。
-
attentions (
tuple(tf.Tensor)，可选，当传递output_attentions=True或config.output_attentions=True时返回) —tf.Tensor元组（每个层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
-
cross_attentions (
tuple(tf.Tensor)，可选，当传递output_attentions=True或config.output_attentions=True时返回) —tf.Tensor元组（每个层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。解码器交叉注意力层的注意力权重，在注意力 softmax 之后，用于计算交叉注意力头中的加权平均。
-
past_key_values (
list[tf.Tensor]，可选，当传递use_cache=True或config.use_cache=True时返回) — 长度为config.n_layers的tf.Tensor列表，每个张量形状为(2, batch_size, num_heads, sequence_length, embed_size_per_head))。包含预先计算的隐藏状态（注意力块中的键和值），可用于（参见
past_key_values输入）加速顺序解码。
encoder_hidden_states (tf.Tensor 形状为 (batch_size, sequence_length, hidden_size), 可选): 编码器最后一层输出的隐藏状态序列。如果模型配置为解码器，则用于交叉注意力。encoder_attention_mask (tf.Tensor 形状为 (batch_size, sequence_length), 可选): 用于避免对编码器输入的填充标记索引执行注意力的掩码。如果模型配置为解码器，则此掩码用于交叉注意力。掩码值选择在 [0, 1] 之间。
- 1 表示 未被掩盖 的标记，
- 0 代表**被掩码**的标记。
past_key_values (tuple[tuple[tf.Tensor]] 长度为 config.n_layers) 包含注意力块的预计算键值隐藏状态。可用于加速解码。如果使用 past_key_values，用户可以选择只输入最后一个 decoder_input_ids（那些没有将其过去的键值状态提供给此模型的）形状为 (batch_size, 1)，而不是所有 decoder_input_ids 形状为 (batch_size, sequence_length)。use_cache (bool, 可选, 默认为 True): 如果设置为 True，则返回 past_key_values 键值状态，并可用于加速解码（参见 past_key_values）。训练期间设置为 False，生成期间设置为 True。labels (tf.Tensor 或 np.ndarray 形状为 (batch_size, sequence_length), 可选): 用于计算交叉熵分类损失的标签。索引应在 [0, ..., config.vocab_size - 1] 之间。
示例
>>> from transformers import AutoTokenizer, TFBertLMHeadModel
>>> import tensorflow as tf
>>> tokenizer = AutoTokenizer.from_pretrained("google-bert/bert-base-uncased")
>>> model = TFBertLMHeadModel.from_pretrained("google-bert/bert-base-uncased")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="tf")
>>> outputs = model(inputs)
>>> logits = outputs.logitsTFBertForMaskedLM
class transformers.TFBertForMaskedLM
< 源 >( config: BertConfig *inputs **kwargs )
参数
- config (BertConfig) — 带有模型所有参数的模型配置类。使用配置文件初始化不会加载与模型相关的权重，只加载配置。请查看 from_pretrained() 方法来加载模型权重。
Bert 模型顶部带有 语言建模 头。
此模型继承自 TFPreTrainedModel。请查阅超类文档，了解库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头部等）。
此模型也是 keras.Model 子类。将其作为常规的 TF 2.0 Keras 模型使用，并参考 TF 2.0 文档了解所有与通用用法和行为相关的事项。
transformers 中的 TensorFlow 模型和层接受两种输入格式
- 所有输入作为关键字参数（如 PyTorch 模型），或
- 所有输入作为第一个位置参数中的列表、元组或字典。
支持第二种格式的原因是，Keras 方法在将输入传递给模型和层时更喜欢这种格式。由于这种支持，当使用 model.fit() 等方法时，一切都应该“正常工作”——只需以 model.fit() 支持的任何格式传递输入和标签即可！但是，如果您想在 Keras 方法（如 fit() 和 predict()）之外使用第二种格式，例如在使用 Keras Functional API 创建自己的层或模型时，有三种可能性可以用来在第一个位置参数中收集所有输入张量。
- 只有一个
input_ids的单个张量，没有其他：model(input_ids) - 长度可变的列表，包含一个或多个输入张量，按文档字符串中给出的顺序：
model([input_ids, attention_mask])或model([input_ids, attention_mask, token_type_ids]) - 一个字典，其中包含一个或多个与文档字符串中给出的输入名称关联的输入张量：
model({"input_ids": input_ids, "token_type_ids": token_type_ids})
请注意，当使用子类化创建模型和层时，您无需担心这些，因为您可以像对待任何其他 Python 函数一样传递输入！
调用
< 源 >( input_ids: TFModelInputType | None = None attention_mask: np.ndarray | tf.Tensor | None = None token_type_ids: np.ndarray | tf.Tensor | None = None position_ids: np.ndarray | tf.Tensor | None = None head_mask: np.ndarray | tf.Tensor | None = None inputs_embeds: np.ndarray | tf.Tensor | None = None output_attentions: Optional[bool] = None output_hidden_states: Optional[bool] = None return_dict: Optional[bool] = None labels: np.ndarray | tf.Tensor | None = None training: Optional[bool] = False ) → transformers.modeling_tf_outputs.TFMaskedLMOutput 或 tuple(tf.Tensor)
参数
- input_ids (
np.ndarray,tf.Tensor,list[tf.Tensor]`dict[str, tf.Tensor]或dict[str, np.ndarray]，每个示例的形状必须为(batch_size, sequence_length)) — 词汇表中输入序列标记的索引。索引可以使用 AutoTokenizer 获取。有关详细信息，请参见 PreTrainedTokenizer.call() 和 PreTrainedTokenizer.encode()。
- attention_mask (
np.ndarray或tf.Tensor形状为(batch_size, sequence_length), 可选) — 用于避免对填充标记索引执行注意力的掩码。掩码值选择在[0, 1]之间:- 1 表示**未被掩码**的标记，
- 0 表示**被掩码**的标记。
- token_type_ids (
np.ndarray或tf.Tensor形状为(batch_size, sequence_length), 可选) — 分段标记索引，指示输入的第一个和第二个部分。索引选择在[0, 1]之间:- 0 对应于 句子 A 标记，
- 1 对应于 句子 B 标记。
- position_ids (
np.ndarray或tf.Tensor形状为(batch_size, sequence_length), 可选) — 每个输入序列标记在位置嵌入中的位置索引。选择范围为[0, config.max_position_embeddings - 1]。 - head_mask (
np.ndarray或tf.Tensor形状为(num_heads,)或(num_layers, num_heads), 可选) — 用于使自注意力模块的选定头无效的掩码。掩码值选择在[0, 1]之间:- 1 表示头部**未被掩码**，
- 0 表示头部**被掩码**。
- inputs_embeds (
np.ndarray或tf.Tensor形状为(batch_size, sequence_length, hidden_size), 可选) — （可选）您可以选择直接传入嵌入表示，而不是传入input_ids。如果您希望对如何将input_ids索引转换为相关向量有更多控制，而不是使用模型的内部嵌入查找矩阵，这将非常有用。 - output_attentions (
bool, 可选) — 是否返回所有注意力层的注意力张量。有关详细信息，请参见返回张量下的attentions。此参数只能在急切模式下使用，在图模式下将使用配置中的值。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。有关详细信息，请参见返回张量下的hidden_states。此参数只能在急切模式下使用，在图模式下将使用配置中的值。 - return_dict (
bool, 可选) — 是否返回 ModelOutput 而不是普通元组。此参数可在急切模式下使用，在图模式下此值将始终设置为 True。 - training (
bool, 可选, 默认为 `False“) — 是否在训练模式下使用模型（某些模块（如 dropout 模块）在训练和评估之间有不同的行为）。 - labels (
tf.Tensor或np.ndarray形状为(batch_size, sequence_length), 可选) — 用于计算掩码语言建模损失的标签。索引应在[-100, 0, ..., config.vocab_size]之间（请参阅input_ids文档字符串）。索引设置为-100的标记将被忽略（掩码），损失只计算标签在[0, ..., config.vocab_size]之间的标记。
返回
transformers.modeling_tf_outputs.TFMaskedLMOutput 或 tuple(tf.Tensor)
一个 transformers.modeling_tf_outputs.TFMaskedLMOutput 或一个 tf.Tensor 元组（如果传入 return_dict=False 或 config.return_dict=False），包含根据配置（BertConfig）和输入的不同元素。
-
loss (
tf.Tensorof shape(n,), 可选, 其中 n 是非掩码标签的数量，当提供labels时返回) — 掩码语言模型 (MLM) 损失。 -
logits (
tf.Tensorof shape(batch_size, sequence_length, config.vocab_size)) — 语言模型头部的预测分数（SoftMax 之前每个词汇标记的分数）。 -
hidden_states (
tuple(tf.Tensor)，可选，当传递output_hidden_states=True或config.output_hidden_states=True时返回) —tf.Tensor元组（一个用于嵌入输出 + 每个层的一个输出），形状为(batch_size, sequence_length, hidden_size)。模型在每个层输出的隐藏状态加上初始嵌入输出。
-
attentions (
tuple(tf.Tensor)，可选，当传递output_attentions=True或config.output_attentions=True时返回) —tf.Tensor元组（每个层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
TFBertForMaskedLM 的前向方法，重写了 __call__ 特殊方法。
尽管前向传播的实现需要在该函数中定义，但之后应该调用 Module 实例而不是这个函数，因为前者负责运行预处理和后处理步骤，而后者会默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, TFBertForMaskedLM
>>> import tensorflow as tf
>>> tokenizer = AutoTokenizer.from_pretrained("google-bert/bert-base-uncased")
>>> model = TFBertForMaskedLM.from_pretrained("google-bert/bert-base-uncased")
>>> inputs = tokenizer("The capital of France is [MASK].", return_tensors="tf")
>>> logits = model(**inputs).logits
>>> # retrieve index of [MASK]
>>> mask_token_index = tf.where((inputs.input_ids == tokenizer.mask_token_id)[0])
>>> selected_logits = tf.gather_nd(logits[0], indices=mask_token_index)
>>> predicted_token_id = tf.math.argmax(selected_logits, axis=-1)
>>> tokenizer.decode(predicted_token_id)
'paris'TFBertForNextSentencePrediction
class transformers.TFBertForNextSentencePrediction
< 源 >( config: BertConfig *inputs **kwargs )
参数
- config (BertConfig) — 带有模型所有参数的模型配置类。使用配置文件初始化不会加载与模型相关的权重，只加载配置。请查看 from_pretrained() 方法来加载模型权重。
Bert 模型，顶部带有 下一个句子预测（分类） 头。
此模型继承自 TFPreTrainedModel。请查阅超类文档，了解库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头部等）。
此模型也是 keras.Model 子类。将其作为常规的 TF 2.0 Keras 模型使用，并参考 TF 2.0 文档了解所有与通用用法和行为相关的事项。
transformers 中的 TensorFlow 模型和层接受两种输入格式
- 所有输入作为关键字参数（如 PyTorch 模型），或
- 所有输入作为第一个位置参数中的列表、元组或字典。
支持第二种格式的原因是，Keras 方法在将输入传递给模型和层时更喜欢这种格式。由于这种支持，当使用 model.fit() 等方法时，一切都应该“正常工作”——只需以 model.fit() 支持的任何格式传递输入和标签即可！但是，如果您想在 Keras 方法（如 fit() 和 predict()）之外使用第二种格式，例如在使用 Keras Functional API 创建自己的层或模型时，有三种可能性可以用来在第一个位置参数中收集所有输入张量。
- 只有一个
input_ids的单个张量，没有其他：model(input_ids) - 长度可变的列表，包含一个或多个输入张量，按文档字符串中给出的顺序：
model([input_ids, attention_mask])或model([input_ids, attention_mask, token_type_ids]) - 一个字典，其中包含一个或多个与文档字符串中给出的输入名称关联的输入张量：
model({"input_ids": input_ids, "token_type_ids": token_type_ids})
请注意，当使用子类化创建模型和层时，您无需担心这些，因为您可以像对待任何其他 Python 函数一样传递输入！
调用
< 源 >( input_ids: TFModelInputType | None = None attention_mask: np.ndarray | tf.Tensor | None = None token_type_ids: np.ndarray | tf.Tensor | None = None position_ids: np.ndarray | tf.Tensor | None = None head_mask: np.ndarray | tf.Tensor | None = None inputs_embeds: np.ndarray | tf.Tensor | None = None output_attentions: Optional[bool] = None output_hidden_states: Optional[bool] = None return_dict: Optional[bool] = None next_sentence_label: np.ndarray | tf.Tensor | None = None training: Optional[bool] = False ) → transformers.modeling_tf_outputs.TFNextSentencePredictorOutput 或 tuple(tf.Tensor)
参数
- input_ids (
np.ndarray,tf.Tensor,list[tf.Tensor]`dict[str, tf.Tensor]或dict[str, np.ndarray]，每个示例的形状必须为(batch_size, sequence_length)) — 词汇表中输入序列标记的索引。索引可以使用 AutoTokenizer 获取。有关详细信息，请参见 PreTrainedTokenizer.call() 和 PreTrainedTokenizer.encode()。
- attention_mask (
np.ndarray或tf.Tensor形状为(batch_size, sequence_length), 可选) — 用于避免对填充标记索引执行注意力的掩码。掩码值选择在[0, 1]之间:- 1 表示**未被掩码**的标记，
- 0 表示**被掩码**的标记。
- token_type_ids (
np.ndarray或tf.Tensor形状为(batch_size, sequence_length), 可选) — 分段标记索引，指示输入的第一个和第二个部分。索引选择在[0, 1]之间:- 0 对应于 句子 A 标记，
- 1 对应于 句子 B 标记。
- position_ids (
np.ndarray或tf.Tensor形状为(batch_size, sequence_length), 可选) — 每个输入序列标记在位置嵌入中的位置索引。选择范围为[0, config.max_position_embeddings - 1]。 - head_mask (
np.ndarray或tf.Tensor形状为(num_heads,)或(num_layers, num_heads), 可选) — 用于使自注意力模块的选定头无效的掩码。掩码值选择在[0, 1]之间:- 1 表示头部**未被掩码**，
- 0 表示头部**被掩码**。
- inputs_embeds (
np.ndarray或tf.Tensor形状为(batch_size, sequence_length, hidden_size), 可选) — （可选）您可以选择直接传入嵌入表示，而不是传入input_ids。如果您希望对如何将input_ids索引转换为相关向量有更多控制，而不是使用模型的内部嵌入查找矩阵，这将非常有用。 - output_attentions (
bool, 可选) — 是否返回所有注意力层的注意力张量。有关详细信息，请参见返回张量下的attentions。此参数只能在急切模式下使用，在图模式下将使用配置中的值。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。有关详细信息，请参见返回张量下的hidden_states。此参数只能在急切模式下使用，在图模式下将使用配置中的值。 - return_dict (
bool, 可选) — 是否返回 ModelOutput 而不是普通元组。此参数可在急切模式下使用，在图模式下此值将始终设置为 True。 - training (
bool, 可选, 默认为 `False“) — 是否在训练模式下使用模型（某些模块（如 dropout 模块）在训练和评估之间有不同的行为）。
返回
transformers.modeling_tf_outputs.TFNextSentencePredictorOutput 或 tuple(tf.Tensor)
一个 transformers.modeling_tf_outputs.TFNextSentencePredictorOutput 或一个 tf.Tensor 元组（如果传入 return_dict=False 或 config.return_dict=False），包含根据配置（BertConfig）和输入的不同元素。
-
loss (
tf.Tensor形状为(n,), 可选, 当提供next_sentence_label时返回，其中 n 是非掩码标签的数量) — 下一句预测损失。 -
logits (
tf.Tensor形状为(batch_size, 2)) — 下一个序列预测（分类）头的预测分数（SoftMax 之前的 True/False 延续分数）。 -
hidden_states (
tuple(tf.Tensor)，可选，当传递output_hidden_states=True或config.output_hidden_states=True时返回) —tf.Tensor元组（一个用于嵌入输出 + 每个层的一个输出），形状为(batch_size, sequence_length, hidden_size)。模型在每个层输出的隐藏状态加上初始嵌入输出。
-
attentions (
tuple(tf.Tensor)，可选，当传递output_attentions=True或config.output_attentions=True时返回) —tf.Tensor元组（每个层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
TFBertForNextSentencePrediction 的前向方法，重写了 __call__ 特殊方法。
尽管前向传播的实现需要在该函数中定义，但之后应该调用 Module 实例而不是这个函数，因为前者负责运行预处理和后处理步骤，而后者会默默地忽略它们。
示例
>>> import tensorflow as tf
>>> from transformers import AutoTokenizer, TFBertForNextSentencePrediction
>>> tokenizer = AutoTokenizer.from_pretrained("google-bert/bert-base-uncased")
>>> model = TFBertForNextSentencePrediction.from_pretrained("google-bert/bert-base-uncased")
>>> prompt = "In Italy, pizza served in formal settings, such as at a restaurant, is presented unsliced."
>>> next_sentence = "The sky is blue due to the shorter wavelength of blue light."
>>> encoding = tokenizer(prompt, next_sentence, return_tensors="tf")
>>> logits = model(encoding["input_ids"], token_type_ids=encoding["token_type_ids"])[0]
>>> assert logits[0][0] < logits[0][1] # the next sentence was randomTFBertForSequenceClassification
class transformers.TFBertForSequenceClassification
< 源 >( config: BertConfig *inputs **kwargs )
参数
- config (BertConfig) — 带有模型所有参数的模型配置类。使用配置文件初始化不会加载与模型相关的权重，只加载配置。请查看 from_pretrained() 方法来加载模型权重。
Bert 模型转换器，顶部带有一个序列分类/回归头（在池化输出之上有一个线性层），例如用于 GLUE 任务。
此模型继承自 TFPreTrainedModel。请查阅超类文档，了解库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头部等）。
此模型也是 keras.Model 子类。将其作为常规的 TF 2.0 Keras 模型使用，并参考 TF 2.0 文档了解所有与通用用法和行为相关的事项。
transformers 中的 TensorFlow 模型和层接受两种输入格式
- 所有输入作为关键字参数（如 PyTorch 模型），或
- 所有输入作为第一个位置参数中的列表、元组或字典。
支持第二种格式的原因是，Keras 方法在将输入传递给模型和层时更喜欢这种格式。由于这种支持，当使用 model.fit() 等方法时，一切都应该“正常工作”——只需以 model.fit() 支持的任何格式传递输入和标签即可！但是，如果您想在 Keras 方法（如 fit() 和 predict()）之外使用第二种格式，例如在使用 Keras Functional API 创建自己的层或模型时，有三种可能性可以用来在第一个位置参数中收集所有输入张量。
- 只有一个
input_ids的单个张量，没有其他：model(input_ids) - 长度可变的列表，包含一个或多个输入张量，按文档字符串中给出的顺序：
model([input_ids, attention_mask])或model([input_ids, attention_mask, token_type_ids]) - 一个字典，其中包含一个或多个与文档字符串中给出的输入名称关联的输入张量：
model({"input_ids": input_ids, "token_type_ids": token_type_ids})
请注意，当使用子类化创建模型和层时，您无需担心这些，因为您可以像对待任何其他 Python 函数一样传递输入！
调用
< 源 >( input_ids: TFModelInputType | None = None attention_mask: np.ndarray | tf.Tensor | None = None token_type_ids: np.ndarray | tf.Tensor | None = None position_ids: np.ndarray | tf.Tensor | None = None head_mask: np.ndarray | tf.Tensor | None = None inputs_embeds: np.ndarray | tf.Tensor | None = None output_attentions: Optional[bool] = None output_hidden_states: Optional[bool] = None return_dict: Optional[bool] = None labels: np.ndarray | tf.Tensor | None = None training: Optional[bool] = False ) → transformers.modeling_tf_outputs.TFSequenceClassifierOutput 或 tuple(tf.Tensor)
参数
- input_ids (
np.ndarray,tf.Tensor,list[tf.Tensor]`dict[str, tf.Tensor]或dict[str, np.ndarray]，每个示例的形状必须为(batch_size, sequence_length)) — 词汇表中输入序列标记的索引。索引可以使用 AutoTokenizer 获取。有关详细信息，请参见 PreTrainedTokenizer.call() 和 PreTrainedTokenizer.encode()。
- attention_mask (
np.ndarray或tf.Tensor形状为(batch_size, sequence_length), 可选) — 用于避免对填充标记索引执行注意力的掩码。掩码值选择在[0, 1]之间:- 1 表示**未被掩码**的标记，
- 0 表示**被掩码**的标记。
- token_type_ids (
np.ndarray或tf.Tensor形状为(batch_size, sequence_length), 可选) — 分段标记索引，指示输入的第一个和第二个部分。索引选择在[0, 1]之间:- 0 对应于 句子 A 标记，
- 1 对应于 句子 B 标记。
- position_ids (
np.ndarray或tf.Tensor形状为(batch_size, sequence_length), 可选) — 每个输入序列标记在位置嵌入中的位置索引。选择范围为[0, config.max_position_embeddings - 1]。 - head_mask (
np.ndarray或tf.Tensor形状为(num_heads,)或(num_layers, num_heads), 可选) — 用于使自注意力模块的选定头无效的掩码。掩码值选择在[0, 1]之间:- 1 表示头部**未被掩码**，
- 0 表示头部**被掩码**。
- inputs_embeds (
np.ndarray或tf.Tensor形状为(batch_size, sequence_length, hidden_size), 可选) — （可选）您可以选择直接传入嵌入表示，而不是传入input_ids。如果您希望对如何将input_ids索引转换为相关向量有更多控制，而不是使用模型的内部嵌入查找矩阵，这将非常有用。 - output_attentions (
bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的attentions。此参数只能在 eager 模式下使用，在 graph 模式下将使用配置中的值。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的hidden_states。此参数只能在 eager 模式下使用，在 graph 模式下将使用配置中的值。 - return_dict (
bool, 可选) — 是否返回 ModelOutput 而不是普通元组。此参数可在 eager 模式下使用，在 graph 模式下该值将始终设置为 True。 - training (
bool, 可选, 默认为 `False“) — 是否在训练模式下使用模型（某些模块（如 dropout 模块）在训练和评估之间的行为不同）。 - labels (
tf.Tensor或np.ndarray，形状为(batch_size,), 可选) — 用于计算序列分类/回归损失的标签。索引应在[0, ..., config.num_labels - 1]范围内。如果config.num_labels == 1，则计算回归损失（均方损失），如果config.num_labels > 1，则计算分类损失（交叉熵）。
返回
transformers.modeling_tf_outputs.TFSequenceClassifierOutput 或 tuple(tf.Tensor)
一个 transformers.modeling_tf_outputs.TFSequenceClassifierOutput 或一个 tf.Tensor 元组（如果传入 return_dict=False 或当 config.return_dict=False 时），包含根据配置（BertConfig）和输入的不同元素。
-
loss (
tf.Tensor，形状为(batch_size, )，可选，当提供labels时返回) — 分类损失（如果 config.num_labels==1，则为回归损失）。 -
logits (
tf.Tensor，形状为(batch_size, config.num_labels)) — 分类（或回归，如果 config.num_labels==1）分数（SoftMax 之前）。 -
hidden_states (
tuple(tf.Tensor)，可选，当传递output_hidden_states=True或config.output_hidden_states=True时返回) —tf.Tensor元组（一个用于嵌入输出 + 每个层的一个输出），形状为(batch_size, sequence_length, hidden_size)。模型在每个层输出的隐藏状态加上初始嵌入输出。
-
attentions (
tuple(tf.Tensor)，可选，当传递output_attentions=True或config.output_attentions=True时返回) —tf.Tensor元组（每个层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
TFBertForSequenceClassification 的 forward 方法，重写了 `__call__` 特殊方法。
尽管前向传播的实现需要在该函数中定义，但之后应该调用 Module 实例而不是这个函数，因为前者负责运行预处理和后处理步骤，而后者会默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, TFBertForSequenceClassification
>>> import tensorflow as tf
>>> tokenizer = AutoTokenizer.from_pretrained("ydshieh/bert-base-uncased-yelp-polarity")
>>> model = TFBertForSequenceClassification.from_pretrained("ydshieh/bert-base-uncased-yelp-polarity")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="tf")
>>> logits = model(**inputs).logits
>>> predicted_class_id = int(tf.math.argmax(logits, axis=-1)[0])
>>> model.config.id2label[predicted_class_id]
'LABEL_1'>>> # 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 = TFBertForSequenceClassification.from_pretrained("ydshieh/bert-base-uncased-yelp-polarity", num_labels=num_labels)
>>> labels = tf.constant(1)
>>> loss = model(**inputs, labels=labels).loss
>>> round(float(loss), 2)
0.01TFBertForMultipleChoice
class transformers.TFBertForMultipleChoice
< source >( config: BertConfig *inputs **kwargs )
参数
- config (BertConfig) — 模型的配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型相关的权重，仅加载配置。请查看 from_pretrained() 方法加载模型权重。
Bert 模型，顶部带有多项选择分类头（在池化输出之上有一个线性层和一个 softmax），例如用于 RocStories/SWAG 任务。
此模型继承自 TFPreTrainedModel。请查阅超类文档，了解库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头部等）。
此模型也是 keras.Model 子类。将其作为常规的 TF 2.0 Keras 模型使用，并参考 TF 2.0 文档了解所有与通用用法和行为相关的事项。
transformers 中的 TensorFlow 模型和层接受两种输入格式
- 所有输入作为关键字参数（如 PyTorch 模型），或
- 所有输入作为第一个位置参数中的列表、元组或字典。
支持第二种格式的原因是，Keras 方法在将输入传递给模型和层时更喜欢这种格式。由于这种支持，当使用 model.fit() 等方法时，一切都应该“正常工作”——只需以 model.fit() 支持的任何格式传递输入和标签即可！但是，如果您想在 Keras 方法（如 fit() 和 predict()）之外使用第二种格式，例如在使用 Keras Functional API 创建自己的层或模型时，有三种可能性可以用来在第一个位置参数中收集所有输入张量。
- 只有一个
input_ids的单个张量，没有其他：model(input_ids) - 长度可变的列表，包含一个或多个输入张量，按文档字符串中给出的顺序：
model([input_ids, attention_mask])或model([input_ids, attention_mask, token_type_ids]) - 一个字典，其中包含一个或多个与文档字符串中给出的输入名称关联的输入张量：
model({"input_ids": input_ids, "token_type_ids": token_type_ids})
请注意，当使用子类化创建模型和层时，您无需担心这些，因为您可以像对待任何其他 Python 函数一样传递输入！
调用
< source >( input_ids: TFModelInputType | None = None attention_mask: np.ndarray | tf.Tensor | None = None token_type_ids: np.ndarray | tf.Tensor | None = None position_ids: np.ndarray | tf.Tensor | None = None head_mask: np.ndarray | tf.Tensor | None = None inputs_embeds: np.ndarray | tf.Tensor | None = None output_attentions: Optional[bool] = None output_hidden_states: Optional[bool] = None return_dict: Optional[bool] = None labels: np.ndarray | tf.Tensor | None = None training: Optional[bool] = False ) → transformers.modeling_tf_outputs.TFMultipleChoiceModelOutput 或 tuple(tf.Tensor)
参数
- input_ids (
np.ndarray,tf.Tensor,list[tf.Tensor]`dict[str, tf.Tensor]或dict[str, np.ndarray]，每个示例的形状必须为(batch_size, num_choices, sequence_length)) — 词汇表中输入序列 token 的索引。索引可以通过 AutoTokenizer 获取。有关详细信息，请参阅 PreTrainedTokenizer.call() 和 PreTrainedTokenizer.encode()。
- attention_mask (
np.ndarray或tf.Tensor，形状为(batch_size, num_choices, sequence_length), 可选) — 用于避免对填充 token 索引执行注意力的掩码。掩码值选择在[0, 1]之间：- 1 表示 未被掩码 的 token，
- 0 表示 被掩码 的 token。
- token_type_ids (
np.ndarray或tf.Tensor，形状为(batch_size, num_choices, sequence_length), 可选) — 表示输入第一部分和第二部分的段 token 索引。索引选择在[0, 1]之间：- 0 对应于 句子 A token，
- 1 对应于 句子 B token。
- position_ids (
np.ndarray或tf.Tensor，形状为(batch_size, num_choices, sequence_length), 可选) — 每个输入序列 token 在位置嵌入中的位置索引。选择范围为[0, config.max_position_embeddings - 1]。 - head_mask (
np.ndarray或tf.Tensor，形状为(num_heads,)或(num_layers, num_heads), 可选) — 用于使自注意力模块的选定头部无效的掩码。掩码值选择在[0, 1]之间：- 1 表示头部 未被掩码，
- 0 表示头部 被掩码。
- inputs_embeds (
np.ndarray或tf.Tensor，形状为(batch_size, num_choices, sequence_length, hidden_size), 可选) — 可选地，您可以直接传入嵌入表示，而不是传入input_ids。如果您希望对如何将input_ids索引转换为相关向量有比模型内部嵌入查找矩阵更多的控制，这将很有用。 - output_attentions (
bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的attentions。此参数只能在 eager 模式下使用，在 graph 模式下将使用配置中的值。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的hidden_states。此参数只能在 eager 模式下使用，在 graph 模式下将使用配置中的值。 - return_dict (
bool, 可选) — 是否返回 ModelOutput 而不是普通元组。此参数可在 eager 模式下使用，在 graph 模式下该值将始终设置为 True。 - training (
bool, 可选, 默认为 `False“) — 是否在训练模式下使用模型（某些模块（如 dropout 模块）在训练和评估之间的行为不同）。 - labels (
tf.Tensor或np.ndarray，形状为(batch_size,), 可选) — 用于计算多项选择分类损失的标签。索引应在[0, ..., num_choices]范围内，其中num_choices是输入张量第二维的大小。（请参阅上面的input_ids）
返回
transformers.modeling_tf_outputs.TFMultipleChoiceModelOutput 或 tuple(tf.Tensor)
一个 transformers.modeling_tf_outputs.TFMultipleChoiceModelOutput 或一个 tf.Tensor 元组（如果传入 return_dict=False 或当 config.return_dict=False 时），包含根据配置（BertConfig）和输入的不同元素。
-
loss (
tf.Tensor，形状为 (batch_size, )，可选，当提供labels时返回) — 分类损失。 -
logits (
tf.Tensor，形状为(batch_size, num_choices)) — num_choices 是输入张量的第二维。（参见上面的 input_ids）。分类分数（SoftMax 之前）。
-
hidden_states (
tuple(tf.Tensor)，可选，当传递output_hidden_states=True或config.output_hidden_states=True时返回) —tf.Tensor元组（一个用于嵌入输出 + 每个层的一个输出），形状为(batch_size, sequence_length, hidden_size)。模型在每个层输出的隐藏状态加上初始嵌入输出。
-
attentions (
tuple(tf.Tensor)，可选，当传递output_attentions=True或config.output_attentions=True时返回) —tf.Tensor元组（每个层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
TFBertForMultipleChoice 的 forward 方法，重写了 `__call__` 特殊方法。
尽管前向传播的实现需要在该函数中定义，但之后应该调用 Module 实例而不是这个函数，因为前者负责运行预处理和后处理步骤，而后者会默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, TFBertForMultipleChoice
>>> import tensorflow as tf
>>> tokenizer = AutoTokenizer.from_pretrained("google-bert/bert-base-uncased")
>>> model = TFBertForMultipleChoice.from_pretrained("google-bert/bert-base-uncased")
>>> 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."
>>> encoding = tokenizer([prompt, prompt], [choice0, choice1], return_tensors="tf", padding=True)
>>> inputs = {k: tf.expand_dims(v, 0) for k, v in encoding.items()}
>>> outputs = model(inputs) # batch size is 1
>>> # the linear classifier still needs to be trained
>>> logits = outputs.logitsTFBertForTokenClassification
class transformers.TFBertForTokenClassification
< source >( config: BertConfig *inputs **kwargs )
参数
- config (BertConfig) — 模型的配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型相关的权重，仅加载配置。请查看 from_pretrained() 方法加载模型权重。
Bert 模型，顶部带有 token 分类头（在隐藏状态输出之上有一个线性层），例如用于命名实体识别（NER）任务。
此模型继承自 TFPreTrainedModel。请查阅超类文档，了解库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头部等）。
此模型也是 keras.Model 子类。将其作为常规的 TF 2.0 Keras 模型使用，并参考 TF 2.0 文档了解所有与通用用法和行为相关的事项。
transformers 中的 TensorFlow 模型和层接受两种输入格式
- 所有输入作为关键字参数（如 PyTorch 模型），或
- 所有输入作为第一个位置参数中的列表、元组或字典。
支持第二种格式的原因是，Keras 方法在将输入传递给模型和层时更喜欢这种格式。由于这种支持，当使用 model.fit() 等方法时，一切都应该“正常工作”——只需以 model.fit() 支持的任何格式传递输入和标签即可！但是，如果您想在 Keras 方法（如 fit() 和 predict()）之外使用第二种格式，例如在使用 Keras Functional API 创建自己的层或模型时，有三种可能性可以用来在第一个位置参数中收集所有输入张量。
- 只有一个
input_ids的单个张量，没有其他：model(input_ids) - 长度可变的列表，包含一个或多个输入张量，按文档字符串中给出的顺序：
model([input_ids, attention_mask])或model([input_ids, attention_mask, token_type_ids]) - 一个字典，其中包含一个或多个与文档字符串中给出的输入名称关联的输入张量：
model({"input_ids": input_ids, "token_type_ids": token_type_ids})
请注意，当使用子类化创建模型和层时，您无需担心这些，因为您可以像对待任何其他 Python 函数一样传递输入！
调用
< source >( input_ids: TFModelInputType | None = None attention_mask: np.ndarray | tf.Tensor | None = None token_type_ids: np.ndarray | tf.Tensor | None = None position_ids: np.ndarray | tf.Tensor | None = None head_mask: np.ndarray | tf.Tensor | None = None inputs_embeds: np.ndarray | tf.Tensor | None = None output_attentions: Optional[bool] = None output_hidden_states: Optional[bool] = None return_dict: Optional[bool] = None labels: np.ndarray | tf.Tensor | None = None training: Optional[bool] = False ) → transformers.modeling_tf_outputs.TFTokenClassifierOutput 或 tuple(tf.Tensor)
参数
- input_ids (
np.ndarray,tf.Tensor,list[tf.Tensor]`dict[str, tf.Tensor]或dict[str, np.ndarray]，每个示例的形状必须为(batch_size, sequence_length)) — 词汇表中输入序列 token 的索引。索引可以通过 AutoTokenizer 获取。有关详细信息，请参阅 PreTrainedTokenizer.call() 和 PreTrainedTokenizer.encode()。
- attention_mask (
np.ndarray或tf.Tensor，形状为(batch_size, sequence_length), 可选) — 用于避免对填充 token 索引执行注意力的掩码。掩码值选择在[0, 1]之间：- 1 表示 未被掩码 的 token，
- 0 表示 被掩码 的 token。
- token_type_ids (
np.ndarray或tf.Tensor，形状为(batch_size, sequence_length), 可选) — 表示输入第一部分和第二部分的段 token 索引。索引选择在[0, 1]之间：- 0 对应于 句子 A token，
- 1 对应于 句子 B token。
- position_ids (
np.ndarray或tf.Tensor，形状为(batch_size, sequence_length), 可选) — 每个输入序列 token 在位置嵌入中的位置索引。选择范围为[0, config.max_position_embeddings - 1]。 - head_mask (
np.ndarray或tf.Tensor，形状为(num_heads,)或(num_layers, num_heads), 可选) — 用于使自注意力模块的选定头部无效的掩码。掩码值选择在[0, 1]之间：- 1 表示头部 未被掩码，
- 0 表示头部 被掩码。
- inputs_embeds (
np.ndarray或tf.Tensor，形状为(batch_size, sequence_length, hidden_size), 可选) — 可选地，您可以直接传入嵌入表示，而不是传入input_ids。如果您希望对如何将input_ids索引转换为相关向量有比模型内部嵌入查找矩阵更多的控制，这将很有用。 - output_attentions (
bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的attentions。此参数只能在 eager 模式下使用，在 graph 模式下将使用配置中的值。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的hidden_states。此参数只能在 eager 模式下使用，在 graph 模式下将使用配置中的值。 - return_dict (
bool, 可选) — 是否返回 ModelOutput 而不是普通元组。此参数可在 eager 模式下使用，在 graph 模式下该值将始终设置为 True。 - training (
bool, 可选, 默认为 `False“) — 是否在训练模式下使用模型（某些模块（如 dropout 模块）在训练和评估之间的行为不同）。 - labels (
tf.Tensor或np.ndarray，形状为(batch_size, sequence_length), 可选) — 用于计算 token 分类损失的标签。索引应在[0, ..., config.num_labels - 1]范围内。
返回
transformers.modeling_tf_outputs.TFTokenClassifierOutput 或 tuple(tf.Tensor)
一个 transformers.modeling_tf_outputs.TFTokenClassifierOutput 或一个 tf.Tensor 元组（如果传入 return_dict=False 或当 config.return_dict=False 时），包含根据配置（BertConfig）和输入的不同元素。
-
loss (
tf.Tensor，形状为(n,)，可选，其中 n 是未被掩盖的标签数量，当提供labels时返回) — 分类损失。 -
logits (
tf.Tensor，形状为(batch_size, sequence_length, config.num_labels)) — 分类分数（SoftMax 之前）。 -
hidden_states (
tuple(tf.Tensor)，可选，当传递output_hidden_states=True或config.output_hidden_states=True时返回) —tf.Tensor元组（一个用于嵌入输出 + 每个层的一个输出），形状为(batch_size, sequence_length, hidden_size)。模型在每个层输出的隐藏状态加上初始嵌入输出。
-
attentions (
tuple(tf.Tensor)，可选，当传递output_attentions=True或config.output_attentions=True时返回) —tf.Tensor元组（每个层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
TFBertForTokenClassification 的 forward 方法，重写了 `__call__` 特殊方法。
尽管前向传播的实现需要在该函数中定义，但之后应该调用 Module 实例而不是这个函数，因为前者负责运行预处理和后处理步骤，而后者会默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, TFBertForTokenClassification
>>> import tensorflow as tf
>>> tokenizer = AutoTokenizer.from_pretrained("dbmdz/bert-large-cased-finetuned-conll03-english")
>>> model = TFBertForTokenClassification.from_pretrained("dbmdz/bert-large-cased-finetuned-conll03-english")
>>> inputs = tokenizer(
... "HuggingFace is a company based in Paris and New York", add_special_tokens=False, return_tensors="tf"
... )
>>> logits = model(**inputs).logits
>>> predicted_token_class_ids = tf.math.argmax(logits, axis=-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] for t in predicted_token_class_ids[0].numpy().tolist()]
>>> predicted_tokens_classes
['O', 'I-ORG', 'I-ORG', 'I-ORG', 'O', 'O', 'O', 'O', 'O', 'I-LOC', 'O', 'I-LOC', 'I-LOC'] TFBertForQuestionAnswering
class transformers.TFBertForQuestionAnswering
< source >( config: BertConfig *inputs **kwargs )
参数
- config (BertConfig) — 模型的配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型相关的权重，仅加载配置。请查看 from_pretrained() 方法加载模型权重。
Bert 模型，顶部带有一个用于抽取式问答任务（如 SQuAD）的 span 分类头（在隐藏状态输出之上有一个线性层，用于计算 span start logits 和 span end logits）。
此模型继承自 TFPreTrainedModel。请查阅超类文档，了解库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头部等）。
此模型也是 keras.Model 子类。将其作为常规的 TF 2.0 Keras 模型使用，并参考 TF 2.0 文档了解所有与通用用法和行为相关的事项。
transformers 中的 TensorFlow 模型和层接受两种输入格式
- 所有输入作为关键字参数（如 PyTorch 模型），或
- 所有输入作为第一个位置参数中的列表、元组或字典。
支持第二种格式的原因是，Keras 方法在将输入传递给模型和层时更喜欢这种格式。由于这种支持，当使用 model.fit() 等方法时，一切都应该“正常工作”——只需以 model.fit() 支持的任何格式传递输入和标签即可！但是，如果您想在 Keras 方法（如 fit() 和 predict()）之外使用第二种格式，例如在使用 Keras Functional API 创建自己的层或模型时，有三种可能性可以用来在第一个位置参数中收集所有输入张量。
- 只有一个
input_ids的单个张量，没有其他：model(input_ids) - 长度可变的列表，包含一个或多个输入张量，按文档字符串中给出的顺序：
model([input_ids, attention_mask])或model([input_ids, attention_mask, token_type_ids]) - 一个字典，其中包含一个或多个与文档字符串中给出的输入名称关联的输入张量：
model({"input_ids": input_ids, "token_type_ids": token_type_ids})
请注意，当使用子类化创建模型和层时，您无需担心这些，因为您可以像对待任何其他 Python 函数一样传递输入！
调用
< source >( input_ids: TFModelInputType | None = None attention_mask: np.ndarray | tf.Tensor | None = None token_type_ids: np.ndarray | tf.Tensor | None = None position_ids: np.ndarray | tf.Tensor | None = None head_mask: np.ndarray | tf.Tensor | None = None inputs_embeds: np.ndarray | tf.Tensor | None = None output_attentions: Optional[bool] = None output_hidden_states: Optional[bool] = None return_dict: Optional[bool] = None start_positions: np.ndarray | tf.Tensor | None = None end_positions: np.ndarray | tf.Tensor | None = None training: Optional[bool] = False ) → transformers.modeling_tf_outputs.TFQuestionAnsweringModelOutput 或 tuple(tf.Tensor)
参数
- input_ids (
np.ndarray,tf.Tensor,list[tf.Tensor]`dict[str, tf.Tensor]或dict[str, np.ndarray]，每个示例的形状必须为(batch_size, sequence_length)) — 词汇表中输入序列 token 的索引。索引可以通过 AutoTokenizer 获取。有关详细信息，请参阅 PreTrainedTokenizer.call() 和 PreTrainedTokenizer.encode()。
- attention_mask (
np.ndarray或tf.Tensor，形状为(batch_size, sequence_length), 可选) — 用于避免对填充 token 索引执行注意力的掩码。掩码值选择在[0, 1]之间：- 1 表示 未被掩码 的 token，
- 0 表示 被掩码 的 token。
- token_type_ids (
np.ndarray或tf.Tensor, 形状为(batch_size, sequence_length), 可选) — 分段 token 索引，用于指示输入的第一个和第二个部分。索引值在[0, 1]之间选择：- 0 对应于 句子 A 的 token，
- 1 对应于 句子 B 的 token。
- position_ids (
np.ndarray或tf.Tensor, 形状为(batch_size, sequence_length), 可选) — 输入序列中每个 token 在位置嵌入中的位置索引。选择范围为[0, config.max_position_embeddings - 1]。 - head_mask (
np.ndarray或tf.Tensor, 形状为(num_heads,)或(num_layers, num_heads), 可选) — 用于使自注意力模块中的选定头部无效的掩码。掩码值在[0, 1]之间选择：- 1 表示头部 未被掩盖，
- 0 表示头部 被掩盖。
- inputs_embeds (
np.ndarray或tf.Tensor, 形状为(batch_size, sequence_length, hidden_size), 可选) — 可选地，你可以选择直接传递嵌入表示，而不是传递input_ids。如果你想更精细地控制如何将input_ids索引转换为相关向量，而不是使用模型内部的嵌入查找矩阵，这会很有用。 - output_attentions (
bool, 可选) — 是否返回所有注意力层的注意力张量。更多详情请参见返回张量中的attentions。此参数只能在即时执行模式下使用，在图模式下将使用配置中的值。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。更多详情请参见返回张量中的hidden_states。此参数只能在即时执行模式下使用，在图模式下将使用配置中的值。 - return_dict (
bool, 可选) — 是否返回 ModelOutput 对象，而不是普通的元组。此参数可在即时执行模式下使用，在图模式下该值将始终设置为 True。 - training (
bool, 可选, 默认为 `False`) — 是否在训练模式下使用模型（某些模块，如 dropout 模块在训练和评估之间有不同的行为）。 - start_positions (
tf.Tensor或np.ndarray, 形状为(batch_size,), 可选) — 用于计算 token 分类损失的标注 span 起始位置（索引）的标签。位置将被限制在序列长度（sequence_length）范围内。序列以外的位置不计入损失计算。 - end_positions (
tf.Tensor或np.ndarray, 形状为(batch_size,), 可选) — 用于计算 token 分类损失的标注 span 结束位置（索引）的标签。位置将被限制在序列长度（sequence_length）范围内。序列以外的位置不计入损失计算。
返回
transformers.modeling_tf_outputs.TFQuestionAnsweringModelOutput 或 tuple(tf.Tensor)
一个 transformers.modeling_tf_outputs.TFQuestionAnsweringModelOutput 或一个 tf.Tensor 元组（如果传递 return_dict=False 或 config.return_dict=False），包含根据配置（BertConfig）和输入的不同元素。
-
loss (
tf.Tensor, 形状为(batch_size, ), 可选, 当提供了start_positions和end_positions时返回) — 总 span 提取损失，是起始位置和结束位置的交叉熵之和。 -
start_logits (形状为
(batch_size, sequence_length)的tf.Tensor) — 跨度起始分数（SoftMax 之前）。 -
end_logits (形状为
(batch_size, sequence_length)的tf.Tensor) — 跨度结束分数（SoftMax 之前）。 -
hidden_states (
tuple(tf.Tensor)，可选，当传递output_hidden_states=True或config.output_hidden_states=True时返回) —tf.Tensor元组（一个用于嵌入输出 + 每个层的一个输出），形状为(batch_size, sequence_length, hidden_size)。模型在每个层输出的隐藏状态加上初始嵌入输出。
-
attentions (
tuple(tf.Tensor)，可选，当传递output_attentions=True或config.output_attentions=True时返回) —tf.Tensor元组（每个层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
TFBertForQuestionAnswering 的 forward 方法，重写了 __call__ 特殊方法。
尽管前向传播的实现需要在该函数中定义，但之后应该调用 Module 实例而不是这个函数，因为前者负责运行预处理和后处理步骤，而后者会默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, TFBertForQuestionAnswering
>>> import tensorflow as tf
>>> tokenizer = AutoTokenizer.from_pretrained("ydshieh/bert-base-cased-squad2")
>>> model = TFBertForQuestionAnswering.from_pretrained("ydshieh/bert-base-cased-squad2")
>>> question, text = "Who was Jim Henson?", "Jim Henson was a nice puppet"
>>> inputs = tokenizer(question, text, return_tensors="tf")
>>> outputs = model(**inputs)
>>> answer_start_index = int(tf.math.argmax(outputs.start_logits, axis=-1)[0])
>>> answer_end_index = int(tf.math.argmax(outputs.end_logits, axis=-1)[0])
>>> predict_answer_tokens = inputs.input_ids[0, answer_start_index : answer_end_index + 1]
>>> tokenizer.decode(predict_answer_tokens)
'a nice puppet'FlaxBertModel
class transformers.FlaxBertModel
< source >( config: BertConfig input_shape: tuple = (1, 1) seed: int = 0 dtype: dtype = <class 'jax.numpy.float32'> _do_init: bool = True gradient_checkpointing: bool = False **kwargs )
参数
- config (BertConfig) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型相关的权重，只加载配置。请查阅 from_pretrained() 方法以加载模型权重。
- dtype (
jax.numpy.dtype, 可选, 默认为jax.numpy.float32) — 计算的数据类型。可以是jax.numpy.float32,jax.numpy.float16(在 GPU 上) 和jax.numpy.bfloat16(在 TPU 上) 中的一种。这可用于在 GPU 或 TPU 上启用混合精度训练或半精度推理。如果指定，所有计算都将使用给定的
dtype执行。请注意，这仅指定计算的数据类型，不影响模型参数的数据类型。
- dtype (
jax.numpy.dtype, 可选, 默认为jax.numpy.float32) — 计算的数据类型。可以是jax.numpy.float32,jax.numpy.float16(在 GPU 上) 和jax.numpy.bfloat16(在 TPU 上) 中的一种。这可用于在 GPU 或 TPU 上启用混合精度训练或半精度推理。如果指定，所有计算都将使用给定的
dtype执行。请注意，这仅指定计算的数据类型，不影响模型参数的数据类型。
原始的 Bert 模型 transformer，输出原始的隐藏状态，没有顶部任何特定的头部。
该模型继承自 FlaxPreTrainedModel。请查阅其超类文档，了解该库为所有模型实现的通用方法（例如下载、保存和转换 PyTorch 模型权重）
该模型也是 flax.linen.Module 的子类。将其作为常规的 Flax Linen 模块使用，并参考 Flax 文档中有关通用用法和行为的所有事项。
最后，此模型支持固有的 JAX 功能，例如
__call__
< source >( input_ids attention_mask = None token_type_ids = None position_ids = None head_mask = None encoder_hidden_states = None encoder_attention_mask = None params: typing.Optional[dict] = None dropout_rng: <function PRNGKey at 0x7effc7ad3a30> = None train: bool = False output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None past_key_values: typing.Optional[dict] = None ) → transformers.modeling_flax_outputs.FlaxBaseModelOutputWithPooling 或 tuple(torch.FloatTensor)
参数
- input_ids (
numpy.ndarray, 形状为(batch_size, sequence_length)) — 词汇表中输入序列 token 的索引。索引可以使用 AutoTokenizer 获取。更多详情请参见 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
numpy.ndarray, 形状为(batch_size, sequence_length), 可选) — 避免对填充 token 索引执行注意力操作的掩码。掩码值在[0, 1]之间选择：- 1 表示 token 未被掩盖，
- 0 表示 token 被掩盖。
- token_type_ids (
numpy.ndarray, 形状为(batch_size, sequence_length), 可选) — 分段 token 索引，用于指示输入的第一个和第二个部分。索引值在[0, 1]之间选择：- 0 对应于 句子 A 的 token，
- 1 对应于 句子 B 的 token。
- position_ids (
numpy.ndarray, 形状为(batch_size, sequence_length), 可选) — 输入序列中每个 token 在位置嵌入中的位置索引。选择范围为[0, config.max_position_embeddings - 1]。 - head_mask (
numpy.ndarray, 形状为(batch_size, sequence_length),可选) -- 用于使注意力模块中选定头部无效的掩码。掩码值在[0, 1]` 之间选择：- 1 表示头部 未被掩盖，
- 0 表示头部 被掩盖。
- return_dict (
bool, 可选) — 是否返回 ModelOutput 对象，而不是普通的元组。
返回
transformers.modeling_flax_outputs.FlaxBaseModelOutputWithPooling 或 tuple(torch.FloatTensor)
一个 transformers.modeling_flax_outputs.FlaxBaseModelOutputWithPooling 或一个 torch.FloatTensor 元组（如果传递 return_dict=False 或 config.return_dict=False），包含根据配置（BertConfig）和输入的不同元素。
-
last_hidden_state (形状为
(batch_size, sequence_length, hidden_size)的jnp.ndarray) — 模型最后一层输出的隐藏状态序列。 -
pooler_output (
jnp.ndarray, 形状为(batch_size, hidden_size)) — 序列第一个 token（分类 token）的最后一层隐藏状态，经线性层和 Tanh 激活函数进一步处理。线性层权重在预训练期间根据下一句预测（分类）目标进行训练。 -
hidden_states (
tuple(jnp.ndarray), 可选, 当传递output_hidden_states=True或config.output_hidden_states=True时返回) —jnp.ndarray元组（一个用于嵌入输出 + 一个用于每层输出），形状为(batch_size, sequence_length, hidden_size)。模型在每个层输出的隐藏状态加上初始嵌入输出。
-
attentions (
tuple(jnp.ndarray), 可选, 当传递output_attentions=True或config.output_attentions=True时返回) —jnp.ndarray元组（每层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
FlaxBertPreTrainedModel 的 forward 方法，重写了 __call__ 特殊方法。
尽管前向传播的实现需要在该函数中定义，但之后应该调用 Module 实例而不是这个函数，因为前者负责运行预处理和后处理步骤，而后者会默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, FlaxBertModel
>>> tokenizer = AutoTokenizer.from_pretrained("google-bert/bert-base-uncased")
>>> model = FlaxBertModel.from_pretrained("google-bert/bert-base-uncased")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="jax")
>>> outputs = model(**inputs)
>>> last_hidden_states = outputs.last_hidden_stateFlaxBertForPreTraining
class transformers.FlaxBertForPreTraining
< source >( config: BertConfig input_shape: tuple = (1, 1) seed: int = 0 dtype: dtype = <class 'jax.numpy.float32'> _do_init: bool = True gradient_checkpointing: bool = False **kwargs )
参数
- config (BertConfig) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型相关的权重，只加载配置。请查阅 from_pretrained() 方法以加载模型权重。
- dtype (
jax.numpy.dtype, 可选, 默认为jax.numpy.float32) — 计算的数据类型。可以是jax.numpy.float32,jax.numpy.float16(在 GPU 上) 和jax.numpy.bfloat16(在 TPU 上) 中的一种。这可用于在 GPU 或 TPU 上启用混合精度训练或半精度推理。如果指定，所有计算都将使用给定的
dtype执行。请注意，这仅指定计算的数据类型，不影响模型参数的数据类型。
- dtype (
jax.numpy.dtype, 可选, 默认为jax.numpy.float32) — 计算的数据类型。可以是jax.numpy.float32,jax.numpy.float16(在 GPU 上) 和jax.numpy.bfloat16(在 TPU 上) 中的一种。这可用于在 GPU 或 TPU 上启用混合精度训练或半精度推理。如果指定，所有计算都将使用给定的
dtype执行。请注意，这仅指定计算的数据类型，不影响模型参数的数据类型。
Bert 模型在预训练期间在顶部带有两个头：一个 masked language modeling（掩码语言建模）头和一个 next sentence prediction (classification)（下一句预测（分类））头。
该模型继承自 FlaxPreTrainedModel。请查阅其超类文档，了解该库为所有模型实现的通用方法（例如下载、保存和转换 PyTorch 模型权重）
该模型也是 flax.linen.Module 的子类。将其作为常规的 Flax Linen 模块使用，并参考 Flax 文档中有关通用用法和行为的所有事项。
最后，此模型支持固有的 JAX 功能，例如
__call__
< source >( input_ids attention_mask = None token_type_ids = None position_ids = None head_mask = None encoder_hidden_states = None encoder_attention_mask = None params: typing.Optional[dict] = None dropout_rng: <function PRNGKey at 0x7effc7ad3a30> = None train: bool = False output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None past_key_values: typing.Optional[dict] = None ) → transformers.models.bert.modeling_flax_bert.FlaxBertForPreTrainingOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
numpy.ndarray, 形状为(batch_size, sequence_length)) — 词汇表中输入序列 token 的索引。索引可以使用 AutoTokenizer 获取。更多详情请参见 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
numpy.ndarray, 形状为(batch_size, sequence_length), 可选) — 避免对填充 token 索引执行注意力操作的掩码。掩码值在[0, 1]之间选择：- 1 表示 token 未被掩盖，
- 0 表示 token 被掩盖。
- token_type_ids (
numpy.ndarray, 形状为(batch_size, sequence_length), 可选) — 分段 token 索引，用于指示输入的第一个和第二个部分。索引值在[0, 1]之间选择：- 0 对应于 句子 A 的 token，
- 1 对应于 句子 B 的 token。
- position_ids (
numpy.ndarray, 形状为(batch_size, sequence_length), 可选) — 输入序列中每个 token 在位置嵌入中的位置索引。选择范围为[0, config.max_position_embeddings - 1]。 - head_mask (
numpy.ndarray, 形状为(batch_size, sequence_length),可选) -- 用于使注意力模块中选定头部无效的掩码。掩码值在[0, 1]` 之间选择：- 1 表示头部 未被掩盖，
- 0 表示头部 被掩盖。
- return_dict (
bool, 可选) — 是否返回 ModelOutput 对象，而不是普通的元组。
返回
transformers.models.bert.modeling_flax_bert.FlaxBertForPreTrainingOutput 或 tuple(torch.FloatTensor)
一个 transformers.models.bert.modeling_flax_bert.FlaxBertForPreTrainingOutput 或一个 torch.FloatTensor 元组（如果传递 return_dict=False 或 config.return_dict=False），包含根据配置（BertConfig）和输入的不同元素。
-
prediction_logits (
jnp.ndarray, 形状为(batch_size, sequence_length, config.vocab_size)) — 语言建模头部（SoftMax 之前的每个词汇 token 的分数）的预测分数。 -
seq_relationship_logits (
jnp.ndarray, 形状为(batch_size, 2)) — 下一序列预测（分类）头部（SoftMax 之前 True/False 延续的分数）的预测分数。 -
hidden_states (
tuple(jnp.ndarray), 可选, 当传递output_hidden_states=True或config.output_hidden_states=True时返回) —jnp.ndarray元组（一个用于嵌入输出 + 一个用于每层输出），形状为(batch_size, sequence_length, hidden_size)。模型在每个层输出的隐藏状态加上初始嵌入输出。
-
attentions (
tuple(jnp.ndarray), 可选, 当传递output_attentions=True或config.output_attentions=True时返回) —jnp.ndarray元组（每层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
FlaxBertPreTrainedModel 的 forward 方法，重写了 __call__ 特殊方法。
尽管前向传播的实现需要在该函数中定义，但之后应该调用 Module 实例而不是这个函数，因为前者负责运行预处理和后处理步骤，而后者会默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, FlaxBertForPreTraining
>>> tokenizer = AutoTokenizer.from_pretrained("google-bert/bert-base-uncased")
>>> model = FlaxBertForPreTraining.from_pretrained("google-bert/bert-base-uncased")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="np")
>>> outputs = model(**inputs)
>>> prediction_logits = outputs.prediction_logits
>>> seq_relationship_logits = outputs.seq_relationship_logitsFlaxBertForCausalLM
class transformers.FlaxBertForCausalLM
< source >( config: BertConfig input_shape: tuple = (1, 1) seed: int = 0 dtype: dtype = <class 'jax.numpy.float32'> _do_init: bool = True gradient_checkpointing: bool = False **kwargs )
参数
- config (BertConfig) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型相关的权重，只加载配置。请查阅 from_pretrained() 方法以加载模型权重。
- dtype (
jax.numpy.dtype, 可选, 默认为jax.numpy.float32) — 计算的数据类型。可以是jax.numpy.float32,jax.numpy.float16(在 GPU 上) 和jax.numpy.bfloat16(在 TPU 上) 中的一种。这可用于在 GPU 或 TPU 上启用混合精度训练或半精度推理。如果指定，所有计算都将使用给定的
dtype执行。请注意，这仅指定计算的数据类型，不影响模型参数的数据类型。
- dtype (
jax.numpy.dtype, 可选, 默认为jax.numpy.float32) — 计算的数据类型。可以是jax.numpy.float32,jax.numpy.float16(在 GPU 上) 和jax.numpy.bfloat16(在 TPU 上) 中的一种。这可用于在 GPU 或 TPU 上启用混合精度训练或半精度推理。如果指定，所有计算都将使用给定的
dtype执行。请注意，这仅指定计算的数据类型，不影响模型参数的数据类型。
Bert 模型顶部带有语言建模头部（隐藏状态输出顶部的线性层），例如用于自回归任务。
该模型继承自 FlaxPreTrainedModel。请查阅其超类文档，了解该库为所有模型实现的通用方法（例如下载、保存和转换 PyTorch 模型权重）
该模型也是 flax.linen.Module 的子类。将其作为常规的 Flax Linen 模块使用，并参考 Flax 文档中有关通用用法和行为的所有事项。
最后，此模型支持固有的 JAX 功能，例如
__call__
< source >( input_ids attention_mask = None token_type_ids = None position_ids = None head_mask = None encoder_hidden_states = None encoder_attention_mask = None params: typing.Optional[dict] = None dropout_rng: <function PRNGKey at 0x7effc7ad3a30> = None train: bool = False output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None past_key_values: typing.Optional[dict] = None ) → transformers.modeling_flax_outputs.FlaxCausalLMOutputWithCrossAttentions 或 tuple(torch.FloatTensor)
参数
- input_ids (
numpy.ndarray, 形状为(batch_size, sequence_length)) — 词汇表中输入序列 token 的索引。索引可以使用 AutoTokenizer 获取。更多详情请参见 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
numpy.ndarray, 形状为(batch_size, sequence_length), 可选) — 避免对填充 token 索引执行注意力操作的掩码。掩码值在[0, 1]之间选择：- 1 表示 token 未被掩盖，
- 0 表示 token 被掩盖。
- token_type_ids (
numpy.ndarray, 形状为(batch_size, sequence_length), 可选) — 分段 token 索引，用于指示输入的第一个和第二个部分。索引值在[0, 1]之间选择：- 0 对应于 句子 A 的 token，
- 1 对应于 句子 B 的 token。
- position_ids (
numpy.ndarray, 形状为(batch_size, sequence_length), 可选) — 输入序列中每个 token 在位置嵌入中的位置索引。选择范围为[0, config.max_position_embeddings - 1]。 - head_mask (
numpy.ndarray, 形状为(batch_size, sequence_length),可选) -- 用于使注意力模块中选定头部无效的掩码。掩码值在[0, 1]` 之间选择：- 1 表示头部 未被掩盖，
- 0 表示头部 被掩盖。
- return_dict (
bool, 可选) — 是否返回 ModelOutput 对象，而不是普通的元组。
返回
transformers.modeling_flax_outputs.FlaxCausalLMOutputWithCrossAttentions 或 tuple(torch.FloatTensor)
一个 transformers.modeling_flax_outputs.FlaxCausalLMOutputWithCrossAttentions 或一个 torch.FloatTensor 元组（如果传递 return_dict=False 或 config.return_dict=False），包含根据配置（BertConfig）和输入的不同元素。
-
logits (形状为
(batch_size, sequence_length, config.vocab_size)的jnp.ndarray) — 语言建模头的预测分数（SoftMax 之前每个词汇 token 的分数）。 -
hidden_states (
tuple(jnp.ndarray), 可选, 当传递output_hidden_states=True或config.output_hidden_states=True时返回) —jnp.ndarray元组（一个用于嵌入输出 + 一个用于每层输出），形状为(batch_size, sequence_length, hidden_size)。模型在每个层输出的隐藏状态加上初始嵌入输出。
-
attentions (
tuple(jnp.ndarray), 可选, 当传递output_attentions=True或config.output_attentions=True时返回) —jnp.ndarray元组（每层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
-
cross_attentions (
tuple(jnp.ndarray), 可选, 当传递output_attentions=True或config.output_attentions=True时返回) —jnp.ndarray元组（每层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 后的交叉注意力权重，用于计算交叉注意力头中的加权平均。
-
past_key_values (
tuple(tuple(jnp.ndarray)), 可选, 当传递use_cache=True或config.use_cache=True时返回) — 长度为config.n_layers的jnp.ndarray元组，每个元组包含自注意力和交叉注意力层的缓存键值状态（如果模型用于编码器-解码器设置）。仅当config.is_decoder = True时相关。包含预先计算的隐藏状态（注意力块中的键和值），可用于（参见
past_key_values输入）加速顺序解码。
FlaxBertPreTrainedModel 的 forward 方法，重写了 __call__ 特殊方法。
尽管前向传播的实现需要在该函数中定义，但之后应该调用 Module 实例而不是这个函数，因为前者负责运行预处理和后处理步骤，而后者会默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, FlaxBertForCausalLM
>>> tokenizer = AutoTokenizer.from_pretrained("google-bert/bert-base-uncased")
>>> model = FlaxBertForCausalLM.from_pretrained("google-bert/bert-base-uncased")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="np")
>>> outputs = model(**inputs)
>>> # retrieve logts for next token
>>> next_token_logits = outputs.logits[:, -1]FlaxBertForMaskedLM
class transformers.FlaxBertForMaskedLM
< source >( config: BertConfig input_shape: tuple = (1, 1) seed: int = 0 dtype: dtype = <class 'jax.numpy.float32'> _do_init: bool = True gradient_checkpointing: bool = False **kwargs )
参数
- config (BertConfig) — 模型配置类，包含模型的所有参数。用配置文件初始化不会加载与模型相关的权重，只会加载配置。要加载模型权重，请查看from_pretrained()方法。
- dtype (
jax.numpy.dtype, 可选, 默认为jax.numpy.float32) — 计算的数据类型。可以是jax.numpy.float32、jax.numpy.float16（在GPU上）和jax.numpy.bfloat16（在TPU上）之一。这可用于在GPU或TPU上启用混合精度训练或半精度推理。如果指定，所有计算将使用给定的
dtype执行。请注意，这仅指定了计算的数据类型，不影响模型参数的数据类型。
- dtype (
jax.numpy.dtype, 可选, 默认为jax.numpy.float32) — 计算的数据类型。可以是jax.numpy.float32、jax.numpy.float16（在GPU上）和jax.numpy.bfloat16（在TPU上）之一。这可用于在GPU或TPU上启用混合精度训练或半精度推理。如果指定，所有计算将使用给定的
dtype执行。请注意，这仅指定了计算的数据类型，不影响模型参数的数据类型。
Bert 模型顶部带有 语言建模 头。
该模型继承自 FlaxPreTrainedModel。请查阅其超类文档，了解该库为所有模型实现的通用方法（例如下载、保存和转换 PyTorch 模型权重）
该模型也是 flax.linen.Module 的子类。将其作为常规的 Flax Linen 模块使用，并参考 Flax 文档中有关通用用法和行为的所有事项。
最后，此模型支持固有的 JAX 功能，例如
__call__
< source >( input_ids attention_mask = None token_type_ids = None position_ids = None head_mask = None encoder_hidden_states = None encoder_attention_mask = None params: typing.Optional[dict] = None dropout_rng: <function PRNGKey at 0x7effc7ad3a30> = None train: bool = False output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None past_key_values: typing.Optional[dict] = None ) → transformers.modeling_flax_outputs.FlaxMaskedLMOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (形状为
(batch_size, sequence_length)的numpy.ndarray) — 词汇表中输入序列标记的索引。索引可以使用 AutoTokenizer 获取。详情请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (形状为
(batch_size, sequence_length)的numpy.ndarray, 可选) — 避免对填充标记索引执行注意力的掩码。掩码值选自[0, 1]：- 1 表示标记 未被掩码,
- 0 表示标记 已被掩码.
- token_type_ids (形状为
(batch_size, sequence_length)的numpy.ndarray, 可选) — 分段标记索引，用于指示输入的第一个和第二个部分。索引选自[0, 1]：- 0 对应于 句子 A 标记,
- 1 对应于 句子 B 标记.
- position_ids (形状为
(batch_size, sequence_length)的numpy.ndarray, 可选) — 每个输入序列标记在位置嵌入中的位置索引。选择范围为[0, config.max_position_embeddings - 1]。 - head_mask (形状为
(batch_size, sequence_length)的numpy.ndarray,可选) — 用于屏蔽注意力模块中选定头的掩码。掩码值选自[0, 1]：- 1 表示头部 未被掩码,
- 0 表示头部 已被掩码.
- return_dict (
bool, 可选) — 是否返回 ModelOutput 而不是普通元组。
返回
transformers.modeling_flax_outputs.FlaxMaskedLMOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_flax_outputs.FlaxMaskedLMOutput 或一个 torch.FloatTensor 元组（如果传入 return_dict=False 或 config.return_dict=False），包含根据配置（BertConfig）和输入的不同元素。
-
logits (形状为
(batch_size, sequence_length, config.vocab_size)的jnp.ndarray) — 语言建模头的预测分数（SoftMax 之前每个词汇 token 的分数）。 -
hidden_states (
tuple(jnp.ndarray), 可选, 当传递output_hidden_states=True或config.output_hidden_states=True时返回) —jnp.ndarray元组（一个用于嵌入输出 + 一个用于每层输出），形状为(batch_size, sequence_length, hidden_size)。模型在每个层输出的隐藏状态加上初始嵌入输出。
-
attentions (
tuple(jnp.ndarray), 可选, 当传递output_attentions=True或config.output_attentions=True时返回) —jnp.ndarray元组（每层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
FlaxBertPreTrainedModel 的 forward 方法，重写了 __call__ 特殊方法。
尽管前向传播的实现需要在该函数中定义，但之后应该调用 Module 实例而不是这个函数，因为前者负责运行预处理和后处理步骤，而后者会默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, FlaxBertForMaskedLM
>>> tokenizer = AutoTokenizer.from_pretrained("google-bert/bert-base-uncased")
>>> model = FlaxBertForMaskedLM.from_pretrained("google-bert/bert-base-uncased")
>>> inputs = tokenizer("The capital of France is [MASK].", return_tensors="jax")
>>> outputs = model(**inputs)
>>> logits = outputs.logitsFlaxBertForNextSentencePrediction
class transformers.FlaxBertForNextSentencePrediction
< source >( config: BertConfig input_shape: tuple = (1, 1) seed: int = 0 dtype: dtype = <class 'jax.numpy.float32'> _do_init: bool = True gradient_checkpointing: bool = False **kwargs )
参数
- config (BertConfig) — 模型配置类，包含模型的所有参数。用配置文件初始化不会加载与模型相关的权重，只会加载配置。要加载模型权重，请查看from_pretrained()方法。
- dtype (
jax.numpy.dtype, 可选, 默认为jax.numpy.float32) — 计算的数据类型。可以是jax.numpy.float32、jax.numpy.float16（在GPU上）和jax.numpy.bfloat16（在TPU上）之一。这可用于在GPU或TPU上启用混合精度训练或半精度推理。如果指定，所有计算将使用给定的
dtype执行。请注意，这仅指定了计算的数据类型，不影响模型参数的数据类型。
- dtype (
jax.numpy.dtype, 可选, 默认为jax.numpy.float32) — 计算的数据类型。可以是jax.numpy.float32、jax.numpy.float16（在GPU上）和jax.numpy.bfloat16（在TPU上）之一。这可用于在GPU或TPU上启用混合精度训练或半精度推理。如果指定，所有计算将使用给定的
dtype执行。请注意，这仅指定了计算的数据类型，不影响模型参数的数据类型。
Bert 模型，顶部带有 下一个句子预测（分类） 头。
该模型继承自 FlaxPreTrainedModel。请查阅其超类文档，了解该库为所有模型实现的通用方法（例如下载、保存和转换 PyTorch 模型权重）
该模型也是 flax.linen.Module 的子类。将其作为常规的 Flax Linen 模块使用，并参考 Flax 文档中有关通用用法和行为的所有事项。
最后，此模型支持固有的 JAX 功能，例如
__call__
< source >( input_ids attention_mask = None token_type_ids = None position_ids = None head_mask = None encoder_hidden_states = None encoder_attention_mask = None params: typing.Optional[dict] = None dropout_rng: <function PRNGKey at 0x7effc7ad3a30> = None train: bool = False output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None past_key_values: typing.Optional[dict] = None ) → transformers.modeling_flax_outputs.FlaxNextSentencePredictorOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (形状为
(batch_size, sequence_length)的numpy.ndarray) — 词汇表中输入序列标记的索引。索引可以使用 AutoTokenizer 获取。详情请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (形状为
(batch_size, sequence_length)的numpy.ndarray, 可选) — 避免对填充标记索引执行注意力的掩码。掩码值选自[0, 1]：- 1 表示标记 未被掩码,
- 0 表示标记 已被掩码.
- token_type_ids (形状为
(batch_size, sequence_length)的numpy.ndarray, 可选) — 分段标记索引，用于指示输入的第一个和第二个部分。索引选自[0, 1]：- 0 对应于 句子 A 标记,
- 1 对应于 句子 B 标记.
- position_ids (形状为
(batch_size, sequence_length)的numpy.ndarray, 可选) — 每个输入序列标记在位置嵌入中的位置索引。选择范围为[0, config.max_position_embeddings - 1]。 - head_mask (形状为
(batch_size, sequence_length)的numpy.ndarray,可选) — 用于屏蔽注意力模块中选定头的掩码。掩码值选自[0, 1]：- 1 表示头部 未被掩码,
- 0 表示头部 已被掩码.
- return_dict (
bool, 可选) — 是否返回 ModelOutput 而不是普通元组。
返回
transformers.modeling_flax_outputs.FlaxNextSentencePredictorOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_flax_outputs.FlaxNextSentencePredictorOutput 或一个 torch.FloatTensor 元组（如果传入 return_dict=False 或 config.return_dict=False），包含根据配置（BertConfig）和输入的不同元素。
-
logits (形状为
(batch_size, 2)的jnp.ndarray) — 下一个序列预测（分类）头部（SoftMax 之前的 True/False 延续分数）的预测分数。 -
hidden_states (
tuple(jnp.ndarray), 可选, 当传递output_hidden_states=True或config.output_hidden_states=True时返回) —jnp.ndarray元组（一个用于嵌入输出 + 一个用于每层输出），形状为(batch_size, sequence_length, hidden_size)。模型在每个层输出的隐藏状态加上初始嵌入输出。
-
attentions (
tuple(jnp.ndarray), 可选, 当传递output_attentions=True或config.output_attentions=True时返回) —jnp.ndarray元组（每层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
FlaxBertPreTrainedModel 的 forward 方法，重写了 __call__ 特殊方法。
尽管前向传播的实现需要在该函数中定义，但之后应该调用 Module 实例而不是这个函数，因为前者负责运行预处理和后处理步骤，而后者会默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, FlaxBertForNextSentencePrediction
>>> tokenizer = AutoTokenizer.from_pretrained("google-bert/bert-base-uncased")
>>> model = FlaxBertForNextSentencePrediction.from_pretrained("google-bert/bert-base-uncased")
>>> prompt = "In Italy, pizza served in formal settings, such as at a restaurant, is presented unsliced."
>>> next_sentence = "The sky is blue due to the shorter wavelength of blue light."
>>> encoding = tokenizer(prompt, next_sentence, return_tensors="jax")
>>> outputs = model(**encoding)
>>> logits = outputs.logits
>>> assert logits[0, 0] < logits[0, 1] # next sentence was randomFlaxBertForSequenceClassification
class transformers.FlaxBertForSequenceClassification
< source >( config: BertConfig input_shape: tuple = (1, 1) seed: int = 0 dtype: dtype = <class 'jax.numpy.float32'> _do_init: bool = True gradient_checkpointing: bool = False **kwargs )
参数
- config (BertConfig) — 模型配置类，包含模型的所有参数。用配置文件初始化不会加载与模型相关的权重，只会加载配置。要加载模型权重，请查看from_pretrained()方法。
- dtype (
jax.numpy.dtype, 可选, 默认为jax.numpy.float32) — 计算的数据类型。可以是jax.numpy.float32、jax.numpy.float16（在GPU上）和jax.numpy.bfloat16（在TPU上）之一。这可用于在GPU或TPU上启用混合精度训练或半精度推理。如果指定，所有计算将使用给定的
dtype执行。请注意，这仅指定了计算的数据类型，不影响模型参数的数据类型。
- dtype (
jax.numpy.dtype, 可选, 默认为jax.numpy.float32) — 计算的数据类型。可以是jax.numpy.float32、jax.numpy.float16（在GPU上）和jax.numpy.bfloat16（在TPU上）之一。这可用于在GPU或TPU上启用混合精度训练或半精度推理。如果指定，所有计算将使用给定的
dtype执行。请注意，这仅指定了计算的数据类型，不影响模型参数的数据类型。
Bert 模型转换器，顶部带有一个序列分类/回归头（在池化输出之上有一个线性层），例如用于 GLUE 任务。
该模型继承自 FlaxPreTrainedModel。请查阅其超类文档，了解该库为所有模型实现的通用方法（例如下载、保存和转换 PyTorch 模型权重）
该模型也是 flax.linen.Module 的子类。将其作为常规的 Flax Linen 模块使用，并参考 Flax 文档中有关通用用法和行为的所有事项。
最后，此模型支持固有的 JAX 功能，例如
__call__
< source >( input_ids attention_mask = None token_type_ids = None position_ids = None head_mask = None encoder_hidden_states = None encoder_attention_mask = None params: typing.Optional[dict] = None dropout_rng: <function PRNGKey at 0x7effc7ad3a30> = None train: bool = False output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None past_key_values: typing.Optional[dict] = None ) → transformers.modeling_flax_outputs.FlaxSequenceClassifierOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (形状为
(batch_size, sequence_length)的numpy.ndarray) — 词汇表中输入序列标记的索引。索引可以使用 AutoTokenizer 获取。详情请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (形状为
(batch_size, sequence_length)的numpy.ndarray, 可选) — 避免对填充标记索引执行注意力的掩码。掩码值选自[0, 1]：- 1 表示标记 未被掩码,
- 0 表示标记 已被掩码.
- token_type_ids (形状为
(batch_size, sequence_length)的numpy.ndarray, 可选) — 分段标记索引，用于指示输入的第一个和第二个部分。索引选自[0, 1]：- 0 对应于 句子 A 标记,
- 1 对应于 句子 B 标记.
- position_ids (形状为
(batch_size, sequence_length)的numpy.ndarray, 可选) — 每个输入序列标记在位置嵌入中的位置索引。选择范围为[0, config.max_position_embeddings - 1]。 - head_mask (形状为
(batch_size, sequence_length)的numpy.ndarray,可选) — 用于屏蔽注意力模块中选定头的掩码。掩码值选自[0, 1]：- 1 表示头部 未被掩码,
- 0 表示头部 已被掩码.
- return_dict (
bool, 可选) — 是否返回 ModelOutput 而不是普通元组。
返回
transformers.modeling_flax_outputs.FlaxSequenceClassifierOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_flax_outputs.FlaxSequenceClassifierOutput 或一个 torch.FloatTensor 元组（如果传入 return_dict=False 或 config.return_dict=False），包含根据配置（BertConfig）和输入的不同元素。
-
logits (形状为
(batch_size, config.num_labels)的jnp.ndarray) — 分类（如果 config.num_labels==1，则为回归）分数（SoftMax 之前）。 -
hidden_states (
tuple(jnp.ndarray), 可选, 当传递output_hidden_states=True或config.output_hidden_states=True时返回) —jnp.ndarray元组（一个用于嵌入输出 + 一个用于每层输出），形状为(batch_size, sequence_length, hidden_size)。模型在每个层输出的隐藏状态加上初始嵌入输出。
-
attentions (
tuple(jnp.ndarray), 可选, 当传递output_attentions=True或config.output_attentions=True时返回) —jnp.ndarray元组（每层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
FlaxBertPreTrainedModel 的 forward 方法，重写了 __call__ 特殊方法。
尽管前向传播的实现需要在该函数中定义，但之后应该调用 Module 实例而不是这个函数，因为前者负责运行预处理和后处理步骤，而后者会默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, FlaxBertForSequenceClassification
>>> tokenizer = AutoTokenizer.from_pretrained("google-bert/bert-base-uncased")
>>> model = FlaxBertForSequenceClassification.from_pretrained("google-bert/bert-base-uncased")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="jax")
>>> outputs = model(**inputs)
>>> logits = outputs.logitsFlaxBertForMultipleChoice
class transformers.FlaxBertForMultipleChoice
< source >( config: BertConfig input_shape: tuple = (1, 1) seed: int = 0 dtype: dtype = <class 'jax.numpy.float32'> _do_init: bool = True gradient_checkpointing: bool = False **kwargs )
参数
- config (BertConfig) — 模型配置类，包含模型的所有参数。用配置文件初始化不会加载与模型相关的权重，只会加载配置。要加载模型权重，请查看from_pretrained()方法。
- dtype (
jax.numpy.dtype, 可选, 默认为jax.numpy.float32) — 计算的数据类型。可以是jax.numpy.float32、jax.numpy.float16（在GPU上）和jax.numpy.bfloat16（在TPU上）之一。这可用于在GPU或TPU上启用混合精度训练或半精度推理。如果指定，所有计算将使用给定的
dtype执行。请注意，这仅指定了计算的数据类型，不影响模型参数的数据类型。
- dtype (
jax.numpy.dtype, 可选, 默认为jax.numpy.float32) — 计算的数据类型。可以是jax.numpy.float32、jax.numpy.float16（在GPU上）和jax.numpy.bfloat16（在TPU上）之一。这可用于在GPU或TPU上启用混合精度训练或半精度推理。如果指定，所有计算将使用给定的
dtype执行。请注意，这仅指定了计算的数据类型，不影响模型参数的数据类型。
Bert 模型，顶部带有多项选择分类头（在池化输出之上有一个线性层和一个 softmax），例如用于 RocStories/SWAG 任务。
该模型继承自 FlaxPreTrainedModel。请查阅其超类文档，了解该库为所有模型实现的通用方法（例如下载、保存和转换 PyTorch 模型权重）
该模型也是 flax.linen.Module 的子类。将其作为常规的 Flax Linen 模块使用，并参考 Flax 文档中有关通用用法和行为的所有事项。
最后，此模型支持固有的 JAX 功能，例如
__call__
< source >( input_ids attention_mask = None token_type_ids = None position_ids = None head_mask = None encoder_hidden_states = None encoder_attention_mask = None params: typing.Optional[dict] = None dropout_rng: <function PRNGKey at 0x7effc7ad3a30> = None train: bool = False output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None past_key_values: typing.Optional[dict] = None ) → transformers.modeling_flax_outputs.FlaxMultipleChoiceModelOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (形状为
(batch_size, num_choices, sequence_length)的numpy.ndarray) — 词汇表中输入序列标记的索引。索引可以使用 AutoTokenizer 获取。详情请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (形状为
(batch_size, num_choices, sequence_length)的numpy.ndarray, 可选) — 避免对填充标记索引执行注意力的掩码。掩码值选自[0, 1]：- 1 表示标记 未被掩码,
- 0 表示标记 已被掩码.
- token_type_ids (形状为
(batch_size, num_choices, sequence_length)的numpy.ndarray, 可选) — 分段标记索引，用于指示输入的第一个和第二个部分。索引选自[0, 1]：- 0 对应于 句子 A 标记,
- 1 对应于 句子 B 标记.
- position_ids (形状为
(batch_size, num_choices, sequence_length)的numpy.ndarray, 可选) — 每个输入序列标记在位置嵌入中的位置索引。选择范围为[0, config.max_position_embeddings - 1]。 - head_mask (形状为
(batch_size, num_choices, sequence_length)的numpy.ndarray,可选) — 用于屏蔽注意力模块中选定头的掩码。掩码值选自[0, 1]：- 1 表示头部 未被掩码,
- 0 表示头部 已被掩码.
- return_dict (
bool, 可选) — 是否返回 ModelOutput 而不是普通元组。
返回
transformers.modeling_flax_outputs.FlaxMultipleChoiceModelOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_flax_outputs.FlaxMultipleChoiceModelOutput 或一个 torch.FloatTensor 元组（如果传入 return_dict=False 或 config.return_dict=False），包含根据配置（BertConfig）和输入的不同元素。
-
logits (形状为
(batch_size, num_choices)的jnp.ndarray) — num_choices 是输入张量的第二个维度。（请参阅上面的 input_ids）。分类分数（SoftMax 之前）。
-
hidden_states (
tuple(jnp.ndarray), 可选, 当传递output_hidden_states=True或config.output_hidden_states=True时返回) —jnp.ndarray元组（一个用于嵌入输出 + 一个用于每层输出），形状为(batch_size, sequence_length, hidden_size)。模型在每个层输出的隐藏状态加上初始嵌入输出。
-
attentions (
tuple(jnp.ndarray), 可选, 当传递output_attentions=True或config.output_attentions=True时返回) —jnp.ndarray元组（每层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
FlaxBertPreTrainedModel 的 forward 方法，重写了 __call__ 特殊方法。
尽管前向传播的实现需要在该函数中定义，但之后应该调用 Module 实例而不是这个函数，因为前者负责运行预处理和后处理步骤，而后者会默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, FlaxBertForMultipleChoice
>>> tokenizer = AutoTokenizer.from_pretrained("google-bert/bert-base-uncased")
>>> model = FlaxBertForMultipleChoice.from_pretrained("google-bert/bert-base-uncased")
>>> 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."
>>> encoding = tokenizer([prompt, prompt], [choice0, choice1], return_tensors="jax", padding=True)
>>> outputs = model(**{k: v[None, :] for k, v in encoding.items()})
>>> logits = outputs.logitsFlaxBertForTokenClassification
class transformers.FlaxBertForTokenClassification
< source >( config: BertConfig input_shape: tuple = (1, 1) seed: int = 0 dtype: dtype = <class 'jax.numpy.float32'> _do_init: bool = True gradient_checkpointing: bool = False **kwargs )
参数
- config (BertConfig) — 模型的配置类，包含模型的所有参数。使用配置文件初始化时不会加载与模型相关的权重，只会加载配置。要加载模型权重，请查看 from_pretrained() 方法。
- dtype (
jax.numpy.dtype, 可选, 默认为jax.numpy.float32) — 计算的数据类型。可以是jax.numpy.float32、jax.numpy.float16（在 GPU 上）和jax.numpy.bfloat16（在 TPU 上）之一。这可用于在 GPU 或 TPU 上启用混合精度训练或半精度推理。如果指定，所有计算将使用给定的
dtype执行。请注意，这仅指定计算的数据类型，不影响模型参数的数据类型。
- dtype (
jax.numpy.dtype, 可选, 默认为jax.numpy.float32) — 计算的数据类型。可以是jax.numpy.float32、jax.numpy.float16（在 GPU 上）和jax.numpy.bfloat16（在 TPU 上）之一。这可用于在 GPU 或 TPU 上启用混合精度训练或半精度推理。如果指定，所有计算将使用给定的
dtype执行。请注意，这仅指定计算的数据类型，不影响模型参数的数据类型。
Bert 模型，顶部带有 token 分类头（在隐藏状态输出之上有一个线性层），例如用于命名实体识别（NER）任务。
该模型继承自 FlaxPreTrainedModel。请查阅其超类文档，了解该库为所有模型实现的通用方法（例如下载、保存和转换 PyTorch 模型权重）
该模型也是 flax.linen.Module 的子类。将其作为常规的 Flax Linen 模块使用，并参考 Flax 文档中有关通用用法和行为的所有事项。
最后，此模型支持固有的 JAX 功能，例如
__call__
< source >( input_ids attention_mask = None token_type_ids = None position_ids = None head_mask = None encoder_hidden_states = None encoder_attention_mask = None params: typing.Optional[dict] = None dropout_rng: <function PRNGKey at 0x7effc7ad3a30> = None train: bool = False output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None past_key_values: typing.Optional[dict] = None ) → transformers.modeling_flax_outputs.FlaxTokenClassifierOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
numpy.ndarray，形状为(batch_size, sequence_length)) — 词汇表中输入序列标记的索引。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
numpy.ndarray，形状为(batch_size, sequence_length)，可选) — 遮罩，用于避免在填充标记索引上执行注意力。遮罩值在[0, 1]中选择：- 1 表示未被遮罩的标记，
- 0 表示被遮罩的标记。
- token_type_ids (
numpy.ndarray，形状为(batch_size, sequence_length)，可选) — 段标记索引，用于指示输入的第一个和第二个部分。索引在[0, 1]中选择：- 0 对应于 *句子 A* 标记，
- 1 对应于 *句子 B* 标记。
- position_ids (
numpy.ndarray，形状为(batch_size, sequence_length)，可选) — 每个输入序列标记在位置嵌入中的位置索引。选择范围为[0, config.max_position_embeddings - 1]。 - head_mask (
numpy.ndarray，形状为(batch_size, sequence_length)，可选) — 遮罩，用于将注意力模块中选定的头置空。遮罩值在[0, 1]中选择：- 1 表示头未被遮罩，
- 0 表示头被遮罩。
- return_dict (
bool, 可选) — 是否返回 ModelOutput 而不是普通元组。
返回
transformers.modeling_flax_outputs.FlaxTokenClassifierOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_flax_outputs.FlaxTokenClassifierOutput 或一个 torch.FloatTensor 元组（如果传递了 return_dict=False 或 config.return_dict=False），包含根据配置 (BertConfig) 和输入的不同元素。
-
logits (
jnp.ndarray，形状为(batch_size, sequence_length, config.num_labels)) — 分类得分（SoftMax 之前）。 -
hidden_states (
tuple(jnp.ndarray), 可选, 当传递output_hidden_states=True或config.output_hidden_states=True时返回) —jnp.ndarray元组（一个用于嵌入输出 + 一个用于每层输出），形状为(batch_size, sequence_length, hidden_size)。模型在每个层输出的隐藏状态加上初始嵌入输出。
-
attentions (
tuple(jnp.ndarray), 可选, 当传递output_attentions=True或config.output_attentions=True时返回) —jnp.ndarray元组（每层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
FlaxBertPreTrainedModel 的 forward 方法，重写了 __call__ 特殊方法。
尽管前向传播的实现需要在该函数中定义，但之后应该调用 Module 实例而不是这个函数，因为前者负责运行预处理和后处理步骤，而后者会默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, FlaxBertForTokenClassification
>>> tokenizer = AutoTokenizer.from_pretrained("google-bert/bert-base-uncased")
>>> model = FlaxBertForTokenClassification.from_pretrained("google-bert/bert-base-uncased")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="jax")
>>> outputs = model(**inputs)
>>> logits = outputs.logitsFlaxBertForQuestionAnswering
class transformers.FlaxBertForQuestionAnswering
< source >( config: BertConfig input_shape: tuple = (1, 1) seed: int = 0 dtype: dtype = <class 'jax.numpy.float32'> _do_init: bool = True gradient_checkpointing: bool = False **kwargs )
参数
- config (BertConfig) — 模型的配置类，包含模型的所有参数。使用配置文件初始化时不会加载与模型相关的权重，只会加载配置。要加载模型权重，请查看 from_pretrained() 方法。
- dtype (
jax.numpy.dtype, 可选, 默认为jax.numpy.float32) — 计算的数据类型。可以是jax.numpy.float32、jax.numpy.float16（在 GPU 上）和jax.numpy.bfloat16（在 TPU 上）之一。这可用于在 GPU 或 TPU 上启用混合精度训练或半精度推理。如果指定，所有计算将使用给定的
dtype执行。请注意，这仅指定计算的数据类型，不影响模型参数的数据类型。
- dtype (
jax.numpy.dtype, 可选, 默认为jax.numpy.float32) — 计算的数据类型。可以是jax.numpy.float32、jax.numpy.float16（在 GPU 上）和jax.numpy.bfloat16（在 TPU 上）之一。这可用于在 GPU 或 TPU 上启用混合精度训练或半精度推理。如果指定，所有计算将使用给定的
dtype执行。请注意，这仅指定计算的数据类型，不影响模型参数的数据类型。
Bert 模型，顶部带有用于 SQuAD 等抽取式问答任务的 span 分类头（在隐藏状态输出之上有一个线性层，用于计算 span start logits 和 span end logits）。
该模型继承自 FlaxPreTrainedModel。请查阅其超类文档，了解该库为所有模型实现的通用方法（例如下载、保存和转换 PyTorch 模型权重）
该模型也是 flax.linen.Module 的子类。将其作为常规的 Flax Linen 模块使用，并参考 Flax 文档中有关通用用法和行为的所有事项。
最后，此模型支持固有的 JAX 功能，例如
__call__
< source >( input_ids attention_mask = None token_type_ids = None position_ids = None head_mask = None encoder_hidden_states = None encoder_attention_mask = None params: typing.Optional[dict] = None dropout_rng: <function PRNGKey at 0x7effc7ad3a30> = None train: bool = False output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None past_key_values: typing.Optional[dict] = None ) → transformers.modeling_flax_outputs.FlaxQuestionAnsweringModelOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
numpy.ndarray，形状为(batch_size, sequence_length)) — 词汇表中输入序列标记的索引。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
numpy.ndarray，形状为(batch_size, sequence_length)，可选) — 遮罩，用于避免在填充标记索引上执行注意力。遮罩值在[0, 1]中选择：- 1 表示未被遮罩的标记，
- 0 表示被遮罩的标记。
- token_type_ids (
numpy.ndarray，形状为(batch_size, sequence_length)，可选) — 段标记索引，用于指示输入的第一个和第二个部分。索引在[0, 1]中选择：- 0 对应于 *句子 A* 标记，
- 1 对应于 *句子 B* 标记。
- position_ids (
numpy.ndarray，形状为(batch_size, sequence_length)，可选) — 每个输入序列标记在位置嵌入中的位置索引。选择范围为[0, config.max_position_embeddings - 1]。 - head_mask (
numpy.ndarray，形状为(batch_size, sequence_length)，可选) — 遮罩，用于将注意力模块中选定的头置空。遮罩值在[0, 1]中选择：- 1 表示头未被遮罩，
- 0 表示头被遮罩。
- return_dict (
bool, 可选) — 是否返回 ModelOutput 而不是普通元组。
返回
transformers.modeling_flax_outputs.FlaxQuestionAnsweringModelOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_flax_outputs.FlaxQuestionAnsweringModelOutput 或一个 torch.FloatTensor 元组（如果传递了 return_dict=False 或 config.return_dict=False），包含根据配置 (BertConfig) 和输入的不同元素。
-
start_logits (
jnp.ndarray，形状为(batch_size, sequence_length)) — 跨度开始得分（SoftMax 之前）。 -
end_logits (
jnp.ndarray，形状为(batch_size, sequence_length)) — 跨度结束得分（SoftMax 之前）。 -
hidden_states (
tuple(jnp.ndarray), 可选, 当传递output_hidden_states=True或config.output_hidden_states=True时返回) —jnp.ndarray元组（一个用于嵌入输出 + 一个用于每层输出），形状为(batch_size, sequence_length, hidden_size)。模型在每个层输出的隐藏状态加上初始嵌入输出。
-
attentions (
tuple(jnp.ndarray), 可选, 当传递output_attentions=True或config.output_attentions=True时返回) —jnp.ndarray元组（每层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
FlaxBertPreTrainedModel 的 forward 方法，重写了 __call__ 特殊方法。
尽管前向传播的实现需要在该函数中定义，但之后应该调用 Module 实例而不是这个函数，因为前者负责运行预处理和后处理步骤，而后者会默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, FlaxBertForQuestionAnswering
>>> tokenizer = AutoTokenizer.from_pretrained("google-bert/bert-base-uncased")
>>> model = FlaxBertForQuestionAnswering.from_pretrained("google-bert/bert-base-uncased")
>>> question, text = "Who was Jim Henson?", "Jim Henson was a nice puppet"
>>> inputs = tokenizer(question, text, return_tensors="jax")
>>> outputs = model(**inputs)
>>> start_scores = outputs.start_logits
>>> end_scores = outputs.end_logitsBert 特定输出
class transformers.models.bert.modeling_bert.BertForPreTrainingOutput
< source >( loss: typing.Optional[torch.FloatTensor] = None prediction_logits: typing.Optional[torch.FloatTensor] = None seq_relationship_logits: typing.Optional[torch.FloatTensor] = None hidden_states: typing.Optional[tuple[torch.FloatTensor]] = None attentions: typing.Optional[tuple[torch.FloatTensor]] = None )
参数
- loss (
*可选*，在提供labels时返回，torch.FloatTensor，形状为(1,)) — 总损失，是遮罩语言模型损失和下一序列预测（分类）损失的总和。 - prediction_logits (
torch.FloatTensor，形状为(batch_size, sequence_length, config.vocab_size)) — 语言模型头的预测分数（SoftMax 之前每个词汇标记的分数）。 - seq_relationship_logits (
torch.FloatTensor，形状为(batch_size, 2)) — 下一序列预测（分类）头的预测分数（SoftMax 之前 True/False 延续的分数）。 - 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 之后的注意力权重，用于计算自注意力头中的加权平均值。
BertForPreTraining 的输出类型。
class transformers.models.bert.modeling_tf_bert.TFBertForPreTrainingOutput
< source >( loss: tf.Tensor | None = None prediction_logits: Optional[tf.Tensor] = None seq_relationship_logits: Optional[tf.Tensor] = None hidden_states: Optional[Union[tuple[tf.Tensor], tf.Tensor]] = None attentions: Optional[Union[tuple[tf.Tensor], tf.Tensor]] = None )
参数
- prediction_logits (
tf.Tensor，形状为(batch_size, sequence_length, config.vocab_size)) — 语言模型头的预测分数（SoftMax 之前每个词汇标记的分数）。 - seq_relationship_logits (
tf.Tensor，形状为(batch_size, 2)) — 下一序列预测（分类）头的预测分数（SoftMax 之前 True/False 延续的分数）。 - hidden_states (
tuple(tf.Tensor), 可选, 当传递output_hidden_states=True或config.output_hidden_states=True时返回) —tf.Tensor元组（一个用于嵌入的输出 + 一个用于每层的输出），形状为(batch_size, sequence_length, hidden_size)。模型在每层输出处的隐藏状态，以及初始嵌入输出。
- attentions (
tuple(tf.Tensor), 可选, 当传递output_attentions=True或config.output_attentions=True时返回) —tf.Tensor元组（每层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 Softmax 之后的注意力权重，用于计算自注意力头中的加权平均值。
TFBertForPreTraining 的输出类型。
class transformers.models.bert.modeling_flax_bert.FlaxBertForPreTrainingOutput
< source >( prediction_logits: Array = None seq_relationship_logits: Array = None hidden_states: typing.Optional[tuple[jax.Array]] = None attentions: typing.Optional[tuple[jax.Array]] = None )
参数
- prediction_logits (
jnp.ndarray，形状为(batch_size, sequence_length, config.vocab_size)) — 语言模型头的预测分数（SoftMax 之前每个词汇标记的分数）。 - seq_relationship_logits (
jnp.ndarray，形状为(batch_size, 2)) — 下一序列预测（分类）头的预测分数（SoftMax 之前 True/False 延续的分数）。 - hidden_states (
tuple(jnp.ndarray), 可选, 当传递output_hidden_states=True或config.output_hidden_states=True时返回) —jnp.ndarray元组（一个用于嵌入的输出 + 一个用于每层的输出），形状为(batch_size, sequence_length, hidden_size)。模型在每层输出处的隐藏状态，以及初始嵌入输出。
- attentions (
tuple(jnp.ndarray), 可选, 当传递output_attentions=True或config.output_attentions=True时返回) —jnp.ndarray元组（每层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 Softmax 之后的注意力权重，用于计算自注意力头中的加权平均值。
BertForPreTraining 的输出类型。
“返回一个新对象，用新值替换指定字段。