Transformers 文档

QDQBERT

Transformers

加入Hugging Face社区

并获得增强型文档体验

协作模型、数据集和空间

使用加速推理的更快的示例

在文档主题之间切换

开始使用

QDQBERT

此模型仅处于维护模式，我们不接受任何更改其代码的 PR。如果您在运行此模型时遇到任何问题，请重新安装支持此模型的最后一个版本：v4.40.2。您可以通过运行以下命令来执行此操作：pip install -U transformers==4.40.2。

概述

QDQBERT 模型可以在 Hao Wu、Patrick Judd、Xiaojie Zhang、Mikhail Isaev 和 Paulius Micikevicius 撰写的深度学习推理的整数量化：原理和经验评估中找到参考。

该论文的摘要如下：

量化技术可以减小深度神经网络的规模，并通过利用高吞吐量整数指令来提高推理延迟和吞吐量。在本文中，我们回顾了量化参数的数学方面，并评估了它们在各种神经网络模型上的选择，这些模型适用于不同的应用领域，包括视觉、语音和语言。我们专注于适用于通过具有高吞吐量整数数学管道的处理器进行加速的量化技术。我们还介绍了一种用于 8 位量化的工作流程，该流程能够在所有研究的网络中保持与浮点基线相比不超过 1% 的精度，包括更难量化的模型，例如 MobileNets 和 BERT-large。

此模型由 shangz 贡献。

使用技巧

QDQBERT 模型在 BERT 模型中添加了伪量化操作（一对 QuantizeLinear/DequantizeLinear 操作）到 (i) 线性层输入和权重，(ii) matmul 输入，(iii) 残差添加输入。
QDQBERT 需要 Pytorch 量化工具包的依赖关系。要安装，请运行 pip install pytorch-quantization --extra-index-url https://pypi.ngc.nvidia.com。
QDQBERT 模型可以从 HuggingFace BERT 模型的任何检查点（例如 *google-bert/bert-base-uncased*）加载，并执行量化感知训练/后训练量化。
在 transformers/examples/research_projects/quantization-qdqbert/ 中可以找到使用 QDQBERT 模型执行 SQUAD 任务的量化感知训练和后训练量化的完整示例。

设置默认量化器

QDQBERT 模型通过 Pytorch 量化工具包中的 TensorQuantizer 在 BERT 中添加了伪量化操作（一对 QuantizeLinear/DequantizeLinear 操作）。TensorQuantizer 是用于量化张量的模块，其中 QuantDescriptor 定义了张量应该如何量化。有关更多详细信息，请参阅 Pytorch 量化工具包用户指南。

在创建 QDQBERT 模型之前，必须设置定义默认张量量化器的默认 QuantDescriptor。

示例

>>> import pytorch_quantization.nn as quant_nn
>>> from pytorch_quantization.tensor_quant import QuantDescriptor

>>> # The default tensor quantizer is set to use Max calibration method
>>> input_desc = QuantDescriptor(num_bits=8, calib_method="max")
>>> # The default tensor quantizer is set to be per-channel quantization for weights
>>> weight_desc = QuantDescriptor(num_bits=8, axis=((0,)))
>>> quant_nn.QuantLinear.set_default_quant_desc_input(input_desc)
>>> quant_nn.QuantLinear.set_default_quant_desc_weight(weight_desc)

校准

校准是指将数据样本传递给量化器并确定张量最佳缩放因子的术语。在设置张量量化器之后，可以使用以下示例来校准模型。

>>> # Find the TensorQuantizer and enable calibration
>>> for name, module in model.named_modules():
...     if name.endswith("_input_quantizer"):
...         module.enable_calib()
...         module.disable_quant()  # Use full precision data to calibrate

>>> # Feeding data samples
>>> model(x)
>>> # ...

>>> # Finalize calibration
>>> for name, module in model.named_modules():
...     if name.endswith("_input_quantizer"):
...         module.load_calib_amax()
...         module.enable_quant()

>>> # If running on GPU, it needs to call .cuda() again because new tensors will be created by calibration process
>>> model.cuda()

>>> # Keep running the quantized model
>>> # ...

导出到 ONNX

导出到 ONNX 的目的是通过 TensorRT 部署推理。伪量化将被拆分为一对 QuantizeLinear/DequantizeLinear ONNX 操作。在将 TensorQuantizer 的静态成员设置为使用 Pytorch 自己的伪量化函数后，可以将伪量化模型导出到 ONNX，按照 torch.onnx 中的说明进行操作。示例

>>> from pytorch_quantization.nn import TensorQuantizer

>>> TensorQuantizer.use_fb_fake_quant = True

>>> # Load the calibrated model
>>> ...
>>> # ONNX export
>>> torch.onnx.export(...)

资源

QDQBertConfig

class transformers.QDQBertConfig

< 源代码 >

( vocab_size = 30522 hidden_size = 768 num_hidden_layers = 12 num_attention_heads = 12 intermediate_size = 3072 hidden_act = 'gelu' hidden_dropout_prob = 0.1 attention_probs_dropout_prob = 0.1 max_position_embeddings = 512 type_vocab_size = 2 initializer_range = 0.02 layer_norm_eps = 1e-12 use_cache = True pad_token_id = 1 bos_token_id = 0 eos_token_id = 2 **kwargs )

参数

vocab_size (int, 可选, 默认值为 30522) — QDQBERT 模型的词汇量大小。定义了调用 QDQBertModel 时可由 inputs_ids 表示的不同标记的数量。
hidden_size (int, 可选, 默认值为 768) — 编码器层和池化层的维度。
num_hidden_layers (int, 可选, 默认值为 12) — Transformer 编码器中的隐藏层数量。
num_attention_heads (int, 可选, 默认值为 12) — Transformer 编码器中每个注意力层的注意力头数量。
intermediate_size (int, 可选, 默认值为 3072) — Transformer 编码器中“中间”（即前馈）层的维度。
hidden_act (str 或 function, 可选, 默认值为 "gelu") — 编码器和池化器中的非线性激活函数（函数或字符串）。如果为字符串，则支持 "gelu"、"relu"、"selu" 和 "gelu_new"。
hidden_dropout_prob (float, 可选, 默认值为 0.1) — 嵌入、编码器和池化器中所有全连接层的 dropout 概率。
attention_probs_dropout_prob (float, 可选, 默认值为 0.1) — 注意力概率的 dropout 比率。
max_position_embeddings (int, 可选, 默认值为 512) — 此模型可能使用的最大序列长度。通常将其设置为一个较大的值以防万一（例如，512 或 1024 或 2048）。
initializer_range (float, 可选, 默认值为 0.02) — 初始化所有权重矩阵的截断正态分布初始化器的标准差。
layer_norm_eps (float, 可选, 默认值为 1e-12) — 层归一化层使用的 epsilon。
is_decoder (bool, 可选, 默认值为 False) — 模型是否用作解码器。如果为 False，则模型用作编码器。
use_cache (bool, 可选, 默认值为 True) — 模型是否应该返回最后的键值注意力（并非所有模型都使用）。仅在 config.is_decoder=True 时相关。

这是一个用于存储 QDQBertModel 配置的配置类。它用于根据指定的参数实例化一个 QDQBERT 模型，定义模型架构。使用默认值实例化配置将产生与 BERT google-bert/bert-base-uncased 架构类似的配置。

配置对象继承自 PretrainedConfig，可用于控制模型输出。阅读 PretrainedConfig 的文档以了解更多信息。

示例

>>> from transformers import QDQBertModel, QDQBertConfig

>>> # Initializing a QDQBERT google-bert/bert-base-uncased style configuration
>>> configuration = QDQBertConfig()

>>> # Initializing a model from the google-bert/bert-base-uncased style configuration
>>> model = QDQBertModel(configuration)

>>> # Accessing the model configuration
>>> configuration = model.config

QDQBertModel

class transformers.QDQBertModel

< 源代码 >

( config add_pooling_layer: bool = True )

参数

config (QDQBertConfig) — 模型配置类，包含模型的所有参数。使用配置文件进行初始化不会加载与模型关联的权重，只会加载配置。查看 from_pretrained() 方法以加载模型权重。

输出原始隐藏状态的裸 QDQBERT 模型转换器，没有在其顶部添加任何特定的头部。

该模型继承自 PreTrainedModel。查看超类文档以获取库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、裁剪头部等）。

该模型也是一个 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档以了解有关一般用法和行为的所有事项。

该模型可以充当编码器（只有自注意力）以及解码器，在这种情况下，将在自注意力层之间添加一层交叉注意力，遵循 Ashish Vaswani、Noam Shazeer、Niki Parmar、Jakob Uszkoreit、Llion Jones、Aidan N. Gomez、Lukasz Kaiser 和 Illia Polosukhin 在 Attention is all you need 中描述的架构。

为了充当解码器，模型需要使用配置中的 is_decoder 参数设置为 True 来进行初始化。要在 Seq2Seq 模型中使用，模型需要使用 is_decoder 参数和 add_cross_attention 都设置为 True 来进行初始化；然后，将需要 encoder_hidden_states 作为正向传递的输入。

forward

< 源代码 >

( input_ids: Optional = None attention_mask: Optional = None token_type_ids: Optional = None position_ids: Optional = None head_mask: Optional = None inputs_embeds: Optional = None encoder_hidden_states: Optional = None encoder_attention_mask: Optional = None past_key_values: Optional = None use_cache: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → transformers.modeling_outputs.BaseModelOutputWithPoolingAndCrossAttentions 或 tuple(torch.FloatTensor)

参数

input_ids (torch.LongTensor 形状为 (batch_size, sequence_length)) — 词汇表中输入序列标记的索引。

索引可以通过 AutoTokenizer 获取。有关详细信息，请参见 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。

什么是输入 ID？
attention_mask (torch.FloatTensor 形状为 (batch_size, sequence_length), 可选) — 掩码以避免对填充标记索引执行注意力。掩码值在 [0, 1] 中选择：
- 1 用于未被掩码的标记，
- 0 用于被掩码的标记。
什么是注意力掩码？
token_type_ids (torch.LongTensor 形状为 (batch_size, sequence_length), 可选) — 段标记索引，指示输入的第一部分和第二部分。索引在 [0, 1] 中选择：
- 0 对应于句子 A 标记，
- 1 对应于句子 B 标记。
什么是标记类型 ID？
position_ids (torch.LongTensor 形状为 (batch_size, sequence_length), 可选) — 每个输入序列标记在位置嵌入中的位置索引。在范围 [0, config.max_position_embeddings - 1] 中选择。

什么是位置 ID？
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 而不是普通元组。
encoder_hidden_states (torch.FloatTensor 形状为 (batch_size, sequence_length, hidden_size), 可选) — 编码器最后一层的输出处的隐藏状态序列。如果模型配置为解码器，则在交叉注意力中使用。
encoder_attention_mask (torch.FloatTensor 形状为 (batch_size, sequence_length), 可选) — 掩码用于避免对编码器输入的填充标记索引进行注意力计算。如果模型配置为解码器，则此掩码用于交叉注意力。掩码值选择在 [0, 1] 内：
- 1 代表未被掩码的标记，
- 0 代表被掩码的标记。
past_key_values (tuple(tuple(torch.FloatTensor)) 长度为 config.n_layers，每个元组包含 4 个形状为 (batch_size, num_heads, sequence_length - 1, embed_size_per_head) 的张量) — 包含注意力块的预计算键和值隐藏状态。可以用来加速解码。

如果使用了 past_key_values，用户可以选择性地仅输入最后一个 decoder_input_ids（那些没有给定模型的过去键值状态的）形状为 (batch_size, 1)，而不是所有形状为 (batch_size, sequence_length) 的 decoder_input_ids。
use_cache (bool, 可选) — 如果设置为 True，则返回 past_key_values 键值状态，可用于加速解码（参见 past_key_values）。

transformers.modeling_outputs.BaseModelOutputWithPoolingAndCrossAttentions 或 tuple(torch.FloatTensor)

一个 transformers.modeling_outputs.BaseModelOutputWithPoolingAndCrossAttentions 或一个 torch.FloatTensor 元组（如果传递 return_dict=False 或当 config.return_dict=False 时），包含各种元素，具体取决于配置 (QDQBertConfig) 和输入。

last_hidden_state (torch.FloatTensor 形状为 (batch_size, sequence_length, hidden_size)) — 模型最后一层输出的隐藏状态序列。
pooler_output (torch.FloatTensor 形状为 (batch_size, hidden_size)) — 序列第一个标记（分类标记）的最后一层隐藏状态，经过用于辅助预训练任务的层的进一步处理。例如，对于 BERT 家族的模型，这将返回经过线性层和 tanh 激活函数处理后的分类标记。线性层权重在预训练期间从下一个句子预测（分类）目标中训练得到。
hidden_states (tuple(torch.FloatTensor), 可选, 在传递 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — torch.FloatTensor 元组（一个用于嵌入的输出，如果模型具有嵌入层，加上一个用于每一层的输出）形状为 (batch_size, sequence_length, hidden_size)。

模型在每一层输出的隐藏状态，加上可选的初始嵌入输出。
attentions (tuple(torch.FloatTensor), 可选, 在传递 output_attentions=True 或当 config.output_attentions=True 时返回) — torch.FloatTensor 元组（每一层一个）形状为 (batch_size, num_heads, sequence_length, sequence_length)。

注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
cross_attentions (tuple(torch.FloatTensor), 可选, 在传递 output_attentions=True 和 config.add_cross_attention=True 或当 config.output_attentions=True 时返回) — torch.FloatTensor 元组（每一层一个）形状为 (batch_size, num_heads, sequence_length, sequence_length)。

解码器交叉注意力层的注意力权重，在注意力 softmax 之后，用于计算交叉注意力头中的加权平均值。
past_key_values (tuple(tuple(torch.FloatTensor)), 可选, 在传递 use_cache=True 或当 config.use_cache=True 时返回) — tuple(torch.FloatTensor) 元组，长度为 config.n_layers，每个元组包含 2 个形状为 (batch_size, num_heads, sequence_length, embed_size_per_head) 的张量）并且如果 config.is_encoder_decoder=True，则可选地包含 2 个形状为 (batch_size, num_heads, encoder_sequence_length, embed_size_per_head) 的附加张量。

包含预计算的隐藏状态（自注意力块中的键和值，以及如果 config.is_encoder_decoder=True 则可选地包含交叉注意力块中的键和值），可用于（参见 past_key_values 输入）加速顺序解码。

该 QDQBertModel 正向方法覆盖了 __call__ 特殊方法。

虽然正向传递的配方需要在此函数内定义，但应该随后调用 Module 实例，而不是这个函数，因为前者负责运行前处理和后处理步骤，而后者则默默忽略它们。

示例

>>> from transformers import AutoTokenizer, QDQBertModel
>>> import torch

>>> tokenizer = AutoTokenizer.from_pretrained("google-bert/bert-base-uncased")
>>> model = QDQBertModel.from_pretrained("google-bert/bert-base-uncased")

>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")
>>> outputs = model(**inputs)

>>> last_hidden_states = outputs.last_hidden_state

QDQBertLMHeadModel

class transformers.QDQBertLMHeadModel

< 源代码 >

( config )

参数

config (QDQBertConfig) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型相关的权重，只会加载配置。查看 from_pretrained() 方法来加载模型权重。

带有语言建模头的 QDQBERT 模型，用于 CLM 微调。

该模型继承自 PreTrainedModel。查看超类文档以获取库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、裁剪头部等）。

该模型也是一个 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档以了解有关一般用法和行为的所有事项。

forward

< 源代码 >

( input_ids: Optional = None attention_mask: Optional = None token_type_ids: Optional = None position_ids: Optional = None head_mask: Optional = None inputs_embeds: Optional = None encoder_hidden_states: Optional = None encoder_attention_mask: Optional = None labels: Optional = None past_key_values: Optional = None use_cache: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → transformers.modeling_outputs.CausalLMOutputWithCrossAttentions or tuple(torch.FloatTensor)

参数

input_ids (torch.LongTensor 形状为 (batch_size, sequence_length)) — 输入序列词元在词表的索引。

可以使用 AutoTokenizer 获取索引。有关详细信息，请参见 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。

什么是输入 ID？
attention_mask (torch.FloatTensor 形状为 (batch_size, sequence_length), 可选) — 用于避免在填充词元索引上执行注意力的掩码。掩码值选择在 [0, 1] 内：
- 1 表示不掩码的词元，
- 0 表示掩码的词元。
什么是注意力掩码？
token_type_ids (torch.LongTensor 形状为 (batch_size, sequence_length), 可选) — 用于指示输入的第一部分和第二部分的段词元索引。索引选择在 [0, 1] 内：
- 0 表示句子 A 词元，
- 1 表示句子 B 词元。
什么是词元类型 ID？
position_ids (torch.LongTensor 形状为 (batch_size, sequence_length), 可选) — 输入序列词元在位置嵌入中的位置索引。选择范围为 [0, config.max_position_embeddings - 1] 内。

什么是位置 ID？
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 而不是普通元组。
encoder_hidden_states (torch.FloatTensor 形状为 (batch_size, sequence_length, hidden_size), 可选) — 编码器最后一层输出的隐藏状态序列。如果模型配置为解码器，则在交叉注意力中使用。
encoder_attention_mask (torch.FloatTensor 形状为 (batch_size, sequence_length), 可选) — 用于避免对编码器输入的填充标记索引执行注意力的掩码。如果模型配置为解码器，则此掩码用于交叉注意力。掩码值选择在 [0, 1] 中：
- 1 表示未掩码的标记，
- 0 表示掩码的标记。
labels (torch.LongTensor 形状为 (batch_size, sequence_length), 可选) — 用于计算从左到右语言建模损失（下一个词预测）的标签。索引应该在 [-100, 0, ..., config.vocab_size] 中（参见 input_ids 文档字符串）索引设置为 -100 的标记被忽略（屏蔽），损失仅针对标签 n [0, ..., config.vocab_size] 的标记计算
past_key_values (tuple(tuple(torch.FloatTensor)) 长度为 config.n_layers，每个元组包含 4 个形状为 (batch_size, num_heads, sequence_length - 1, embed_size_per_head) 的张量) — 包含预计算的注意力块的关键和值隐藏状态。可用于加速解码。

如果使用 past_key_values，则用户可以选择性地仅输入形状为 (batch_size, 1) 的最后 decoder_input_ids（那些没有为此模型提供其过去键值状态的）而不是所有形状为 (batch_size, sequence_length) 的 decoder_input_ids。
use_cache (bool, 可选) — 如果设置为 True，则返回 past_key_values 键值状态，可用于加速解码（参见 past_key_values）。

transformers.modeling_outputs.CausalLMOutputWithCrossAttentions 或 tuple(torch.FloatTensor)

A transformers.modeling_outputs.CausalLMOutputWithCrossAttentions 或 torch.FloatTensor 的元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），包含取决于配置（QDQBertConfig）和输入的不同元素。

loss (torch.FloatTensor 形状为 (1,), 可选，当提供 labels 时返回) — 语言建模损失（用于下一个标记预测）。
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 后的注意力权重，用于计算自注意力头中的加权平均值。
cross_attentions (tuple(torch.FloatTensor), 可选，当传递 output_attentions=True 或当 config.output_attentions=True 时返回) — torch.FloatTensor 的元组（每层一个），形状为 (batch_size, num_heads, sequence_length, sequence_length)。

注意力 Softmax 后的交叉注意力权重，用于计算交叉注意力头中的加权平均值。
past_key_values (tuple(tuple(torch.FloatTensor)), 可选，当传递 use_cache=True 或当 config.use_cache=True 时返回) — torch.FloatTensor 元组的元组，长度为 config.n_layers，每个元组包含自注意力和交叉注意力层的缓存键、值状态（如果模型在编码器-解码器设置中使用）。仅当 config.is_decoder = True 时才相关。

包含预计算的隐藏状态（注意力块中的键和值），可用于（参见 past_key_values 输入）加速顺序解码。

The QDQBertLMHeadModel forward method, overrides the __call__ special method.

示例

>>> from transformers import AutoTokenizer, QDQBertLMHeadModel, QDQBertConfig
>>> import torch

>>> tokenizer = AutoTokenizer.from_pretrained("google-bert/bert-base-cased")
>>> config = QDQBertConfig.from_pretrained("google-bert/bert-base-cased")
>>> config.is_decoder = True
>>> model = QDQBertLMHeadModel.from_pretrained("google-bert/bert-base-cased", config=config)

>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")
>>> outputs = model(**inputs)

>>> prediction_logits = outputs.logits

QDQBertForMaskedLM

class transformers.QDQBertForMaskedLM

< 源代码 >

( config )

参数

config (QDQBertConfig) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型关联的权重，仅加载配置。查看 from_pretrained() 方法以加载模型权重。

带有语言建模头的 QDQBERT 模型。

该模型继承自 PreTrainedModel。查看超类文档以获取库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、裁剪头部等）。

该模型也是一个 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档以了解有关一般用法和行为的所有事项。

forward

< 源代码 >

( input_ids: Optional = None attention_mask: Optional = None token_type_ids: Optional = None position_ids: Optional = None head_mask: Optional = None inputs_embeds: Optional = None encoder_hidden_states: Optional = None encoder_attention_mask: Optional = None labels: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → transformers.modeling_outputs.MaskedLMOutput 或 tuple(torch.FloatTensor)

参数

input_ids (torch.LongTensor 形状为 (batch_size, sequence_length)) — 输入序列词元在词汇表中的索引。

可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。

什么是输入 ID？
attention_mask (torch.FloatTensor 形状为 (batch_size, sequence_length), 可选) — 用于避免对填充词元索引执行注意的掩码。掩码值选自 [0, 1]:
- 1 表示未掩码的词元。
- 0 表示掩码的词元。
什么是注意力掩码？
token_type_ids (torch.LongTensor 形状为 (batch_size, sequence_length), 可选) — 用于指示输入的第一部分和第二部分的段词元索引。索引选自 [0, 1]:
- 0 对应于句子 A 词元。
- 1 对应于句子 B 词元。
什么是词元类型 ID？
position_ids (torch.LongTensor 形状为 (batch_size, sequence_length), 可选) — 位置嵌入中每个输入序列词元的位置索引。选自范围 [0, config.max_position_embeddings - 1]。

什么是位置 ID？
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。
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)

A transformers.modeling_outputs.MaskedLMOutput 或 torch.FloatTensor 元组（如果传递了 return_dict=False 或者 config.return_dict=False）包含各种元素，具体取决于配置 (QDQBertConfig) 和输入。

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 QDQBertForMaskedLM 正向方法，覆盖了 __call__ 特殊方法。

示例

>>> from transformers import AutoTokenizer, QDQBertForMaskedLM
>>> import torch

>>> tokenizer = AutoTokenizer.from_pretrained("google-bert/bert-base-uncased")
>>> model = QDQBertForMaskedLM.from_pretrained("google-bert/bert-base-uncased")

>>> inputs = tokenizer("The capital of France is [MASK].", return_tensors="pt")

>>> with torch.no_grad():
...     logits = model(**inputs).logits

>>> # retrieve index of [MASK]
>>> mask_token_index = (inputs.input_ids == tokenizer.mask_token_id)[0].nonzero(as_tuple=True)[0]

>>> predicted_token_id = logits[0, mask_token_index].argmax(axis=-1)

>>> 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)

QDQBertForSequenceClassification

class transformers.QDQBertForSequenceClassification

< 源代码 >

( config )

参数

config (QDQBertConfig) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型关联的权重，仅加载配置。查看 from_pretrained() 方法以加载模型权重。

Bert 模型转换器，在其顶部具有序列分类/回归头（池化输出顶部的线性层），例如用于 GLUE 任务。

该模型继承自 PreTrainedModel。查看超类文档以获取库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、裁剪头部等）。

该模型也是一个 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档以了解有关一般用法和行为的所有事项。

forward

< 源代码 >

( input_ids: Optional = None attention_mask: Optional = None token_type_ids: Optional = None position_ids: 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 or tuple(torch.FloatTensor)

参数

input_ids (torch.LongTensor 形状为 (batch_size, sequence_length)) — 输入序列令牌在词汇表中的索引。

索引可以使用 AutoTokenizer 获取。查看 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call() 了解更多信息。

什么是输入 ID？
attention_mask (torch.FloatTensor 形状为 (batch_size, sequence_length), 可选) — 掩码以避免对填充令牌索引执行注意力。在 [0, 1] 中选择的掩码值：
- 1 代表未掩码的令牌，
- 0 代表掩码的令牌。
什么是注意力掩码？
token_type_ids (torch.LongTensor 形状为 (batch_size, sequence_length), 可选) — 段标记索引，用于指示输入的第一部分和第二部分。索引在 [0, 1] 中选择：
- 0 对应于 句子 A 标记,
- 1 对应于 句子 B 标记.
什么是标记类型 ID？
position_ids (torch.LongTensor 形状为 (batch_size, sequence_length), 可选) — 每个输入序列标记在位置嵌入中的位置索引。在 [0, config.max_position_embeddings - 1] 范围内选择。

什么是位置 ID？
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 时），包含取决于配置（QDQBertConfig）和输入的各种元素。

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 QDQBertForSequenceClassification 正向方法，覆盖 __call__ 特殊方法。

单标签分类示例

>>> import torch
>>> from transformers import AutoTokenizer, QDQBertForSequenceClassification

>>> tokenizer = AutoTokenizer.from_pretrained("google-bert/bert-base-uncased")
>>> model = QDQBertForSequenceClassification.from_pretrained("google-bert/bert-base-uncased")

>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")

>>> with torch.no_grad():
...     logits = model(**inputs).logits

>>> predicted_class_id = logits.argmax().item()

>>> # 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 = QDQBertForSequenceClassification.from_pretrained("google-bert/bert-base-uncased", num_labels=num_labels)

>>> labels = torch.tensor([1])
>>> loss = model(**inputs, labels=labels).loss

多标签分类示例

>>> import torch
>>> from transformers import AutoTokenizer, QDQBertForSequenceClassification

>>> tokenizer = AutoTokenizer.from_pretrained("google-bert/bert-base-uncased")
>>> model = QDQBertForSequenceClassification.from_pretrained("google-bert/bert-base-uncased", problem_type="multi_label_classification")

>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")

>>> with torch.no_grad():
...     logits = model(**inputs).logits

>>> predicted_class_ids = torch.arange(0, logits.shape[-1])[torch.sigmoid(logits).squeeze(dim=0) > 0.5]

>>> # To train a model on `num_labels` classes, you can pass `num_labels=num_labels` to `.from_pretrained(...)`
>>> num_labels = len(model.config.id2label)
>>> model = QDQBertForSequenceClassification.from_pretrained(
...     "google-bert/bert-base-uncased", num_labels=num_labels, problem_type="multi_label_classification"
... )

>>> labels = torch.sum(
...     torch.nn.functional.one_hot(predicted_class_ids[None, :].clone(), num_classes=num_labels), dim=1
... ).to(torch.float)
>>> loss = model(**inputs, labels=labels).loss

QDQBertForNextSentencePrediction

class transformers.QDQBertForNextSentencePrediction

< 源代码 >

( config )

参数

配置 (QDQBertConfig) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型关联的权重，只会加载配置。查看 from_pretrained() 方法加载模型权重。

带有 `下一个句子预测（分类）` 头部的 Bert 模型。

该模型继承自 PreTrainedModel。查看超类文档以获取库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、裁剪头部等）。

该模型也是一个 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档以了解有关一般用法和行为的所有事项。

forward

< 源代码 >

( input_ids: Optional = None attention_mask: Optional = None token_type_ids: Optional = None position_ids: 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 **kwargs ) → transformers.modeling_outputs.NextSentencePredictorOutput or tuple(torch.FloatTensor)

参数

输入 ID (torch.LongTensor 形状为 (batch_size, sequence_length)) — 输入序列标记在词汇表中的索引。

索引可以使用 AutoTokenizer 获取。查看 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call() 了解更多信息。

什么是输入 ID？
注意力掩码 (torch.FloatTensor 形状为 (batch_size, sequence_length), 可选) — 掩码用于避免对填充标记索引执行注意力。掩码值在 `[0, 1]` 中选择：
- 1 表示 未屏蔽 的标记，
- 0 表示屏蔽的标记。
什么是注意力掩码？
标记类型 ID (torch.LongTensor 形状为 (batch_size, sequence_length), 可选) — 段标记索引，指示输入的第一部分和第二部分。索引在 `[0, 1]` 中选择：
- 0 对应于 句子 A 标记，
- 1 对应于 句子 B 标记。
什么是标记类型 ID？
位置 ID (torch.LongTensor 形状为 (batch_size, sequence_length), 可选) — 每个输入序列标记在位置嵌入中的位置索引。在范围 `[0, config.max_position_embeddings - 1]` 中选择。

什么是位置 ID？
头掩码 (torch.FloatTensor 形状为 (num_heads,) 或 (num_layers, num_heads), 可选) — 掩码用于使自注意力模块的选定头无效。掩码值在 `[0, 1]` 中选择：
- 1 表示 未屏蔽 的头，
- 0 表示屏蔽的头。
inputs_embeds (torch.FloatTensor of shape (batch_size, sequence_length, hidden_size), optional) — 可选，而不是传递input_ids，您可以选择直接传递嵌入式表示。如果您想要更多控制权，将如何将input_ids索引转换为相关的向量，而不是模型的内部嵌入查找矩阵，这将非常有用。
output_attentions (bool, optional) — 是否返回所有注意力层的注意力张量。详细信息请参阅返回张量中的attentions。
output_hidden_states (bool, optional) — 是否返回所有层的隐藏状态。详细信息请参阅返回张量中的hidden_states。
return_dict (bool, optional) — 是否返回一个ModelOutput，而不是一个简单的元组。
labels (torch.LongTensor of shape (batch_size,), optional) — 用于计算下一个句子预测（分类）损失的标签。输入应该是句子对（参见input_ids文档字符串）。索引应该在[0, 1]中：
- 0 表示句子 B 是句子 A 的延续，
- 1 表示句子 B 是一个随机句子。

transformers.modeling_outputs.NextSentencePredictorOutput or tuple(torch.FloatTensor)

一个transformers.modeling_outputs.NextSentencePredictorOutput 或一个torch.FloatTensor元组（如果传递了return_dict=False，或者当config.return_dict=False时），包含根据配置（QDQBertConfig）和输入而变化的各种元素。

loss (torch.FloatTensor of shape (1,), optional, returned when next_sentence_label is provided) — 下一个句子预测（分类）损失。
logits (torch.FloatTensor of shape (batch_size, 2)) — 下一个句子预测（分类）头的预测分数（在 SoftMax 之前，True/False 延续的分数）。
hidden_states (tuple(torch.FloatTensor), 可选, 在传递 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — torch.FloatTensor 元组（一个用于嵌入的输出，如果模型具有嵌入层，加上一个用于每一层的输出）形状为 (batch_size, sequence_length, hidden_size)。

模型在每一层输出的隐藏状态，加上可选的初始嵌入输出。
attentions (tuple(torch.FloatTensor), 可选, 在传递 output_attentions=True 或当 config.output_attentions=True 时返回) — torch.FloatTensor 元组（每一层一个）形状为 (batch_size, num_heads, sequence_length, sequence_length)。

注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。

The QDQBertForNextSentencePrediction forward method, overrides the __call__ special method.

示例

>>> from transformers import AutoTokenizer, QDQBertForNextSentencePrediction
>>> import torch

>>> tokenizer = AutoTokenizer.from_pretrained("google-bert/bert-base-uncased")
>>> model = QDQBertForNextSentencePrediction.from_pretrained("google-bert/bert-base-uncased")

>>> prompt = "In Italy, pizza served in formal settings, such as at a restaurant, is presented unsliced."
>>> next_sentence = "The sky is blue due to the shorter wavelength of blue light."
>>> encoding = tokenizer(prompt, next_sentence, return_tensors="pt")

>>> outputs = model(**encoding, labels=torch.LongTensor([1]))
>>> logits = outputs.logits
>>> assert logits[0, 0] < logits[0, 1]  # next sentence was random

QDQBertForMultipleChoice

class transformers.QDQBertForMultipleChoice

< source >

( config )

参数

config (QDQBertConfig) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型相关的权重，只会加载配置。查看from_pretrained()方法来加载模型权重。

Bert 模型，在顶部有一个多选分类头（在池化输出的顶部有一个线性层和一个 softmax），例如，用于 RocStories/SWAG 任务。

该模型继承自 PreTrainedModel。查看超类文档以获取库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、裁剪头部等）。

该模型也是一个 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档以了解有关一般用法和行为的所有事项。

forward

< source >

( input_ids: 可选 = None attention_mask: 可选 = None token_type_ids: 可选 = None position_ids: 可选 = None head_mask: 可选 = None inputs_embeds: 可选 = None labels: 可选 = None output_attentions: 可选 = None output_hidden_states: 可选 = None return_dict: 可选 = None ) → transformers.modeling_outputs.MultipleChoiceModelOutput 或 tuple(torch.FloatTensor)

参数

input_ids (torch.LongTensor 形状为 (batch_size, num_choices, sequence_length)) — 词汇表中输入序列标记的索引。

可以使用 AutoTokenizer 获取索引。有关详细信息，请参见 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。

什么是输入 ID？
attention_mask (torch.FloatTensor 形状为 (batch_size, num_choices, sequence_length), 可选) — 避免对填充标记索引执行注意的掩码。在 [0, 1] 中选择掩码值：
- 1 表示未掩码的标记，
- 0 表示掩码的标记。
什么是注意掩码？
token_type_ids (torch.LongTensor 形状为 (batch_size, num_choices, sequence_length), 可选) — 分段标记索引，用于指示输入的第一部分和第二部分。索引在 [0, 1] 中选择：
- 0 对应于句子 A 标记，
- 1 对应于句子 B 标记。
什么是标记类型 ID？
position_ids (torch.LongTensor 形状为 (batch_size, num_choices, sequence_length), 可选) — 位置嵌入中每个输入序列标记的位置索引。在 [0, config.max_position_embeddings - 1] 范围内选择。

什么是位置 ID？
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 时)，包括根据配置 (QDQBertConfig) 和输入的不同元素。

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 QDQBertForMultipleChoice 前向方法，覆盖了 __call__ 特殊方法。

示例

>>> from transformers import AutoTokenizer, QDQBertForMultipleChoice
>>> import torch

>>> tokenizer = AutoTokenizer.from_pretrained("google-bert/bert-base-uncased")
>>> model = QDQBertForMultipleChoice.from_pretrained("google-bert/bert-base-uncased")

>>> prompt = "In Italy, pizza served in formal settings, such as at a restaurant, is presented unsliced."
>>> choice0 = "It is eaten with a fork and a knife."
>>> choice1 = "It is eaten while held in the hand."
>>> labels = torch.tensor(0).unsqueeze(0)  # choice0 is correct (according to Wikipedia ;)), batch size 1

>>> encoding = tokenizer([prompt, prompt], [choice0, choice1], return_tensors="pt", padding=True)
>>> outputs = model(**{k: v.unsqueeze(0) for k, v in encoding.items()}, labels=labels)  # batch size is 1

>>> # the linear classifier still needs to be trained
>>> loss = outputs.loss
>>> logits = outputs.logits

QDQBertForTokenClassification

class transformers.QDQBertForTokenClassification

< 源代码 >

( config )

参数

config (QDQBertConfig) — 模型配置类，包含模型的所有参数。用配置文件初始化不会加载与模型相关的权重，只会加载配置。查看 from_pretrained() 方法来加载模型权重。

QDQBERT 模型，在顶部有一个令牌分类头 (隐藏状态输出顶部的线性层)，例如用于命名实体识别 (NER) 任务。

该模型继承自 PreTrainedModel。查看超类文档以获取库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、裁剪头部等）。

该模型也是一个 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档以了解有关一般用法和行为的所有事项。

forward

< 源代码 >

( input_ids: Optional = None attention_mask: Optional = None token_type_ids: Optional = None position_ids: 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.TokenClassifierOutput 或者 tuple(torch.FloatTensor)

参数

input_ids (torch.LongTensor 形状为 (batch_size, sequence_length)) — 输入序列令牌在词汇表中的索引。

可以使用 AutoTokenizer 获取索引。有关详细信息，请参见 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。

什么是输入 ID？
attention_mask (torch.FloatTensor 形状为 (batch_size, sequence_length)，可选) — 掩码，避免对填充令牌索引执行注意力。在 [0, 1] 中选择掩码值：
- 1 用于未掩盖的令牌。
- 0 用于掩盖的令牌。
什么是注意力掩码？
token_type_ids (torch.LongTensor 形状为 (batch_size, sequence_length), 可选) — 用于指示输入的第一部分和第二部分的段标记索引。索引在 [0, 1] 中选择：
- 0 对应于 句子 A 标记
- 1 对应于 句子 B 标记
什么是 token type IDs？
position_ids (torch.LongTensor 形状为 (batch_size, sequence_length), 可选) — 输入序列标记在位置嵌入中的位置索引。在 [0, config.max_position_embeddings - 1] 范围内选择。

什么是位置 IDs？
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, 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 时），包含根据配置 (QDQBertConfig) 和输入的不同元素。

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 后的注意力权重，用于计算自注意力头中的加权平均值。

QDQBertForTokenClassification 前向方法覆盖 __call__ 特殊方法。

示例

>>> from transformers import AutoTokenizer, QDQBertForTokenClassification
>>> import torch

>>> tokenizer = AutoTokenizer.from_pretrained("google-bert/bert-base-uncased")
>>> model = QDQBertForTokenClassification.from_pretrained("google-bert/bert-base-uncased")

>>> inputs = tokenizer(
...     "HuggingFace is a company based in Paris and New York", add_special_tokens=False, return_tensors="pt"
... )

>>> with torch.no_grad():
...     logits = model(**inputs).logits

>>> predicted_token_class_ids = logits.argmax(-1)

>>> # Note that tokens are classified rather then input words which means that
>>> # there might be more predicted token classes than words.
>>> # Multiple token classes might account for the same word
>>> predicted_tokens_classes = [model.config.id2label[t.item()] for t in predicted_token_class_ids[0]]

>>> labels = predicted_token_class_ids
>>> loss = model(**inputs, labels=labels).loss

QDQBertForQuestionAnswering

class transformers.QDQBertForQuestionAnswering

( config )

参数

config (QDQBertConfig) — 模型配置类，包含模型的所有参数。使用配置文件进行初始化不会加载与模型相关的权重，只会加载配置。查看 from_pretrained() 方法来加载模型权重。

QDQBERT 模型，顶部带有一个跨度分类头部，用于抽取式问答任务，如 SQuAD（在隐藏状态输出的顶部进行线性层计算，以计算 span start logits 和 span end logits）。

该模型继承自 PreTrainedModel。查看超类文档以获取库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、裁剪头部等）。

该模型也是一个 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档以了解有关一般用法和行为的所有事项。

forward

< 源代码 >

( input_ids: Optional = None attention_mask: Optional = None token_type_ids: Optional = None position_ids: 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, sequence_length)) — 输入序列词元在词表的索引。

可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。

什么是 input IDs?
attention_mask (torch.FloatTensor 形状为 (batch_size, sequence_length)，可选) — 掩码，避免对填充词元索引执行注意力。掩码值选择在 [0, 1] 中：
- 1 表示 未掩码 的词元，
- 0 表示掩码的词元。
什么是注意力掩码?
token_type_ids (torch.LongTensor 形状为 (batch_size, sequence_length)，可选) — 段词元索引，用于指示输入的第一部分和第二部分。索引选择在 [0, 1] 中：
- 0 对应于 句子 A 词元，
- 1 对应于 句子 B 词元。
什么是词元类型 ID?
position_ids (torch.LongTensor 形状为 (batch_size, sequence_length)，可选) — 输入序列词元在位置嵌入中的位置索引。选择在 [0, config.max_position_embeddings - 1] 范围内。

什么是位置 ID?
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 而不是普通元组。
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 时），包含根据配置 (QDQBertConfig) 和输入的不同元素。

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 QDQBertForQuestionAnswering 正向方法，覆盖 __call__ 特殊方法。

示例

>>> from transformers import AutoTokenizer, QDQBertForQuestionAnswering
>>> import torch

>>> tokenizer = AutoTokenizer.from_pretrained("google-bert/bert-base-uncased")
>>> model = QDQBertForQuestionAnswering.from_pretrained("google-bert/bert-base-uncased")

>>> question, text = "Who was Jim Henson?", "Jim Henson was a nice puppet"

>>> inputs = tokenizer(question, text, return_tensors="pt")
>>> with torch.no_grad():
...     outputs = model(**inputs)

>>> answer_start_index = outputs.start_logits.argmax()
>>> answer_end_index = outputs.end_logits.argmax()

>>> predict_answer_tokens = inputs.input_ids[0, answer_start_index : answer_end_index + 1]

>>> # 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

< > 在 GitHub 上更新

←ProphetNet Qwen2→