DistilBERT
概述
DistilBERT 模型在博客文章 更小、更快、更便宜、更轻巧：介绍 DistilBERT，BERT 的蒸馏版本 和论文 DistilBERT，BERT 的蒸馏版本：更小、更快、更便宜、更轻巧 中提出。DistilBERT 是一个小型、快速、廉价且轻巧的 Transformer 模型，通过蒸馏 BERT base 训练而成。与 google-bert/bert-base-uncased 相比，它参数减少了 40%，运行速度提高了 60%，同时在 GLUE 语言理解基准测试中保留了超过 95% 的 BERT 性能。
论文摘要如下
随着从大规模预训练模型的迁移学习在自然语言处理 (NLP) 中越来越普遍，在边缘或计算资源受限的训练或推理预算下运行这些大型模型仍然是一个挑战。在这项工作中，我们提出了一种预训练更小通用语言表示模型的方法，称为 DistilBERT，然后可以对其进行微调，在各种任务上获得与大型模型相当的性能。虽然大多数先前的工作研究了蒸馏在构建特定于任务的模型中的应用，但我们在预训练阶段利用了知识蒸馏，并表明可以将 BERT 模型的大小减少 40%，同时保留其 97% 的语言理解能力，速度提高 60%。为了利用大型模型在预训练期间学习到的归纳偏差，我们引入了结合语言建模、蒸馏和余弦距离损失的三重损失。我们更小、更快、更轻巧的模型预训练成本更低，我们在概念验证实验和比较的设备上研究中展示了其在设备上计算的能力。
该模型由 victorsanh 贡献。该模型的 jax 版本由 kamalkraj 贡献。原始代码可以在 此处 找到。
使用技巧
DistilBERT 没有
token_type_ids，您无需指明哪个标记属于哪个段。只需使用分隔标记tokenizer.sep_token（或[SEP]）分隔您的段。DistilBERT 没有选择输入位置（
position_ids输入）的选项。如果需要，可以添加此选项，如果您需要此选项，请告知我们。与 BERT 相同，但更小。通过预训练的 BERT 模型蒸馏进行训练，这意味着它已经过训练以预测与大型模型相同的概率。实际目标是以下目标的组合：
- 找到与教师模型相同的概率
- 正确预测掩码标记（但没有句子预测目标）
- 学生模型和教师模型隐藏状态之间的余弦相似度
资源
以下是一些官方 Hugging Face 和社区（🌎 表示）资源，可以帮助您开始使用 DistilBERT。如果您有兴趣提交要包含在此处的资源，请随时打开一个 Pull Request，我们将对其进行审查！理想情况下，该资源应该展示一些新内容，而不是重复现有的资源。
- 一篇关于 使用 Python 开始使用情感分析 的博客文章，其中使用 DistilBERT。
- 一篇关于如何 使用 Blurr 训练 DistilBERT 以进行序列分类 的博客文章。
- 一篇关于如何 使用 Ray 调整 DistilBERT 超参数 的博客文章。
- 一篇关于如何 使用 Hugging Face 和 Amazon SageMaker 训练 DistilBERT 的博客文章。
- 一个关于如何 微调 DistilBERT 以进行多标签分类 的笔记本。🌎
- 一个关于如何 使用 PyTorch 微调 DistilBERT 以进行多类分类 的笔记本。🌎
- 一个关于如何 在 TensorFlow 中微调 DistilBERT 以进行文本分类 的笔记本。🌎
- DistilBertForSequenceClassification 由此 示例脚本 和 笔记本 支持。
- TFDistilBertForSequenceClassification 由此 示例脚本 和 笔记本 支持。
- FlaxDistilBertForSequenceClassification 由此 示例脚本 和 笔记本 支持。
- 文本分类任务指南
- DistilBertForTokenClassification 由此 示例脚本 和 笔记本 支持。
- TFDistilBertForTokenClassification 由此 示例脚本 和 笔记本 支持。
- FlaxDistilBertForTokenClassification 由此 示例脚本 支持。
- 标记分类 🤗 Hugging Face 课程的章节。
- 标记分类任务指南
- DistilBertForMaskedLM 由此 示例脚本 和 笔记本 支持。
- TFDistilBertForMaskedLM 由此 示例脚本 和 笔记本 支持。
- FlaxDistilBertForMaskedLM 由此 示例脚本 和 笔记本 支持。
- 掩码语言建模 🤗 Hugging Face 课程的章节。
- 掩码语言建模任务指南
- DistilBertForQuestionAnswering 由此 示例脚本 和 笔记本 支持。
- TFDistilBertForQuestionAnswering 由此 示例脚本 和 笔记本 支持。
- FlaxDistilBertForQuestionAnswering 由此 示例脚本 支持。
- 问答 🤗 Hugging Face 课程的章节。
- 问答任务指南
多项选择
- DistilBertForMultipleChoice 由此 示例脚本 和 笔记本 支持。
- TFDistilBertForMultipleChoice 由此 示例脚本 和 笔记本 支持。
- 多项选择任务指南
⚗️ 优化
- 一篇关于如何 使用 🤗 Optimum 和 Intel 量化 DistilBERT 的博客文章。
- 一篇关于如何 使用 🤗 Optimum 为 GPU 优化 Transformers 的博客文章。
- 一篇关于 使用 Hugging Face Optimum 优化 Transformers 的博客文章。
⚡️ 推理
- 一篇关于如何 使用 Hugging Face Transformers 和 AWS Inferentia 加速 BERT 推理 的博客文章，其中使用 DistilBERT。
- 一篇关于 使用 Hugging Face 的 Transformers、DistilBERT 和 Amazon SageMaker 进行无服务器推理 的博客文章。
🚀 部署
- 一篇关于如何 在 Google Cloud 上部署 DistilBERT 的博客文章。
- 一篇关于如何 使用 Amazon SageMaker 部署 DistilBERT 的博客文章。
- 一篇关于如何 使用 Hugging Face Transformers、Amazon SageMaker 和 Terraform 模块部署 BERT 的博客文章。
结合 DistilBERT 和 Flash Attention 2
首先，请确保已安装最新版本的 Flash Attention 2，以包含滑动窗口注意力功能。
pip install -U flash-attn --no-build-isolation
同时确保您拥有与 Flash-Attention 2 兼容的硬件。有关更多信息，请阅读 flash-attn 存储库的官方文档。还请确保以半精度（例如 torch.float16）加载您的模型。
要使用 Flash Attention 2 加载和运行模型，请参考以下代码段
>>> import torch
>>> from transformers import AutoTokenizer, AutoModel
>>> device = "cuda" # the device to load the model onto
>>> tokenizer = AutoTokenizer.from_pretrained('distilbert/distilbert-base-uncased')
>>> model = AutoModel.from_pretrained("distilbert/distilbert-base-uncased", torch_dtype=torch.float16, attn_implementation="flash_attention_2")
>>> text = "Replace me by any text you'd like."
>>> encoded_input = tokenizer(text, return_tensors='pt').to(device)
>>> model.to(device)
>>> output = model(**encoded_input)DistilBertConfig
class transformers.DistilBertConfig
< source >( 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表示的不同标记的数量。 - 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) — 编码器层和池化层的维度。 - attention_dropout (
float, 可选, 默认为 0.1) — 注意力概率的 dropout 比率。 - activation (
str或Callable, 可选, 默认为"gelu") — 编码器和池化器中的非线性激活函数（函数或字符串）。 如果是字符串，则支持"gelu"、"relu"、"silu"和"gelu_new"。 - initializer_range (
float, 可选, 默认为 0.02) — 初始化所有权重矩阵的截断正态分布初始化器的标准差。 - 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
< 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, defaults toTrue) — 标记化时是否将输入小写。 - do_basic_tokenize (
bool, optional, defaults toTrue) — 是否在 WordPiece 之前进行基本标记化。 - never_split (
Iterable, optional) — 标记化过程中永远不会分割的标记集合。仅当do_basic_tokenize=True时有效 - unk_token (
str, optional, defaults to"[UNK]") — 未知标记。词汇表中没有的标记无法转换为 ID，而是设置为该标记。 - sep_token (
str, optional, defaults to"[SEP]") — 分隔符标记，用于从多个序列构建序列时，例如用于序列分类的两个序列或用于问答的文本和问题。它也用作使用特殊标记构建的序列的最后一个标记。 - pad_token (
str, optional, defaults to"[PAD]") — 用于填充的标记，例如在对不同长度的序列进行批处理时。 - cls_token (
str, optional, defaults to"[CLS]") — 分类标记，用于执行序列分类（对整个序列进行分类，而不是对每个标记进行分类）。它是使用特殊标记构建的序列的第一个标记。 - mask_token (
str, optional, defaults to"[MASK]") — 用于屏蔽值的标记。这是使用蒙面语言建模训练此模型时使用的标记。这是模型将尝试预测的标记。 - tokenize_chinese_chars (
bool, optional, defaults toTrue) — 是否对汉字进行标记化。对于日语，这可能需要停用（参见此 问题）。
构建 DistilBERT 分词器。基于 WordPiece。
此分词器继承自 PreTrainedTokenizer，其中包含大多数主要方法。用户应参考此超类以获取有关这些方法的更多信息。
build_inputs_with_special_tokens
< 源代码 >( token_ids_0: List token_ids_1: Optional = None ) → List[int]
通过连接和添加特殊标记，从用于序列分类任务的序列或序列对构建模型输入。BERT 序列具有以下格式
- 单个序列：
[CLS] X [SEP] - 序列对：
[CLS] A [SEP] B [SEP]
将一个令牌序列（字符串）转换为单个字符串。
create_token_type_ids_from_sequences
< 源代码 >( token_ids_0: List token_ids_1: Optional = None ) → List[int]
从传递的两个序列中创建掩码，以用于序列对分类任务。BERT 序列
如果 token_ids_1 为 None，此方法只返回掩码的第一部分（0）。
get_special_tokens_mask
< 源代码 >( token_ids_0: List token_ids_1: Optional = None already_has_special_tokens: bool = False 参数 返回
一个范围在 [0, 1] 内的整数列表：特殊令牌为 1，序列令牌为 0。List[int]) — ID 列表。 List[int], 可选) — 针对序列对的可选第二个 ID 列表。 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]") — 分隔符令牌，用于从多个序列构建序列，例如序列分类的两个序列或问答的文本和问题。它也用作使用特殊令牌构建的序列的最后一个令牌。 - 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，其中包含大多数主要方法。用户应该参考此超类以获取有关这些方法的更多信息。
build_inputs_with_special_tokens
< 源代码 >( token_ids_0 token_ids_1 = None ) → List[int]
通过连接和添加特殊标记，从用于序列分类任务的序列或序列对构建模型输入。BERT 序列具有以下格式
- 单个序列：
[CLS] X [SEP] - 序列对：
[CLS] A [SEP] B [SEP]
create_token_type_ids_from_sequences
< 源代码 >( token_ids_0: List token_ids_1: Optional = None ) → List[int]
从传递的两个序列中创建掩码，以用于序列对分类任务。BERT 序列
如果 token_ids_1 为 None，此方法只返回掩码的第一部分（0）。
DistilBertModel
class transformers.DistilBertModel
< 源代码 >( config: PretrainedConfig )
参数
- config (DistilBertConfig) — 模型配置类，包含模型的所有参数。用配置文件初始化不会加载与模型相关的权重，只会加载配置。查看 from_pretrained() 方法来加载模型权重。
只输出原始隐藏状态的 DistilBERT 编码器/转换器，没有任何特定的头部。
此模型继承自 PreTrainedModel。查看超类文档，了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头部等）。
此模型也是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档了解与一般使用和行为有关的所有事宜。
forward
< 源代码 >( input_ids: Optional = None attention_mask: Optional = None head_mask: Optional = None inputs_embeds: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → transformers.modeling_outputs.BaseModelOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor形状为(batch_size, num_choices)) — 词汇表中输入序列标记的索引。可以使用 AutoTokenizer 获取索引。查看 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call() 以获取详细信息。
- attention_mask (
torch.FloatTensor形状为(batch_size, num_choices), 可选) — 用于避免对填充标记索引执行注意的掩码。在[0, 1]中选择掩码值：- 1 表示未被掩码的标记，
- 0 表示被掩码的标记。
- head_mask (
torch.FloatTensor形状为(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 之后的注意力权重，用于计算自注意力头中的加权平均值。
The DistilBertModel forward method, overrides the __call__ special method.
虽然正向传递的配方需要在此函数中定义，但应该在之后调用 Module 实例而不是此函数，因为前者负责运行预处理和后处理步骤，而后者则会默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, DistilBertModel
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("distilbert-base-uncased")
>>> model = DistilBertModel.from_pretrained("distilbert-base-uncased")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")
>>> outputs = model(**inputs)
>>> last_hidden_states = outputs.last_hidden_stateDistilBertForMaskedLM
class transformers.DistilBertForMaskedLM
< source >( config: PretrainedConfig )
参数
- config (DistilBertConfig) — 模型配置类，包含模型的所有参数。 使用配置文件初始化不会加载与模型关联的权重，只会加载配置。 查看 from_pretrained() 方法以加载模型权重。
具有 masked language modeling 头的 DistilBert 模型。
此模型继承自 PreTrainedModel。查看超类文档，了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头部等）。
此模型也是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档了解与一般使用和行为有关的所有事宜。
forward
< source >( input_ids: Optional = None attention_mask: Optional = None head_mask: Optional = None inputs_embeds: Optional = None labels: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → transformers.modeling_outputs.MaskedLMOutput or tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor形状为(batch_size, num_choices)) — 词汇表中输入序列标记的索引。可以使用 AutoTokenizer 获取索引。请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call() 获取更多信息。
- attention_mask (
torch.FloatTensor形状为(batch_size, num_choices)，可选) — 用于避免对填充标记索引执行注意力的掩码。掩码值选择在[0, 1]中：- 1 表示未掩码的标记，
- 0 表示已掩码的标记。
- head_mask (
torch.FloatTensor形状为(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 而不是普通元组。 - labels (
torch.LongTensor形状为(batch_size, sequence_length)，可选) — 用于计算掩码语言建模损失的标签。索引应在[-100, 0, ..., config.vocab_size]中（请参阅input_ids文档字符串）。索引设置为-100的标记将被忽略（掩码），损失仅针对标签在[0, ..., config.vocab_size]中的标记进行计算。
返回
transformers.modeling_outputs.MaskedLMOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.MaskedLMOutput 或 torch.FloatTensor 的元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），包含根据配置 (DistilBertConfig) 和输入而变化的各种元素。
-
loss (
torch.FloatTensor形状为(1,)，可选，在提供labels时返回) — 掩码语言建模 (MLM) 损失。 -
logits (
torch.FloatTensor形状为(batch_size, sequence_length, config.vocab_size)) — 语言建模头的预测分数（SoftMax 之前的每个词汇标记的分数）。 -
hidden_states (
tuple(torch.FloatTensor), 可选，在传递output_hidden_states=True或config.output_hidden_states=True时返回) —torch.FloatTensor的元组（一个用于嵌入的输出，如果模型有嵌入层，加上每个层的输出）形状为(batch_size, sequence_length, hidden_size)。每个层的输出处的模型隐藏状态加上可选的初始嵌入输出。
-
attentions (
tuple(torch.FloatTensor), 可选，在传递output_attentions=True或config.output_attentions=True时返回) —torch.FloatTensor的元组（每个层一个）形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 之后的注意力权重，用于计算自注意力头中的加权平均值。
The DistilBertForMaskedLM 正向方法覆盖 __call__ 特殊方法。
虽然正向传递的配方需要在此函数中定义，但应该在之后调用 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)
>>> 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)DistilBertForSequenceClassification
DistilBert 模型转换器，顶部带有序列分类/回归头（在池化输出之上使用线性层），例如用于 GLUE 任务。
此模型继承自 PreTrainedModel。查看超类文档，了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头部等）。
此模型也是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档了解与一般使用和行为有关的所有事宜。
forward
< 源代码 >( input_ids: Optional = None attention_mask: Optional = None head_mask: Optional = None inputs_embeds: Optional = None labels: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → transformers.modeling_outputs.SequenceClassifierOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor形状为(batch_size, sequence_length)) — 输入序列标记在词汇表中的索引。索引可以通过 AutoTokenizer 获得。查看 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call() 了解详情。
- attention_mask (
torch.FloatTensor形状为(batch_size, sequence_length), 可选) — 掩码，用于避免对填充标记索引执行注意力。掩码值在[0, 1]中选择：- 1 表示标记为未掩码，
- 0 表示标记为掩码。
- head_mask (
torch.FloatTensor形状为(num_heads,)或(num_layers, num_heads), 可选) — 掩码，用于使自注意力模块的选定头无效。掩码值在[0, 1]中选择：- 1 表示头为未掩码，
- 0 表示头为掩码。
- inputs_embeds (
torch.FloatTensor形状为(batch_size, sequence_length, hidden_size), 可选) — 可选地，您可以选择直接传递嵌入式表示，而不是传递input_ids。如果您希望对如何将input_ids索引转换为关联向量（而不是模型的内部嵌入查找矩阵）有更多控制，这将很有用。 - output_attentions (
bool, 可选) — 是否返回所有注意力层的注意力张量。查看返回张量下的attentions了解详情。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。查看返回张量下的hidden_states了解详情。 - return_dict (
bool, 可选) — 是否返回 ModelOutput 而不是普通元组。 - labels (
torch.LongTensor形状为(batch_size,)，可选) — 用于计算序列分类/回归损失的标签。索引应在[0, ..., config.num_labels - 1]内。如果config.num_labels == 1，则计算回归损失（均方损失），如果config.num_labels > 1，则计算分类损失（交叉熵）。
返回
transformers.modeling_outputs.SequenceClassifierOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.SequenceClassifierOutput 或 torch.FloatTensor 的元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），包含根据配置 (DistilBertConfig) 和输入的不同元素。
-
loss (
torch.FloatTensor形状为(1,)，可选，在提供labels时返回) — 分类（或回归，如果 config.num_labels==1）损失。 -
logits (
torch.FloatTensor形状为(batch_size, config.num_labels)) — 分类（或回归，如果 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 之后的注意力权重，用于计算自注意力头中的加权平均值。
The DistilBertForSequenceClassification forward method, overrides the __call__ special method.
虽然正向传递的配方需要在此函数中定义，但应该在之后调用 Module 实例而不是此函数，因为前者负责运行预处理和后处理步骤，而后者则会默默地忽略它们。
Example of single-label classification
>>> 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()
>>> # 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).lossExample of multi-label classification
>>> 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 (DistilBertConfig) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型关联的权重，只会加载配置。查看 from_pretrained() 方法以加载模型权重。
DistilBert 模型，顶部有一个多项选择分类头（在池化输出之上有一个线性层和一个 softmax），例如用于 RocStories/SWAG 任务。
此模型继承自 PreTrainedModel。查看超类文档，了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头部等）。
此模型也是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档了解与一般使用和行为有关的所有事宜。
forward
< source >( input_ids: Optional = None attention_mask: Optional = None head_mask: Optional = None inputs_embeds: Optional = None labels: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → transformers.modeling_outputs.MultipleChoiceModelOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor形状为(batch_size, num_choices, sequence_length)) — 词汇表中输入序列标记的索引。可以使用 AutoTokenizer 获取索引。查看 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call() 以了解详细信息。
- attention_mask (
torch.FloatTensor形状为(batch_size, num_choices, sequence_length)，可选) — 掩码，避免对填充标记索引执行注意力。在[0, 1]中选择的掩码值：- 1 表示标记未被掩码，
- 0 表示标记被掩码。
- head_mask (
torch.FloatTensor形状为(num_heads,)或(num_layers, num_heads)，可选) — 掩码，用于使自注意力模块的选定头无效。在[0, 1]中选择的掩码值：- 1 表示头未被掩码，
- 0 表示头被掩码。
- inputs_embeds (
torch.FloatTensor形状为(batch_size, num_choices, sequence_length, hidden_size), 可选) — 可选地，您可以选择直接传递嵌入表示，而不是传递input_ids。如果您想对如何将input_ids索引转换为关联向量进行更多控制，而不是模型的内部嵌入查找矩阵，这将非常有用。 - output_attentions (
bool, 可选) — 是否返回所有注意力层的注意力张量。有关详细信息，请参阅返回的张量中的attentions。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。有关详细信息，请参阅返回的张量中的hidden_states。 - return_dict (
bool, 可选) — 是否返回 ModelOutput 而不是普通元组。 - labels (
torch.LongTensor形状为(batch_size,), 可选) — 用于计算多选分类损失的标签。索引应在[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 时)，包含根据配置 (DistilBertConfig) 和输入的不同元素。
-
loss (
torch.FloatTensor形状为 (1,), 可选, 当提供labels时返回) — 分类损失。 -
logits (
torch.FloatTensor形状为(batch_size, num_choices)) — 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 之后的注意力权重，用于计算自注意力头中的加权平均值。
The DistilBertForMultipleChoice forward method, overrides the __call__ special method.
虽然正向传递的配方需要在此函数中定义，但应该在之后调用 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 (DistilBertConfig) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型关联的权重，只会加载配置。查看 from_pretrained() 方法来加载模型权重。
DistilBert 模型，顶部有一个令牌分类头（隐藏状态输出顶部的线性层），例如用于命名实体识别 (NER) 任务。
此模型继承自 PreTrainedModel。查看超类文档，了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头部等）。
此模型也是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档了解与一般使用和行为有关的所有事宜。
forward
< source >( input_ids: Optional = None attention_mask: Optional = None head_mask: Optional = None inputs_embeds: Optional = None labels: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → <
参数
- input_ids (
torch.LongTensor形状为({0})) — 词汇表中输入序列标记的索引。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.FloatTensor形状为({0})，可选) — 用于避免对填充标记索引执行注意的掩码。在[0, 1]中选择的掩码值：- 1 表示 未掩码 的标记，
- 0 表示 掩码 的标记。
- head_mask (
torch.FloatTensor形状为(num_heads,)或(num_layers, num_heads)，可选) — 用于使自注意力模块中选定的头部无效的掩码。在[0, 1]中选择的掩码值：- 1 表示头部 未掩码，
- 0 表示头部 掩码。
- inputs_embeds (
torch.FloatTensor形状为({0}, hidden_size)，可选) — 可选地，您可以选择直接传递嵌入表示，而不是传递input_ids。如果您希望对如何将input_ids索引转换为相关向量（而不是模型的内部嵌入查找矩阵）具有更多控制，这将非常有用。 - output_attentions (
bool，可选) — 是否返回所有注意力层的注意力张量。有关详细信息，请参阅返回张量中的attentions。 - output_hidden_states (
bool，可选) — 是否返回所有层的隐藏状态。有关详细信息，请参阅返回张量中的hidden_states。 - return_dict (
bool，可选) — 是否返回一个 ModelOutput 而不是一个简单的元组。 - labels (
torch.LongTensor形状为(batch_size, sequence_length)，可选) — 用于计算标记分类损失的标签。索引应在[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 时），包含取决于配置（DistilBertConfig）和输入的各种元素。
-
loss (
torch.FloatTensor形状为(1,)，可选，当提供labels时返回) — 分类损失。 -
logits (
torch.FloatTensor形状为(batch_size, sequence_length, config.num_labels)) — 分类分数（在 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 之后的注意力权重，用于计算自注意力头中的加权平均值。
The DistilBertForTokenClassification 正向方法覆盖了 __call__ 特殊方法。
虽然正向传递的配方需要在此函数中定义，但应该在之后调用 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]]
>>> labels = predicted_token_class_ids
>>> loss = model(**inputs, labels=labels).lossDistilBertForQuestionAnswering
DistilBert 模型，顶部带有跨度分类头，用于 SQuAD 等抽取式问答任务（在隐藏状态输出之上进行线性层计算以计算 span start logits 和 span end logits）。
此模型继承自 PreTrainedModel。查看超类文档，了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头部等）。
此模型也是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档了解与一般使用和行为有关的所有事宜。
forward
< 源代码 >( input_ids: Optional = None attention_mask: Optional = None head_mask: Optional = None inputs_embeds: Optional = None start_positions: Optional = None end_positions: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → transformers.modeling_outputs.QuestionAnsweringModelOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor形状为(batch_size, num_choices)) — 词汇表中输入序列标记的索引。可以使用 AutoTokenizer 获取索引。 请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call() 获取详细信息。
- attention_mask (
torch.FloatTensor形状为(batch_size, num_choices), 可选) — 用于避免对填充标记索引执行注意力的掩码。 掩码值在[0, 1]中选择：- 1 表示 未掩码 的标记，
- 0 表示 掩码 的标记。
- head_mask (
torch.FloatTensor形状为(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 而不是一个简单的元 - start_positions (
torch.LongTensor形状为(batch_size,)，可选) — 用于计算令牌分类损失的标记跨度的开始位置（索引）的标签。位置被限制在序列的长度（sequence_length）内。序列之外的位置不会被考虑用于计算损失。 - end_positions (
torch.LongTensor形状为(batch_size,)，可选) — 用于计算令牌分类损失的标记跨度的结束位置（索引）的标签。位置被限制在序列的长度（sequence_length）内。序列之外的位置不会被考虑用于计算损失。
返回
transformers.modeling_outputs.QuestionAnsweringModelOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.QuestionAnsweringModelOutput 或一个 torch.FloatTensor 元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），包含取决于配置 (DistilBertConfig) 和输入的不同元素。
-
loss (
torch.FloatTensor形状为(1,)，可选，当提供labels时返回) — 总跨度提取损失是开始和结束位置的交叉熵之和。 -
start_logits (
torch.FloatTensor形状为(batch_size, sequence_length)) — 跨度开始得分（在 SoftMax 之前）。 -
end_logits (
torch.FloatTensor形状为(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 之后的注意力权重，用于计算自注意力头中的加权平均值。
The DistilBertForQuestionAnswering forward method, overrides the __call__ special method.
虽然正向传递的配方需要在此函数中定义，但应该在之后调用 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]
>>> # 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.lossTFDistilBertModel
class transformers.TFDistilBertModel
< source >( config *inputs **kwargs )
参数
- config (DistilBertConfig) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型相关的权重，只加载配置。查看 from_pretrained() 方法来加载模型权重。
只输出原始隐藏状态的 DistilBERT 编码器/转换器，没有任何特定的头部。
此模型继承自 TFPreTrainedModel。查看超类文档以了解库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入的大小、修剪头部等）。
此模型也是一个 keras.Model 子类。将其用作常规 TF 2.0 Keras 模型，并参考 TF 2.0 文档以了解与一般使用和行为相关的所有事项。
transformers 中的 TensorFlow 模型和层接受两种格式作为输入
- 将所有输入作为关键字参数（如 PyTorch 模型），或
- 将所有输入作为第一个位置参数中的列表、元组或字典。
支持第二种格式的原因是 Keras 方法在将输入传递给模型和层时更喜欢这种格式。由于这种支持，当使用 model.fit() 等方法时，事情应该会“正常运行” - 只需以 model.fit() 支持的任何格式传递您的输入和标签即可！但是，如果您想在 Keras 方法（如 fit() 和 predict()）之外使用第二种格式，例如在使用 Keras Functional API 创建自己的层或模型时，您可以使用三种方法来收集第一个位置参数中的所有输入张量
- 只有一个张量，仅包含
input_ids，其他什么都没有：model(input_ids) - 一个长度可变的列表，包含一个或多个输入张量，顺序按照文档字符串中给定的顺序：
model([input_ids, attention_mask])或model([input_ids, attention_mask, token_type_ids]) - 一个字典，其中一个或多个输入张量与文档字符串中给定的输入名称相关联：
model({"input_ids": input_ids, "token_type_ids": token_type_ids})
请注意，在使用 子类化 创建模型和层时，您无需担心这些内容，因为您可以像传递给任何其他 Python 函数一样传递输入！
call
< source >( 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.Tensor形状为(batch_size, sequence_length)) — 词汇表中输入序列标记的索引。索引可以使用 AutoTokenizer 获得。有关详细信息，请参阅 PreTrainedTokenizer.call() 和 PreTrainedTokenizer.encode()。
- attention_mask (
Numpy array或tf.Tensor形状为(batch_size, sequence_length)，可选) — 掩码以避免对填充标记索引执行注意力。掩码值在[0, 1]中选择：- 1 表示未屏蔽的标记，
- 0 表示已屏蔽的标记。
- head_mask (
Numpy array或tf.Tensor形状为(num_heads,)或(num_layers, num_heads)，可选) — 掩码以使自注意力模块的选定头部无效。掩码值在[0, 1]中选择：- 1 表示未屏蔽的头部，
- 0 表示已屏蔽的头部。
- inputs_embeds (
tf.Tensor形状为(batch_size, sequence_length, hidden_size)，可选) — 可选地，您可以选择直接传递嵌入表示，而不是传递input_ids。如果您想要更多地控制如何将input_ids索引转换为相关向量，而不是模型的内部嵌入查找矩阵，这将很有用。 - output_attentions (
bool，可选) — 是否返回所有注意力层的注意力张量。有关详细信息，请参阅返回张量中的attentions。此参数只能在急切模式下使用，在图形模式下，将使用配置中的值。 - output_hidden_states (
bool，可选) — 是否返回所有层的隐藏状态。有关详细信息，请参阅返回张量中的hidden_states。此参数只能在急切模式下使用，在图形模式下，将使用配置中的值。 - return_dict (
bool，可选) — 是否返回 ModelOutput 而不是普通元组。此参数可以在急切模式下使用，在图形模式下，该值将始终设置为 True。 - training (
bool，可选，默认值为False) — 是否以训练模式使用模型（一些模块，如 dropout 模块，在训练和评估之间具有不同的行为）。
返回
transformers.modeling_tf_outputs.TFBaseModelOutput 或 tuple(tf.Tensor)
一个 transformers.modeling_tf_outputs.TFBaseModelOutput 或 tf.Tensor 的元组（如果传递 return_dict=False 或 config.return_dict=False 时），包含根据配置（DistilBertConfig）和输入而不同的各种元素。
-
last_hidden_state (
tf.Tensor形状为(batch_size, sequence_length, hidden_size)) — 模型最后一层的输出处的隐藏状态序列。 -
hidden_states (
tuple(tf.FloatTensor)，可选，当传递output_hidden_states=True或config.output_hidden_states=True时返回) —tf.Tensor的元组（一个用于嵌入的输出，一个用于每个层的输出）形状为(batch_size, sequence_length, hidden_size)。模型在每个层的输出处的隐藏状态加上初始嵌入输出。
-
attentions (
tuple(tf.Tensor)，可选，当传递output_attentions=True或config.output_attentions=True时返回) —tf.Tensor的元组（每个层一个）形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 之后的注意力权重，用于计算自注意力头中的加权平均值。
TFDistilBertModel 正向方法，覆盖 __call__ 特殊方法。
虽然正向传递的配方需要在此函数中定义，但应该在之后调用 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
class transformers.TFDistilBertForMaskedLM
< 源代码 >( config *inputs **kwargs )
参数
- config (DistilBertConfig) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型关联的权重，只会加载配置。查看 from_pretrained() 方法来加载模型权重。
具有 masked language modeling 头的 DistilBert 模型。
此模型继承自 TFPreTrainedModel。查看超类文档以了解库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入的大小、修剪头部等）。
此模型也是一个 keras.Model 子类。将其用作常规 TF 2.0 Keras 模型，并参考 TF 2.0 文档以了解与一般使用和行为相关的所有事项。
transformers 中的 TensorFlow 模型和层接受两种格式作为输入
- 将所有输入作为关键字参数（如 PyTorch 模型），或
- 将所有输入作为第一个位置参数中的列表、元组或字典。
支持第二种格式的原因是 Keras 方法在将输入传递给模型和层时更喜欢这种格式。由于这种支持，当使用 model.fit() 等方法时，事情应该会“正常运行” - 只需以 model.fit() 支持的任何格式传递您的输入和标签即可！但是，如果您想在 Keras 方法（如 fit() 和 predict()）之外使用第二种格式，例如在使用 Keras Functional API 创建自己的层或模型时，您可以使用三种方法来收集第一个位置参数中的所有输入张量
- 只有一个张量，仅包含
input_ids，其他什么都没有：model(input_ids) - 一个长度可变的列表，包含一个或多个输入张量，顺序按照文档字符串中给定的顺序：
model([input_ids, attention_mask])或model([input_ids, attention_mask, token_type_ids]) - 一个字典，其中一个或多个输入张量与文档字符串中给定的输入名称相关联：
model({"input_ids": input_ids, "token_type_ids": token_type_ids})
请注意，在使用 子类化 创建模型和层时，您无需担心这些内容，因为您可以像传递给任何其他 Python 函数一样传递输入！
call
< 源代码 >( 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 数组或tf.Tensor形状为(batch_size, sequence_length)) — 输入序列词元在词汇表中的索引。 - attention_mask (
Numpy 数组或tf.Tensor形状为(batch_size, sequence_length), 可选) — 掩码以避免对填充词元索引执行注意力。掩码值选自[0, 1]: - head_mask (
Numpy 数组或tf.Tensor形状为(num_heads,)或(num_layers, num_heads), 可选) — 掩码以使自注意力模块中选定的头无效。掩码值选自[0, 1]: - inputs_embeds (
tf.Tensor形状为(batch_size, sequence_length, hidden_size), 可选) — 可选地，您可以选择直接传递嵌入表示，而不是传递input_ids。如果您想对如何将input_ids索引转换为关联的向量进行更多控制（而不是模型的内部嵌入查找矩阵），这将很有用。 - output_attentions (
bool, 可选) — 是否返回所有注意力层的注意力张量。查看返回张量中的attentions获取更多详细信息。此参数只能在急切模式下使用，在图形模式下，将使用配置中的值。 - training (
bool, 可选，默认为False) — 是否在训练模式下使用模型（一些模块，例如 dropout 模块，在训练和评估之间具有不同的行为）。 - labels (
tf.Tensor形状为(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.Tensor形状为(n,)，可选，当提供labels时返回) — 掩码语言建模 (MLM) 损失。 -
logits (
tf.Tensor形状为(batch_size, sequence_length, config.vocab_size)) — 语言建模头的预测分数（SoftMax 之前每个词汇标记的分数）。 -
hidden_states (
tuple(tf.Tensor)，可选，当传递output_hidden_states=True或当config.output_hidden_states=True时返回) —tf.Tensor元组（一个用于嵌入的输出，一个用于每个层的输出）形状为(batch_size, sequence_length, hidden_size)。模型在每个层的输出处的隐藏状态加上初始嵌入输出。
-
attentions (
tuple(tf.Tensor)，可选，当传递output_attentions=True或config.output_attentions=True时返回) —tf.Tensor的元组（每个层一个）形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 之后的注意力权重，用于计算自注意力头中的加权平均值。
The TFDistilBertForMaskedLM 正向方法，覆盖了 __call__ 特殊方法。
虽然正向传递的配方需要在此函数中定义，但应该在之后调用 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
class transformers.TFDistilBertForSequenceClassification
< 源代码 >( config *inputs **kwargs )
参数
- config (DistilBertConfig) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型关联的权重，只会加载配置。查看 from_pretrained() 方法加载模型权重。
DistilBert 模型转换器，顶部带有序列分类/回归头（在池化输出之上使用线性层），例如用于 GLUE 任务。
此模型继承自 TFPreTrainedModel。查看超类文档以了解库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入的大小、修剪头部等）。
此模型也是一个 keras.Model 子类。将其用作常规 TF 2.0 Keras 模型，并参考 TF 2.0 文档以了解与一般使用和行为相关的所有事项。
transformers 中的 TensorFlow 模型和层接受两种格式作为输入
- 将所有输入作为关键字参数（如 PyTorch 模型），或
- 将所有输入作为第一个位置参数中的列表、元组或字典。
支持第二种格式的原因是 Keras 方法在将输入传递给模型和层时更喜欢这种格式。由于这种支持，当使用 model.fit() 等方法时，事情应该会“正常运行” - 只需以 model.fit() 支持的任何格式传递您的输入和标签即可！但是，如果您想在 Keras 方法（如 fit() 和 predict()）之外使用第二种格式，例如在使用 Keras Functional API 创建自己的层或模型时，您可以使用三种方法来收集第一个位置参数中的所有输入张量
- 只有一个张量，仅包含
input_ids，其他什么都没有：model(input_ids) - 一个长度可变的列表，包含一个或多个输入张量，顺序按照文档字符串中给定的顺序：
model([input_ids, attention_mask])或model([input_ids, attention_mask, token_type_ids]) - 一个字典，其中一个或多个输入张量与文档字符串中给定的输入名称相关联：
model({"input_ids": input_ids, "token_type_ids": token_type_ids})
请注意，在使用 子类化 创建模型和层时，您无需担心这些内容，因为您可以像传递给任何其他 Python 函数一样传递输入！
call
< 源代码 >( 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 数组或tf.Tensor形状为(batch_size, sequence_length)) — 输入序列词元在词汇表中的索引。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.call() 和 PreTrainedTokenizer.encode()。
- attention_mask (
Numpy 数组或tf.Tensor形状为(batch_size, sequence_length)，可选) — 掩码，避免在填充词元索引上执行注意力。掩码值选择在[0, 1]中：- 1 表示未掩码的词元，
- 0 表示掩码的词元。
- head_mask (
Numpy 数组或tf.Tensor形状为(num_heads,)或(num_layers, num_heads)，可选) — 掩码，用于使自注意力模块的选定头部无效。掩码值选择在[0, 1]中：- 1 表示未掩码的头部，
- 0 表示掩码的头部。
- inputs_embeds (
tf.Tensor形状为(batch_size, sequence_length, hidden_size)，可选) — 可选地，您可以选择直接传递嵌入表示，而不是传递input_ids。如果您想要比模型的内部嵌入查找矩阵对如何将input_ids索引转换为关联向量有更多控制，这将很有用。 - output_attentions (
bool，可选) — 是否返回所有注意力层的注意力张量。有关详细信息，请参阅返回张量中的attentions。此参数只能在急切模式下使用，在图模式下，将使用配置中的值。 - output_hidden_states (
bool，可选) — 是否返回所有层的隐藏状态。有关详细信息，请参阅返回张量中的hidden_states。此参数只能在急切模式下使用，在图模式下，将使用配置中的值。 - return_dict (
bool，可选) — 是否返回一个 ModelOutput 而不是一个简单的元组。此参数可以在急切模式下使用，在图模式下，该值将始终设置为 True。 - training (
bool，可选，默认为False) — 是否以训练模式使用模型（某些模块，如 dropout 模块，在训练和评估之间具有不同的行为）。 - labels (
tf.Tensor形状为(batch_size,)，可选) — 用于计算序列分类/回归损失的标签。索引应在[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时返回) —tf.Tensor元组（一个用于嵌入的输出，一个用于每个层的输出）形状为(batch_size, sequence_length, hidden_size)。模型在每个层的输出处的隐藏状态加上初始嵌入输出。
-
attentions (
tuple(tf.Tensor)，可选，当传递output_attentions=True或config.output_attentions=True时返回) —tf.Tensor的元组（每个层一个）形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 之后的注意力权重，用于计算自注意力头中的加权平均值。
The TFDistilBertForSequenceClassification 前向方法覆盖了 __call__ 特殊方法。
虽然正向传递的配方需要在此函数中定义，但应该在之后调用 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).lossTFDistilBertForTokenClassification
class transformers.TFDistilBertForTokenClassification
< 源代码 >( config *inputs **kwargs )
参数
- config (DistilBertConfig) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型关联的权重，仅加载配置。查看 from_pretrained() 方法以加载模型权重。
DistilBert 模型，顶部有一个令牌分类头（隐藏状态输出顶部的线性层），例如用于命名实体识别 (NER) 任务。
此模型继承自 TFPreTrainedModel。查看超类文档以了解库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入的大小、修剪头部等）。
此模型也是一个 keras.Model 子类。将其用作常规 TF 2.0 Keras 模型，并参考 TF 2.0 文档以了解与一般使用和行为相关的所有事项。
transformers 中的 TensorFlow 模型和层接受两种格式作为输入
- 将所有输入作为关键字参数（如 PyTorch 模型），或
- 将所有输入作为第一个位置参数中的列表、元组或字典。
支持第二种格式的原因是 Keras 方法在将输入传递给模型和层时更喜欢这种格式。由于这种支持，当使用 model.fit() 等方法时，事情应该会“正常运行” - 只需以 model.fit() 支持的任何格式传递您的输入和标签即可！但是，如果您想在 Keras 方法（如 fit() 和 predict()）之外使用第二种格式，例如在使用 Keras Functional API 创建自己的层或模型时，您可以使用三种方法来收集第一个位置参数中的所有输入张量
- 只有一个张量，仅包含
input_ids，其他什么都没有：model(input_ids) - 一个长度可变的列表，包含一个或多个输入张量，顺序按照文档字符串中给定的顺序：
model([input_ids, attention_mask])或model([input_ids, attention_mask, token_type_ids]) - 一个字典，其中一个或多个输入张量与文档字符串中给定的输入名称相关联：
model({"input_ids": input_ids, "token_type_ids": token_type_ids})
请注意，在使用 子类化 创建模型和层时，您无需担心这些内容，因为您可以像传递给任何其他 Python 函数一样传递输入！
call
< 源代码 >( 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 or tuple(tf.Tensor)
参数
- input_ids (
Numpy 数组或tf.Tensor形状为(batch_size, sequence_length)) — 输入序列标记在词汇表中的索引。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.call() 和 PreTrainedTokenizer.encode() 。
- attention_mask (
Numpy 数组或tf.Tensor形状为(batch_size, sequence_length), 可选) — 用于避免对填充标记索引执行注意的掩码。掩码值在[0, 1]中选择:- 1 表示未被掩码的标记，
- 0 表示被掩码的标记。
- head_mask (
Numpy 数组或tf.Tensor形状为(num_heads,)或(num_layers, num_heads), 可选) — 用于使自注意力模块中选定的头部失效的掩码。掩码值在[0, 1]中选择:- 1 表示未被掩码的头部，
- 0 表示被掩码的头部。
- inputs_embeds (
tf.Tensor形状为(batch_size, sequence_length, hidden_size), 可选) — 可选地，您可以选择直接传递嵌入表示，而不是传递input_ids。如果您想要对如何将input_ids索引转换为关联向量（相对于模型的内部嵌入查找矩阵）有更多控制，这将很有用。 - output_attentions (
bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参见返回张量中的attentions。此参数只能在急切模式下使用，在图模式下，将使用配置中的值。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参见返回张量中的hidden_states。此参数只能在急切模式下使用，在图模式下，将使用配置中的值。 - return_dict (
bool, 可选) — 是否返回 ModelOutput 而不是普通元组。此参数可以在急切模式下使用，在图模式下，该值将始终设置为 True。 - training (
bool, 可选, 默认值为False) — 是否以训练模式使用模型（某些模块，如 dropout 模块，在训练和评估之间具有不同的行为）。 - labels (
tf.Tensor形状为(batch_size, sequence_length), 可选) — 用于计算标记分类损失的标签。索引应在[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时返回) —tf.Tensor元组（一个用于嵌入的输出，一个用于每个层的输出）形状为(batch_size, sequence_length, hidden_size)。模型在每个层的输出处的隐藏状态加上初始嵌入输出。
-
attentions (
tuple(tf.Tensor)，可选，当传递output_attentions=True或config.output_attentions=True时返回) —tf.Tensor的元组（每个层一个）形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 之后的注意力权重，用于计算自注意力头中的加权平均值。
The TFDistilBertForTokenClassification 前向方法，覆盖了 __call__ 特殊方法。
虽然正向传递的配方需要在此函数中定义，但应该在之后调用 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
DistilBert 模型，顶部带有跨度分类头，用于 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() 支持的任何格式传递您的输入和标签即可！但是，如果您想在 Keras 方法（如 fit() 和 predict()）之外使用第二种格式，例如在使用 Keras Functional API 创建自己的层或模型时，您可以使用三种方法来收集第一个位置参数中的所有输入张量
- 只有一个张量，仅包含
input_ids，其他什么都没有：model(input_ids) - 一个长度可变的列表，包含一个或多个输入张量，顺序按照文档字符串中给定的顺序：
model([input_ids, attention_mask])或model([input_ids, attention_mask, token_type_ids]) - 一个字典，其中一个或多个输入张量与文档字符串中给定的输入名称相关联：
model({"input_ids": input_ids, "token_type_ids": token_type_ids})
请注意，在使用 子类化 创建模型和层时，您无需担心这些内容，因为您可以像传递给任何其他 Python 函数一样传递输入！
call
< 源代码 >( 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 (
Numpy array或tf.Tensor形状为(batch_size, sequence_length)) — 输入序列 token 在词表的索引。索引可以使用 AutoTokenizer 获取。查看 PreTrainedTokenizer.call() 和 PreTrainedTokenizer.encode() 以了解详情。
- attention_mask (
Numpy array或tf.Tensor形状为(batch_size, sequence_length), 可选) — 掩码，用于避免对填充 token 索引执行注意力。掩码值选择在[0, 1]之内：- 1 表示 **不屏蔽** 的 token，
- 0 表示 **屏蔽** 的 token。
- head_mask (
Numpy array或tf.Tensor形状为(num_heads,)或(num_layers, num_heads), 可选) — 掩码，用于使自注意力模块的选定头无效。掩码值选择在[0, 1]之内：- 1 表示 **不屏蔽** 的头，
- 0 表示 **屏蔽** 的头。
- inputs_embeds (
tf.Tensor形状为(batch_size, sequence_length, hidden_size), 可选) — 可选地，您可以选择直接传递嵌入表示，而不是传递input_ids。如果您想要更多地控制如何将input_ids索引转换为关联的向量，而不是模型内部的嵌入查找矩阵，这将非常有用。 - output_attentions (
bool, 可选) — 是否返回所有注意力层的注意力张量。查看返回张量中的attentions以了解详情。此参数只能在 eager 模式下使用，在 graph 模式下，将使用配置中的值。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。查看返回张量中的hidden_states以了解详情。此参数只能在 eager 模式下使用，在 graph 模式下，将使用配置中的值。 - return_dict (
bool, 可选) — 是否返回一个 ModelOutput 而不是一个简单的元组。此参数可以在急切模式下使用，在图模式下，该值将始终设置为 True。 - training (
bool, 可选, 默认值为False) — 是否在训练模式下使用模型（某些模块，如 dropout 模块，在训练和评估之间具有不同的行为）。 - start_positions (
tf.Tensor形状为(batch_size,), 可选) — 用于计算标记分类损失的标记跨度的开始位置（索引）的标签。位置被限制在序列的长度（sequence_length）内。序列之外的位置不会被考虑用于计算损失。 - end_positions (
tf.Tensor形状为(batch_size,), 可选) — 用于计算标记分类损失的标记跨度的结束位置（索引）的标签。位置被限制在序列的长度（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 (
tf.Tensor形状为(batch_size, ), 可选, 当提供start_positions和end_positions时返回) — 跨度提取总损失是开始和结束位置的交叉熵之和。 -
start_logits (
tf.Tensor形状为(batch_size, sequence_length)) — 跨度开始分数（在 SoftMax 之前）。 -
end_logits (
tf.Tensor形状为(batch_size, sequence_length)) — 跨度结束分数（在 SoftMax 之前）。 -
hidden_states (
tuple(tf.Tensor)，可选，当传递output_hidden_states=True或当config.output_hidden_states=True时返回) —tf.Tensor元组（一个用于嵌入的输出，一个用于每个层的输出）形状为(batch_size, sequence_length, hidden_size)。模型在每个层的输出处的隐藏状态加上初始嵌入输出。
-
attentions (
tuple(tf.Tensor)，可选，当传递output_attentions=True或config.output_attentions=True时返回) —tf.Tensor的元组（每个层一个）形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 之后的注意力权重，用于计算自注意力头中的加权平均值。
The TFDistilBertForQuestionAnswering forward method, overrides the __call__ special method.
虽然正向传递的配方需要在此函数中定义，但应该在之后调用 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
< 源代码 >( 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 Module，并参考 Flax 文档以了解有关一般使用和行为的所有事项。
最后，此模型支持 JAX 的固有特性，例如
__call__
< 源代码 >( input_ids attention_mask = None head_mask = None params: dict = None dropout_rng: PRNGKey = None train: bool = False output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None )
参数
- input_ids (
numpy.ndarray形状为(batch_size, sequence_length)) — 输入序列词元在词表的索引。可以使用 AutoTokenizer 获取索引。有关详细信息，请参见 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call() 。
- attention_mask (
numpy.ndarray形状为(batch_size, sequence_length), 可选) — 掩码，用于避免在填充词元索引上执行注意力。掩码值在[0, 1]中选择：- 1 表示未被掩码的词元，
- 0 表示被掩码的词元。
- output_attentions (
bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参见返回张量下的attentions。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参见返回张量下的hidden_states。 - return_dict (
bool, 可选) — 是否返回 ModelOutput 而不是普通元组。
FlaxDistilBertPreTrainedModel 的 forward 方法，覆盖了 __call__ 特殊方法。
虽然正向传递的配方需要在此函数中定义，但应该在之后调用 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
< 源代码 >( 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 Module，并参考 Flax 文档以了解有关一般使用和行为的所有事项。
最后，此模型支持 JAX 的固有特性，例如
__call__
< 源代码 >( input_ids attention_mask = None head_mask = None params: dict = None dropout_rng: PRNGKey = None train: bool = False output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → transformers.modeling_flax_outputs.FlaxMaskedLMOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
numpy.ndarray形状为(batch_size, sequence_length)) — 输入序列标记在词汇表中的索引。索引可以使用 AutoTokenizer 获取。有关详细信息，请参见 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
numpy.ndarray形状为(batch_size, sequence_length), 可选) — 掩码，避免对填充标记索引执行注意力。掩码值在[0, 1]中选择：- 1 代表 未屏蔽 的标记，
- 0 代表 屏蔽 的标记。
- output_attentions (
bool, 可选) — 是否返回所有注意力层的注意力张量。有关详细信息，请参见返回张量中的attentions。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。有关详细信息，请参见返回张量中的hidden_states。 - return_dict (
bool, 可选) — 是否返回 ModelOutput 而不是普通元组。
返回
transformers.modeling_flax_outputs.FlaxMaskedLMOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_flax_outputs.FlaxMaskedLMOutput 或 torch.FloatTensor 的元组（如果传递了 return_dict=False 或 config.return_dict=False 时），包含取决于配置（DistilBertConfig）和输入的不同元素。
-
logits (
jnp.ndarray形状为(batch_size, sequence_length, config.vocab_size)) — 语言建模头的预测得分（SoftMax 之前的每个词汇标记的得分）。 -
hidden_states (
tuple(jnp.ndarray), 可选, 当传递output_hidden_states=True或config.output_hidden_states=True时返回) —jnp.ndarray的元组（一个用于嵌入的输出 + 一个用于每一层的输出）形状为(batch_size, sequence_length, hidden_size)。模型在每个层的输出处的隐藏状态加上初始嵌入输出。
-
attentions (
tuple(jnp.ndarray), 可选, 当传递output_attentions=True或config.output_attentions=True时返回) —jnp.ndarray的元组（每一层一个）形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 之后的注意力权重，用于计算自注意力头中的加权平均值。
FlaxDistilBertPreTrainedModel 的 forward 方法，覆盖了 __call__ 特殊方法。
虽然正向传递的配方需要在此函数中定义，但应该在之后调用 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
< 源代码 >( 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 模型转换器，顶部带有序列分类/回归头（在池化输出之上使用线性层），例如用于 GLUE 任务。
此模型继承自 FlaxPreTrainedModel。查看超类文档以了解库为其所有模型实现的通用方法（例如，下载、保存和从 PyTorch 模型转换权重）。
此模型也是 flax.linen.Module 子类。将其用作常规的 Flax linen Module，并参考 Flax 文档以了解有关一般使用和行为的所有事项。
最后，此模型支持 JAX 的固有特性，例如
__call__
< source >( input_ids attention_mask = None head_mask = None params: dict = None dropout_rng: PRNGKey = None train: bool = False output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → transformers.modeling_flax_outputs.FlaxSequenceClassifierOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
numpy.ndarray形状为(batch_size, sequence_length)) — 输入序列词元的词典索引。索引可以使用 AutoTokenizer 获取。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
numpy.ndarray形状为(batch_size, sequence_length), 可选) — 掩码以避免对填充词元索引执行注意力。掩码值选择在[0, 1]中：- 1 表示未掩码的词元，
- 0 表示掩码的词元。
- output_attentions (
bool, 可选) — 是否返回所有注意力层的注意力张量。有关详细信息，请参阅返回张量中的attentions。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。有关详细信息，请参阅返回张量中的hidden_states。 - return_dict (
bool, 可选) — 是否返回 ModelOutput 而不是普通元组。
返回
transformers.modeling_flax_outputs.FlaxSequenceClassifierOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_flax_outputs.FlaxSequenceClassifierOutput 或一个 torch.FloatTensor 元组（如果传递了 return_dict=False 或 config.return_dict=False 时），包含根据配置 (DistilBertConfig) 和输入的不同元素。
-
logits (
jnp.ndarray形状为(batch_size, config.num_labels)) — 分类（或如果 config.num_labels==1 则为回归）分数（在 SoftMax 之前）。 -
hidden_states (
tuple(jnp.ndarray), 可选, 当传递output_hidden_states=True或config.output_hidden_states=True时返回) —jnp.ndarray的元组（一个用于嵌入的输出 + 一个用于每一层的输出）形状为(batch_size, sequence_length, hidden_size)。模型在每个层的输出处的隐藏状态加上初始嵌入输出。
-
attentions (
tuple(jnp.ndarray), 可选, 当传递output_attentions=True或config.output_attentions=True时返回) —jnp.ndarray的元组（每一层一个）形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 之后的注意力权重，用于计算自注意力头中的加权平均值。
FlaxDistilBertPreTrainedModel 的 forward 方法，覆盖了 __call__ 特殊方法。
虽然正向传递的配方需要在此函数中定义，但应该在之后调用 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 )
FlaxDistilBertForTokenClassification
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 模型，顶部有一个令牌分类头（隐藏状态输出顶部的线性层），例如用于命名实体识别 (NER) 任务。
此模型继承自 FlaxPreTrainedModel。查看超类文档以了解库为其所有模型实现的通用方法（例如，下载、保存和从 PyTorch 模型转换权重）。
此模型也是 flax.linen.Module 子类。将其用作常规的 Flax linen Module，并参考 Flax 文档以了解有关一般使用和行为的所有事项。
最后，此模型支持 JAX 的固有特性，例如
__call__
< source >( input_ids attention_mask = None head_mask = None params: dict = None dropout_rng: PRNGKey = None train: bool = False output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → transformers.modeling_flax_outputs.FlaxTokenClassifierOutput or tuple(torch.FloatTensor)
参数
- input_ids (
numpy.ndarray形状为(batch_size, sequence_length)) — 输入序列标记在词汇表中的索引。索引可以使用AutoTokenizer 获取。 查看PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call() 获取更多信息。
- attention_mask (
numpy.ndarray形状为(batch_size, sequence_length), 可选) — 掩码以避免对填充标记索引执行注意力。 掩码值选择在[0, 1]中：- 1 表示未被掩码的标记，
- 0 表示被掩码的标记。
- output_attentions (
bool, 可选) — 是否返回所有注意力层的注意力张量。 查看返回张量中的attentions获取更多信息。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。 查看返回张量中的hidden_states获取更多信息。 - return_dict (
bool, 可选) — 是否返回 ModelOutput 而不是普通元组。
返回
transformers.modeling_flax_outputs.FlaxTokenClassifierOutput or 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), 可选, 当传递output_hidden_states=True或config.output_hidden_states=True时返回) —jnp.ndarray的元组（一个用于嵌入的输出 + 一个用于每一层的输出）形状为(batch_size, sequence_length, hidden_size)。模型在每个层的输出处的隐藏状态加上初始嵌入输出。
-
attentions (
tuple(jnp.ndarray), 可选, 当传递output_attentions=True或config.output_attentions=True时返回) —jnp.ndarray的元组（每一层一个）形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 之后的注意力权重，用于计算自注意力头中的加权平均值。
FlaxDistilBertPreTrainedModel 的 forward 方法，覆盖了 __call__ 特殊方法。
虽然正向传递的配方需要在此函数中定义，但应该在之后调用 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 Module，并参考 Flax 文档以了解有关一般使用和行为的所有事项。
最后，此模型支持 JAX 的固有特性，例如
__call__
< 源代码 >( input_ids attention_mask = None head_mask = None params: dict = None dropout_rng: PRNGKey = None train: bool = False output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → transformers.modeling_flax_outputs.FlaxQuestionAnsweringModelOutput or tuple(torch.FloatTensor)
参数
- input_ids (
numpy.ndarray形状为(batch_size, sequence_length)) — 输入序列词元在词汇表中的索引。可以使用 AutoTokenizer 获取索引。查看 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call() 获取更多详情。
- attention_mask (
numpy.ndarray形状为(batch_size, sequence_length), 可选) — 掩码，用于避免对填充词元索引执行注意力。掩码值选择在[0, 1]中：- 1 代表未掩码的词元，
- 0 代表掩码的词元。
- output_attentions (
bool, 可选) — 是否返回所有注意力层的注意力张量。查看返回张量中的attentions获取更多详情。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。查看返回张量中的hidden_states获取更多详情。 - return_dict (
bool, 可选) — 是否返回 ModelOutput 而不是普通元组。
返回
transformers.modeling_flax_outputs.FlaxQuestionAnsweringModelOutput or 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), 可选, 当传递output_hidden_states=True或config.output_hidden_states=True时返回) —jnp.ndarray的元组（一个用于嵌入的输出 + 一个用于每一层的输出）形状为(batch_size, sequence_length, hidden_size)。模型在每个层的输出处的隐藏状态加上初始嵌入输出。
-
attentions (
tuple(jnp.ndarray), 可选, 当传递output_attentions=True或config.output_attentions=True时返回) —jnp.ndarray的元组（每一层一个）形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 之后的注意力权重，用于计算自注意力头中的加权平均值。
FlaxDistilBertPreTrainedModel 的 forward 方法，覆盖了 __call__ 特殊方法。
虽然正向传递的配方需要在此函数中定义，但应该在之后调用 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