Transformers 文档
DistilBERT
并获得增强的文档体验
开始使用
DistilBERT
DistilBERT 通过知识蒸馏进行预训练，以创建一个更小的模型，从而实现更快的推理速度并减少训练所需的计算量。通过预训练期间的三重损失目标（语言模型损失、蒸馏损失、余弦距离损失），DistilBERT 表现出与大型 Transformer 语言模型相似的性能。
你可以在 DistilBERT 组织下找到所有原始的 DistilBERT 检查点。
点击右侧边栏中的 DistilBERT 模型，查看更多将 DistilBERT 应用于不同语言任务的示例。
以下示例展示了如何使用 Pipeline、AutoModel 和命令行对文本进行分类。
from transformers import pipeline
classifier = pipeline(
task="text-classification",
model="distilbert-base-uncased-finetuned-sst-2-english",
torch_dtype=torch.float16,
device=0
)
result = classifier("I love using Hugging Face Transformers!")
print(result)
# Output: [{'label': 'POSITIVE', 'score': 0.9998}]注意事项
- DistilBERT 没有 `token_type_ids`，你不需要指示哪个 token 属于哪个 segment。只需使用分隔符 `tokenizer.sep_token`（或 `[SEP]`）分隔你的 segment 即可。
- DistilBERT 没有选择输入位置（`position_ids` 输入）的选项。如果需要，可以添加此选项，只需告知我们。
DistilBertConfig
class transformers.DistilBertConfig
< 来源 >( vocab_size = 30522 max_position_embeddings = 512 sinusoidal_pos_embds = False n_layers = 6 n_heads = 12 dim = 768 hidden_dim = 3072 dropout = 0.1 attention_dropout = 0.1 activation = 'gelu' initializer_range = 0.02 qa_dropout = 0.1 seq_classif_dropout = 0.2 pad_token_id = 0 **kwargs )
参数
- vocab_size (
int, 可选, 默认为 30522) — DistilBERT 模型的词汇量大小。定义了调用 DistilBertModel 或 TFDistilBertModel 时传递的inputs_ids可以表示的不同 token 的数量。 - max_position_embeddings (
int, 可选, 默认为 512) — 此模型可能使用的最大序列长度。通常设置为一个较大的值以备不时之需（例如，512、1024 或 2048）。 - sinusoidal_pos_embds (
boolean, 可选, 默认为False) — 是否使用正弦位置嵌入。 - n_layers (
int, 可选, 默认为 6) — Transformer 编码器中的隐藏层数量。 - n_heads (
int, 可选, 默认为 12) — Transformer 编码器中每个注意力层的注意力头数量。 - dim (
int, 可选, 默认为 768) — 编码器层和池化层维度。 - hidden_dim (
int, 可选, 默认为 3072) — Transformer 编码器中“中间”（通常称为前馈）层的大小。 - dropout (
float, 可选, 默认为 0.1) — 嵌入、编码器和池化器中所有全连接层的 dropout 概率。 - attention_dropout (
float, 可选, 默认为 0.1) — 注意力概率的 dropout 比率。 - activation (
str或Callable, 可选, 默认为"gelu") — 编码器和池化器中的非线性激活函数（函数或字符串）。如果是字符串，则支持"gelu"、"relu"、"silu"和"gelu_new"。 - initializer_range (
float, 可选, 默认为 0.02) — 用于初始化所有权重矩阵的 truncated_normal_initializer 的标准差。 - qa_dropout (
float, 可选, 默认为 0.1) — 在问答模型 DistilBertForQuestionAnswering 中使用的 dropout 概率。 - seq_classif_dropout (
float, 可选, 默认为 0.2) — 在序列分类和多项选择模型 DistilBertForSequenceClassification 中使用的 dropout 概率。
这是用于存储 DistilBertModel 或 TFDistilBertModel 配置的配置类。它用于根据指定的参数实例化 DistilBERT 模型，定义模型架构。使用默认值实例化配置将生成类似于 DistilBERT distilbert-base-uncased 架构的配置。
配置对象继承自 PretrainedConfig，可用于控制模型输出。有关更多信息，请参阅 PretrainedConfig 的文档。
示例
>>> from transformers import DistilBertConfig, DistilBertModel
>>> # Initializing a DistilBERT configuration
>>> configuration = DistilBertConfig()
>>> # Initializing a model (with random weights) from the configuration
>>> model = DistilBertModel(configuration)
>>> # Accessing the model configuration
>>> configuration = model.configDistilBertTokenizer
class transformers.DistilBertTokenizer
< 来源 >( 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, 可选) — 在分词过程中永不拆分的 token 集合。仅当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) — 解码后是否清理空格，清理包括移除潜在的多余空格等。
构建一个 DistilBERT 分词器。基于 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方法添加特殊标记时调用。
DistilBertTokenizerFast
class transformers.DistilBertTokenizerFast
< 源 >( 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, 可选, 默认为"##") — 子词的前缀。
构建一个“快速”DistilBERT 分词器（由 HuggingFace 的 tokenizers 库支持）。基于 WordPiece。
此分词器继承自 PreTrainedTokenizerFast，其中包含大部分主要方法。用户应参阅此超类以获取有关这些方法的更多信息。
DistilBertModel
class transformers.DistilBertModel
< 源 >( config: PretrainedConfig )
参数
- config (PretrainedConfig) — 模型的配置类，包含模型的所有参数。使用配置文件初始化不加载与模型相关的权重，只加载配置。请查看 from_pretrained() 方法以加载模型权重。
裸 Distilbert 模型，输出原始隐藏状态，顶部没有任何特定头部。
此模型继承自 PreTrainedModel。请查看超类文档，了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头部等）。
此模型也是 PyTorch torch.nn.Module 子类。将其作为常规 PyTorch 模块使用，并参阅 PyTorch 文档以获取所有与通用用法和行为相关的事项。
forward
< 源 >( input_ids: typing.Optional[torch.Tensor] = None attention_mask: typing.Optional[torch.Tensor] = None head_mask: typing.Optional[torch.Tensor] = None inputs_embeds: 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.BaseModelOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor, 形状为(batch_size, num_choices)) — 词汇表中输入序列标记的索引。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensor, 形状为(batch_size, sequence_length), 可选) — 遮罩以避免在填充标记索引上执行注意力。遮罩值在[0, 1]中选择：- 1 表示**未遮盖**的标记，
- 0 表示**已遮盖**的标记。
- head_mask (
torch.Tensor, 形状为(num_heads,)或(num_layers, num_heads), 可选) — 遮罩以使自注意力模块的选定头部无效。遮罩值在[0, 1]中选择：- 1 表示头部**未遮盖**，
- 0 表示头部**已遮盖**。
- inputs_embeds (
torch.FloatTensor, 形状为(batch_size, num_choices, hidden_size), 可选) — 可选地，您可以选择直接传递嵌入表示而不是传递input_ids。如果您希望对如何将input_ids索引转换为关联向量（而不是模型的内部嵌入查找矩阵）有更多控制，这会很有用。 - output_attentions (
bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量中的attentions。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量中的hidden_states。 - return_dict (
bool, 可选) — 是否返回 ModelOutput 而不是普通元组。
返回
transformers.modeling_outputs.BaseModelOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.BaseModelOutput 或一个 torch.FloatTensor 元组（如果传递 return_dict=False 或 config.return_dict=False），包含根据配置（DistilBertConfig）和输入而定的各种元素。
-
last_hidden_state (
torch.FloatTensor, 形状为(batch_size, sequence_length, hidden_size)) — 模型最后一层输出的隐藏状态序列。 -
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 后的注意力权重，用于计算自注意力头中的加权平均值。
的 DistilBertModel forward 方法，覆盖了 __call__ 特殊方法。
虽然 forward pass 的配方需要在此函数中定义，但在此之后应该调用 Module 实例，而不是此函数，因为前者负责运行预处理和后处理步骤，而后者则默默地忽略它们。
DistilBertForMaskedLM
class transformers.DistilBertForMaskedLM
< 源 >( config: PretrainedConfig )
参数
- config (PretrainedConfig) — 模型的配置类，包含模型的所有参数。使用配置文件初始化不加载与模型相关的权重，只加载配置。请查看 from_pretrained() 方法以加载模型权重。
DistilBert 模型，顶部带有 masked language modeling 头。
此模型继承自 PreTrainedModel。请查看超类文档，了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头部等）。
此模型也是 PyTorch torch.nn.Module 子类。将其作为常规 PyTorch 模块使用，并参阅 PyTorch 文档以获取所有与通用用法和行为相关的事项。
forward
< 源 >( input_ids: typing.Optional[torch.Tensor] = None attention_mask: typing.Optional[torch.Tensor] = None head_mask: typing.Optional[torch.Tensor] = None inputs_embeds: typing.Optional[torch.Tensor] = None labels: typing.Optional[torch.LongTensor] = 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.LongTensor, 形状为(batch_size, num_choices)) — 词汇表中输入序列标记的索引。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensor, 形状为(batch_size, sequence_length), 可选) — 遮罩以避免在填充标记索引上执行注意力。遮罩值在[0, 1]中选择：- 1 表示**未遮盖**的标记，
- 0 表示**已遮盖**的标记。
- head_mask (
torch.Tensor, 形状为(num_heads,)或(num_layers, num_heads), 可选) — 遮罩以使自注意力模块的选定头部无效。遮罩值在[0, 1]中选择：- 1 表示头部**未遮盖**，
- 0 表示头部**已遮盖**。
- inputs_embeds (
torch.FloatTensor, 形状为(batch_size, num_choices, hidden_size), 可选) — 可选地，您可以选择直接传递嵌入表示而不是传递input_ids。如果您希望对如何将input_ids索引转换为关联向量（而不是模型的内部嵌入查找矩阵）有更多控制，这会很有用。 - 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 时），其中包含根据配置 (DistilBertConfig) 和输入而变化的各种元素。
-
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 后的注意力权重，用于计算自注意力头中的加权平均值。
DistilBertForMaskedLM 的前向方法，重写了 __call__ 特殊方法。
虽然 forward pass 的配方需要在此函数中定义，但在此之后应该调用 Module 实例，而不是此函数，因为前者负责运行预处理和后处理步骤，而后者则默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, DistilBertForMaskedLM
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("distilbert-base-uncased")
>>> model = DistilBertForMaskedLM.from_pretrained("distilbert-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)
...DistilBertForSequenceClassification
class transformers.DistilBertForSequenceClassification
< source >( config: PretrainedConfig )
参数
- config (PretrainedConfig) — 模型的配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型相关的权重，只加载配置。请查看 from_pretrained() 方法来加载模型权重。
DistilBert 模型 Transformer，顶部带有一个序列分类/回归头（池化输出顶部的一个线性层），例如用于 GLUE 任务。
此模型继承自 PreTrainedModel。请查看超类文档，了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头部等）。
此模型也是 PyTorch torch.nn.Module 子类。将其作为常规 PyTorch 模块使用，并参阅 PyTorch 文档以获取所有与通用用法和行为相关的事项。
forward
< source >( input_ids: typing.Optional[torch.Tensor] = None attention_mask: typing.Optional[torch.Tensor] = None head_mask: typing.Optional[torch.Tensor] = None inputs_embeds: typing.Optional[torch.Tensor] = None labels: typing.Optional[torch.LongTensor] = 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 (形状为
(batch_size, sequence_length)的torch.Tensor，可选) — 词汇表中输入序列标记的索引。填充默认会被忽略。索引可以使用 AutoTokenizer 获取。更多详情请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (形状为
(batch_size, sequence_length)的torch.Tensor，可选) — 避免对填充标记索引执行注意力操作的掩码。掩码值选择在[0, 1]之间：- 1 表示未掩码的标记，
- 0 表示已掩码的标记。
- 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,)的torch.LongTensor，可选) — 用于计算序列分类/回归损失的标签。索引应在[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 时），其中包含根据配置 (DistilBertConfig) 和输入而变化的各种元素。
-
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 后的注意力权重，用于计算自注意力头中的加权平均值。
DistilBertForSequenceClassification 的前向方法，重写了 __call__ 特殊方法。
虽然 forward pass 的配方需要在此函数中定义，但在此之后应该调用 Module 实例，而不是此函数，因为前者负责运行预处理和后处理步骤，而后者则默默地忽略它们。
单标签分类示例
>>> import torch
>>> from transformers import AutoTokenizer, DistilBertForSequenceClassification
>>> tokenizer = AutoTokenizer.from_pretrained("distilbert-base-uncased")
>>> model = DistilBertForSequenceClassification.from_pretrained("distilbert-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 = DistilBertForSequenceClassification.from_pretrained("distilbert-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, DistilBertForSequenceClassification
>>> tokenizer = AutoTokenizer.from_pretrained("distilbert-base-uncased")
>>> model = DistilBertForSequenceClassification.from_pretrained("distilbert-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 = DistilBertForSequenceClassification.from_pretrained(
... "distilbert-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).lossDistilBertForMultipleChoice
class transformers.DistilBertForMultipleChoice
< source >( config: PretrainedConfig )
参数
- config (PretrainedConfig) — 模型的配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型相关的权重，只加载配置。请查看 from_pretrained() 方法来加载模型权重。
Distilbert 模型，顶部带有多项选择分类头（池化输出顶部的一个线性层和一个 softmax），例如用于 RocStories/SWAG 任务。
此模型继承自 PreTrainedModel。请查看超类文档，了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头部等）。
此模型也是 PyTorch torch.nn.Module 子类。将其作为常规 PyTorch 模块使用，并参阅 PyTorch 文档以获取所有与通用用法和行为相关的事项。
forward
< source >( input_ids: typing.Optional[torch.Tensor] = None attention_mask: typing.Optional[torch.Tensor] = None head_mask: typing.Optional[torch.Tensor] = None inputs_embeds: typing.Optional[torch.Tensor] = None labels: typing.Optional[torch.LongTensor] = 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 (形状为
(batch_size, num_choices, sequence_length)的torch.LongTensor) — 词汇表中输入序列标记的索引。索引可以使用 AutoTokenizer 获取。更多详情请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (形状为
(batch_size, sequence_length)的torch.Tensor，可选) — 避免对填充标记索引执行注意力操作的掩码。掩码值选择在[0, 1]之间：- 1 表示未掩码的标记，
- 0 表示已掩码的标记。
- head_mask (形状为
(num_heads,)或(num_layers, num_heads)的torch.Tensor，可选) — 用于使自注意力模块的选定头部失效的掩码。掩码值选择在[0, 1]之间：- 1 表示头部未掩码，
- 0 表示头部已掩码。
- inputs_embeds (形状为
(batch_size, num_choices, sequence_length, hidden_size)的torch.FloatTensor，可选) — 可选地，您可以选择直接传递嵌入表示，而不是传递input_ids。如果您希望对如何将input_ids索引转换为关联向量拥有比模型内部嵌入查找矩阵更多的控制，这将非常有用。 - labels (形状为
(batch_size,)的torch.LongTensor，可选) — 用于计算多项选择分类损失的标签。索引应在[0, ..., num_choices-1]之间，其中num_choices是输入张量的第二维大小。（请参阅上面的input_ids） - output_attentions (
bool, 可选) — 是否返回所有注意力层的注意力张量。更多详情请参阅返回张量中的attentions。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。更多详情请参阅返回张量中的hidden_states。 - return_dict (
bool, 可选) — 是否返回 ModelOutput 而不是普通的元组。
返回
transformers.modeling_outputs.MultipleChoiceModelOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.MultipleChoiceModelOutput 或一个 torch.FloatTensor 元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），其中包含根据配置 (DistilBertConfig) 和输入而变化的各种元素。
-
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 后的注意力权重，用于计算自注意力头中的加权平均值。
DistilBertForMultipleChoice 的前向方法，重写了 __call__ 特殊方法。
虽然 forward pass 的配方需要在此函数中定义，但在此之后应该调用 Module 实例，而不是此函数，因为前者负责运行预处理和后处理步骤，而后者则默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, DistilBertForMultipleChoice
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("distilbert-base-cased")
>>> model = DistilBertForMultipleChoice.from_pretrained("distilbert-base-cased")
>>> 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, choice0], [prompt, 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.logitsDistilBertForTokenClassification
class transformers.DistilBertForTokenClassification
< source >( config: PretrainedConfig )
参数
- config (PretrainedConfig) — 模型的配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型相关的权重，只加载配置。请查看 from_pretrained() 方法来加载模型权重。
Distilbert Transformer，顶部带有一个 token 分类头（隐藏状态输出顶部的一个线性层），例如用于命名实体识别 (NER) 任务。
此模型继承自 PreTrainedModel。请查看超类文档，了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头部等）。
此模型也是 PyTorch torch.nn.Module 子类。将其作为常规 PyTorch 模块使用，并参阅 PyTorch 文档以获取所有与通用用法和行为相关的事项。
forward
< source >( input_ids: typing.Optional[torch.Tensor] = None attention_mask: typing.Optional[torch.Tensor] = None head_mask: typing.Optional[torch.Tensor] = None inputs_embeds: typing.Optional[torch.Tensor] = None labels: typing.Optional[torch.LongTensor] = 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 表示已掩码的标记。
- 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，可选) — 用于计算 token 分类损失的标签。索引应在[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 时），其中包含根据配置 (DistilBertConfig) 和输入而变化的各种元素。
-
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 后的注意力权重，用于计算自注意力头中的加权平均值。
DistilBertForTokenClassification 的前向方法，重写了 __call__ 特殊方法。
虽然 forward pass 的配方需要在此函数中定义，但在此之后应该调用 Module 实例，而不是此函数，因为前者负责运行预处理和后处理步骤，而后者则默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, DistilBertForTokenClassification
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("distilbert-base-uncased")
>>> model = DistilBertForTokenClassification.from_pretrained("distilbert-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)
...DistilBertForQuestionAnswering
class transformers.DistilBertForQuestionAnswering
< source >( config: PretrainedConfig )
参数
- config (PretrainedConfig) — 模型的配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型相关的权重，只加载配置。请查看 from_pretrained() 方法来加载模型权重。
Distilbert Transformer，顶部带有一个 span 分类头，用于 SQuAD 等抽取式问答任务（隐藏状态输出顶部的一个线性层，用于计算 span start logits 和 span end logits）。
此模型继承自 PreTrainedModel。请查看超类文档，了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头部等）。
此模型也是 PyTorch torch.nn.Module 子类。将其作为常规 PyTorch 模块使用，并参阅 PyTorch 文档以获取所有与通用用法和行为相关的事项。
forward
< source >( input_ids: typing.Optional[torch.Tensor] = None attention_mask: 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 or tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensorof shape(batch_size, num_choices)) — 词汇表中输入序列标记的索引。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensorof shape(batch_size, sequence_length), 可选) — 用于避免对填充标记索引执行注意力操作的掩码。掩码值选择范围为[0, 1]：- 1 表示未被掩盖的标记，
- 0 表示被掩盖的标记。
- head_mask (
torch.Tensorof shape(num_heads,)或(num_layers, num_heads), 可选) — 用于使自注意力模块的选定头部失效的掩码。掩码值选择范围为[0, 1]：- 1 表示头部未被掩盖，
- 0 表示头部被掩盖。
- inputs_embeds (
torch.FloatTensorof shape(batch_size, num_choices, hidden_size), 可选) — 可选地，您可以通过嵌入表示直接传递，而不是传递input_ids。如果您希望对如何将input_ids索引转换为关联向量具有比模型内部嵌入查找矩阵更多的控制，这将很有用。 - start_positions (
torch.Tensorof shape(batch_size,), 可选) — 用于计算标记分类损失的标记范围起始位置（索引）的标签。位置被限制为序列的长度 (sequence_length)。序列外部的位置不计入损失计算。 - end_positions (
torch.Tensorof shape(batch_size,), 可选) — 用于计算标记分类损失的标记范围结束位置（索引）的标签。位置被限制为序列的长度 (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），其中包含根据配置 (DistilBertConfig) 和输入的不同元素。
-
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 后的注意力权重，用于计算自注意力头中的加权平均值。
DistilBertForQuestionAnswering 的 forward 方法，它覆盖了 __call__ 特殊方法。
虽然 forward pass 的配方需要在此函数中定义，但在此之后应该调用 Module 实例，而不是此函数，因为前者负责运行预处理和后处理步骤，而后者则默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, DistilBertForQuestionAnswering
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("distilbert-base-uncased")
>>> model = DistilBertForQuestionAnswering.from_pretrained("distilbert-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)
...TFDistilBertModel
类 transformers.TFDistilBertModel
< 源 >( 配置 *输入 **kwargs )
参数
- config (DistilBertConfig) — 包含模型所有参数的模型配置类。用配置文件初始化不会加载与模型相关的权重，只加载配置。请查看 from_pretrained() 方法加载模型权重。
DistilBERT 编码器/变换器，输出原始隐藏状态，顶部没有任何特定头部。
此模型继承自 TFPreTrainedModel。查看超类文档，了解库为其所有模型实现的一般方法（例如下载或保存、调整输入嵌入大小、修剪头部等）。
此模型也是 keras.Model 的子类。将其作为常规 TF 2.0 Keras 模型使用，并参阅 TF 2.0 文档了解所有与一般使用和行为相关的事项。
transformers 中的 TensorFlow 模型和层接受两种输入格式
- 所有输入作为关键字参数（如 PyTorch 模型），或
- 所有输入作为第一个位置参数中的列表、元组或字典。
支持第二种格式的原因是 Keras 方法在将输入传递给模型和层时更喜欢这种格式。由于这种支持，当使用 model.fit() 等方法时，一切都应该“正常工作”——只需以 model.fit() 支持的任何格式传递您的输入和标签即可！但是，如果您想在 fit() 和 predict() 等 Keras 方法之外使用第二种格式，例如在使用 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 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 training: Optional[bool] = False ) → transformers.modeling_tf_outputs.TFBaseModelOutput 或 tuple(tf.Tensor)
参数
- input_ids (
Numpy array或tf.Tensorof shape(batch_size, sequence_length)) — 词汇表中输入序列标记的索引。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.call() 和 PreTrainedTokenizer.encode()。
- attention_mask (
Numpy array或tf.Tensorof shape(batch_size, sequence_length), 可选) — 用于避免对填充标记索引执行注意力操作的掩码。掩码值选择范围为[0, 1]：- 1 表示未被掩盖的标记，
- 0 表示被掩盖的标记。
- head_mask (
Numpy array或tf.Tensorof shape(num_heads,)或(num_layers, num_heads), 可选) — 用于使自注意力模块的选定头部失效的掩码。掩码值选择范围为[0, 1]：- 1 表示头部未被掩盖，
- 0 表示头部被掩盖。
- inputs_embeds (
tf.Tensorof shape(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.TFBaseModelOutput 或 tuple(tf.Tensor)
一个 transformers.modeling_tf_outputs.TFBaseModelOutput 或一个 tf.Tensor 元组（如果传递 return_dict=False 或 config.return_dict=False），其中包含根据配置 (DistilBertConfig) 和输入的不同元素。
-
last_hidden_state (
tf.Tensorof shape(batch_size, sequence_length, hidden_size)) — 模型最后一层输出的隐藏状态序列。 -
hidden_states (
tuple(tf.FloatTensor), 可选, 当传递output_hidden_states=True或config.output_hidden_states=True时返回) — 形状为(batch_size, sequence_length, hidden_size)的tf.Tensor元组（一个用于嵌入的输出 + 一个用于每个层的输出）。模型在每个层输出的隐藏状态加上初始嵌入输出。
-
attentions (
tuple(tf.Tensor), 可选, 当传递output_attentions=True或config.output_attentions=True时返回) — 形状为(batch_size, num_heads, sequence_length, sequence_length)的tf.Tensor元组（每个层一个）。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
TFDistilBertModel 的 forward 方法，它覆盖了 __call__ 特殊方法。
虽然 forward pass 的配方需要在此函数中定义，但在此之后应该调用 Module 实例，而不是此函数，因为前者负责运行预处理和后处理步骤，而后者则默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, TFDistilBertModel
>>> import tensorflow as tf
>>> tokenizer = AutoTokenizer.from_pretrained("distilbert-base-uncased")
>>> model = TFDistilBertModel.from_pretrained("distilbert-base-uncased")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="tf")
>>> outputs = model(inputs)
>>> last_hidden_states = outputs.last_hidden_stateTFDistilBertForMaskedLM
类 transformers.TFDistilBertForMaskedLM
< 源 >( 配置 *输入 **kwargs )
参数
- config (DistilBertConfig) — 包含模型所有参数的模型配置类。用配置文件初始化不会加载与模型相关的权重，只加载配置。请查看 from_pretrained() 方法加载模型权重。
DistilBert 模型，顶部带有 masked language modeling 头。
此模型继承自 TFPreTrainedModel。查看超类文档，了解库为其所有模型实现的一般方法（例如下载或保存、调整输入嵌入大小、修剪头部等）。
此模型也是 keras.Model 的子类。将其作为常规 TF 2.0 Keras 模型使用，并参阅 TF 2.0 文档了解所有与一般使用和行为相关的事项。
transformers 中的 TensorFlow 模型和层接受两种输入格式
- 所有输入作为关键字参数（如 PyTorch 模型），或
- 所有输入作为第一个位置参数中的列表、元组或字典。
支持第二种格式的原因是 Keras 方法在将输入传递给模型和层时更喜欢这种格式。由于这种支持，当使用 model.fit() 等方法时，一切都应该“正常工作”——只需以 model.fit() 支持的任何格式传递您的输入和标签即可！但是，如果您想在 fit() 和 predict() 等 Keras 方法之外使用第二种格式，例如在使用 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 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 (
Numpy array或tf.Tensorof shape(batch_size, sequence_length)) — 词汇表中输入序列标记的索引。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.call() 和 PreTrainedTokenizer.encode()。
- attention_mask (
Numpy array或tf.Tensorof shape(batch_size, sequence_length), 可选) — 用于避免对填充标记索引执行注意力操作的掩码。掩码值选择范围为[0, 1]：- 1 表示未被掩盖的标记，
- 0 表示被掩盖的标记。
- head_mask (
Numpy array或tf.Tensorof shape(num_heads,)或(num_layers, num_heads), 可选) — 用于使自注意力模块的选定头部失效的掩码。掩码值选择范围为[0, 1]：- 1 表示头部未被掩盖，
- 0 表示头部被掩盖。
- inputs_embeds (
tf.Tensorof shape(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.Tensorof shape(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），其中包含根据配置 (DistilBertConfig) 和输入的不同元素。
-
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时返回) — 形状为(batch_size, sequence_length, hidden_size)的tf.Tensor元组（一个用于嵌入的输出 + 一个用于每个层的输出）。模型在每个层输出的隐藏状态加上初始嵌入输出。
-
attentions (
tuple(tf.Tensor), 可选, 当传递output_attentions=True或config.output_attentions=True时返回) — 形状为(batch_size, num_heads, sequence_length, sequence_length)的tf.Tensor元组（每个层一个）。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
TFDistilBertForMaskedLM 的 forward 方法，它覆盖了 __call__ 特殊方法。
虽然 forward pass 的配方需要在此函数中定义，但在此之后应该调用 Module 实例，而不是此函数，因为前者负责运行预处理和后处理步骤，而后者则默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, TFDistilBertForMaskedLM
>>> import tensorflow as tf
>>> tokenizer = AutoTokenizer.from_pretrained("distilbert-base-uncased")
>>> model = TFDistilBertForMaskedLM.from_pretrained("distilbert-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)TFDistilBertForSequenceClassification
类 transformers.TFDistilBertForSequenceClassification
< 源 >( 配置 *输入 **kwargs )
参数
- config (DistilBertConfig) — 包含模型所有参数的模型配置类。用配置文件初始化不会加载与模型相关的权重，只加载配置。请查看 from_pretrained() 方法加载模型权重。
DistilBert 模型 Transformer，顶部带有一个序列分类/回归头（池化输出顶部的一个线性层），例如用于 GLUE 任务。
此模型继承自 TFPreTrainedModel。查看超类文档，了解库为其所有模型实现的一般方法（例如下载或保存、调整输入嵌入大小、修剪头部等）。
此模型也是 keras.Model 的子类。将其作为常规 TF 2.0 Keras 模型使用，并参阅 TF 2.0 文档了解所有与一般使用和行为相关的事项。
transformers 中的 TensorFlow 模型和层接受两种输入格式
- 所有输入作为关键字参数（如 PyTorch 模型），或
- 所有输入作为第一个位置参数中的列表、元组或字典。
支持第二种格式的原因是 Keras 方法在将输入传递给模型和层时更喜欢这种格式。由于这种支持，当使用 model.fit() 等方法时，一切都应该“正常工作”——只需以 model.fit() 支持的任何格式传递您的输入和标签即可！但是，如果您想在 fit() 和 predict() 等 Keras 方法之外使用第二种格式，例如在使用 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 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 (
Numpy array或tf.Tensorof shape(batch_size, sequence_length)) — 词汇表中输入序列标记的索引。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.call() 和 PreTrainedTokenizer.encode()。
- attention_mask (
Numpy array或tf.Tensorof shape(batch_size, sequence_length), 可选) — 用于避免对填充标记索引执行注意力操作的掩码。掩码值选择范围为[0, 1]：- 1 表示未被掩盖的标记，
- 0 表示被掩盖的标记。
- head_mask (
Numpy array或tf.Tensorof shape(num_heads,)或(num_layers, num_heads), 可选) — 用于使自注意力模块的选定头部失效的掩码。掩码值选择范围为[0, 1]：- 1 表示头部未被掩盖，
- 0 表示头部被掩盖。
- inputs_embeds (
tf.Tensorof shape(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,)，可选) — 用于计算序列分类/回归损失的标签。索引应在[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 时），包含根据配置 (DistilBertConfig) 和输入的不同元素。
-
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时返回) — 形状为(batch_size, sequence_length, hidden_size)的tf.Tensor元组（一个用于嵌入的输出 + 一个用于每个层的输出）。模型在每个层输出的隐藏状态加上初始嵌入输出。
-
attentions (
tuple(tf.Tensor), 可选, 当传递output_attentions=True或config.output_attentions=True时返回) — 形状为(batch_size, num_heads, sequence_length, sequence_length)的tf.Tensor元组（每个层一个）。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
TFDistilBertForSequenceClassification 前向方法，覆盖了 __call__ 特殊方法。
虽然 forward pass 的配方需要在此函数中定义，但在此之后应该调用 Module 实例，而不是此函数，因为前者负责运行预处理和后处理步骤，而后者则默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, TFDistilBertForSequenceClassification
>>> import tensorflow as tf
>>> tokenizer = AutoTokenizer.from_pretrained("distilbert-base-uncased")
>>> model = TFDistilBertForSequenceClassification.from_pretrained("distilbert-base-uncased")
>>> 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])>>> # 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 = TFDistilBertForSequenceClassification.from_pretrained("distilbert-base-uncased", num_labels=num_labels)
>>> labels = tf.constant(1)
>>> loss = model(**inputs, labels=labels).lossTFDistilBertForMultipleChoice
class transformers.TFDistilBertForMultipleChoice
< 源 >( 配置 *输入 **kwargs )
参数
- config (DistilBertConfig) — 模型的配置类，包含模型的所有参数。使用配置文件初始化并不会加载与模型相关的权重，只加载配置。请查看 from_pretrained() 方法以加载模型权重。
DistilBert 模型，顶部带有多项选择分类头（池化输出顶部的一个线性层和一个 softmax），例如用于 RocStories/SWAG 任务。
此模型继承自 TFPreTrainedModel。查看超类文档，了解库为其所有模型实现的一般方法（例如下载或保存、调整输入嵌入大小、修剪头部等）。
此模型也是 keras.Model 的子类。将其作为常规 TF 2.0 Keras 模型使用，并参阅 TF 2.0 文档了解所有与一般使用和行为相关的事项。
transformers 中的 TensorFlow 模型和层接受两种输入格式
- 所有输入作为关键字参数（如 PyTorch 模型），或
- 所有输入作为第一个位置参数中的列表、元组或字典。
支持第二种格式的原因是 Keras 方法在将输入传递给模型和层时更喜欢这种格式。由于这种支持，当使用 model.fit() 等方法时，一切都应该“正常工作”——只需以 model.fit() 支持的任何格式传递您的输入和标签即可！但是，如果您想在 fit() 和 predict() 等 Keras 方法之外使用第二种格式，例如在使用 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 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 (形状为
(batch_size, num_choices, sequence_length)的Numpy array或tf.Tensor) — 词汇表中输入序列 token 的索引。索引可以使用 AutoTokenizer 获取。详情请参阅 PreTrainedTokenizer.call() 和 PreTrainedTokenizer.encode()。
- attention_mask (形状为
(batch_size, num_choices, sequence_length)的Numpy array或tf.Tensor，可选) — 避免在填充 token 索引上执行注意力操作的掩码。掩码值选择在[0, 1]之间：- 1 表示 token 未被掩盖，
- 0 表示 token 已被掩盖。
- head_mask (形状为
(num_heads,)或(num_layers, num_heads)的Numpy array或tf.Tensor，可选) — 用于使自注意力模块的选定头部无效的掩码。掩码值选择在[0, 1]之间：- 1 表示头部未被掩盖，
- 0 表示头部已被掩盖。
- inputs_embeds (形状为
(batch_size, num_choices, sequence_length, hidden_size)的tf.Tensor，可选) — 可选地，您可以选择直接传入嵌入表示，而不是传入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,)，可选) — 用于计算多项选择分类损失的标签。索引应在[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 时），包含根据配置 (DistilBertConfig) 和输入的不同元素。
-
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时返回) — 形状为(batch_size, sequence_length, hidden_size)的tf.Tensor元组（一个用于嵌入的输出 + 一个用于每个层的输出）。模型在每个层输出的隐藏状态加上初始嵌入输出。
-
attentions (
tuple(tf.Tensor), 可选, 当传递output_attentions=True或config.output_attentions=True时返回) — 形状为(batch_size, num_heads, sequence_length, sequence_length)的tf.Tensor元组（每个层一个）。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
TFDistilBertForMultipleChoice 前向方法，覆盖了 __call__ 特殊方法。
虽然 forward pass 的配方需要在此函数中定义，但在此之后应该调用 Module 实例，而不是此函数，因为前者负责运行预处理和后处理步骤，而后者则默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, TFDistilBertForMultipleChoice
>>> import tensorflow as tf
>>> tokenizer = AutoTokenizer.from_pretrained("distilbert-base-uncased")
>>> model = TFDistilBertForMultipleChoice.from_pretrained("distilbert-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.logitsTFDistilBertForTokenClassification
class transformers.TFDistilBertForTokenClassification
< 源 >( 配置 *输入 **kwargs )
参数
- config (DistilBertConfig) — 模型的配置类，包含模型的所有参数。使用配置文件初始化并不会加载与模型相关的权重，只加载配置。请查看 from_pretrained() 方法以加载模型权重。
DistilBert 模型，顶部带有 token 分类头（隐藏状态输出顶部的一个线性层），例如用于命名实体识别（NER）任务。
此模型继承自 TFPreTrainedModel。查看超类文档，了解库为其所有模型实现的一般方法（例如下载或保存、调整输入嵌入大小、修剪头部等）。
此模型也是 keras.Model 的子类。将其作为常规 TF 2.0 Keras 模型使用，并参阅 TF 2.0 文档了解所有与一般使用和行为相关的事项。
transformers 中的 TensorFlow 模型和层接受两种输入格式
- 所有输入作为关键字参数（如 PyTorch 模型），或
- 所有输入作为第一个位置参数中的列表、元组或字典。
支持第二种格式的原因是 Keras 方法在将输入传递给模型和层时更喜欢这种格式。由于这种支持，当使用 model.fit() 等方法时，一切都应该“正常工作”——只需以 model.fit() 支持的任何格式传递您的输入和标签即可！但是，如果您想在 fit() 和 predict() 等 Keras 方法之外使用第二种格式，例如在使用 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 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 (形状为
(batch_size, sequence_length)的Numpy array或tf.Tensor) — 词汇表中输入序列 token 的索引。索引可以使用 AutoTokenizer 获取。详情请参阅 PreTrainedTokenizer.call() 和 PreTrainedTokenizer.encode()。
- attention_mask (形状为
(batch_size, sequence_length)的Numpy array或tf.Tensor，可选) — 避免在填充 token 索引上执行注意力操作的掩码。掩码值选择在[0, 1]之间：- 1 表示 token 未被掩盖，
- 0 表示 token 已被掩盖。
- head_mask (形状为
(num_heads,)或(num_layers, num_heads)的Numpy array或tf.Tensor，可选) — 用于使自注意力模块的选定头部无效的掩码。掩码值选择在[0, 1]之间：- 1 表示头部未被掩盖，
- 0 表示头部已被掩盖。
- inputs_embeds (形状为
(batch_size, sequence_length, hidden_size)的tf.Tensor，可选) — 可选地，您可以选择直接传入嵌入表示，而不是传入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)，可选) — 用于计算 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 时），包含根据配置 (DistilBertConfig) 和输入的不同元素。
-
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时返回) — 形状为(batch_size, sequence_length, hidden_size)的tf.Tensor元组（一个用于嵌入的输出 + 一个用于每个层的输出）。模型在每个层输出的隐藏状态加上初始嵌入输出。
-
attentions (
tuple(tf.Tensor), 可选, 当传递output_attentions=True或config.output_attentions=True时返回) — 形状为(batch_size, num_heads, sequence_length, sequence_length)的tf.Tensor元组（每个层一个）。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
TFDistilBertForTokenClassification 前向方法，覆盖了 __call__ 特殊方法。
虽然 forward pass 的配方需要在此函数中定义，但在此之后应该调用 Module 实例，而不是此函数，因为前者负责运行预处理和后处理步骤，而后者则默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, TFDistilBertForTokenClassification
>>> import tensorflow as tf
>>> tokenizer = AutoTokenizer.from_pretrained("distilbert-base-uncased")
>>> model = TFDistilBertForTokenClassification.from_pretrained("distilbert-base-uncased")
>>> 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()]TFDistilBertForQuestionAnswering
class transformers.TFDistilBertForQuestionAnswering
< 源 >( 配置 *输入 **kwargs )
参数
- config (DistilBertConfig) — 模型的配置类，包含模型的所有参数。使用配置文件初始化并不会加载与模型相关的权重，只加载配置。请查看 from_pretrained() 方法以加载模型权重。
DistilBert 模型，顶部带有 span 分类头，用于抽取式问答任务，如 SQuAD（隐藏状态输出顶部的一个线性层，用于计算 span start logits 和 span end logits）。
此模型继承自 TFPreTrainedModel。查看超类文档，了解库为其所有模型实现的一般方法（例如下载或保存、调整输入嵌入大小、修剪头部等）。
此模型也是 keras.Model 的子类。将其作为常规 TF 2.0 Keras 模型使用，并参阅 TF 2.0 文档了解所有与一般使用和行为相关的事项。
transformers 中的 TensorFlow 模型和层接受两种输入格式
- 所有输入作为关键字参数（如 PyTorch 模型），或
- 所有输入作为第一个位置参数中的列表、元组或字典。
支持第二种格式的原因是 Keras 方法在将输入传递给模型和层时更喜欢这种格式。由于这种支持，当使用 model.fit() 等方法时，一切都应该“正常工作”——只需以 model.fit() 支持的任何格式传递您的输入和标签即可！但是，如果您想在 fit() 和 predict() 等 Keras 方法之外使用第二种格式，例如在使用 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 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 (形状为
(batch_size, sequence_length)的Numpy array或tf.Tensor) — 词汇表中输入序列 token 的索引。索引可以使用 AutoTokenizer 获取。详情请参阅 PreTrainedTokenizer.call() 和 PreTrainedTokenizer.encode()。
- attention_mask (形状为
(batch_size, sequence_length)的Numpy array或tf.Tensor，可选) — 避免在填充 token 索引上执行注意力操作的掩码。掩码值选择在[0, 1]之间：- 1 表示 token 未被掩盖，
- 0 表示 token 已被掩盖。
- head_mask (形状为
(num_heads,)或(num_layers, num_heads)的Numpy array或tf.Tensor，可选) — 用于使自注意力模块的选定头部无效的掩码。掩码值选择在[0, 1]之间：- 1 表示头部未被掩盖，
- 0 表示头部已被掩盖。
- inputs_embeds (形状为
(batch_size, sequence_length, hidden_size)的tf.Tensor，可选) — 可选地，您可以选择直接传入嵌入表示，而不是传入input_ids。如果您希望对input_ids索引如何转换为相关向量有更多控制，而不是模型内部的嵌入查找矩阵，这会很有用。 - output_attentions (
bool, 可选) — 是否返回所有注意力层的注意力张量。更多详情请参阅返回张量下的attentions。此参数只能在即时模式下使用，在图模式下将使用配置中的值。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。更多详情请参阅返回张量下的hidden_states。此参数只能在即时模式下使用，在图模式下将使用配置中的值。 - return_dict (
bool, optional) — 是否返回 ModelOutput 而不是普通元组。此参数可在即时模式下使用，在图模式下该值将始终设置为 True。 - training (
bool, optional, defaults toFalse) — 是否在训练模式下使用模型（某些模块如 dropout 模块在训练和评估之间有不同的行为）。 - start_positions (形状为
(batch_size,)的tf.Tensor, optional) — 用于计算令牌分类损失的标记跨度起始位置（索引）的标签。位置被限制在序列的长度（sequence_length）范围内。序列外部的位置不计入损失计算。 - end_positions (形状为
(batch_size,)的tf.Tensor, optional) — 用于计算令牌分类损失的标记跨度结束位置（索引）的标签。位置被限制在序列的长度（sequence_length）范围内。序列外部的位置不计入损失计算。
返回
transformers.modeling_tf_outputs.TFQuestionAnsweringModelOutput 或 tuple(tf.Tensor)
一个 transformers.modeling_tf_outputs.TFQuestionAnsweringModelOutput 或一个 tf.Tensor 元组（如果传入 return_dict=False 或当 config.return_dict=False 时），包含根据配置 (DistilBertConfig) 和输入的不同元素。
-
loss (形状为
(batch_size, )的tf.Tensor, optional, 当提供start_positions和end_positions时返回) — 总跨度提取损失是起始位置和结束位置的交叉熵之和。 -
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时返回) — 形状为(batch_size, sequence_length, hidden_size)的tf.Tensor元组（一个用于嵌入的输出 + 一个用于每个层的输出）。模型在每个层输出的隐藏状态加上初始嵌入输出。
-
attentions (
tuple(tf.Tensor), 可选, 当传递output_attentions=True或config.output_attentions=True时返回) — 形状为(batch_size, num_heads, sequence_length, sequence_length)的tf.Tensor元组（每个层一个）。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
TFDistilBertForQuestionAnswering 的 forward 方法，覆盖了 __call__ 特殊方法。
虽然 forward pass 的配方需要在此函数中定义，但在此之后应该调用 Module 实例，而不是此函数，因为前者负责运行预处理和后处理步骤，而后者则默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, TFDistilBertForQuestionAnswering
>>> import tensorflow as tf
>>> tokenizer = AutoTokenizer.from_pretrained("distilbert-base-uncased")
>>> model = TFDistilBertForQuestionAnswering.from_pretrained("distilbert-base-uncased")
>>> 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]FlaxDistilBertModel
class transformers.FlaxDistilBertModel
< source >( config: DistilBertConfig input_shape: tuple = (1, 1) seed: int = 0 dtype: dtype = <class 'jax.numpy.float32'> _do_init: bool = True **kwargs )
参数
- config (DistilBertConfig) — 模型配置类，包含模型的所有参数。用配置文件初始化不会加载与模型相关的权重，只加载配置。请查看 from_pretrained() 方法来加载模型权重。
裸 DistilBert 模型转换器，输出原始隐藏状态，顶部没有任何特定头。
该模型继承自 FlaxPreTrainedModel。请查看超类文档，了解库为其所有模型实现的通用方法（例如从 PyTorch 模型下载、保存和转换权重）。
此模型也是 flax.linen.Module 的子类。将其作为常规的 Flax Linen 模块使用，并参考 Flax 文档了解所有与一般用法和行为相关的事项。
最后，此模型支持固有的 JAX 功能，例如
__call__
< source >( input_ids attention_mask = None head_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 )
参数
- input_ids (形状为
(batch_size, sequence_length)的numpy.ndarray) — 词汇表中输入序列 token 的索引。可以使用 AutoTokenizer 获取索引。有关详细信息，请参见 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (形状为
(batch_size, sequence_length)的numpy.ndarray, optional) — 用于避免在填充 token 索引上执行注意力操作的掩码。掩码值选择范围为[0, 1]：- 1 表示 未被掩盖 的 token，
- 0 表示 被掩盖 的 token。
- output_attentions (
bool, optional) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的attentions。 - output_hidden_states (
bool, optional) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的hidden_states。 - return_dict (
bool, optional) — 是否返回 ModelOutput 而不是普通元组。
FlaxDistilBertPreTrainedModel 的 forward 方法，覆盖了 __call__ 特殊方法。
虽然 forward pass 的配方需要在此函数中定义，但在此之后应该调用 Module 实例，而不是此函数，因为前者负责运行预处理和后处理步骤，而后者则默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, FlaxDistilBertModel
>>> tokenizer = AutoTokenizer.from_pretrained("distilbert-base-uncased")
>>> model = FlaxDistilBertModel.from_pretrained("distilbert-base-uncased")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="jax")
>>> outputs = model(**inputs)
>>> last_hidden_states = outputs.last_hidden_stateFlaxDistilBertForMaskedLM
class transformers.FlaxDistilBertForMaskedLM
< source >( config: DistilBertConfig input_shape: tuple = (1, 1) seed: int = 0 dtype: dtype = <class 'jax.numpy.float32'> _do_init: bool = True **kwargs )
参数
- config (DistilBertConfig) — 模型配置类，包含模型的所有参数。用配置文件初始化不会加载与模型相关的权重，只加载配置。请查看 from_pretrained() 方法来加载模型权重。
DistilBert 模型，顶部带有 语言建模 头。
该模型继承自 FlaxPreTrainedModel。请查看超类文档，了解库为其所有模型实现的通用方法（例如从 PyTorch 模型下载、保存和转换权重）。
此模型也是 flax.linen.Module 的子类。将其作为常规的 Flax Linen 模块使用，并参考 Flax 文档了解所有与一般用法和行为相关的事项。
最后，此模型支持固有的 JAX 功能，例如
__call__
< source >( input_ids attention_mask = None head_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 ) → transformers.modeling_flax_outputs.FlaxMaskedLMOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (形状为
(batch_size, sequence_length)的numpy.ndarray) — 词汇表中输入序列 token 的索引。可以使用 AutoTokenizer 获取索引。有关详细信息，请参见 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (形状为
(batch_size, sequence_length)的numpy.ndarray, optional) — 用于避免在填充 token 索引上执行注意力操作的掩码。掩码值选择范围为[0, 1]：- 1 表示 未被掩盖 的 token，
- 0 表示 被掩盖 的 token。
- output_attentions (
bool, optional) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的attentions。 - output_hidden_states (
bool, optional) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的hidden_states。 - return_dict (
bool, optional) — 是否返回 ModelOutput 而不是普通元组。
返回
transformers.modeling_flax_outputs.FlaxMaskedLMOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_flax_outputs.FlaxMaskedLMOutput 或一个 torch.FloatTensor 元组（如果传入 return_dict=False 或当 config.return_dict=False 时），包含根据配置 (DistilBertConfig) 和输入的不同元素。
-
logits (形状为
(batch_size, sequence_length, config.vocab_size)的jnp.ndarray) — 语言建模头的预测分数（SoftMax 之前每个词汇 token 的分数）。 -
hidden_states (
tuple(jnp.ndarray), optional, 当传入output_hidden_states=True或当config.output_hidden_states=True时返回) — 形状为(batch_size, sequence_length, hidden_size)的jnp.ndarray元组（一个用于嵌入输出 + 一个用于每层的输出）。模型在每个层输出的隐藏状态加上初始嵌入输出。
-
attentions (
tuple(jnp.ndarray), optional, 当传入output_attentions=True或当config.output_attentions=True时返回) — 形状为(batch_size, num_heads, sequence_length, sequence_length)的jnp.ndarray元组（每个层一个）。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
FlaxDistilBertPreTrainedModel 的 forward 方法，覆盖了 __call__ 特殊方法。
虽然 forward pass 的配方需要在此函数中定义，但在此之后应该调用 Module 实例，而不是此函数，因为前者负责运行预处理和后处理步骤，而后者则默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, FlaxDistilBertForMaskedLM
>>> tokenizer = AutoTokenizer.from_pretrained("distilbert-base-uncased")
>>> model = FlaxDistilBertForMaskedLM.from_pretrained("distilbert-base-uncased")
>>> inputs = tokenizer("The capital of France is [MASK].", return_tensors="jax")
>>> outputs = model(**inputs)
>>> logits = outputs.logitsFlaxDistilBertForSequenceClassification
class transformers.FlaxDistilBertForSequenceClassification
< source >( config: DistilBertConfig input_shape: tuple = (1, 1) seed: int = 0 dtype: dtype = <class 'jax.numpy.float32'> _do_init: bool = True **kwargs )
参数
- config (DistilBertConfig) — 模型配置类，包含模型的所有参数。用配置文件初始化不会加载与模型相关的权重，只加载配置。请查看 from_pretrained() 方法来加载模型权重。
DistilBert 模型 Transformer，顶部带有一个序列分类/回归头（池化输出顶部的一个线性层），例如用于 GLUE 任务。
该模型继承自 FlaxPreTrainedModel。请查看超类文档，了解库为其所有模型实现的通用方法（例如从 PyTorch 模型下载、保存和转换权重）。
此模型也是 flax.linen.Module 的子类。将其作为常规的 Flax Linen 模块使用，并参考 Flax 文档了解所有与一般用法和行为相关的事项。
最后，此模型支持固有的 JAX 功能，例如
__call__
< source >( input_ids attention_mask = None head_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 ) → transformers.modeling_flax_outputs.FlaxSequenceClassifierOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (形状为
(batch_size, sequence_length)的numpy.ndarray) — 词汇表中输入序列 token 的索引。可以使用 AutoTokenizer 获取索引。有关详细信息，请参见 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (形状为
(batch_size, sequence_length)的numpy.ndarray, optional) — 用于避免在填充 token 索引上执行注意力操作的掩码。掩码值选择范围为[0, 1]：- 1 表示 未被掩盖 的 token，
- 0 表示 被掩盖 的 token。
- output_attentions (
bool, optional) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的attentions。 - output_hidden_states (
bool, optional) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的hidden_states。 - return_dict (
bool, optional) — 是否返回 ModelOutput 而不是普通元组。
返回
transformers.modeling_flax_outputs.FlaxSequenceClassifierOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_flax_outputs.FlaxSequenceClassifierOutput 或一个 torch.FloatTensor 元组（如果传入 return_dict=False 或当 config.return_dict=False 时），包含根据配置 (DistilBertConfig) 和输入的不同元素。
-
logits (形状为
(batch_size, config.num_labels)的jnp.ndarray) — 分类（如果 config.num_labels==1，则为回归）分数（SoftMax 之前）。 -
hidden_states (
tuple(jnp.ndarray), optional, 当传入output_hidden_states=True或当config.output_hidden_states=True时返回) — 形状为(batch_size, sequence_length, hidden_size)的jnp.ndarray元组（一个用于嵌入输出 + 一个用于每层的输出）。模型在每个层输出的隐藏状态加上初始嵌入输出。
-
attentions (
tuple(jnp.ndarray), optional, 当传入output_attentions=True或当config.output_attentions=True时返回) — 形状为(batch_size, num_heads, sequence_length, sequence_length)的jnp.ndarray元组（每个层一个）。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
FlaxDistilBertPreTrainedModel 的 forward 方法，覆盖了 __call__ 特殊方法。
虽然 forward pass 的配方需要在此函数中定义，但在此之后应该调用 Module 实例，而不是此函数，因为前者负责运行预处理和后处理步骤，而后者则默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, FlaxDistilBertForSequenceClassification
>>> tokenizer = AutoTokenizer.from_pretrained("distilbert-base-uncased")
>>> model = FlaxDistilBertForSequenceClassification.from_pretrained("distilbert-base-uncased")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="jax")
>>> outputs = model(**inputs)
>>> logits = outputs.logitsFlaxDistilBertForMultipleChoice
class transformers.FlaxDistilBertForMultipleChoice
< source >( config: DistilBertConfig input_shape: tuple = (1, 1) seed: int = 0 dtype: dtype = <class 'jax.numpy.float32'> _do_init: bool = True **kwargs )
参数
- config (DistilBertConfig) — 模型配置类，包含模型的所有参数。用配置文件初始化不会加载与模型相关的权重，只加载配置。请查看 from_pretrained() 方法来加载模型权重。
DistilBert 模型，顶部带有多项选择分类头（池化输出顶部的一个线性层和一个 softmax），例如用于 RocStories/SWAG 任务。
该模型继承自 FlaxPreTrainedModel。请查看超类文档，了解库为其所有模型实现的通用方法（例如从 PyTorch 模型下载、保存和转换权重）。
此模型也是 flax.linen.Module 的子类。将其作为常规的 Flax Linen 模块使用，并参考 Flax 文档了解所有与一般用法和行为相关的事项。
最后，此模型支持固有的 JAX 功能，例如
__call__
< source >( input_ids attention_mask = None head_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 ) → transformers.modeling_flax_outputs.FlaxMultipleChoiceModelOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (形状为
(batch_size, num_choices, sequence_length)的numpy.ndarray) — 词汇表中输入序列 token 的索引。可以使用 AutoTokenizer 获取索引。有关详细信息，请参见 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (形状为
(batch_size, num_choices, sequence_length)的numpy.ndarray, optional) — 用于避免在填充 token 索引上执行注意力操作的掩码。掩码值选择范围为[0, 1]：- 1 表示 未被掩盖 的 token，
- 0 表示 被掩盖 的 token。
- output_attentions (
bool, optional) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的attentions。 - output_hidden_states (
bool, optional) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的hidden_states。 - return_dict (
bool, optional) — 是否返回 ModelOutput 而不是普通元组。
返回
transformers.modeling_flax_outputs.FlaxMultipleChoiceModelOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_flax_outputs.FlaxMultipleChoiceModelOutput 或一个 torch.FloatTensor 元组（如果传入 return_dict=False 或当 config.return_dict=False 时），包含根据配置 (DistilBertConfig) 和输入的不同元素。
-
logits (形状为
(batch_size, num_choices)的jnp.ndarray) — num_choices 是输入张量的第二个维度。（请参阅上面的 input_ids）。分类分数（SoftMax 之前）。
-
hidden_states (
tuple(jnp.ndarray), optional, 当传入output_hidden_states=True或当config.output_hidden_states=True时返回) — 形状为(batch_size, sequence_length, hidden_size)的jnp.ndarray元组（一个用于嵌入输出 + 一个用于每层的输出）。模型在每个层输出的隐藏状态加上初始嵌入输出。
-
attentions (
tuple(jnp.ndarray), optional, 当传入output_attentions=True或当config.output_attentions=True时返回) — 形状为(batch_size, num_heads, sequence_length, sequence_length)的jnp.ndarray元组（每个层一个）。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
FlaxDistilBertPreTrainedModel 的 forward 方法，覆盖了 __call__ 特殊方法。
虽然 forward pass 的配方需要在此函数中定义，但在此之后应该调用 Module 实例，而不是此函数，因为前者负责运行预处理和后处理步骤，而后者则默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, FlaxDistilBertForMultipleChoice
>>> tokenizer = AutoTokenizer.from_pretrained("distilbert-base-uncased")
>>> model = FlaxDistilBertForMultipleChoice.from_pretrained("distilbert-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.logitsFlaxDistilBertForTokenClassification
class transformers.FlaxDistilBertForTokenClassification
< source >( config: DistilBertConfig input_shape: tuple = (1, 1) seed: int = 0 dtype: dtype = <class 'jax.numpy.float32'> _do_init: bool = True **kwargs )
参数
- config (DistilBertConfig) — 模型配置类，包含模型的所有参数。用配置文件初始化不会加载与模型相关的权重，只加载配置。请查看 from_pretrained() 方法来加载模型权重。
DistilBert 模型，顶部带有 token 分类头（隐藏状态输出顶部的一个线性层），例如用于命名实体识别（NER）任务。
该模型继承自 FlaxPreTrainedModel。请查看超类文档，了解库为其所有模型实现的通用方法（例如从 PyTorch 模型下载、保存和转换权重）。
此模型也是 flax.linen.Module 的子类。将其作为常规的 Flax Linen 模块使用，并参考 Flax 文档了解所有与一般用法和行为相关的事项。
最后，此模型支持固有的 JAX 功能，例如
__call__
< source >( input_ids attention_mask = None head_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 ) → transformers.modeling_flax_outputs.FlaxTokenClassifierOutput 或 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。
- output_attentions (
bool, 可选) — 是否返回所有注意力层的注意力张量。有关详细信息，请参阅返回张量中的attentions。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。有关详细信息，请参阅返回张量中的hidden_states。 - 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 时），包含取决于配置 (DistilBertConfig) 和输入的不同元素。
-
logits (
jnp.ndarray，形状为(batch_size, sequence_length, config.num_labels)) — 分类得分（SoftMax 之前）。 -
hidden_states (
tuple(jnp.ndarray), optional, 当传入output_hidden_states=True或当config.output_hidden_states=True时返回) — 形状为(batch_size, sequence_length, hidden_size)的jnp.ndarray元组（一个用于嵌入输出 + 一个用于每层的输出）。模型在每个层输出的隐藏状态加上初始嵌入输出。
-
attentions (
tuple(jnp.ndarray), optional, 当传入output_attentions=True或当config.output_attentions=True时返回) — 形状为(batch_size, num_heads, sequence_length, sequence_length)的jnp.ndarray元组（每个层一个）。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
FlaxDistilBertPreTrainedModel 的 forward 方法，覆盖了 __call__ 特殊方法。
虽然 forward pass 的配方需要在此函数中定义，但在此之后应该调用 Module 实例，而不是此函数，因为前者负责运行预处理和后处理步骤，而后者则默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, FlaxDistilBertForTokenClassification
>>> tokenizer = AutoTokenizer.from_pretrained("distilbert-base-uncased")
>>> model = FlaxDistilBertForTokenClassification.from_pretrained("distilbert-base-uncased")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="jax")
>>> outputs = model(**inputs)
>>> logits = outputs.logitsFlaxDistilBertForQuestionAnswering
class transformers.FlaxDistilBertForQuestionAnswering
< 源 >( config: DistilBertConfig input_shape: tuple = (1, 1) seed: int = 0 dtype: dtype = <class 'jax.numpy.float32'> _do_init: bool = True **kwargs )
参数
- config (DistilBertConfig) — 模型的配置类，包含模型的所有参数。用配置文件初始化不会加载与模型相关的权重，只会加载配置。请查看 from_pretrained() 方法来加载模型权重。
DistilBert 模型，顶部带有一个用于抽取式问答任务（如 SQuAD）的跨度分类头（在隐藏状态输出之上的一层线性层，用于计算 span start logits 和 span end logits）。
该模型继承自 FlaxPreTrainedModel。请查看超类文档，了解库为其所有模型实现的通用方法（例如从 PyTorch 模型下载、保存和转换权重）。
此模型也是 flax.linen.Module 的子类。将其作为常规的 Flax Linen 模块使用，并参考 Flax 文档了解所有与一般用法和行为相关的事项。
最后，此模型支持固有的 JAX 功能，例如
__call__
< 源 >( input_ids attention_mask = None head_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 ) → transformers.modeling_flax_outputs.FlaxQuestionAnsweringModelOutput 或 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。
- output_attentions (
bool, 可选) — 是否返回所有注意力层的注意力张量。有关详细信息，请参阅返回张量中的attentions。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。有关详细信息，请参阅返回张量中的hidden_states。 - 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 时），包含取决于配置 (DistilBertConfig) 和输入的不同元素。
-
start_logits (
jnp.ndarray，形状为(batch_size, sequence_length)) — 跨度开始得分（SoftMax 之前）。 -
end_logits (
jnp.ndarray，形状为(batch_size, sequence_length)) — 跨度结束得分（SoftMax 之前）。 -
hidden_states (
tuple(jnp.ndarray), optional, 当传入output_hidden_states=True或当config.output_hidden_states=True时返回) — 形状为(batch_size, sequence_length, hidden_size)的jnp.ndarray元组（一个用于嵌入输出 + 一个用于每层的输出）。模型在每个层输出的隐藏状态加上初始嵌入输出。
-
attentions (
tuple(jnp.ndarray), optional, 当传入output_attentions=True或当config.output_attentions=True时返回) — 形状为(batch_size, num_heads, sequence_length, sequence_length)的jnp.ndarray元组（每个层一个）。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
FlaxDistilBertPreTrainedModel 的 forward 方法，覆盖了 __call__ 特殊方法。
虽然 forward pass 的配方需要在此函数中定义，但在此之后应该调用 Module 实例，而不是此函数，因为前者负责运行预处理和后处理步骤，而后者则默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, FlaxDistilBertForQuestionAnswering
>>> tokenizer = AutoTokenizer.from_pretrained("distilbert-base-uncased")
>>> model = FlaxDistilBertForQuestionAnswering.from_pretrained("distilbert-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_logits