Transformers 文件
QDQBERT
並獲得增強的文件體驗
開始使用
QDQBERT
該模型僅處於維護模式，我們不接受任何更改其程式碼的新 PR。如果您在執行此模型時遇到任何問題，請重新安裝支援此模型的最後一個版本：v4.40.2。您可以透過執行以下命令來執行此操作：pip install -U transformers==4.40.2。
概述
QDQBERT 模型可參考 Hao Wu, Patrick Judd, Xiaojie Zhang, Mikhail Isaev 和 Paulius Micikevicius 的論文 《深度學習推理的整數量化：原理和實證評估》 (Integer Quantization for Deep Learning Inference: Principles and Empirical Evaluation)。
論文摘要如下：
量化技術可以透過利用高吞吐量的整數指令來減小深度神經網路的大小，並提高推理延遲和吞吐量。在本文中，我們回顧了量化引數的數學方面，並在各種神經網路模型上評估了它們的選擇，這些模型涵蓋了視覺、語音和語言等不同應用領域。我們專注於適用於具有高吞吐量整數數學流水線處理器的量化技術。我們還提出了一個 8 位量化工作流，該工作流能夠在所有研究的網路上保持精度在浮點基線的 1% 以內，包括那些更難量化的模型，如 MobileNets 和 BERT-large。
此模型由 shangz 貢獻。
使用技巧
- QDQBERT 模型在 BERT 模型中向 (i) 線性層的輸入和權重，(ii) 矩陣乘法輸入，(iii) 殘差加法輸入添加了偽量化操作（QuantizeLinear/DequantizeLinear 操作對）。
- QDQBERT 需要依賴 Pytorch Quantization Toolkit。安裝命令：
pip install pytorch-quantization --extra-index-url https://pypi.ngc.nvidia.com - QDQBERT 模型可以從 HuggingFace BERT 模型的任何檢查點載入（例如 google-bert/bert-base-uncased），並執行量化感知訓練/訓練後量化。
- 一個使用 QDQBERT 模型為 SQUAD 任務執行量化感知訓練和訓練後量化的完整示例可以在 https://github.com/huggingface/transformers-research-projects/tree/main/quantization-qdqbert 找到。
設定預設量化器
QDQBERT 模型透過 Pytorch Quantization Toolkit 中的 TensorQuantizer 向 BERT 新增偽量化操作（QuantizeLinear/DequantizeLinear 操作對）。TensorQuantizer 是用於量化張量的模組，其中 QuantDescriptor 定義了張量應如何被量化。更多細節請參考 Pytorch Quantization Toolkit 使用者指南。
在建立 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) — 嵌入層、編碼器和池化器中所有全連線層的丟棄機率。 - attention_probs_dropout_prob (
float，可選，預設為 0.1) — 注意力機率的丟棄率。 - max_position_embeddings (
int，可選，預設為 512) — 此模型可能使用的最大序列長度。通常，將其設定為一個較大的值以備不時之需（例如，512、1024 或 2048）。 - type_vocab_size (
int，可選，預設為 2) — 呼叫 QDQBertModel 時傳遞的token_type_ids的詞彙表大小。 - 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.configQDQBertModel
class transformers.QDQBertModel
< 源 >( config add_pooling_layer: bool = True )
引數
- config (QDQBertConfig) — 模型配置類，包含模型的所有引數。使用配置檔案初始化不會載入與模型相關的權重，只會載入配置。請檢視 from_pretrained() 方法來載入模型權重。
基礎的 QDQBERT Transformer 模型，輸出原始的隱藏狀態，頂部沒有任何特定的頭。
該模型繼承自 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: typing.Optional[torch.LongTensor] = None attention_mask: typing.Optional[torch.FloatTensor] = None token_type_ids: typing.Optional[torch.LongTensor] = None position_ids: typing.Optional[torch.LongTensor] = None head_mask: typing.Optional[torch.FloatTensor] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None encoder_hidden_states: typing.Optional[torch.FloatTensor] = None encoder_attention_mask: typing.Optional[torch.FloatTensor] = None past_key_values: typing.Optional[tuple[tuple[torch.FloatTensor]]] = None use_cache: typing.Optional[bool] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.modeling_outputs.BaseModelOutputWithPoolingAndCrossAttentions 或 tuple(torch.FloatTensor)
引數
- input_ids (
torch.LongTensor，形狀為(batch_size, sequence_length)) — 詞彙表中輸入序列標記的索引。可以使用 AutoTokenizer 獲取索引。有關詳細資訊，請參閱 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- 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 的標記。
- position_ids (
torch.LongTensor，形狀為(batch_size, sequence_length), 可選) — 每個輸入序列標記在位置嵌入中的位置索引。在範圍[0, config.max_position_embeddings - 1]內選擇。 - 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 (
Cache, 可選, 當傳遞use_cache=True或config.use_cache=True時返回) — 這是一個 Cache 例項。有關更多詳細資訊，請參閱我們的 kv 快取指南。包含預先計算的隱藏狀態（自注意力塊中的鍵和值，以及當
config.is_encoder_decoder=True時可選地在交叉注意力塊中），可用於（參見past_key_values輸入）加速序列解碼。
QDQBertModel 的 forward 方法覆蓋了 __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_stateQDQBertLMHeadModel
class transformers.QDQBertLMHeadModel
< 原始碼 >( config )
引數
- config (QDQBertConfig) — 模型配置類，包含模型的所有引數。使用配置檔案初始化不會載入與模型相關的權重，只會載入配置。請檢視 from_pretrained() 方法來載入模型權重。
QDQBERT 模型，頂部帶有一個用於因果語言模型（CLM）微調的 `language modeling` 頭。
該模型繼承自 PreTrainedModel。請檢視超類的文件以瞭解該庫為其所有模型實現的通用方法（例如下載或儲存、調整輸入嵌入大小、修剪注意力頭等）。
該模型也是 PyTorch torch.nn.Module 的子類。可以像常規的 PyTorch 模組一樣使用它，並參考 PyTorch 文件瞭解所有與通用用法和行為相關的事項。
forward
< 原始碼 >( input_ids: typing.Optional[torch.LongTensor] = None attention_mask: typing.Optional[torch.Tensor] = None token_type_ids: typing.Optional[torch.LongTensor] = None position_ids: typing.Optional[torch.LongTensor] = None head_mask: typing.Optional[torch.Tensor] = None inputs_embeds: typing.Optional[torch.Tensor] = None encoder_hidden_states: typing.Optional[torch.FloatTensor] = None encoder_attention_mask: typing.Optional[torch.FloatTensor] = None labels: typing.Optional[torch.LongTensor] = None past_key_values: typing.Optional[tuple[tuple[torch.LongTensor]]] = None use_cache: typing.Optional[bool] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.modeling_outputs.CausalLMOutputWithCrossAttentions 或 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 表示標記已被遮蔽。
- token_type_ids (
torch.LongTensor，形狀為(batch_size, sequence_length), 可選) — 用於指示輸入的第一部分和第二部分的段標記索引。索引在[0, 1]中選擇：- 0 對應於 句子 A 的標記，
- 1 對應於 句子 B 的標記。
- position_ids (
torch.LongTensor，形狀為(batch_size, sequence_length), 可選) — 每個輸入序列標記在位置嵌入中的位置索引。在範圍[0, config.max_position_embeddings - 1]內選擇。 - 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的標記會被忽略（遮蔽），損失僅對標籤在[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，使用者可以只輸入最後一個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.CausalLMOutputWithCrossAttentions 或 tuple(torch.FloatTensor)
一個 transformers.modeling_outputs.CausalLMOutputWithCrossAttentions 或一個 torch.FloatTensor 的元組（如果傳遞了 return_dict=False 或當 config.return_dict=False 時），包含根據配置（QDQBertConfig）和輸入的不同元素。
-
loss (
torch.FloatTensor形狀為(1,)，可選，當提供labels時返回) — 語言建模損失（用於下一個 token 預測）。 -
logits (形狀為
(batch_size, sequence_length, config.vocab_size)的torch.FloatTensor) — 語言建模頭部的預測分數（SoftMax 之前的每個詞彙標記的分數）。 -
hidden_states (
tuple(torch.FloatTensor), 可選, 當傳遞output_hidden_states=True或config.output_hidden_states=True時返回) —torch.FloatTensor的元組（一個用於嵌入層的輸出，如果模型有嵌入層，+ 每個層的輸出），形狀為(batch_size, sequence_length, hidden_size)。模型在每個層輸出的隱藏狀態以及可選的初始嵌入輸出。
-
attentions (
tuple(torch.FloatTensor), 可選, 當傳遞output_attentions=True或config.output_attentions=True時返回) —torch.FloatTensor的元組（每層一個），形狀為(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 後的注意力權重，用於計算自注意力頭中的加權平均值。
-
cross_attentions (
tuple(torch.FloatTensor), 可選, 當傳遞output_attentions=True或config.output_attentions=True時返回) —torch.FloatTensor的元組（每層一個），形狀為(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 後的交叉注意力權重，用於計算交叉注意力頭中的加權平均。
-
past_key_values (
Cache, 可選, 當傳遞use_cache=True或config.use_cache=True時返回) — 這是一個 Cache 例項。有關更多詳細資訊，請參閱我們的 kv 快取指南。包含預先計算的隱藏狀態（注意力塊中的鍵和值），可用於（參見
past_key_values輸入）加速順序解碼。
QDQBertLMHeadModel 的 forward 方法覆蓋了 __call__ 特殊方法。
雖然前向傳遞的邏輯需要在此函式內定義，但之後應該呼叫 Module 例項而不是這個函式，因為前者會處理前處理和後處理步驟，而後者會靜默地忽略它們。
示例
>>> 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.logitsQDQBertForMaskedLM
class transformers.QDQBertForMaskedLM
< 原始碼 >( config )
引數
- config (QDQBertConfig) — 模型配置類，包含模型的所有引數。使用配置檔案初始化不會載入與模型相關的權重，只會載入配置。請檢視 from_pretrained() 方法來載入模型權重。
QDQBERT 模型，頂部帶有一個 `language modeling` 頭。
該模型繼承自 PreTrainedModel。請檢視超類的文件以瞭解該庫為其所有模型實現的通用方法（例如下載或儲存、調整輸入嵌入大小、修剪注意力頭等）。
該模型也是 PyTorch torch.nn.Module 的子類。可以像常規的 PyTorch 模組一樣使用它，並參考 PyTorch 文件瞭解所有與通用用法和行為相關的事項。
forward
< 原始碼 >( input_ids: typing.Optional[torch.LongTensor] = None attention_mask: typing.Optional[torch.FloatTensor] = None token_type_ids: typing.Optional[torch.LongTensor] = None position_ids: typing.Optional[torch.LongTensor] = None head_mask: typing.Optional[torch.FloatTensor] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None encoder_hidden_states: typing.Optional[torch.FloatTensor] = None encoder_attention_mask: typing.Optional[torch.FloatTensor] = None labels: typing.Optional[torch.LongTensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.modeling_outputs.MaskedLMOutput 或 tuple(torch.FloatTensor)
引數
- input_ids (
torch.LongTensor，形狀為(batch_size, sequence_length)) — 詞彙表中輸入序列標記的索引。可以使用 AutoTokenizer 獲取索引。有關詳細資訊，請參閱 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- 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 的標記。
- position_ids (
torch.LongTensor，形狀為(batch_size, sequence_length), 可選) — 每個輸入序列標記在位置嵌入中的位置索引。在範圍[0, config.max_position_embeddings - 1]內選擇。 - 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)，可選) — 用於計算掩碼語言建模損失的標籤。索引應在[-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），根據配置 (QDQBertConfig) 和輸入包含各種元素。
-
loss (形狀為
(1,)的torch.FloatTensor，可選，當提供labels時返回) — 掩碼語言建模 (MLM) 損失。 -
logits (形狀為
(batch_size, sequence_length, config.vocab_size)的torch.FloatTensor) — 語言建模頭部的預測分數（SoftMax 之前的每個詞彙標記的分數）。 -
hidden_states (
tuple(torch.FloatTensor), 可選, 當傳遞output_hidden_states=True或config.output_hidden_states=True時返回) —torch.FloatTensor的元組（一個用於嵌入層的輸出，如果模型有嵌入層，+ 每個層的輸出），形狀為(batch_size, sequence_length, hidden_size)。模型在每個層輸出的隱藏狀態以及可選的初始嵌入輸出。
-
attentions (
tuple(torch.FloatTensor), 可選, 當傳遞output_attentions=True或config.output_attentions=True時返回) —torch.FloatTensor的元組（每層一個），形狀為(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 後的注意力權重，用於計算自注意力頭中的加權平均值。
QDQBertForMaskedLM 的 forward 方法重寫了 __call__ 特殊方法。
雖然前向傳遞的邏輯需要在此函式內定義，但之後應該呼叫 Module 例項而不是這個函式，因為前者會處理前處理和後處理步驟，而後者會靜默地忽略它們。
示例
>>> 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: typing.Optional[torch.LongTensor] = None attention_mask: typing.Optional[torch.FloatTensor] = None token_type_ids: typing.Optional[torch.LongTensor] = None position_ids: typing.Optional[torch.LongTensor] = None head_mask: typing.Optional[torch.FloatTensor] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None labels: typing.Optional[torch.LongTensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.modeling_outputs.SequenceClassifierOutput 或 tuple(torch.FloatTensor)
引數
- input_ids (
torch.LongTensor，形狀為(batch_size, sequence_length)) — 詞彙表中輸入序列標記的索引。可以使用 AutoTokenizer 獲取索引。有關詳細資訊，請參閱 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- 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* 標記。
- position_ids (
torch.LongTensor，形狀為(batch_size, sequence_length)，可選) — 每個輸入序列標記在位置嵌入中的位置索引。在[0, config.max_position_embeddings - 1]範圍內選擇。 - 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 (形狀為
(1,)的torch.FloatTensor，可選，當提供labels時返回) — 分類損失（如果 config.num_labels==1，則為迴歸損失）。 -
logits (形狀為
(batch_size, config.num_labels)的torch.FloatTensor) — 分類（如果 config.num_labels==1，則為迴歸）分數（SoftMax 之前）。 -
hidden_states (
tuple(torch.FloatTensor), 可選, 當傳遞output_hidden_states=True或config.output_hidden_states=True時返回) —torch.FloatTensor的元組（一個用於嵌入層的輸出，如果模型有嵌入層，+ 每個層的輸出），形狀為(batch_size, sequence_length, hidden_size)。模型在每個層輸出的隱藏狀態以及可選的初始嵌入輸出。
-
attentions (
tuple(torch.FloatTensor), 可選, 當傳遞output_attentions=True或config.output_attentions=True時返回) —torch.FloatTensor的元組（每層一個），形狀為(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 後的注意力權重，用於計算自注意力頭中的加權平均值。
QDQBertForSequenceClassification 的 forward 方法重寫了 __call__ 特殊方法。
雖然前向傳遞的邏輯需要在此函式內定義，但之後應該呼叫 Module 例項而不是這個函式，因為前者會處理前處理和後處理步驟，而後者會靜默地忽略它們。
單標籤分類示例
>>> 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).lossQDQBertForNextSentencePrediction
class transformers.QDQBertForNextSentencePrediction
< 來源 >( config )
引數
- config (QDQBertConfig) — 包含模型所有引數的模型配置類。使用配置檔案進行初始化不會載入與模型關聯的權重，只會載入配置。請檢視 from_pretrained() 方法來載入模型權重。
Bert 模型，在其頂部帶有一個 `下一句預測 (分類)` 頭。
該模型繼承自 PreTrainedModel。請檢視超類的文件以瞭解該庫為其所有模型實現的通用方法（例如下載或儲存、調整輸入嵌入大小、修剪注意力頭等）。
該模型也是 PyTorch torch.nn.Module 的子類。可以像常規的 PyTorch 模組一樣使用它，並參考 PyTorch 文件瞭解所有與通用用法和行為相關的事項。
forward
< 來源 >( input_ids: typing.Optional[torch.LongTensor] = None attention_mask: typing.Optional[torch.FloatTensor] = None token_type_ids: typing.Optional[torch.LongTensor] = None position_ids: typing.Optional[torch.LongTensor] = None head_mask: typing.Optional[torch.FloatTensor] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None labels: typing.Optional[torch.LongTensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None **kwargs ) → transformers.modeling_outputs.NextSentencePredictorOutput 或 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 表示標記被掩碼。
- token_type_ids (
torch.LongTensor，形狀為(batch_size, sequence_length)，可選) — 段標記索引，用於指示輸入的第一部分和第二部分。索引在[0, 1]中選擇：- 0 對應於 *句子 A* 標記，
- 1 對應於 *句子 B* 標記。
- position_ids (
torch.LongTensor，形狀為(batch_size, sequence_length)，可選) — 每個輸入序列標記在位置嵌入中的位置索引。在[0, config.max_position_embeddings - 1]範圍內選擇。 - 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,)，可選) — 用於計算下一句預測（分類）損失的標籤。輸入應該是一個序列對（參見input_ids文件字串）。索引應在[0, 1]中：- 0 表示序列 B 是序列 A 的延續，
- 1 表示序列 B 是一個隨機序列。
返回
transformers.modeling_outputs.NextSentencePredictorOutput 或 tuple(torch.FloatTensor)
一個 transformers.modeling_outputs.NextSentencePredictorOutput 或一個 torch.FloatTensor 的元組（如果傳入 return_dict=False 或 config.return_dict=False），根據配置 (QDQBertConfig) 和輸入包含各種元素。
-
loss (
torch.FloatTensor，形狀為(1,)，可選，當提供next_sentence_label時返回) — 下一個序列預測（分類）損失。 -
logits (
torch.FloatTensor，形狀為(batch_size, 2)) — 下一個序列預測（分類）頭的預測分數（SoftMax 之前的真/假延續分數）。 -
hidden_states (
tuple(torch.FloatTensor), 可選, 當傳遞output_hidden_states=True或config.output_hidden_states=True時返回) —torch.FloatTensor的元組（一個用於嵌入層的輸出，如果模型有嵌入層，+ 每個層的輸出），形狀為(batch_size, sequence_length, hidden_size)。模型在每個層輸出的隱藏狀態以及可選的初始嵌入輸出。
-
attentions (
tuple(torch.FloatTensor), 可選, 當傳遞output_attentions=True或config.output_attentions=True時返回) —torch.FloatTensor的元組（每層一個），形狀為(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 後的注意力權重，用於計算自注意力頭中的加權平均值。
QDQBertForNextSentencePrediction 的 forward 方法重寫了 __call__ 特殊方法。
雖然前向傳遞的邏輯需要在此函式內定義，但之後應該呼叫 Module 例項而不是這個函式，因為前者會處理前處理和後處理步驟，而後者會靜默地忽略它們。
示例
>>> 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 randomQDQBertForMultipleChoice
class transformers.QDQBertForMultipleChoice
< 來源 >( config )
引數
- config (QDQBertConfig) — 包含模型所有引數的模型配置類。使用配置檔案進行初始化不會載入與模型關聯的權重，只會載入配置。請檢視 from_pretrained() 方法來載入模型權重。
Bert 模型，在其頂部帶有一個多項選擇分類頭（在池化輸出之上是一個線性層和一個 softmax），例如用於 RocStories/SWAG 任務。
該模型繼承自 PreTrainedModel。請檢視超類的文件以瞭解該庫為其所有模型實現的通用方法（例如下載或儲存、調整輸入嵌入大小、修剪注意力頭等）。
該模型也是 PyTorch torch.nn.Module 的子類。可以像常規的 PyTorch 模組一樣使用它，並參考 PyTorch 文件瞭解所有與通用用法和行為相關的事項。
forward
< 來源 >( input_ids: typing.Optional[torch.LongTensor] = None attention_mask: typing.Optional[torch.FloatTensor] = None token_type_ids: typing.Optional[torch.LongTensor] = None position_ids: typing.Optional[torch.LongTensor] = None head_mask: typing.Optional[torch.FloatTensor] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None labels: typing.Optional[torch.LongTensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.modeling_outputs.MultipleChoiceModelOutput 或 tuple(torch.FloatTensor)
引數
- input_ids (
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 表示標記被掩碼。
- token_type_ids (
torch.LongTensor，形狀為(batch_size, num_choices, sequence_length)，可選) — 段標記索引，用於指示輸入的第一部分和第二部分。索引在[0, 1]中選擇：- 0 對應於 *句子 A* 標記，
- 1 對應於 *句子 B* 標記。
- position_ids (
torch.LongTensor，形狀為(batch_size, num_choices, sequence_length)，可選) — 每個輸入序列標記在位置嵌入中的位置索引。在[0, config.max_position_embeddings - 1]範圍內選擇。 - head_mask (
torch.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 (形狀為 (1,) 的
torch.FloatTensor，可選，當提供labels時返回) — 分類損失。 -
logits (形狀為
(batch_size, num_choices)的torch.FloatTensor) — num_choices 是輸入張量的第二維大小。（請參閱上面的 input_ids）。分類分數（SoftMax 之前）。
-
hidden_states (
tuple(torch.FloatTensor), 可選, 當傳遞output_hidden_states=True或config.output_hidden_states=True時返回) —torch.FloatTensor的元組（一個用於嵌入層的輸出，如果模型有嵌入層，+ 每個層的輸出），形狀為(batch_size, sequence_length, hidden_size)。模型在每個層輸出的隱藏狀態以及可選的初始嵌入輸出。
-
attentions (
tuple(torch.FloatTensor), 可選, 當傳遞output_attentions=True或config.output_attentions=True時返回) —torch.FloatTensor的元組（每層一個），形狀為(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 後的注意力權重，用於計算自注意力頭中的加權平均值。
QDQBertForMultipleChoice 的 forward 方法重寫了 __call__ 特殊方法。
雖然前向傳遞的邏輯需要在此函式內定義，但之後應該呼叫 Module 例項而不是這個函式，因為前者會處理前處理和後處理步驟，而後者會靜默地忽略它們。
示例
>>> 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.logitsQDQBertForTokenClassification
class transformers.QDQBertForTokenClassification
< 來源 >( config )
引數
- config (QDQBertConfig) — 包含模型所有引數的模型配置類。使用配置檔案進行初始化不會載入與模型關聯的權重，只會載入配置。請檢視 from_pretrained() 方法來載入模型權重。
QDQBERT 模型，在其頂部帶有一個標記分類頭（在隱藏狀態輸出之上是一個線性層），例如用於命名實體識別（NER）任務。
該模型繼承自 PreTrainedModel。請檢視超類的文件以瞭解該庫為其所有模型實現的通用方法（例如下載或儲存、調整輸入嵌入大小、修剪注意力頭等）。
該模型也是 PyTorch torch.nn.Module 的子類。可以像常規的 PyTorch 模組一樣使用它，並參考 PyTorch 文件瞭解所有與通用用法和行為相關的事項。
forward
< 來源 >( input_ids: typing.Optional[torch.LongTensor] = None attention_mask: typing.Optional[torch.FloatTensor] = None token_type_ids: typing.Optional[torch.LongTensor] = None position_ids: typing.Optional[torch.LongTensor] = None head_mask: typing.Optional[torch.FloatTensor] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None labels: typing.Optional[torch.LongTensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.modeling_outputs.TokenClassifierOutput 或 tuple(torch.FloatTensor)
引數
- input_ids (
torch.LongTensor，形狀為(batch_size, sequence_length)) — 詞彙表中輸入序列標記的索引。可以使用 AutoTokenizer 獲取索引。有關詳細資訊，請參閱 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- 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 的標記。
- position_ids (
torch.LongTensor，形狀為(batch_size, sequence_length)，可選) — 每個輸入序列標記在位置嵌入中的位置索引。選自範圍[0, config.max_position_embeddings - 1]。 - 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 (形狀為
(1,)的torch.FloatTensor，可選，當提供labels時返回) — 分類損失。 -
logits (形狀為
(batch_size, sequence_length, config.num_labels)的torch.FloatTensor) — 分類分數（SoftMax 之前）。 -
hidden_states (
tuple(torch.FloatTensor), 可選, 當傳遞output_hidden_states=True或config.output_hidden_states=True時返回) —torch.FloatTensor的元組（一個用於嵌入層的輸出，如果模型有嵌入層，+ 每個層的輸出），形狀為(batch_size, sequence_length, hidden_size)。模型在每個層輸出的隱藏狀態以及可選的初始嵌入輸出。
-
attentions (
tuple(torch.FloatTensor), 可選, 當傳遞output_attentions=True或config.output_attentions=True時返回) —torch.FloatTensor的元組（每層一個），形狀為(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 後的注意力權重，用於計算自注意力頭中的加權平均值。
QDQBertForTokenClassification 的 forward 方法重寫了 __call__ 特殊方法。
雖然前向傳遞的邏輯需要在此函式內定義，但之後應該呼叫 Module 例項而不是這個函式，因為前者會處理前處理和後處理步驟，而後者會靜默地忽略它們。
示例
>>> 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).lossQDQBertForQuestionAnswering
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: typing.Optional[torch.LongTensor] = None attention_mask: typing.Optional[torch.FloatTensor] = None token_type_ids: typing.Optional[torch.LongTensor] = None position_ids: typing.Optional[torch.LongTensor] = None head_mask: typing.Optional[torch.FloatTensor] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None start_positions: typing.Optional[torch.LongTensor] = None end_positions: typing.Optional[torch.LongTensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.modeling_outputs.QuestionAnsweringModelOutput 或 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 表示標記已被掩碼。
- token_type_ids (
torch.LongTensor，形狀為(batch_size, sequence_length)，可選) — 片段標記索引，用於指示輸入的第一部分和第二部分。索引選自[0, 1]：- 0 對應於句子 A 的標記，
- 1 對應於句子 B 的標記。
- position_ids (
torch.LongTensor，形狀為(batch_size, sequence_length)，可選) — 每個輸入序列標記在位置嵌入中的位置索引。選自範圍[0, config.max_position_embeddings - 1]。 - 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.FloatTensorof shape(1,), 可選, 當提供labels時返回) — 總範圍提取損失是起始位置和結束位置的交叉熵之和。 -
start_logits (
torch.FloatTensorof shape(batch_size, sequence_length)) — 範圍起始分數（SoftMax 之前）。 -
end_logits (
torch.FloatTensorof shape(batch_size, sequence_length)) — 範圍結束分數（SoftMax 之前）。 -
hidden_states (
tuple(torch.FloatTensor), 可選, 當傳遞output_hidden_states=True或config.output_hidden_states=True時返回) —torch.FloatTensor的元組（一個用於嵌入層的輸出，如果模型有嵌入層，+ 每個層的輸出），形狀為(batch_size, sequence_length, hidden_size)。模型在每個層輸出的隱藏狀態以及可選的初始嵌入輸出。
-
attentions (
tuple(torch.FloatTensor), 可選, 當傳遞output_attentions=True或config.output_attentions=True時返回) —torch.FloatTensor的元組（每層一個），形狀為(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 後的注意力權重，用於計算自注意力頭中的加權平均值。
QDQBertForQuestionAnswering 的 forward 方法重寫了 __call__ 特殊方法。
雖然前向傳遞的邏輯需要在此函式內定義，但之後應該呼叫 Module 例項而不是這個函式，因為前者會處理前處理和後處理步驟，而後者會靜默地忽略它們。
示例
>>> 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