Transformers 文档
BERT
并获得增强的文档体验
开始使用
此模型发布于 2018-10-11，并于 2020-11-16 添加到 Hugging Face Transformers。
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",
dtype=torch.float16,
device=0
)
pipeline("Plants create [MASK] through a process known as photosynthesis.")注意事项
- 输入应在右侧进行填充，因为 BERT 使用绝对位置嵌入。
BertConfig
class transformers.BertConfig
< 来源 >( 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 use_cache = True classifier_dropout = None is_decoder = False add_cross_attention = False bos_token_id = None eos_token_id = None tie_word_embeddings = True **kwargs )
参数
- vocab_size (
int, 可选, 默认值 30522) — BERT 模型词汇表大小。定义在调用 BertModel 时传递的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 时传递的token_type_ids的词汇表大小。 - initializer_range (
float, 可选, 默认值 0.02) — 用于初始化所有权重矩阵的 truncated_normal_initializer 的标准差。 - layer_norm_eps (
float, 可选, 默认值 1e-12) — 层归一化层使用的 epsilon。 - is_decoder (
bool, 可选, 默认值False) — 模型是用作解码器还是编码器。如果为False，则模型用作编码器。 - use_cache (
bool, 可选, 默认值True) — 模型是否应返回最后一个键/值注意力（并非所有模型都使用）。仅当config.is_decoder=True时相关。 - classifier_dropout (
float, 可选) — 分类头的 dropout 比率。
这是用于存储 BertModel 配置的配置类。它用于根据指定的参数实例化一个 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
< 来源 >( vocab: str | dict[str, int] | None = None do_lower_case: bool = False unk_token: str = '[UNK]' sep_token: str = '[SEP]' pad_token: str = '[PAD]' cls_token: str = '[CLS]' mask_token: str = '[MASK]' tokenize_chinese_chars: bool = True strip_accents: bool | None = None **kwargs )
参数
- vocab (
str或dict[str, int], 可选) — 自定义词汇表字典。如果未提供，则从vocab_file加载词汇表。 - do_lower_case (
bool, 可选, 默认值False) — 在标记化时是否将输入转换为小写。 - 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）。
构造一个 BERT 分词器（基于 HuggingFace 的 tokenizers 库）。基于 WordPiece。
此分词器继承自 TokenizersBackend，其中包含大部分主要方法。用户应参考此父类了解有关这些方法的更多信息。
get_special_tokens_mask
< 来源 >( token_ids_0: list[int] token_ids_1: list[int] | None = None already_has_special_tokens: bool = False ) → 一个介于 0 和 1 之间的整数列表
从没有添加特殊标记的标记列表中检索序列 ID。
对于快速分词器，数据整理器会使用 already_has_special_tokens=True 来调用此函数，以便构建一个已格式化序列的掩码。在这种情况下，我们通过检查 all_special_ids 中的成员资格来计算掩码。
BertTokenizerLegacy
class transformers.BertTokenizerLegacy
< 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, optional, 默认为True) — 分词时是否将输入转换为小写。 - do_basic_tokenize (
bool, optional, 默认为True) — 是否在 WordPiece 之前进行基本分词。 - never_split (
Iterable, optional) — 永不会在分词过程中被分割的标记集合。仅当do_basic_tokenize=True时有效。 - unk_token (
str, optional, 默认为"[UNK]") — 未知标记。词汇表中不存在的标记无法转换为 ID，而是被设置为此标记。 - sep_token (
str, optional, 默认为"[SEP]") — 分隔符标记，用于构建多序列时，例如用于序列分类的两个序列，或用于问答的文本和问题。它也是用特殊标记构建的序列的最后一个标记。 - pad_token (
str, optional, 默认为"[PAD]") — 用于填充的标记，例如当对不同长度的序列进行批处理时。 - cls_token (
str, optional, 默认为"[CLS]") — 分类标记，在进行序列分类（对整个序列进行分类而不是逐标记分类）时使用。当使用特殊标记构建序列时，它是序列的第一个标记。 - mask_token (
str, optional, 默认为"[MASK]") — 用于掩码值的标记。这是在通过掩码语言建模训练此模型时使用的标记。这是模型将尝试预测的标记。 - tokenize_chinese_chars (
bool, optional, 默认为True) — 是否分词中文。参见此问题，应禁用日语。
- strip_accents (
bool, optional) — 是否去除所有变音符号。如果未指定此选项，则将根据lowercase的值确定（如原始 BERT 中）。 - clean_up_tokenization_spaces (
bool, optional, 默认为True) — 分词后是否清理空格，清理包括移除可能的伪影，如额外的空格。
构建一个 BERT 分词器。基于 WordPiece。
此分词器继承自 PreTrainedTokenizer，其中包含大部分主要方法。用户应参考此超类以获取有关这些方法的更多信息。
build_inputs_with_special_tokens
< source >( token_ids_0: list token_ids_1: list[int] | None = None already_has_special_tokens: bool = False ) → List[int]
通过连接和添加特殊标记，从一个序列或一对序列构建用于序列分类任务的模型输入。BERT 序列的格式如下：
- 单个序列：
[CLS] X [SEP] - 序列对：
[CLS] A [SEP] B [SEP]
将标记序列（字符串）转换为单个字符串。
get_special_tokens_mask
< source >( token_ids_0: list token_ids_1: list[int] | None = None already_has_special_tokens: bool = False ) → List[int]
从没有添加特殊标记的标记列表中检索序列ID。此方法在使用分词器prepare_for_model方法添加特殊标记时调用。
BertTokenizerFast
class transformers.BertTokenizer
< 来源 >( vocab: str | dict[str, int] | None = None do_lower_case: bool = False unk_token: str = '[UNK]' sep_token: str = '[SEP]' pad_token: str = '[PAD]' cls_token: str = '[CLS]' mask_token: str = '[MASK]' tokenize_chinese_chars: bool = True strip_accents: bool | None = None **kwargs )
参数
- vocab (
str或dict[str, int], 可选) — 自定义词汇表字典。如果未提供，则从vocab_file加载词汇表。 - do_lower_case (
bool, 可选, 默认值False) — 在标记化时是否将输入转换为小写。 - 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）。
构造一个 BERT 分词器（基于 HuggingFace 的 tokenizers 库）。基于 WordPiece。
此分词器继承自 TokenizersBackend，其中包含大部分主要方法。用户应参考此父类了解有关这些方法的更多信息。
BertModel
class transformers.BertModel
< source >( config add_pooling_layer = True )
参数
- config (BertModel) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型相关的权重，仅加载配置。请查看 from_pretrained() 方法以加载模型权重。
- add_pooling_layer (
bool, optional, 默认为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 作为 forward 调用的输入。
此模型继承自 PreTrainedModel。有关库为所有模型实现的通用方法（如下载或保存、调整输入嵌入大小、修剪头等），请参考超类文档。
此模型也是一个 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档了解所有通用用法和行为。
forward
< source >( input_ids: torch.Tensor | None = None attention_mask: torch.Tensor | None = None token_type_ids: torch.Tensor | None = None position_ids: torch.Tensor | None = None inputs_embeds: torch.Tensor | None = None encoder_hidden_states: torch.Tensor | None = None encoder_attention_mask: torch.Tensor | None = None past_key_values: transformers.cache_utils.Cache | None = None use_cache: bool | None = None cache_position: torch.Tensor | None = None **kwargs: typing_extensions.Unpack[transformers.utils.generic.TransformersKwargs] ) → transformers.modeling_outputs.BaseModelOutputWithPoolingAndCrossAttentions or tuple(torch.FloatTensor)
参数
- input_ids (
torch.Tensor, shape(batch_size, sequence_length), optional) — 词汇表中输入序列标记的索引。默认情况下将忽略填充。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensor, shape(batch_size, sequence_length), optional) — 用于避免对填充标记索引执行注意力的掩码。掩码值选择在[0, 1]中：- 1 表示未掩码的标记，
- 0 表示已掩码的标记。
- token_type_ids (
torch.Tensor, shape(batch_size, sequence_length), optional) — 用于区分输入的第一个和第二个部分的段标记索引。索引选择在[0, 1]中：- 0 对应于句子 A 标记，
- 1 对应于句子 B 标记。
- position_ids (
torch.Tensor, shape(batch_size, sequence_length), optional) — 位置嵌入中每个输入序列标记的位置索引。与position_ids不同，此张量不受填充影响。它用于在正确的位置更新缓存并推断完整的序列长度。 - inputs_embeds (
torch.Tensor, shape(batch_size, sequence_length, hidden_size), optional) — 可选地，您可以直接传入嵌入表示，而不是传递input_ids。如果您希望对如何将input_ids索引转换为关联向量进行比模型内部嵌入查找矩阵更多的控制，这将非常有用。 - encoder_hidden_states (
torch.Tensor, shape(batch_size, sequence_length, hidden_size), optional) — 编码器最后一层输出的隐藏状态序列。在模型配置为解码器时用于交叉注意力。 - encoder_attention_mask (
torch.Tensor, shape(batch_size, sequence_length), optional) — 用于避免对编码器输入中的填充标记索引执行注意力的掩码。在模型配置为解码器时，此掩码用于交叉注意力。掩码值选择在[0, 1]中：- 1 表示未掩码的标记，
- 0 表示已掩码的标记。
- past_key_values (
~cache_utils.Cache, optional) — 可用于加速顺序解码的预计算隐藏状态（自注意力块和交叉注意力块中的键和值）。通常由前一个解码阶段模型返回的past_key_values组成，当use_cache=True或config.use_cache=True时。仅允许
Cache实例作为输入，请参阅我们的kv 缓存指南。如果未传入past_key_values，则默认初始化DynamicCache。模型将输出与输入相同的缓存格式。
如果使用
past_key_values，用户预计只输入未处理的input_ids（其过去键值状态已传递给此模型的那些），形状为(batch_size, unprocessed_length)，而不是全部input_ids，形状为(batch_size, sequence_length)。 - use_cache (
bool, optional) — 如果设置为True，则返回past_key_values键值状态，可用于加速解码（参见past_key_values）。 - cache_position (
torch.Tensor, shape(sequence_length), optional) — 描绘输入序列标记在序列中位置的索引。与position_ids不同，此张量不受填充影响。它用于在正确的位置更新缓存并推断完整的序列长度。
返回
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, shape(batch_size, hidden_size)) — 序列的第一个标记的最后一层隐藏状态（分类标记），在经过用于辅助预训练任务的层进一步处理后。例如，对于 BERT 系列模型，这会返回分类标记，经过线性层和 tanh 激活函数处理后。线性层的权重是通过预训练期间的下一句预测（分类）目标进行训练的。 -
hidden_states (
tuple(torch.FloatTensor), optional，当传递output_hidden_states=True或当config.output_hidden_states=True时返回) — 形状为(batch_size, sequence_length, hidden_size)的torch.FloatTensor元组（一个用于嵌入层的输出，如果模型有嵌入层，+ 每个层的输出）。模型在每个层输出的隐藏状态以及可选的初始嵌入输出。
-
attentions (
tuple(torch.FloatTensor), optional，当传递output_attentions=True或当config.output_attentions=True时返回) — 形状为(batch_size, num_heads, sequence_length, sequence_length)的torch.FloatTensor元组（每个层一个）。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
-
cross_attentions (
tuple(torch.FloatTensor), optional，当传递output_attentions=True和config.add_cross_attention=True或当config.output_attentions=True时返回) — 形状为(batch_size, num_heads, sequence_length, sequence_length)的torch.FloatTensor元组（每个层一个）。解码器交叉注意力层的注意力权重，在注意力 softmax 之后，用于计算交叉注意力头中的加权平均。
-
past_key_values (
Cache, optional，当传递use_cache=True或当config.use_cache=True时返回) — 这是一个 Cache 实例。有关更多详细信息，请参阅我们的kv 缓存指南。包含预计算的隐藏状态（自注意力块中的键和值，如果
config.is_encoder_decoder=True，则还包括交叉注意力块中的键和值），这些状态可用于（参见past_key_values输入）加速顺序解码。
BertModel 的 forward 方法重写了 __call__ 特殊方法。
虽然 forward 过程的实现需要在该函数内定义，但之后应该调用
Module实例而不是这个函数，因为前者会处理预处理和后处理步骤，而后者会默默忽略它们。
BertForPreTraining
class transformers.BertForPreTraining
< source >( config )
参数
- config (BertForPreTraining) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型相关的权重，仅加载配置。请查看 from_pretrained() 方法以加载模型权重。
Bert 模型在顶部带有两个头，如预训练时一样：一个 masked language modeling 头和一个 next sentence prediction (classification) 头。
此模型继承自 PreTrainedModel。有关库为所有模型实现的通用方法（如下载或保存、调整输入嵌入大小、修剪头等），请参考超类文档。
此模型也是一个 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档了解所有通用用法和行为。
forward
< source >( input_ids: torch.Tensor | None = None attention_mask: torch.Tensor | None = None token_type_ids: torch.Tensor | None = None position_ids: torch.Tensor | None = None inputs_embeds: torch.Tensor | None = None labels: torch.Tensor | None = None next_sentence_label: torch.Tensor | None = None **kwargs: typing_extensions.Unpack[transformers.utils.generic.TransformersKwargs] ) → transformers.models.bert.modeling_bert.BertForPreTrainingOutput or tuple(torch.FloatTensor)
参数
- input_ids (
torch.Tensor, shape(batch_size, sequence_length), optional) — 词汇表中输入序列标记的索引。默认情况下将忽略填充。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensor, shape(batch_size, sequence_length), optional) — 用于避免对填充标记索引执行注意力的掩码。掩码值选择在[0, 1]中：- 1 表示未掩码的标记，
- 0 表示已掩码的标记。
- token_type_ids (
torch.Tensor, shape(batch_size, sequence_length), optional) — 用于区分输入的第一个和第二个部分的段标记索引。索引选择在[0, 1]中：- 0 对应于句子 A 标记，
- 1 对应于句子 B 标记。
- position_ids (
torch.Tensor, 形状为(batch_size, sequence_length), 可选) — 位置嵌入中每个输入序列 token 的位置索引。选择范围为[0, config.n_positions - 1]。 - 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 是随机序列。
返回
transformers.models.bert.modeling_bert.BertForPreTrainingOutput 或 tuple(torch.FloatTensor)
一个 transformers.models.bert.modeling_bert.BertForPreTrainingOutput 或一个 tuple(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] | None.hidden_states, 当传递output_hidden_states=True或当config.output_hidden_states=True时返回) —torch.FloatTensor的元组（一个用于嵌入的输出，如果模型有嵌入层，+ 每个层的输出），形状为(batch_size, sequence_length, hidden_size)。模型在每个层输出的隐藏状态以及可选的初始嵌入输出。
-
attentions (
tuple[torch.FloatTensor] | None.attentions, 当传递output_attentions=True或当config.output_attentions=True时返回) —torch.FloatTensor的元组（每个层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
transformers.BertForPreTraining 的 forward 方法，覆盖了 __call__ 特殊方法。
虽然 forward 过程的实现需要在该函数内定义，但之后应该调用
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
< source >( config )
参数
- config (BertLMHeadModel) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型相关的权重，只会加载配置。请查看
from_pretrained()方法以加载模型权重。
带有用于 CLM 微调的 language modeling 头部的 Bert 模型。
此模型继承自 PreTrainedModel。有关库为所有模型实现的通用方法（如下载或保存、调整输入嵌入大小、修剪头等），请参考超类文档。
此模型也是一个 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档了解所有通用用法和行为。
forward
< source >( input_ids: torch.Tensor | None = None attention_mask: torch.Tensor | None = None token_type_ids: torch.Tensor | None = None position_ids: torch.Tensor | None = None inputs_embeds: torch.Tensor | None = None encoder_hidden_states: torch.Tensor | None = None encoder_attention_mask: torch.Tensor | None = None labels: torch.Tensor | None = None past_key_values: transformers.cache_utils.Cache | None = None use_cache: bool | None = None cache_position: torch.Tensor | None = None logits_to_keep: int | torch.Tensor = 0 **kwargs: typing_extensions.Unpack[transformers.utils.generic.TransformersKwargs] ) → 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 索引上执行 attention 的掩码。掩码值选择在[0, 1]中：- 1 表示 **未掩码** 的 token，
- 0 表示 **已掩码** 的 token。
- token_type_ids (
torch.Tensor, 形状为(batch_size, sequence_length), 可选) — 用于指示输入第一部分和第二部分的 segment token 索引。索引选择在[0, 1]中：- 0 对应于 sentence A token，
- 1 对应于 sentence B token。
- position_ids (
torch.Tensor, 形状为(batch_size, sequence_length), 可选) — 位置嵌入中每个输入序列 token 的位置索引。选择范围为[0, config.n_positions - 1]。 - 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), 可选) — 编码器最后一层输出的隐藏状态序列。如果模型配置为解码器，则在交叉 attention 中使用。 - encoder_attention_mask (
torch.Tensor, 形状为(batch_size, sequence_length), 可选) — 用于避免在编码器输入的填充 token 索引上执行 attention 的掩码。如果模型配置为解码器，则在交叉 attention 中使用。掩码值选择在[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 (
~cache_utils.Cache, 可选) — 可以用来加速顺序解码的预计算隐藏状态（自 attention 块和交叉 attention 块中的键和值）。这通常包括在解码的早期阶段由模型返回的past_key_values，当use_cache=True或config.use_cache=True时。只有 Cache 实例被允许作为输入，请参阅我们的 kv cache 指南。如果未传递
past_key_values，则默认情况下将初始化 DynamicCache。模型将输出与输入相同的 cache 格式。
如果使用
past_key_values，用户应仅输入未处理的input_ids（其 past key value 状态未提供给此模型），形状为(batch_size, unprocessed_length)，而不是所有input_ids，其形状为(batch_size, sequence_length)。 - use_cache (
bool, 可选) — 如果设置为True，则返回past_key_values键值状态，可用于加速解码（请参阅past_key_values）。 - cache_position (
torch.Tensor, 形状为(sequence_length,), 可选) — 指示输入序列 token 在序列中位置的索引。与position_ids不同，此张量不受填充影响。它用于在正确位置更新 cache 并推断完整的序列长度。 - logits_to_keep (
Union[int, torch.Tensor], 可选, 默认为0) — 如果是int，则计算最后一个logits_to_keeptoken 的 logits。如果是0，则计算所有input_ids的 logits（特殊情况）。仅最后一个 token 的 logits 对于生成是必需的，并且仅为该 token 计算它们可以节省内存，这对于长序列或大词汇量来说非常重要。如果是一个torch.Tensor，则必须是 1D 的，对应于序列长度维度中要保留的索引。这在使用 packed tensor 格式（批次和序列长度的单维度）时很有用。
返回
transformers.modeling_outputs.CausalLMOutputWithCrossAttentions 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.CausalLMOutputWithCrossAttentions 或一个 tuple(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), optional，当传递output_hidden_states=True或当config.output_hidden_states=True时返回) — 形状为(batch_size, sequence_length, hidden_size)的torch.FloatTensor元组（一个用于嵌入层的输出，如果模型有嵌入层，+ 每个层的输出）。模型在每个层输出的隐藏状态以及可选的初始嵌入输出。
-
attentions (
tuple(torch.FloatTensor), optional，当传递output_attentions=True或当config.output_attentions=True时返回) — 形状为(batch_size, num_heads, sequence_length, sequence_length)的torch.FloatTensor元组（每个层一个）。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
-
cross_attentions (
tuple(torch.FloatTensor), 可选, 当传递output_attentions=True或当config.output_attentions=True时返回) —torch.FloatTensor的元组（每个层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 后的交叉注意力权重，用于计算交叉注意力头中的加权平均。
-
past_key_values (
Cache, optional，当传递use_cache=True或当config.use_cache=True时返回) — 这是一个 Cache 实例。有关更多详细信息，请参阅我们的kv 缓存指南。包含预先计算的隐藏状态（注意力块中的键和值），可用于（参见
past_key_values输入）加速顺序解码。
transformers.BertLMHeadModel 的 forward 方法，覆盖了 __call__ 特殊方法。
虽然 forward 过程的实现需要在该函数内定义，但之后应该调用
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
< source >( config )
参数
- config (BertForMaskedLM) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型相关的权重，只会加载配置。请查看
from_pretrained()方法以加载模型权重。
带有 language modeling 头部的 Bert 模型。
此模型继承自 PreTrainedModel。有关库为所有模型实现的通用方法（如下载或保存、调整输入嵌入大小、修剪头等），请参考超类文档。
此模型也是一个 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档了解所有通用用法和行为。
forward
< source >( input_ids: torch.Tensor | None = None attention_mask: torch.Tensor | None = None token_type_ids: torch.Tensor | None = None position_ids: torch.Tensor | None = None inputs_embeds: torch.Tensor | None = None encoder_hidden_states: torch.Tensor | None = None encoder_attention_mask: torch.Tensor | None = None labels: torch.Tensor | None = None **kwargs: typing_extensions.Unpack[transformers.utils.generic.TransformersKwargs] ) → 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 索引上执行 attention 的掩码。掩码值选择在[0, 1]中：- 1 表示 **未掩码** 的 token，
- 0 表示 **已掩码** 的 token。
- token_type_ids (
torch.Tensor, 形状为(batch_size, sequence_length), 可选) — 用于指示输入第一部分和第二部分的 segment token 索引。索引选择在[0, 1]中：- 0 对应于 sentence A token，
- 1 对应于 sentence B token。
- position_ids (
torch.Tensor, 形状为(batch_size, sequence_length), 可选) — 位置嵌入中每个输入序列 token 的位置索引。选择范围为[0, config.n_positions - 1]。 - 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), 可选) — 编码器最后一层输出的隐藏状态序列。如果模型配置为解码器，则在交叉 attention 中使用。 - encoder_attention_mask (
torch.Tensor, 形状为(batch_size, sequence_length), 可选) — 用于避免在编码器输入的填充 token 索引上执行 attention 的掩码。如果模型配置为解码器，则在交叉 attention 中使用。掩码值选择在[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 计算损失。
返回
transformers.modeling_outputs.MaskedLMOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.MaskedLMOutput 或一个 tuple(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), optional，当传递output_hidden_states=True或当config.output_hidden_states=True时返回) — 形状为(batch_size, sequence_length, hidden_size)的torch.FloatTensor元组（一个用于嵌入层的输出，如果模型有嵌入层，+ 每个层的输出）。模型在每个层输出的隐藏状态以及可选的初始嵌入输出。
-
attentions (
tuple(torch.FloatTensor), optional，当传递output_attentions=True或当config.output_attentions=True时返回) — 形状为(batch_size, num_heads, sequence_length, sequence_length)的torch.FloatTensor元组（每个层一个）。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
transformers.BertForMaskedLM 的 forward 方法，覆盖了 __call__ 特殊方法。
虽然 forward 过程的实现需要在该函数内定义，但之后应该调用
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()方法以加载模型权重。
带有 next sentence prediction (classification) 头部的 Bert 模型。
此模型继承自 PreTrainedModel。有关库为所有模型实现的通用方法（如下载或保存、调整输入嵌入大小、修剪头等），请参考超类文档。
此模型也是一个 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档了解所有通用用法和行为。
forward
< source >( input_ids: torch.Tensor | None = None attention_mask: torch.Tensor | None = None token_type_ids: torch.Tensor | None = None position_ids: torch.Tensor | None = None inputs_embeds: torch.Tensor | None = None labels: torch.Tensor | None = None **kwargs: typing_extensions.Unpack[transformers.utils.generic.TransformersKwargs] ) → transformers.modeling_outputs.NextSentencePredictorOutput 或 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 索引上执行 attention 的掩码。掩码值选择在[0, 1]中：- 1 表示 **未掩码** 的 token，
- 0 表示 **已掩码** 的 token。
- token_type_ids (
torch.Tensor, 形状为(batch_size, sequence_length), 可选) — 用于指示输入第一部分和第二部分的 segment token 索引。索引选择在[0, 1]中：- 0 对应于 sentence A token，
- 1 对应于 sentence B token。
- position_ids (
torch.Tensor, 形状为(batch_size, sequence_length), 可选) — 位置嵌入中每个输入序列 token 的位置索引。选择范围为[0, config.n_positions - 1]。 - 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 是随机序列。
返回
transformers.modeling_outputs.NextSentencePredictorOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.NextSentencePredictorOutput 或一个 tuple(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), optional，当传递output_hidden_states=True或当config.output_hidden_states=True时返回) — 形状为(batch_size, sequence_length, hidden_size)的torch.FloatTensor元组（一个用于嵌入层的输出，如果模型有嵌入层，+ 每个层的输出）。模型在每个层输出的隐藏状态以及可选的初始嵌入输出。
-
attentions (
tuple(torch.FloatTensor), optional，当传递output_attentions=True或当config.output_attentions=True时返回) — 形状为(batch_size, num_heads, sequence_length, sequence_length)的torch.FloatTensor元组（每个层一个）。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
transformers.BertForNextSentencePrediction 的 forward 方法，覆盖了 __call__ 特殊方法。
虽然 forward 过程的实现需要在该函数内定义，但之后应该调用
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 Model transformer with a sequence classification/regression head on top (a linear layer on top of the pooled output) e.g. for GLUE tasks。
此模型继承自 PreTrainedModel。有关库为所有模型实现的通用方法（如下载或保存、调整输入嵌入大小、修剪头等），请参考超类文档。
此模型也是一个 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档了解所有通用用法和行为。
forward
< source >( input_ids: torch.Tensor | None = None attention_mask: torch.Tensor | None = None token_type_ids: torch.Tensor | None = None position_ids: torch.Tensor | None = None inputs_embeds: torch.Tensor | None = None labels: torch.Tensor | None = None **kwargs: typing_extensions.Unpack[transformers.utils.generic.TransformersKwargs] ) → transformers.modeling_outputs.SequenceClassifierOutput or tuple(torch.FloatTensor)
参数
- input_ids (
torch.Tensorof shape(batch_size, sequence_length), optional) — 词汇表中输入序列 token 的索引。默认情况下会忽略填充（padding）。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensorof shape(batch_size, sequence_length), optional) — 避免对填充（padding）token 索引执行注意力（attention）的掩码。掩码值选择在[0, 1]中：- 1 表示未被掩码的 token，
- 0 表示被掩码的 token。
- token_type_ids (
torch.Tensorof shape(batch_size, sequence_length), optional) — 用于指示输入的第一部分和第二部分的 segment token 索引。索引选择在[0, 1]中：- 0 对应于句子 A token，
- 1 对应于句子 B token。
- position_ids (
torch.Tensorof shape(batch_size, sequence_length), optional) — 输入序列 token 在 position embeddings 中的位置索引。选择范围为[0, config.n_positions - 1]。 - inputs_embeds (
torch.Tensorof shape(batch_size, sequence_length, hidden_size), optional) — 可选地，您可以直接传递嵌入表示（embedded representation），而不是传递input_ids。如果您想比模型内部的嵌入查找矩阵（embedding lookup matrix）获得对input_ids索引转换为关联向量（vectors）的更多控制，这将非常有用。 - labels (
torch.LongTensorof shape(batch_size,), optional) — 用于计算序列分类/回归损失的标签。索引应在[0, ..., config.num_labels - 1]范围内。如果config.num_labels == 1，则计算回归损失（均方损失）；如果config.num_labels > 1，则计算分类损失（交叉熵）。
返回
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), optional，当传递output_hidden_states=True或当config.output_hidden_states=True时返回) — 形状为(batch_size, sequence_length, hidden_size)的torch.FloatTensor元组（一个用于嵌入层的输出，如果模型有嵌入层，+ 每个层的输出）。模型在每个层输出的隐藏状态以及可选的初始嵌入输出。
-
attentions (
tuple(torch.FloatTensor), optional，当传递output_attentions=True或当config.output_attentions=True时返回) — 形状为(batch_size, num_heads, sequence_length, sequence_length)的torch.FloatTensor元组（每个层一个）。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
transformers.BertForSequenceClassification 的 forward 方法，覆盖了 __call__ 特殊方法。
虽然 forward 过程的实现需要在该函数内定义，但之后应该调用
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() 方法来加载模型权重。
The Bert Model with a multiple choice classification head on top (a linear layer on top of the pooled output and a softmax) e.g. for RocStories/SWAG tasks。
此模型继承自 PreTrainedModel。有关库为所有模型实现的通用方法（如下载或保存、调整输入嵌入大小、修剪头等），请参考超类文档。
此模型也是一个 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档了解所有通用用法和行为。
forward
< source >( input_ids: torch.Tensor | None = None attention_mask: torch.Tensor | None = None token_type_ids: torch.Tensor | None = None position_ids: torch.Tensor | None = None inputs_embeds: torch.Tensor | None = None labels: torch.Tensor | None = None **kwargs: typing_extensions.Unpack[transformers.utils.generic.TransformersKwargs] ) → transformers.modeling_outputs.MultipleChoiceModelOutput or tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensorof shape(batch_size, num_choices, sequence_length)) — 词汇表中输入序列 token 的索引。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensorof shape(batch_size, sequence_length), optional) — 避免对填充（padding）token 索引执行注意力（attention）的掩码。掩码值选择在[0, 1]中：- 1 表示未被掩码的 token，
- 0 表示被掩码的 token。
- token_type_ids (
torch.LongTensorof shape(batch_size, num_choices, sequence_length), optional) — 用于指示输入的第一部分和第二部分的 segment token 索引。索引选择在[0, 1]中：- 0 对应于句子 A token，
- 1 对应于句子 B token。
- position_ids (
torch.LongTensorof shape(batch_size, num_choices, sequence_length), optional) — 输入序列 token 在 position embeddings 中的位置索引。选择范围为[0, config.max_position_embeddings - 1]。 - inputs_embeds (
torch.FloatTensorof shape(batch_size, num_choices, sequence_length, hidden_size), optional) — 可选地，您可以直接传递嵌入表示（embedded representation），而不是传递input_ids。如果您想比模型内部的嵌入查找矩阵（embedding lookup matrix）获得对input_ids索引转换为关联向量（vectors）的更多控制，这将非常有用。 - labels (
torch.LongTensorof shape(batch_size,), optional) — 用于计算多项选择分类损失的标签。索引应在[0, ..., num_choices-1]范围内，其中num_choices是输入张量的第二个维度的大小。（请参阅上面的input_ids）
返回
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), optional，当传递output_hidden_states=True或当config.output_hidden_states=True时返回) — 形状为(batch_size, sequence_length, hidden_size)的torch.FloatTensor元组（一个用于嵌入层的输出，如果模型有嵌入层，+ 每个层的输出）。模型在每个层输出的隐藏状态以及可选的初始嵌入输出。
-
attentions (
tuple(torch.FloatTensor), optional，当传递output_attentions=True或当config.output_attentions=True时返回) — 形状为(batch_size, num_heads, sequence_length, sequence_length)的torch.FloatTensor元组（每个层一个）。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
transformers.BertForMultipleChoice 的 forward 方法，覆盖了 __call__ 特殊方法。
虽然 forward 过程的实现需要在该函数内定义，但之后应该调用
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() 方法来加载模型权重。
The Bert transformer with a token classification head on top (a linear layer on top of the hidden-states output) e.g. for Named-Entity-Recognition (NER) tasks。
此模型继承自 PreTrainedModel。有关库为所有模型实现的通用方法（如下载或保存、调整输入嵌入大小、修剪头等），请参考超类文档。
此模型也是一个 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档了解所有通用用法和行为。
forward
< source >( input_ids: torch.Tensor | None = None attention_mask: torch.Tensor | None = None token_type_ids: torch.Tensor | None = None position_ids: torch.Tensor | None = None inputs_embeds: torch.Tensor | None = None labels: torch.Tensor | None = None **kwargs: typing_extensions.Unpack[transformers.utils.generic.TransformersKwargs] ) → transformers.modeling_outputs.TokenClassifierOutput or tuple(torch.FloatTensor)
参数
- input_ids (
torch.Tensorof shape(batch_size, sequence_length), optional) — 词汇表中输入序列 token 的索引。默认情况下会忽略填充（padding）。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensorof shape(batch_size, sequence_length), optional) — 避免对填充（padding）token 索引执行注意力（attention）的掩码。掩码值选择在[0, 1]中：- 1 表示未被掩码的 token，
- 0 表示被掩码的 token。
- token_type_ids (
torch.Tensorof shape(batch_size, sequence_length), optional) — 用于指示输入的第一部分和第二部分的 segment token 索引。索引选择在[0, 1]中：- 0 对应于句子 A token，
- 1 对应于句子 B token。
- position_ids (
torch.Tensorof shape(batch_size, sequence_length), optional) — 输入序列 token 在 position embeddings 中的位置索引。选择范围为[0, config.n_positions - 1]。 - inputs_embeds (
torch.Tensorof shape(batch_size, sequence_length, hidden_size), optional) — 可选地，您可以直接传递嵌入表示（embedded representation），而不是传递input_ids。如果您想比模型内部的嵌入查找矩阵（embedding lookup matrix）获得对input_ids索引转换为关联向量（vectors）的更多控制，这将非常有用。 - labels (
torch.LongTensorof shape(batch_size, sequence_length), optional) — 用于计算 token 分类损失的标签。索引应在[0, ..., config.num_labels - 1]范围内。
返回
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), optional，当传递output_hidden_states=True或当config.output_hidden_states=True时返回) — 形状为(batch_size, sequence_length, hidden_size)的torch.FloatTensor元组（一个用于嵌入层的输出，如果模型有嵌入层，+ 每个层的输出）。模型在每个层输出的隐藏状态以及可选的初始嵌入输出。
-
attentions (
tuple(torch.FloatTensor), optional，当传递output_attentions=True或当config.output_attentions=True时返回) — 形状为(batch_size, num_heads, sequence_length, sequence_length)的torch.FloatTensor元组（每个层一个）。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
transformers.BertForTokenClassification 的 forward 方法，覆盖了 __call__ 特殊方法。
虽然 forward 过程的实现需要在该函数内定义，但之后应该调用
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() 方法来加载模型权重。
The Bert transformer with a span classification head on top for extractive question-answering tasks like SQuAD (a linear layer on top of the hidden-states output to compute span start logits and span end logits)。
此模型继承自 PreTrainedModel。有关库为所有模型实现的通用方法（如下载或保存、调整输入嵌入大小、修剪头等），请参考超类文档。
此模型也是一个 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档了解所有通用用法和行为。
forward
< source >( input_ids: torch.Tensor | None = None attention_mask: torch.Tensor | None = None token_type_ids: torch.Tensor | None = None position_ids: torch.Tensor | None = None inputs_embeds: torch.Tensor | None = None start_positions: torch.Tensor | None = None end_positions: torch.Tensor | None = None **kwargs: typing_extensions.Unpack[transformers.utils.generic.TransformersKwargs] ) → transformers.modeling_outputs.QuestionAnsweringModelOutput or tuple(torch.FloatTensor)
参数
- input_ids (
torch.Tensorof shape(batch_size, sequence_length), optional) — 词汇表中输入序列 token 的索引。默认情况下会忽略填充（padding）。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensorof shape(batch_size, sequence_length), optional) — 避免对填充（padding）token 索引执行注意力（attention）的掩码。掩码值选择在[0, 1]中：- 1 表示未被掩码的 token，
- 0 表示被掩码的 token。
- token_type_ids (
torch.Tensorof shape(batch_size, sequence_length), optional) — 用于指示输入的第一部分和第二部分的 segment token 索引。索引选择在[0, 1]中：- 0 对应于句子 A token，
- 1 对应于句子 B token。
- position_ids (
torch.Tensorof shape(batch_size, sequence_length), optional) — 输入序列 token 在 position embeddings 中的位置索引。选择范围为[0, config.n_positions - 1]。 - inputs_embeds (
torch.Tensorof shape(batch_size, sequence_length, hidden_size), optional) — 可选地，您可以直接传递嵌入表示（embedded representation），而不是传递input_ids。如果您想比模型内部的嵌入查找矩阵（embedding lookup matrix）获得对input_ids索引转换为关联向量（vectors）的更多控制，这将非常有用。 - start_positions (
torch.Tensorof shape(batch_size,), optional) — 用于计算 token 分类损失的标记跨度（span）开始位置（索引）的标签。位置被限制在序列长度（sequence_length）内。序列外的（outside of the sequence）位置不用于计算损失。 - end_positions (
torch.Tensorof shape(batch_size,), optional) — 用于计算 token 分类损失的标记跨度（span）结束位置（索引）的标签。位置被限制在序列长度（sequence_length）内。序列外的（outside of the sequence）位置不用于计算损失。
返回
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), optional，当传递output_hidden_states=True或当config.output_hidden_states=True时返回) — 形状为(batch_size, sequence_length, hidden_size)的torch.FloatTensor元组（一个用于嵌入层的输出，如果模型有嵌入层，+ 每个层的输出）。模型在每个层输出的隐藏状态以及可选的初始嵌入输出。
-
attentions (
tuple(torch.FloatTensor), optional，当传递output_attentions=True或当config.output_attentions=True时返回) — 形状为(batch_size, num_heads, sequence_length, sequence_length)的torch.FloatTensor元组（每个层一个）。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
BertForQuestionAnswering 的 forward 方法重写了 __call__ 特殊方法。
虽然 forward 过程的实现需要在该函数内定义，但之后应该调用
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)
...Bert 特定的输出
class transformers.models.bert.modeling_bert.BertForPreTrainingOutput
< source >( loss: torch.FloatTensor | None = None prediction_logits: torch.FloatTensor | None = None seq_relationship_logits: torch.FloatTensor | None = None hidden_states: tuple[torch.FloatTensor] | None = None attentions: tuple[torch.FloatTensor] | None = None )
参数
- loss (
*optional*, 当提供labels时返回,torch.FloatTensorof shape(1,)) — 总损失，是掩码语言模型损失和下一句预测（分类）损失的总和。 - prediction_logits (
torch.FloatTensorof shape(batch_size, sequence_length, config.vocab_size)) — 语言模型头的预测分数（SoftMax 之前的每个词汇标记的得分）。 - seq_relationship_logits (
torch.FloatTensorof shape(batch_size, 2)) — 下一句预测（分类）头的预测分数（SoftMax 之前的 True/False 分数）。 - hidden_states (
tuple[torch.FloatTensor] | None.hidden_states, 当传递output_hidden_states=True或config.output_hidden_states=True时返回) — 形状为(batch_size, sequence_length, hidden_size)的torch.FloatTensor的元组（一个用于嵌入层的输出，如果模型有嵌入层，+ 一个用于每个层的输出）。模型在每个层的输出以及可选的初始嵌入输出处的隐藏状态。
- attentions (
tuple[torch.FloatTensor] | None.attentions, 当传递output_attentions=True或config.output_attentions=True时返回) — 形状为(batch_size, num_heads, sequence_length, sequence_length)的torch.FloatTensor元组（每个层一个）。在自注意力头中用于计算加权平均的注意力权重，在注意力 SoftMax 之后。
BertForPreTraining 的输出类型。