Transformers 文件
DistilBERT
並獲得增強的文件體驗
開始使用
DistilBERT
DistilBERT 透過知識蒸餾進行預訓練，以建立一個更小的模型，從而實現更快的推理速度並減少訓練所需的計算量。透過預訓練期間的三重損失目標（語言模型損失、蒸餾損失、餘弦距離損失），DistilBERT 表現出與大型 Transformer 語言模型相似的效能。
你可以在 DistilBERT 組織下找到所有原始的 DistilBERT 檢查點。
點選右側邊欄中的 DistilBERT 模型，檢視更多將 DistilBERT 應用於不同語言任務的示例。
以下示例展示瞭如何使用 Pipeline、AutoModel 和命令列對文字進行分類。
from transformers import pipeline
classifier = pipeline(
task="text-classification",
model="distilbert-base-uncased-finetuned-sst-2-english",
torch_dtype=torch.float16,
device=0
)
result = classifier("I love using Hugging Face Transformers!")
print(result)
# Output: [{'label': 'POSITIVE', 'score': 0.9998}]注意事項
- DistilBERT 沒有 `token_type_ids`，你不需要指示哪個 token 屬於哪個 segment。只需使用分隔符 `tokenizer.sep_token`（或 `[SEP]`）分隔你的 segment 即可。
- DistilBERT 沒有選擇輸入位置（`position_ids` 輸入）的選項。如果需要，可以新增此選項，只需告知我們。
DistilBertConfig
class transformers.DistilBertConfig
< 來源 >( vocab_size = 30522 max_position_embeddings = 512 sinusoidal_pos_embds = False n_layers = 6 n_heads = 12 dim = 768 hidden_dim = 3072 dropout = 0.1 attention_dropout = 0.1 activation = 'gelu' initializer_range = 0.02 qa_dropout = 0.1 seq_classif_dropout = 0.2 pad_token_id = 0 **kwargs )
引數
- vocab_size (
int, 可選, 預設為 30522) — DistilBERT 模型的詞彙量大小。定義了呼叫 DistilBertModel 或 TFDistilBertModel 時傳遞的inputs_ids可以表示的不同 token 的數量。 - max_position_embeddings (
int, 可選, 預設為 512) — 此模型可能使用的最大序列長度。通常設定為一個較大的值以備不時之需（例如，512、1024 或 2048）。 - sinusoidal_pos_embds (
boolean, 可選, 預設為False) — 是否使用正弦位置嵌入。 - n_layers (
int, 可選, 預設為 6) — Transformer 編碼器中的隱藏層數量。 - n_heads (
int, 可選, 預設為 12) — Transformer 編碼器中每個注意力層的注意力頭數量。 - dim (
int, 可選, 預設為 768) — 編碼器層和池化層維度。 - hidden_dim (
int, 可選, 預設為 3072) — Transformer 編碼器中“中間”（通常稱為前饋）層的大小。 - dropout (
float, 可選, 預設為 0.1) — 嵌入、編碼器和池化器中所有全連線層的 dropout 機率。 - attention_dropout (
float, 可選, 預設為 0.1) — 注意力機率的 dropout 比率。 - activation (
str或Callable, 可選, 預設為"gelu") — 編碼器和池化器中的非線性啟用函式（函式或字串）。如果是字串，則支援"gelu"、"relu"、"silu"和"gelu_new"。 - initializer_range (
float, 可選, 預設為 0.02) — 用於初始化所有權重矩陣的 truncated_normal_initializer 的標準差。 - qa_dropout (
float, 可選, 預設為 0.1) — 在問答模型 DistilBertForQuestionAnswering 中使用的 dropout 機率。 - seq_classif_dropout (
float, 可選, 預設為 0.2) — 在序列分類和多項選擇模型 DistilBertForSequenceClassification 中使用的 dropout 機率。
這是用於儲存 DistilBertModel 或 TFDistilBertModel 配置的配置類。它用於根據指定的引數例項化 DistilBERT 模型，定義模型架構。使用預設值例項化配置將生成類似於 DistilBERT distilbert-base-uncased 架構的配置。
配置物件繼承自 PretrainedConfig，可用於控制模型輸出。有關更多資訊，請參閱 PretrainedConfig 的文件。
示例
>>> from transformers import DistilBertConfig, DistilBertModel
>>> # Initializing a DistilBERT configuration
>>> configuration = DistilBertConfig()
>>> # Initializing a model (with random weights) from the configuration
>>> model = DistilBertModel(configuration)
>>> # Accessing the model configuration
>>> configuration = model.configDistilBertTokenizer
class transformers.DistilBertTokenizer
< 來源 >( vocab_file do_lower_case = True do_basic_tokenize = True never_split = None unk_token = '[UNK]' sep_token = '[SEP]' pad_token = '[PAD]' cls_token = '[CLS]' mask_token = '[MASK]' tokenize_chinese_chars = True strip_accents = None clean_up_tokenization_spaces = True **kwargs )
引數
- vocab_file (
str) — 包含詞彙的檔案。 - do_lower_case (
bool, 可選, 預設為True) — 對輸入進行分詞時是否轉換為小寫。 - do_basic_tokenize (
bool, 可選, 預設為True) — 在 WordPiece 之前是否進行基本分詞。 - never_split (
Iterable, 可選) — 在分詞過程中永不拆分的 token 集合。僅當do_basic_tokenize=True時有效。 - unk_token (
str, 可選, 預設為"[UNK]") — 未知標記。不在詞彙表中的標記無法轉換為ID，將被設定為此標記。 - sep_token (
str, 可選, 預設為"[SEP]") — 分隔標記，用於構建由多個序列組成的序列，例如用於序列分類的兩個序列或用於問答的文字和問題。它也用作使用特殊標記構建的序列的最後一個標記。 - pad_token (
str, 可選, 預設為"[PAD]") — 用於填充的標記，例如在批處理不同長度的序列時使用。 - cls_token (
str, 可選, 預設為"[CLS]") — 分類器標記，用於序列分類（對整個序列進行分類而非按標記分類）。當用特殊標記構建序列時，它是序列的第一個標記。 - mask_token (
str, 可選, 預設為"[MASK]") — 用於遮蓋值的標記。在使用遮蓋語言建模訓練此模型時使用此標記。這是模型將嘗試預測的標記。 - tokenize_chinese_chars (
bool, 可選, 預設為True) — 是否對中文字元進行分詞。對於日語，這可能應該被停用（參見此問題）。
- strip_accents (
bool, 可選) — 是否去除所有重音符號。如果未指定此選項，則將由lowercase的值決定（與原始 BERT 中的一樣）。 - clean_up_tokenization_spaces (
bool, 可選, 預設為True) — 解碼後是否清理空格，清理包括移除潛在的多餘空格等。
構建一個 DistilBERT 分詞器。基於 WordPiece。
此分詞器繼承自 PreTrainedTokenizer，其中包含大部分主要方法。使用者應參閱此超類以獲取有關這些方法的更多資訊。
build_inputs_with_special_tokens
< 源 >( token_ids_0: list token_ids_1: typing.Optional[list[int]] = None ) → List[int]
透過連線和新增特殊標記，從一個序列或一對序列構建用於序列分類任務的模型輸入。BERT 序列的格式如下：
- 單個序列：
[CLS] X [SEP] - 序列對：
[CLS] A [SEP] B [SEP]
將標記序列（字串）轉換為單個字串。
get_special_tokens_mask
< 源 >( token_ids_0: list token_ids_1: typing.Optional[list[int]] = None already_has_special_tokens: bool = False ) → List[int]
從沒有新增特殊標記的標記列表中檢索序列ID。此方法在使用分詞器prepare_for_model方法新增特殊標記時呼叫。
DistilBertTokenizerFast
class transformers.DistilBertTokenizerFast
< 源 >( vocab_file = None tokenizer_file = None do_lower_case = True unk_token = '[UNK]' sep_token = '[SEP]' pad_token = '[PAD]' cls_token = '[CLS]' mask_token = '[MASK]' tokenize_chinese_chars = True strip_accents = None **kwargs )
引數
- vocab_file (
str) — 包含詞彙表的檔案。 - do_lower_case (
bool, 可選, 預設為True) — 分詞時是否將輸入轉換為小寫。 - unk_token (
str, 可選, 預設為"[UNK]") — 未知標記。不在詞彙表中的標記無法轉換為ID，將被設定為此標記。 - sep_token (
str, 可選, 預設為"[SEP]") — 分隔標記，用於構建由多個序列組成的序列，例如用於序列分類的兩個序列或用於問答的文字和問題。它也用作使用特殊標記構建的序列的最後一個標記。 - pad_token (
str, 可選, 預設為"[PAD]") — 用於填充的標記，例如在批處理不同長度的序列時使用。 - cls_token (
str, 可選, 預設為"[CLS]") — 分類器標記，用於序列分類（對整個序列進行分類而非按標記分類）。當用特殊標記構建序列時，它是序列的第一個標記。 - mask_token (
str, 可選, 預設為"[MASK]") — 用於遮蓋值的標記。在使用遮蓋語言建模訓練此模型時使用此標記。這是模型將嘗試預測的標記。 - clean_text (
bool, 可選, 預設為True) — 是否在分詞前透過移除所有控制字元並將所有空格替換為經典空格來清理文字。 - tokenize_chinese_chars (
bool, 可選, 預設為True) — 是否對中文字元進行分詞。對於日語，這可能應該被停用（參見此問題）。 - strip_accents (
bool, 可選) — 是否去除所有重音符號。如果未指定此選項，則將由lowercase的值決定（與原始 BERT 中的一樣）。 - wordpieces_prefix (
str, 可選, 預設為"##") — 子詞的字首。
構建一個“快速”DistilBERT 分詞器（由 HuggingFace 的 tokenizers 庫支援）。基於 WordPiece。
此分詞器繼承自 PreTrainedTokenizerFast，其中包含大部分主要方法。使用者應參閱此超類以獲取有關這些方法的更多資訊。
DistilBertModel
class transformers.DistilBertModel
< 源 >( config: PretrainedConfig )
引數
- config (PretrainedConfig) — 模型的配置類，包含模型的所有引數。使用配置檔案初始化不載入與模型相關的權重，只加載配置。請檢視 from_pretrained() 方法以載入模型權重。
裸 Distilbert 模型，輸出原始隱藏狀態，頂部沒有任何特定頭部。
此模型繼承自 PreTrainedModel。請檢視超類文件，瞭解庫為所有模型實現的通用方法（例如下載或儲存、調整輸入嵌入大小、修剪頭部等）。
此模型也是 PyTorch torch.nn.Module 子類。將其作為常規 PyTorch 模組使用，並參閱 PyTorch 文件以獲取所有與通用用法和行為相關的事項。
forward
< 源 >( input_ids: typing.Optional[torch.Tensor] = None attention_mask: typing.Optional[torch.Tensor] = None head_mask: typing.Optional[torch.Tensor] = None inputs_embeds: typing.Optional[torch.Tensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.modeling_outputs.BaseModelOutput 或 tuple(torch.FloatTensor)
引數
- input_ids (
torch.LongTensor, 形狀為(batch_size, num_choices)) — 詞彙表中輸入序列標記的索引。可以使用 AutoTokenizer 獲取索引。有關詳細資訊，請參閱 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensor, 形狀為(batch_size, sequence_length), 可選) — 遮罩以避免在填充標記索引上執行注意力。遮罩值在[0, 1]中選擇：- 1 表示**未遮蓋**的標記，
- 0 表示**已遮蓋**的標記。
- head_mask (
torch.Tensor, 形狀為(num_heads,)或(num_layers, num_heads), 可選) — 遮罩以使自注意力模組的選定頭部無效。遮罩值在[0, 1]中選擇：- 1 表示頭部**未遮蓋**，
- 0 表示頭部**已遮蓋**。
- inputs_embeds (
torch.FloatTensor, 形狀為(batch_size, num_choices, hidden_size), 可選) — 可選地，您可以選擇直接傳遞嵌入表示而不是傳遞input_ids。如果您希望對如何將input_ids索引轉換為關聯向量（而不是模型的內部嵌入查詢矩陣）有更多控制，這會很有用。 - output_attentions (
bool, 可選) — 是否返回所有注意力層的注意力張量。有關更多詳細資訊，請參閱返回張量中的attentions。 - output_hidden_states (
bool, 可選) — 是否返回所有層的隱藏狀態。有關更多詳細資訊，請參閱返回張量中的hidden_states。 - return_dict (
bool, 可選) — 是否返回 ModelOutput 而不是普通元組。
返回
transformers.modeling_outputs.BaseModelOutput 或 tuple(torch.FloatTensor)
一個 transformers.modeling_outputs.BaseModelOutput 或一個 torch.FloatTensor 元組（如果傳遞 return_dict=False 或 config.return_dict=False），包含根據配置（DistilBertConfig）和輸入而定的各種元素。
-
last_hidden_state (
torch.FloatTensor, 形狀為(batch_size, sequence_length, hidden_size)) — 模型最後一層輸出的隱藏狀態序列。 -
hidden_states (
tuple(torch.FloatTensor), 可選, 當傳遞output_hidden_states=True或config.output_hidden_states=True時返回) —torch.FloatTensor元組（如果模型有嵌入層，則一個用於嵌入輸出，加上一個用於每個層的輸出），形狀為(batch_size, sequence_length, hidden_size)。模型在每個層輸出的隱藏狀態以及可選的初始嵌入輸出。
-
attentions (
tuple(torch.FloatTensor), 可選, 當傳遞output_attentions=True或config.output_attentions=True時返回) —torch.FloatTensor元組（每個層一個），形狀為(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 後的注意力權重，用於計算自注意力頭中的加權平均值。
的 DistilBertModel forward 方法，覆蓋了 __call__ 特殊方法。
雖然 forward pass 的配方需要在此函式中定義，但在此之後應該呼叫 Module 例項，而不是此函式，因為前者負責執行預處理和後處理步驟，而後者則默默地忽略它們。
DistilBertForMaskedLM
class transformers.DistilBertForMaskedLM
< 源 >( config: PretrainedConfig )
引數
- config (PretrainedConfig) — 模型的配置類，包含模型的所有引數。使用配置檔案初始化不載入與模型相關的權重，只加載配置。請檢視 from_pretrained() 方法以載入模型權重。
DistilBert 模型，頂部帶有 masked language modeling 頭。
此模型繼承自 PreTrainedModel。請檢視超類文件，瞭解庫為所有模型實現的通用方法（例如下載或儲存、調整輸入嵌入大小、修剪頭部等）。
此模型也是 PyTorch torch.nn.Module 子類。將其作為常規 PyTorch 模組使用，並參閱 PyTorch 文件以獲取所有與通用用法和行為相關的事項。
forward
< 源 >( input_ids: typing.Optional[torch.Tensor] = None attention_mask: typing.Optional[torch.Tensor] = None head_mask: typing.Optional[torch.Tensor] = None inputs_embeds: typing.Optional[torch.Tensor] = None labels: typing.Optional[torch.LongTensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.modeling_outputs.MaskedLMOutput 或 tuple(torch.FloatTensor)
引數
- input_ids (
torch.LongTensor, 形狀為(batch_size, num_choices)) — 詞彙表中輸入序列標記的索引。可以使用 AutoTokenizer 獲取索引。有關詳細資訊，請參閱 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensor, 形狀為(batch_size, sequence_length), 可選) — 遮罩以避免在填充標記索引上執行注意力。遮罩值在[0, 1]中選擇：- 1 表示**未遮蓋**的標記，
- 0 表示**已遮蓋**的標記。
- head_mask (
torch.Tensor, 形狀為(num_heads,)或(num_layers, num_heads), 可選) — 遮罩以使自注意力模組的選定頭部無效。遮罩值在[0, 1]中選擇：- 1 表示頭部**未遮蓋**，
- 0 表示頭部**已遮蓋**。
- inputs_embeds (
torch.FloatTensor, 形狀為(batch_size, num_choices, hidden_size), 可選) — 可選地，您可以選擇直接傳遞嵌入表示而不是傳遞input_ids。如果您希望對如何將input_ids索引轉換為關聯向量（而不是模型的內部嵌入查詢矩陣）有更多控制，這會很有用。 - labels (
torch.LongTensor, 形狀為(batch_size, sequence_length), 可選) — 用於計算遮蓋語言建模損失的標籤。索引應在[-100, 0, ..., config.vocab_size]範圍內（參見input_ids文件字串）。索引設定為-100的標記將被忽略（遮蓋），損失僅為標籤在[0, ..., config.vocab_size]範圍內的標記計算。 - output_attentions (
bool, 可選) — 是否返回所有注意力層的注意力張量。有關更多詳細資訊，請參閱返回張量中的attentions。 - output_hidden_states (
bool, 可選) — 是否返回所有層的隱藏狀態。更多詳情請參閱返回張量中的hidden_states。 - return_dict (
bool, 可選) — 是否返回 ModelOutput 而不是普通的元組。
返回
transformers.modeling_outputs.MaskedLMOutput 或 tuple(torch.FloatTensor)
一個 transformers.modeling_outputs.MaskedLMOutput 或一個 torch.FloatTensor 元組（如果傳遞了 return_dict=False 或當 config.return_dict=False 時），其中包含根據配置 (DistilBertConfig) 和輸入而變化的各種元素。
-
loss (形狀為
(1,)的torch.FloatTensor，可選，當提供labels時返回) — 掩碼語言建模 (MLM) 損失。 -
logits (形狀為
(batch_size, sequence_length, config.vocab_size)的torch.FloatTensor) — 語言建模頭部的預測分數（SoftMax 之前的每個詞彙標記的分數）。 -
hidden_states (
tuple(torch.FloatTensor), 可選, 當傳遞output_hidden_states=True或config.output_hidden_states=True時返回) —torch.FloatTensor元組（如果模型有嵌入層，則一個用於嵌入輸出，加上一個用於每個層的輸出），形狀為(batch_size, sequence_length, hidden_size)。模型在每個層輸出的隱藏狀態以及可選的初始嵌入輸出。
-
attentions (
tuple(torch.FloatTensor), 可選, 當傳遞output_attentions=True或config.output_attentions=True時返回) —torch.FloatTensor元組（每個層一個），形狀為(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 後的注意力權重，用於計算自注意力頭中的加權平均值。
DistilBertForMaskedLM 的前向方法，重寫了 __call__ 特殊方法。
雖然 forward pass 的配方需要在此函式中定義，但在此之後應該呼叫 Module 例項，而不是此函式，因為前者負責執行預處理和後處理步驟，而後者則默默地忽略它們。
示例
>>> from transformers import AutoTokenizer, DistilBertForMaskedLM
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("distilbert-base-uncased")
>>> model = DistilBertForMaskedLM.from_pretrained("distilbert-base-uncased")
>>> inputs = tokenizer("The capital of France is <mask>.", return_tensors="pt")
>>> with torch.no_grad():
... logits = model(**inputs).logits
>>> # retrieve index of <mask>
>>> mask_token_index = (inputs.input_ids == tokenizer.mask_token_id)[0].nonzero(as_tuple=True)[0]
>>> predicted_token_id = logits[0, mask_token_index].argmax(axis=-1)
>>> tokenizer.decode(predicted_token_id)
...
>>> labels = tokenizer("The capital of France is Paris.", return_tensors="pt")["input_ids"]
>>> # mask labels of non-<mask> tokens
>>> labels = torch.where(inputs.input_ids == tokenizer.mask_token_id, labels, -100)
>>> outputs = model(**inputs, labels=labels)
>>> round(outputs.loss.item(), 2)
...DistilBertForSequenceClassification
class transformers.DistilBertForSequenceClassification
< source >( config: PretrainedConfig )
引數
- config (PretrainedConfig) — 模型的配置類，包含模型的所有引數。使用配置檔案初始化不會載入與模型相關的權重，只加載配置。請檢視 from_pretrained() 方法來載入模型權重。
DistilBert 模型 Transformer，頂部帶有一個序列分類/迴歸頭（池化輸出頂部的一個線性層），例如用於 GLUE 任務。
此模型繼承自 PreTrainedModel。請檢視超類文件，瞭解庫為所有模型實現的通用方法（例如下載或儲存、調整輸入嵌入大小、修剪頭部等）。
此模型也是 PyTorch torch.nn.Module 子類。將其作為常規 PyTorch 模組使用，並參閱 PyTorch 文件以獲取所有與通用用法和行為相關的事項。
forward
< source >( input_ids: typing.Optional[torch.Tensor] = None attention_mask: typing.Optional[torch.Tensor] = None head_mask: typing.Optional[torch.Tensor] = None inputs_embeds: typing.Optional[torch.Tensor] = None labels: typing.Optional[torch.LongTensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.modeling_outputs.SequenceClassifierOutput 或 tuple(torch.FloatTensor)
引數
- input_ids (形狀為
(batch_size, sequence_length)的torch.Tensor，可選) — 詞彙表中輸入序列標記的索引。填充預設會被忽略。索引可以使用 AutoTokenizer 獲取。更多詳情請參閱 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (形狀為
(batch_size, sequence_length)的torch.Tensor，可選) — 避免對填充標記索引執行注意力操作的掩碼。掩碼值選擇在[0, 1]之間：- 1 表示未掩碼的標記，
- 0 表示已掩碼的標記。
- head_mask (形狀為
(num_heads,)或(num_layers, num_heads)的torch.Tensor，可選) — 用於使自注意力模組的選定頭部失效的掩碼。掩碼值選擇在[0, 1]之間：- 1 表示頭部未掩碼，
- 0 表示頭部已掩碼。
- inputs_embeds (形狀為
(batch_size, sequence_length, hidden_size)的torch.Tensor，可選) — 可選地，您可以選擇直接傳遞嵌入表示，而不是傳遞input_ids。如果您希望對如何將input_ids索引轉換為關聯向量擁有比模型內部嵌入查詢矩陣更多的控制，這將非常有用。 - labels (形狀為
(batch_size,)的torch.LongTensor，可選) — 用於計算序列分類/迴歸損失的標籤。索引應在[0, ..., config.num_labels - 1]之間。如果config.num_labels == 1，則計算迴歸損失（均方誤差損失），如果config.num_labels > 1，則計算分類損失（交叉熵）。 - output_attentions (
bool, 可選) — 是否返回所有注意力層的注意力張量。更多詳情請參閱返回張量中的attentions。 - output_hidden_states (
bool, 可選) — 是否返回所有層的隱藏狀態。更多詳情請參閱返回張量中的hidden_states。 - return_dict (
bool, 可選) — 是否返回 ModelOutput 而不是普通的元組。
返回
transformers.modeling_outputs.SequenceClassifierOutput 或 tuple(torch.FloatTensor)
一個 transformers.modeling_outputs.SequenceClassifierOutput 或一個 torch.FloatTensor 元組（如果傳遞了 return_dict=False 或當 config.return_dict=False 時），其中包含根據配置 (DistilBertConfig) 和輸入而變化的各種元素。
-
loss (形狀為
(1,)的torch.FloatTensor，可選，當提供labels時返回) — 分類損失（如果 config.num_labels==1，則為迴歸損失）。 -
logits (形狀為
(batch_size, config.num_labels)的torch.FloatTensor) — 分類（如果 config.num_labels==1，則為迴歸）分數（SoftMax 之前）。 -
hidden_states (
tuple(torch.FloatTensor), 可選, 當傳遞output_hidden_states=True或config.output_hidden_states=True時返回) —torch.FloatTensor元組（如果模型有嵌入層，則一個用於嵌入輸出，加上一個用於每個層的輸出），形狀為(batch_size, sequence_length, hidden_size)。模型在每個層輸出的隱藏狀態以及可選的初始嵌入輸出。
-
attentions (
tuple(torch.FloatTensor), 可選, 當傳遞output_attentions=True或config.output_attentions=True時返回) —torch.FloatTensor元組（每個層一個），形狀為(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 後的注意力權重，用於計算自注意力頭中的加權平均值。
DistilBertForSequenceClassification 的前向方法，重寫了 __call__ 特殊方法。
雖然 forward pass 的配方需要在此函式中定義，但在此之後應該呼叫 Module 例項，而不是此函式，因為前者負責執行預處理和後處理步驟，而後者則默默地忽略它們。
單標籤分類示例
>>> import torch
>>> from transformers import AutoTokenizer, DistilBertForSequenceClassification
>>> tokenizer = AutoTokenizer.from_pretrained("distilbert-base-uncased")
>>> model = DistilBertForSequenceClassification.from_pretrained("distilbert-base-uncased")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")
>>> with torch.no_grad():
... logits = model(**inputs).logits
>>> predicted_class_id = logits.argmax().item()
>>> model.config.id2label[predicted_class_id]
...
>>> # To train a model on `num_labels` classes, you can pass `num_labels=num_labels` to `.from_pretrained(...)`
>>> num_labels = len(model.config.id2label)
>>> model = DistilBertForSequenceClassification.from_pretrained("distilbert-base-uncased", num_labels=num_labels)
>>> labels = torch.tensor([1])
>>> loss = model(**inputs, labels=labels).loss
>>> round(loss.item(), 2)
...多標籤分類示例
>>> import torch
>>> from transformers import AutoTokenizer, DistilBertForSequenceClassification
>>> tokenizer = AutoTokenizer.from_pretrained("distilbert-base-uncased")
>>> model = DistilBertForSequenceClassification.from_pretrained("distilbert-base-uncased", problem_type="multi_label_classification")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")
>>> with torch.no_grad():
... logits = model(**inputs).logits
>>> predicted_class_ids = torch.arange(0, logits.shape[-1])[torch.sigmoid(logits).squeeze(dim=0) > 0.5]
>>> # To train a model on `num_labels` classes, you can pass `num_labels=num_labels` to `.from_pretrained(...)`
>>> num_labels = len(model.config.id2label)
>>> model = DistilBertForSequenceClassification.from_pretrained(
... "distilbert-base-uncased", num_labels=num_labels, problem_type="multi_label_classification"
... )
>>> labels = torch.sum(
... torch.nn.functional.one_hot(predicted_class_ids[None, :].clone(), num_classes=num_labels), dim=1
... ).to(torch.float)
>>> loss = model(**inputs, labels=labels).lossDistilBertForMultipleChoice
class transformers.DistilBertForMultipleChoice
< source >( config: PretrainedConfig )
引數
- config (PretrainedConfig) — 模型的配置類，包含模型的所有引數。使用配置檔案初始化不會載入與模型相關的權重，只加載配置。請檢視 from_pretrained() 方法來載入模型權重。
Distilbert 模型，頂部帶有多項選擇分類頭（池化輸出頂部的一個線性層和一個 softmax），例如用於 RocStories/SWAG 任務。
此模型繼承自 PreTrainedModel。請檢視超類文件，瞭解庫為所有模型實現的通用方法（例如下載或儲存、調整輸入嵌入大小、修剪頭部等）。
此模型也是 PyTorch torch.nn.Module 子類。將其作為常規 PyTorch 模組使用，並參閱 PyTorch 文件以獲取所有與通用用法和行為相關的事項。
forward
< source >( input_ids: typing.Optional[torch.Tensor] = None attention_mask: typing.Optional[torch.Tensor] = None head_mask: typing.Optional[torch.Tensor] = None inputs_embeds: typing.Optional[torch.Tensor] = None labels: typing.Optional[torch.LongTensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.modeling_outputs.MultipleChoiceModelOutput 或 tuple(torch.FloatTensor)
引數
- input_ids (形狀為
(batch_size, num_choices, sequence_length)的torch.LongTensor) — 詞彙表中輸入序列標記的索引。索引可以使用 AutoTokenizer 獲取。更多詳情請參閱 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (形狀為
(batch_size, sequence_length)的torch.Tensor，可選) — 避免對填充標記索引執行注意力操作的掩碼。掩碼值選擇在[0, 1]之間：- 1 表示未掩碼的標記，
- 0 表示已掩碼的標記。
- head_mask (形狀為
(num_heads,)或(num_layers, num_heads)的torch.Tensor，可選) — 用於使自注意力模組的選定頭部失效的掩碼。掩碼值選擇在[0, 1]之間：- 1 表示頭部未掩碼，
- 0 表示頭部已掩碼。
- inputs_embeds (形狀為
(batch_size, num_choices, sequence_length, hidden_size)的torch.FloatTensor，可選) — 可選地，您可以選擇直接傳遞嵌入表示，而不是傳遞input_ids。如果您希望對如何將input_ids索引轉換為關聯向量擁有比模型內部嵌入查詢矩陣更多的控制，這將非常有用。 - labels (形狀為
(batch_size,)的torch.LongTensor，可選) — 用於計算多項選擇分類損失的標籤。索引應在[0, ..., num_choices-1]之間，其中num_choices是輸入張量的第二維大小。（請參閱上面的input_ids） - output_attentions (
bool, 可選) — 是否返回所有注意力層的注意力張量。更多詳情請參閱返回張量中的attentions。 - output_hidden_states (
bool, 可選) — 是否返回所有層的隱藏狀態。更多詳情請參閱返回張量中的hidden_states。 - return_dict (
bool, 可選) — 是否返回 ModelOutput 而不是普通的元組。
返回
transformers.modeling_outputs.MultipleChoiceModelOutput 或 tuple(torch.FloatTensor)
一個 transformers.modeling_outputs.MultipleChoiceModelOutput 或一個 torch.FloatTensor 元組（如果傳遞了 return_dict=False 或當 config.return_dict=False 時），其中包含根據配置 (DistilBertConfig) 和輸入而變化的各種元素。
-
loss (形狀為 (1,) 的
torch.FloatTensor，可選，當提供labels時返回) — 分類損失。 -
logits (形狀為
(batch_size, num_choices)的torch.FloatTensor) — num_choices 是輸入張量的第二維大小。（請參閱上面的 input_ids）。分類分數（SoftMax 之前）。
-
hidden_states (
tuple(torch.FloatTensor), 可選, 當傳遞output_hidden_states=True或config.output_hidden_states=True時返回) —torch.FloatTensor元組（如果模型有嵌入層，則一個用於嵌入輸出，加上一個用於每個層的輸出），形狀為(batch_size, sequence_length, hidden_size)。模型在每個層輸出的隱藏狀態以及可選的初始嵌入輸出。
-
attentions (
tuple(torch.FloatTensor), 可選, 當傳遞output_attentions=True或config.output_attentions=True時返回) —torch.FloatTensor元組（每個層一個），形狀為(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 後的注意力權重，用於計算自注意力頭中的加權平均值。
DistilBertForMultipleChoice 的前向方法，重寫了 __call__ 特殊方法。
雖然 forward pass 的配方需要在此函式中定義，但在此之後應該呼叫 Module 例項，而不是此函式，因為前者負責執行預處理和後處理步驟，而後者則默默地忽略它們。
示例
>>> from transformers import AutoTokenizer, DistilBertForMultipleChoice
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("distilbert-base-cased")
>>> model = DistilBertForMultipleChoice.from_pretrained("distilbert-base-cased")
>>> prompt = "In Italy, pizza served in formal settings, such as at a restaurant, is presented unsliced."
>>> choice0 = "It is eaten with a fork and a knife."
>>> choice1 = "It is eaten while held in the hand."
>>> labels = torch.tensor(0).unsqueeze(0) # choice0 is correct (according to Wikipedia ;)), batch size 1
>>> encoding = tokenizer([[prompt, choice0], [prompt, choice1]], return_tensors="pt", padding=True)
>>> outputs = model(**{k: v.unsqueeze(0) for k, v in encoding.items()}, labels=labels) # batch size is 1
>>> # the linear classifier still needs to be trained
>>> loss = outputs.loss
>>> logits = outputs.logitsDistilBertForTokenClassification
class transformers.DistilBertForTokenClassification
< source >( config: PretrainedConfig )
引數
- config (PretrainedConfig) — 模型的配置類，包含模型的所有引數。使用配置檔案初始化不會載入與模型相關的權重，只加載配置。請檢視 from_pretrained() 方法來載入模型權重。
Distilbert Transformer，頂部帶有一個 token 分類頭（隱藏狀態輸出頂部的一個線性層），例如用於命名實體識別 (NER) 任務。
此模型繼承自 PreTrainedModel。請檢視超類文件，瞭解庫為所有模型實現的通用方法（例如下載或儲存、調整輸入嵌入大小、修剪頭部等）。
此模型也是 PyTorch torch.nn.Module 子類。將其作為常規 PyTorch 模組使用，並參閱 PyTorch 文件以獲取所有與通用用法和行為相關的事項。
forward
< source >( input_ids: typing.Optional[torch.Tensor] = None attention_mask: typing.Optional[torch.Tensor] = None head_mask: typing.Optional[torch.Tensor] = None inputs_embeds: typing.Optional[torch.Tensor] = None labels: typing.Optional[torch.LongTensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.modeling_outputs.TokenClassifierOutput 或 tuple(torch.FloatTensor)
引數
- input_ids (形狀為
(batch_size, sequence_length)的torch.Tensor，可選) — 詞彙表中輸入序列標記的索引。填充預設會被忽略。索引可以使用 AutoTokenizer 獲取。更多詳情請參閱 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (形狀為
(batch_size, sequence_length)的torch.Tensor，可選) — 避免對填充標記索引執行注意力操作的掩碼。掩碼值選擇在[0, 1]之間：- 1 表示未掩碼的標記，
- 0 表示已掩碼的標記。
- head_mask (形狀為
(num_heads,)或(num_layers, num_heads)的torch.Tensor，可選) — 用於使自注意力模組的選定頭部失效的掩碼。掩碼值選擇在[0, 1]之間：- 1 表示頭部未掩碼，
- 0 表示頭部已掩碼。
- inputs_embeds (形狀為
(batch_size, sequence_length, hidden_size)的torch.Tensor，可選) — 可選地，您可以選擇直接傳遞嵌入表示，而不是傳遞input_ids。如果您希望對如何將input_ids索引轉換為關聯向量擁有比模型內部嵌入查詢矩陣更多的控制，這將非常有用。 - labels (形狀為
(batch_size, sequence_length)的torch.LongTensor，可選) — 用於計算 token 分類損失的標籤。索引應在[0, ..., config.num_labels - 1]之間。 - output_attentions (
bool, 可選) — 是否返回所有注意力層的注意力張量。更多詳情請參閱返回張量中的attentions。 - output_hidden_states (
bool, 可選) — 是否返回所有層的隱藏狀態。更多詳情請參閱返回張量中的hidden_states。 - return_dict (
bool, 可選) — 是否返回 ModelOutput 而不是普通的元組。
返回
transformers.modeling_outputs.TokenClassifierOutput 或 tuple(torch.FloatTensor)
一個 transformers.modeling_outputs.TokenClassifierOutput 或一個 torch.FloatTensor 元組（如果傳遞了 return_dict=False 或當 config.return_dict=False 時），其中包含根據配置 (DistilBertConfig) 和輸入而變化的各種元素。
-
loss (形狀為
(1,)的torch.FloatTensor，可選，當提供labels時返回) — 分類損失。 -
logits (形狀為
(batch_size, sequence_length, config.num_labels)的torch.FloatTensor) — 分類分數（SoftMax 之前）。 -
hidden_states (
tuple(torch.FloatTensor), 可選, 當傳遞output_hidden_states=True或config.output_hidden_states=True時返回) —torch.FloatTensor元組（如果模型有嵌入層，則一個用於嵌入輸出，加上一個用於每個層的輸出），形狀為(batch_size, sequence_length, hidden_size)。模型在每個層輸出的隱藏狀態以及可選的初始嵌入輸出。
-
attentions (
tuple(torch.FloatTensor), 可選, 當傳遞output_attentions=True或config.output_attentions=True時返回) —torch.FloatTensor元組（每個層一個），形狀為(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 後的注意力權重，用於計算自注意力頭中的加權平均值。
DistilBertForTokenClassification 的前向方法，重寫了 __call__ 特殊方法。
雖然 forward pass 的配方需要在此函式中定義，但在此之後應該呼叫 Module 例項，而不是此函式，因為前者負責執行預處理和後處理步驟，而後者則默默地忽略它們。
示例
>>> from transformers import AutoTokenizer, DistilBertForTokenClassification
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("distilbert-base-uncased")
>>> model = DistilBertForTokenClassification.from_pretrained("distilbert-base-uncased")
>>> inputs = tokenizer(
... "HuggingFace is a company based in Paris and New York", add_special_tokens=False, return_tensors="pt"
... )
>>> with torch.no_grad():
... logits = model(**inputs).logits
>>> predicted_token_class_ids = logits.argmax(-1)
>>> # Note that tokens are classified rather then input words which means that
>>> # there might be more predicted token classes than words.
>>> # Multiple token classes might account for the same word
>>> predicted_tokens_classes = [model.config.id2label[t.item()] for t in predicted_token_class_ids[0]]
>>> predicted_tokens_classes
...
>>> labels = predicted_token_class_ids
>>> loss = model(**inputs, labels=labels).loss
>>> round(loss.item(), 2)
...DistilBertForQuestionAnswering
class transformers.DistilBertForQuestionAnswering
< source >( config: PretrainedConfig )
引數
- config (PretrainedConfig) — 模型的配置類，包含模型的所有引數。使用配置檔案初始化不會載入與模型相關的權重，只加載配置。請檢視 from_pretrained() 方法來載入模型權重。
Distilbert Transformer，頂部帶有一個 span 分類頭，用於 SQuAD 等抽取式問答任務（隱藏狀態輸出頂部的一個線性層，用於計算 span start logits 和 span end logits）。
此模型繼承自 PreTrainedModel。請檢視超類文件，瞭解庫為所有模型實現的通用方法（例如下載或儲存、調整輸入嵌入大小、修剪頭部等）。
此模型也是 PyTorch torch.nn.Module 子類。將其作為常規 PyTorch 模組使用，並參閱 PyTorch 文件以獲取所有與通用用法和行為相關的事項。
forward
< source >( input_ids: typing.Optional[torch.Tensor] = None attention_mask: typing.Optional[torch.Tensor] = None head_mask: typing.Optional[torch.Tensor] = None inputs_embeds: typing.Optional[torch.Tensor] = None start_positions: typing.Optional[torch.Tensor] = None end_positions: typing.Optional[torch.Tensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.modeling_outputs.QuestionAnsweringModelOutput or tuple(torch.FloatTensor)
引數
- input_ids (
torch.LongTensorof shape(batch_size, num_choices)) — 詞彙表中輸入序列標記的索引。可以使用 AutoTokenizer 獲取索引。有關詳細資訊，請參閱 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensorof shape(batch_size, sequence_length), 可選) — 用於避免對填充標記索引執行注意力操作的掩碼。掩碼值選擇範圍為[0, 1]：- 1 表示未被掩蓋的標記，
- 0 表示被掩蓋的標記。
- head_mask (
torch.Tensorof shape(num_heads,)或(num_layers, num_heads), 可選) — 用於使自注意力模組的選定頭部失效的掩碼。掩碼值選擇範圍為[0, 1]：- 1 表示頭部未被掩蓋，
- 0 表示頭部被掩蓋。
- inputs_embeds (
torch.FloatTensorof shape(batch_size, num_choices, hidden_size), 可選) — 可選地，您可以透過嵌入表示直接傳遞，而不是傳遞input_ids。如果您希望對如何將input_ids索引轉換為關聯向量具有比模型內部嵌入查詢矩陣更多的控制，這將很有用。 - start_positions (
torch.Tensorof shape(batch_size,), 可選) — 用於計算標記分類損失的標記範圍起始位置（索引）的標籤。位置被限制為序列的長度 (sequence_length)。序列外部的位置不計入損失計算。 - end_positions (
torch.Tensorof shape(batch_size,), 可選) — 用於計算標記分類損失的標記範圍結束位置（索引）的標籤。位置被限制為序列的長度 (sequence_length)。序列外部的位置不計入損失計算。 - output_attentions (
bool, 可選) — 是否返回所有注意力層的注意力張量。有關詳細資訊，請參閱返回張量下的attentions。 - output_hidden_states (
bool, 可選) — 是否返回所有層的隱藏狀態。有關詳細資訊，請參閱返回張量下的hidden_states。 - return_dict (
bool, 可選) — 是否返回 ModelOutput 而不是普通元組。
返回
transformers.modeling_outputs.QuestionAnsweringModelOutput 或 tuple(torch.FloatTensor)
一個 transformers.modeling_outputs.QuestionAnsweringModelOutput 或一個 torch.FloatTensor 元組（如果傳遞 return_dict=False 或 config.return_dict=False），其中包含根據配置 (DistilBertConfig) 和輸入的不同元素。
-
loss (
torch.FloatTensorof shape(1,), 可選, 當提供labels時返回) — 總範圍提取損失是起始位置和結束位置的交叉熵之和。 -
start_logits (
torch.FloatTensorof shape(batch_size, sequence_length)) — 範圍起始分數（SoftMax 之前）。 -
end_logits (
torch.FloatTensorof shape(batch_size, sequence_length)) — 範圍結束分數（SoftMax 之前）。 -
hidden_states (
tuple(torch.FloatTensor), 可選, 當傳遞output_hidden_states=True或config.output_hidden_states=True時返回) —torch.FloatTensor元組（如果模型有嵌入層，則一個用於嵌入輸出，加上一個用於每個層的輸出），形狀為(batch_size, sequence_length, hidden_size)。模型在每個層輸出的隱藏狀態以及可選的初始嵌入輸出。
-
attentions (
tuple(torch.FloatTensor), 可選, 當傳遞output_attentions=True或config.output_attentions=True時返回) —torch.FloatTensor元組（每個層一個），形狀為(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 後的注意力權重，用於計算自注意力頭中的加權平均值。
DistilBertForQuestionAnswering 的 forward 方法，它覆蓋了 __call__ 特殊方法。
雖然 forward pass 的配方需要在此函式中定義，但在此之後應該呼叫 Module 例項，而不是此函式，因為前者負責執行預處理和後處理步驟，而後者則默默地忽略它們。
示例
>>> from transformers import AutoTokenizer, DistilBertForQuestionAnswering
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("distilbert-base-uncased")
>>> model = DistilBertForQuestionAnswering.from_pretrained("distilbert-base-uncased")
>>> question, text = "Who was Jim Henson?", "Jim Henson was a nice puppet"
>>> inputs = tokenizer(question, text, return_tensors="pt")
>>> with torch.no_grad():
... outputs = model(**inputs)
>>> answer_start_index = outputs.start_logits.argmax()
>>> answer_end_index = outputs.end_logits.argmax()
>>> predict_answer_tokens = inputs.input_ids[0, answer_start_index : answer_end_index + 1]
>>> tokenizer.decode(predict_answer_tokens, skip_special_tokens=True)
...
>>> # target is "nice puppet"
>>> target_start_index = torch.tensor([14])
>>> target_end_index = torch.tensor([15])
>>> outputs = model(**inputs, start_positions=target_start_index, end_positions=target_end_index)
>>> loss = outputs.loss
>>> round(loss.item(), 2)
...TFDistilBertModel
類 transformers.TFDistilBertModel
< 源 >( 配置 *輸入 **kwargs )
引數
- config (DistilBertConfig) — 包含模型所有引數的模型配置類。用配置檔案初始化不會載入與模型相關的權重，只加載配置。請檢視 from_pretrained() 方法載入模型權重。
DistilBERT 編碼器/變換器，輸出原始隱藏狀態，頂部沒有任何特定頭部。
此模型繼承自 TFPreTrainedModel。檢視超類文件，瞭解庫為其所有模型實現的一般方法（例如下載或儲存、調整輸入嵌入大小、修剪頭部等）。
此模型也是 keras.Model 的子類。將其作為常規 TF 2.0 Keras 模型使用，並參閱 TF 2.0 文件瞭解所有與一般使用和行為相關的事項。
transformers 中的 TensorFlow 模型和層接受兩種輸入格式
- 所有輸入作為關鍵字引數（如 PyTorch 模型），或
- 所有輸入作為第一個位置引數中的列表、元組或字典。
支援第二種格式的原因是 Keras 方法在將輸入傳遞給模型和層時更喜歡這種格式。由於這種支援，當使用 model.fit() 等方法時，一切都應該“正常工作”——只需以 model.fit() 支援的任何格式傳遞您的輸入和標籤即可！但是，如果您想在 fit() 和 predict() 等 Keras 方法之外使用第二種格式，例如在使用 Keras Functional API 建立自己的層或模型時，您可以使用三種可能性來將所有輸入張量收集到第一個位置引數中
- 只有一個
input_ids的單個張量，沒有其他：model(input_ids) - 長度可變的列表，包含一個或多個輸入張量，按文件字串中給出的順序：
model([input_ids, attention_mask])或model([input_ids, attention_mask, token_type_ids]) - 一個字典，其中包含一個或多個與文件字串中給出的輸入名稱關聯的輸入張量：
model({"input_ids": input_ids, "token_type_ids": token_type_ids})
請注意，當使用 子類化 建立模型和層時，您無需擔心這些，因為您可以像傳遞給任何其他 Python 函式一樣傳遞輸入！
呼叫
< 源 >( input_ids: TFModelInputType | None = None attention_mask: np.ndarray | tf.Tensor | None = None head_mask: np.ndarray | tf.Tensor | None = None inputs_embeds: np.ndarray | tf.Tensor | None = None output_attentions: Optional[bool] = None output_hidden_states: Optional[bool] = None return_dict: Optional[bool] = None training: Optional[bool] = False ) → transformers.modeling_tf_outputs.TFBaseModelOutput 或 tuple(tf.Tensor)
引數
- input_ids (
Numpy array或tf.Tensorof shape(batch_size, sequence_length)) — 詞彙表中輸入序列標記的索引。可以使用 AutoTokenizer 獲取索引。有關詳細資訊，請參閱 PreTrainedTokenizer.call() 和 PreTrainedTokenizer.encode()。
- attention_mask (
Numpy array或tf.Tensorof shape(batch_size, sequence_length), 可選) — 用於避免對填充標記索引執行注意力操作的掩碼。掩碼值選擇範圍為[0, 1]：- 1 表示未被掩蓋的標記，
- 0 表示被掩蓋的標記。
- head_mask (
Numpy array或tf.Tensorof shape(num_heads,)或(num_layers, num_heads), 可選) — 用於使自注意力模組的選定頭部失效的掩碼。掩碼值選擇範圍為[0, 1]：- 1 表示頭部未被掩蓋，
- 0 表示頭部被掩蓋。
- inputs_embeds (
tf.Tensorof shape(batch_size, sequence_length, hidden_size), 可選) — 可選地，您可以透過嵌入表示直接傳遞，而不是傳遞input_ids。如果您希望對如何將input_ids索引轉換為關聯向量具有比模型內部嵌入查詢矩陣更多的控制，這將很有用。 - output_attentions (
bool, 可選) — 是否返回所有注意力層的注意力張量。有關詳細資訊，請參閱返回張量下的attentions。此引數只能在即時模式下使用，在圖模式下將使用配置中的值。 - output_hidden_states (
bool, 可選) — 是否返回所有層的隱藏狀態。有關詳細資訊，請參閱返回張量下的hidden_states。此引數只能在即時模式下使用，在圖模式下將使用配置中的值。 - return_dict (
bool, 可選) — 是否返回 ModelOutput 而不是普通元組。此引數可在即時模式下使用，在圖模式下該值將始終設定為 True。 - training (
bool, 可選, 預設為False) — 是否在訓練模式下使用模型（某些模組如 dropout 模組在訓練和評估之間有不同的行為）。
返回
transformers.modeling_tf_outputs.TFBaseModelOutput 或 tuple(tf.Tensor)
一個 transformers.modeling_tf_outputs.TFBaseModelOutput 或一個 tf.Tensor 元組（如果傳遞 return_dict=False 或 config.return_dict=False），其中包含根據配置 (DistilBertConfig) 和輸入的不同元素。
-
last_hidden_state (
tf.Tensorof shape(batch_size, sequence_length, hidden_size)) — 模型最後一層輸出的隱藏狀態序列。 -
hidden_states (
tuple(tf.FloatTensor), 可選, 當傳遞output_hidden_states=True或config.output_hidden_states=True時返回) — 形狀為(batch_size, sequence_length, hidden_size)的tf.Tensor元組（一個用於嵌入的輸出 + 一個用於每個層的輸出）。模型在每個層輸出的隱藏狀態加上初始嵌入輸出。
-
attentions (
tuple(tf.Tensor), 可選, 當傳遞output_attentions=True或config.output_attentions=True時返回) — 形狀為(batch_size, num_heads, sequence_length, sequence_length)的tf.Tensor元組（每個層一個）。注意力 softmax 後的注意力權重，用於計算自注意力頭中的加權平均值。
TFDistilBertModel 的 forward 方法，它覆蓋了 __call__ 特殊方法。
雖然 forward pass 的配方需要在此函式中定義，但在此之後應該呼叫 Module 例項，而不是此函式，因為前者負責執行預處理和後處理步驟，而後者則默默地忽略它們。
示例
>>> from transformers import AutoTokenizer, TFDistilBertModel
>>> import tensorflow as tf
>>> tokenizer = AutoTokenizer.from_pretrained("distilbert-base-uncased")
>>> model = TFDistilBertModel.from_pretrained("distilbert-base-uncased")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="tf")
>>> outputs = model(inputs)
>>> last_hidden_states = outputs.last_hidden_stateTFDistilBertForMaskedLM
類 transformers.TFDistilBertForMaskedLM
< 源 >( 配置 *輸入 **kwargs )
引數
- config (DistilBertConfig) — 包含模型所有引數的模型配置類。用配置檔案初始化不會載入與模型相關的權重，只加載配置。請檢視 from_pretrained() 方法載入模型權重。
DistilBert 模型，頂部帶有 masked language modeling 頭。
此模型繼承自 TFPreTrainedModel。檢視超類文件，瞭解庫為其所有模型實現的一般方法（例如下載或儲存、調整輸入嵌入大小、修剪頭部等）。
此模型也是 keras.Model 的子類。將其作為常規 TF 2.0 Keras 模型使用，並參閱 TF 2.0 文件瞭解所有與一般使用和行為相關的事項。
transformers 中的 TensorFlow 模型和層接受兩種輸入格式
- 所有輸入作為關鍵字引數（如 PyTorch 模型），或
- 所有輸入作為第一個位置引數中的列表、元組或字典。
支援第二種格式的原因是 Keras 方法在將輸入傳遞給模型和層時更喜歡這種格式。由於這種支援，當使用 model.fit() 等方法時，一切都應該“正常工作”——只需以 model.fit() 支援的任何格式傳遞您的輸入和標籤即可！但是，如果您想在 fit() 和 predict() 等 Keras 方法之外使用第二種格式，例如在使用 Keras Functional API 建立自己的層或模型時，您可以使用三種可能性來將所有輸入張量收集到第一個位置引數中
- 只有一個
input_ids的單個張量，沒有其他：model(input_ids) - 長度可變的列表，包含一個或多個輸入張量，按文件字串中給出的順序：
model([input_ids, attention_mask])或model([input_ids, attention_mask, token_type_ids]) - 一個字典，其中包含一個或多個與文件字串中給出的輸入名稱關聯的輸入張量：
model({"input_ids": input_ids, "token_type_ids": token_type_ids})
請注意，當使用 子類化 建立模型和層時，您無需擔心這些，因為您可以像傳遞給任何其他 Python 函式一樣傳遞輸入！
呼叫
< 源 >( input_ids: TFModelInputType | None = None attention_mask: np.ndarray | tf.Tensor | None = None head_mask: np.ndarray | tf.Tensor | None = None inputs_embeds: np.ndarray | tf.Tensor | None = None output_attentions: Optional[bool] = None output_hidden_states: Optional[bool] = None return_dict: Optional[bool] = None labels: np.ndarray | tf.Tensor | None = None training: Optional[bool] = False ) → transformers.modeling_tf_outputs.TFMaskedLMOutput 或 tuple(tf.Tensor)
引數
- input_ids (
Numpy array或tf.Tensorof shape(batch_size, sequence_length)) — 詞彙表中輸入序列標記的索引。可以使用 AutoTokenizer 獲取索引。有關詳細資訊，請參閱 PreTrainedTokenizer.call() 和 PreTrainedTokenizer.encode()。
- attention_mask (
Numpy array或tf.Tensorof shape(batch_size, sequence_length), 可選) — 用於避免對填充標記索引執行注意力操作的掩碼。掩碼值選擇範圍為[0, 1]：- 1 表示未被掩蓋的標記，
- 0 表示被掩蓋的標記。
- head_mask (
Numpy array或tf.Tensorof shape(num_heads,)或(num_layers, num_heads), 可選) — 用於使自注意力模組的選定頭部失效的掩碼。掩碼值選擇範圍為[0, 1]：- 1 表示頭部未被掩蓋，
- 0 表示頭部被掩蓋。
- inputs_embeds (
tf.Tensorof shape(batch_size, sequence_length, hidden_size), 可選) — 可選地，您可以透過嵌入表示直接傳遞，而不是傳遞input_ids。如果您希望對如何將input_ids索引轉換為關聯向量具有比模型內部嵌入查詢矩陣更多的控制，這將很有用。 - output_attentions (
bool, 可選) — 是否返回所有注意力層的注意力張量。有關詳細資訊，請參閱返回張量下的attentions。此引數只能在即時模式下使用，在圖模式下將使用配置中的值。 - output_hidden_states (
bool, 可選) — 是否返回所有層的隱藏狀態。有關詳細資訊，請參閱返回張量下的hidden_states。此引數只能在即時模式下使用，在圖模式下將使用配置中的值。 - return_dict (
bool, 可選) — 是否返回 ModelOutput 而不是普通元組。此引數可在即時模式下使用，在圖模式下該值將始終設定為 True。 - training (
bool, 可選, 預設為False) — 是否在訓練模式下使用模型（某些模組如 dropout 模組在訓練和評估之間有不同的行為）。 - labels (
tf.Tensorof shape(batch_size, sequence_length), 可選) — 用於計算掩碼語言模型損失的標籤。索引應在[-100, 0, ..., config.vocab_size]範圍內（請參閱input_ids文件字串）。索引設定為-100的標記將被忽略（掩碼），損失僅針對標籤在[0, ..., config.vocab_size]範圍內的標記計算。
返回
transformers.modeling_tf_outputs.TFMaskedLMOutput 或 tuple(tf.Tensor)
一個 transformers.modeling_tf_outputs.TFMaskedLMOutput 或一個 tf.Tensor 元組（如果傳遞 return_dict=False 或 config.return_dict=False），其中包含根據配置 (DistilBertConfig) 和輸入的不同元素。
-
loss (
tf.Tensorof shape(n,), 可選, 其中 n 是非掩碼標籤的數量，當提供labels時返回) — 掩碼語言模型 (MLM) 損失。 -
logits (
tf.Tensorof shape(batch_size, sequence_length, config.vocab_size)) — 語言模型頭部的預測分數（SoftMax 之前每個詞彙標記的分數）。 -
hidden_states (
tuple(tf.Tensor), 可選, 當傳遞output_hidden_states=True或config.output_hidden_states=True時返回) — 形狀為(batch_size, sequence_length, hidden_size)的tf.Tensor元組（一個用於嵌入的輸出 + 一個用於每個層的輸出）。模型在每個層輸出的隱藏狀態加上初始嵌入輸出。
-
attentions (
tuple(tf.Tensor), 可選, 當傳遞output_attentions=True或config.output_attentions=True時返回) — 形狀為(batch_size, num_heads, sequence_length, sequence_length)的tf.Tensor元組（每個層一個）。注意力 softmax 後的注意力權重，用於計算自注意力頭中的加權平均值。
TFDistilBertForMaskedLM 的 forward 方法，它覆蓋了 __call__ 特殊方法。
雖然 forward pass 的配方需要在此函式中定義，但在此之後應該呼叫 Module 例項，而不是此函式，因為前者負責執行預處理和後處理步驟，而後者則默默地忽略它們。
示例
>>> from transformers import AutoTokenizer, TFDistilBertForMaskedLM
>>> import tensorflow as tf
>>> tokenizer = AutoTokenizer.from_pretrained("distilbert-base-uncased")
>>> model = TFDistilBertForMaskedLM.from_pretrained("distilbert-base-uncased")
>>> inputs = tokenizer("The capital of France is [MASK].", return_tensors="tf")
>>> logits = model(**inputs).logits
>>> # retrieve index of [MASK]
>>> mask_token_index = tf.where((inputs.input_ids == tokenizer.mask_token_id)[0])
>>> selected_logits = tf.gather_nd(logits[0], indices=mask_token_index)
>>> predicted_token_id = tf.math.argmax(selected_logits, axis=-1)TFDistilBertForSequenceClassification
類 transformers.TFDistilBertForSequenceClassification
< 源 >( 配置 *輸入 **kwargs )
引數
- config (DistilBertConfig) — 包含模型所有引數的模型配置類。用配置檔案初始化不會載入與模型相關的權重，只加載配置。請檢視 from_pretrained() 方法載入模型權重。
DistilBert 模型 Transformer，頂部帶有一個序列分類/迴歸頭（池化輸出頂部的一個線性層），例如用於 GLUE 任務。
此模型繼承自 TFPreTrainedModel。檢視超類文件，瞭解庫為其所有模型實現的一般方法（例如下載或儲存、調整輸入嵌入大小、修剪頭部等）。
此模型也是 keras.Model 的子類。將其作為常規 TF 2.0 Keras 模型使用，並參閱 TF 2.0 文件瞭解所有與一般使用和行為相關的事項。
transformers 中的 TensorFlow 模型和層接受兩種輸入格式
- 所有輸入作為關鍵字引數（如 PyTorch 模型），或
- 所有輸入作為第一個位置引數中的列表、元組或字典。
支援第二種格式的原因是 Keras 方法在將輸入傳遞給模型和層時更喜歡這種格式。由於這種支援，當使用 model.fit() 等方法時，一切都應該“正常工作”——只需以 model.fit() 支援的任何格式傳遞您的輸入和標籤即可！但是，如果您想在 fit() 和 predict() 等 Keras 方法之外使用第二種格式，例如在使用 Keras Functional API 建立自己的層或模型時，您可以使用三種可能性來將所有輸入張量收集到第一個位置引數中
- 只有一個
input_ids的單個張量，沒有其他：model(input_ids) - 長度可變的列表，包含一個或多個輸入張量，按文件字串中給出的順序：
model([input_ids, attention_mask])或model([input_ids, attention_mask, token_type_ids]) - 一個字典，其中包含一個或多個與文件字串中給出的輸入名稱關聯的輸入張量：
model({"input_ids": input_ids, "token_type_ids": token_type_ids})
請注意，當使用 子類化 建立模型和層時，您無需擔心這些，因為您可以像傳遞給任何其他 Python 函式一樣傳遞輸入！
呼叫
< 源 >( input_ids: TFModelInputType | None = None attention_mask: np.ndarray | tf.Tensor | None = None head_mask: np.ndarray | tf.Tensor | None = None inputs_embeds: np.ndarray | tf.Tensor | None = None output_attentions: Optional[bool] = None output_hidden_states: Optional[bool] = None return_dict: Optional[bool] = None labels: np.ndarray | tf.Tensor | None = None training: Optional[bool] = False ) → transformers.modeling_tf_outputs.TFSequenceClassifierOutput 或 tuple(tf.Tensor)
引數
- input_ids (
Numpy array或tf.Tensorof shape(batch_size, sequence_length)) — 詞彙表中輸入序列標記的索引。可以使用 AutoTokenizer 獲取索引。有關詳細資訊，請參閱 PreTrainedTokenizer.call() 和 PreTrainedTokenizer.encode()。
- attention_mask (
Numpy array或tf.Tensorof shape(batch_size, sequence_length), 可選) — 用於避免對填充標記索引執行注意力操作的掩碼。掩碼值選擇範圍為[0, 1]：- 1 表示未被掩蓋的標記，
- 0 表示被掩蓋的標記。
- head_mask (
Numpy array或tf.Tensorof shape(num_heads,)或(num_layers, num_heads), 可選) — 用於使自注意力模組的選定頭部失效的掩碼。掩碼值選擇範圍為[0, 1]：- 1 表示頭部未被掩蓋，
- 0 表示頭部被掩蓋。
- inputs_embeds (
tf.Tensorof shape(batch_size, sequence_length, hidden_size), 可選) — 可選地，您可以透過嵌入表示直接傳遞，而不是傳遞input_ids。如果您希望對如何將input_ids索引轉換為關聯向量具有比模型內部嵌入查詢矩陣更多的控制，這將很有用。 - output_attentions (
bool, 可選) — 是否返回所有注意力層的注意力張量。有關詳細資訊，請參閱返回張量下的attentions。此引數只能在即時模式下使用，在圖模式下將使用配置中的值。 - output_hidden_states (
bool, 可選) — 是否返回所有層的隱藏狀態。更多詳情請參閱返回張量下的hidden_states。此引數只能在即時模式下使用，在圖模式下將使用配置中的值。 - return_dict (
bool, 可選) — 是否返回 ModelOutput 而不是普通的元組。此引數可在即時模式下使用，在圖模式下該值將始終設定為 True。 - training (
bool, 可選, 預設為False) — 是否在訓練模式下使用模型（某些模組，如 Dropout 模組，在訓練和評估之間有不同的行為）。 - labels (
tf.Tensor，形狀為(batch_size,)，可選) — 用於計算序列分類/迴歸損失的標籤。索引應在[0, ..., config.num_labels - 1]範圍內。如果config.num_labels == 1，則計算迴歸損失（均方損失）；如果config.num_labels > 1，則計算分類損失（交叉熵）。
返回
transformers.modeling_tf_outputs.TFSequenceClassifierOutput 或 tuple(tf.Tensor)
一個 transformers.modeling_tf_outputs.TFSequenceClassifierOutput 或一個 tf.Tensor 元組（如果傳入 return_dict=False 或 config.return_dict=False 時），包含根據配置 (DistilBertConfig) 和輸入的不同元素。
-
loss (
tf.Tensor，形狀為(batch_size, )，可選，當提供labels時返回) — 分類損失（如果 config.num_labels==1，則為迴歸損失）。 -
logits (
tf.Tensor，形狀為(batch_size, config.num_labels)) — 分類（或迴歸，如果 config.num_labels==1）分數（SoftMax 之前）。 -
hidden_states (
tuple(tf.Tensor), 可選, 當傳遞output_hidden_states=True或config.output_hidden_states=True時返回) — 形狀為(batch_size, sequence_length, hidden_size)的tf.Tensor元組（一個用於嵌入的輸出 + 一個用於每個層的輸出）。模型在每個層輸出的隱藏狀態加上初始嵌入輸出。
-
attentions (
tuple(tf.Tensor), 可選, 當傳遞output_attentions=True或config.output_attentions=True時返回) — 形狀為(batch_size, num_heads, sequence_length, sequence_length)的tf.Tensor元組（每個層一個）。注意力 softmax 後的注意力權重，用於計算自注意力頭中的加權平均值。
TFDistilBertForSequenceClassification 前向方法，覆蓋了 __call__ 特殊方法。
雖然 forward pass 的配方需要在此函式中定義，但在此之後應該呼叫 Module 例項，而不是此函式，因為前者負責執行預處理和後處理步驟，而後者則默默地忽略它們。
示例
>>> from transformers import AutoTokenizer, TFDistilBertForSequenceClassification
>>> import tensorflow as tf
>>> tokenizer = AutoTokenizer.from_pretrained("distilbert-base-uncased")
>>> model = TFDistilBertForSequenceClassification.from_pretrained("distilbert-base-uncased")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="tf")
>>> logits = model(**inputs).logits
>>> predicted_class_id = int(tf.math.argmax(logits, axis=-1)[0])>>> # To train a model on `num_labels` classes, you can pass `num_labels=num_labels` to `.from_pretrained(...)`
>>> num_labels = len(model.config.id2label)
>>> model = TFDistilBertForSequenceClassification.from_pretrained("distilbert-base-uncased", num_labels=num_labels)
>>> labels = tf.constant(1)
>>> loss = model(**inputs, labels=labels).lossTFDistilBertForMultipleChoice
class transformers.TFDistilBertForMultipleChoice
< 源 >( 配置 *輸入 **kwargs )
引數
- config (DistilBertConfig) — 模型的配置類，包含模型的所有引數。使用配置檔案初始化並不會載入與模型相關的權重，只加載配置。請檢視 from_pretrained() 方法以載入模型權重。
DistilBert 模型，頂部帶有多項選擇分類頭（池化輸出頂部的一個線性層和一個 softmax），例如用於 RocStories/SWAG 任務。
此模型繼承自 TFPreTrainedModel。檢視超類文件，瞭解庫為其所有模型實現的一般方法（例如下載或儲存、調整輸入嵌入大小、修剪頭部等）。
此模型也是 keras.Model 的子類。將其作為常規 TF 2.0 Keras 模型使用，並參閱 TF 2.0 文件瞭解所有與一般使用和行為相關的事項。
transformers 中的 TensorFlow 模型和層接受兩種輸入格式
- 所有輸入作為關鍵字引數（如 PyTorch 模型），或
- 所有輸入作為第一個位置引數中的列表、元組或字典。
支援第二種格式的原因是 Keras 方法在將輸入傳遞給模型和層時更喜歡這種格式。由於這種支援，當使用 model.fit() 等方法時，一切都應該“正常工作”——只需以 model.fit() 支援的任何格式傳遞您的輸入和標籤即可！但是，如果您想在 fit() 和 predict() 等 Keras 方法之外使用第二種格式，例如在使用 Keras Functional API 建立自己的層或模型時，您可以使用三種可能性來將所有輸入張量收集到第一個位置引數中
- 只有一個
input_ids的單個張量，沒有其他：model(input_ids) - 長度可變的列表，包含一個或多個輸入張量，按文件字串中給出的順序：
model([input_ids, attention_mask])或model([input_ids, attention_mask, token_type_ids]) - 一個字典，其中包含一個或多個與文件字串中給出的輸入名稱關聯的輸入張量：
model({"input_ids": input_ids, "token_type_ids": token_type_ids})
請注意，當使用 子類化 建立模型和層時，您無需擔心這些，因為您可以像傳遞給任何其他 Python 函式一樣傳遞輸入！
呼叫
< 源 >( input_ids: TFModelInputType | None = None attention_mask: np.ndarray | tf.Tensor | None = None head_mask: np.ndarray | tf.Tensor | None = None inputs_embeds: np.ndarray | tf.Tensor | None = None output_attentions: Optional[bool] = None output_hidden_states: Optional[bool] = None return_dict: Optional[bool] = None labels: np.ndarray | tf.Tensor | None = None training: Optional[bool] = False ) → transformers.modeling_tf_outputs.TFMultipleChoiceModelOutput 或 tuple(tf.Tensor)
引數
- input_ids (形狀為
(batch_size, num_choices, sequence_length)的Numpy array或tf.Tensor) — 詞彙表中輸入序列 token 的索引。索引可以使用 AutoTokenizer 獲取。詳情請參閱 PreTrainedTokenizer.call() 和 PreTrainedTokenizer.encode()。
- attention_mask (形狀為
(batch_size, num_choices, sequence_length)的Numpy array或tf.Tensor，可選) — 避免在填充 token 索引上執行注意力操作的掩碼。掩碼值選擇在[0, 1]之間：- 1 表示 token 未被掩蓋，
- 0 表示 token 已被掩蓋。
- head_mask (形狀為
(num_heads,)或(num_layers, num_heads)的Numpy array或tf.Tensor，可選) — 用於使自注意力模組的選定頭部無效的掩碼。掩碼值選擇在[0, 1]之間：- 1 表示頭部未被掩蓋，
- 0 表示頭部已被掩蓋。
- inputs_embeds (形狀為
(batch_size, num_choices, sequence_length, hidden_size)的tf.Tensor，可選) — 可選地，您可以選擇直接傳入嵌入表示，而不是傳入input_ids。如果您希望對input_ids索引如何轉換為相關向量有更多控制，而不是模型內部的嵌入查詢矩陣，這會很有用。 - output_attentions (
bool, 可選) — 是否返回所有注意力層的注意力張量。更多詳情請參閱返回張量下的attentions。此引數只能在即時模式下使用，在圖模式下將使用配置中的值。 - output_hidden_states (
bool, 可選) — 是否返回所有層的隱藏狀態。更多詳情請參閱返回張量下的hidden_states。此引數只能在即時模式下使用，在圖模式下將使用配置中的值。 - return_dict (
bool, 可選) — 是否返回 ModelOutput 而不是普通的元組。此引數可在即時模式下使用，在圖模式下該值將始終設定為 True。 - training (
bool, 可選, 預設為False) — 是否在訓練模式下使用模型（某些模組，如 Dropout 模組，在訓練和評估之間有不同的行為）。 - labels (
tf.Tensor，形狀為(batch_size,)，可選) — 用於計算多項選擇分類損失的標籤。索引應在[0, ..., num_choices]範圍內，其中num_choices是輸入張量第二維的大小。（請參見上面的input_ids）
返回
transformers.modeling_tf_outputs.TFMultipleChoiceModelOutput 或 tuple(tf.Tensor)
一個 transformers.modeling_tf_outputs.TFMultipleChoiceModelOutput 或一個 tf.Tensor 元組（如果傳入 return_dict=False 或 config.return_dict=False 時），包含根據配置 (DistilBertConfig) 和輸入的不同元素。
-
loss (
tf.Tensor，形狀為 (batch_size, )，可選，當提供labels時返回) — 分類損失。 -
logits (
tf.Tensor，形狀為(batch_size, num_choices)) — num_choices 是輸入張量的第二維。（參見上面的 input_ids）。分類分數（SoftMax 之前）。
-
hidden_states (
tuple(tf.Tensor), 可選, 當傳遞output_hidden_states=True或config.output_hidden_states=True時返回) — 形狀為(batch_size, sequence_length, hidden_size)的tf.Tensor元組（一個用於嵌入的輸出 + 一個用於每個層的輸出）。模型在每個層輸出的隱藏狀態加上初始嵌入輸出。
-
attentions (
tuple(tf.Tensor), 可選, 當傳遞output_attentions=True或config.output_attentions=True時返回) — 形狀為(batch_size, num_heads, sequence_length, sequence_length)的tf.Tensor元組（每個層一個）。注意力 softmax 後的注意力權重，用於計算自注意力頭中的加權平均值。
TFDistilBertForMultipleChoice 前向方法，覆蓋了 __call__ 特殊方法。
雖然 forward pass 的配方需要在此函式中定義，但在此之後應該呼叫 Module 例項，而不是此函式，因為前者負責執行預處理和後處理步驟，而後者則默默地忽略它們。
示例
>>> from transformers import AutoTokenizer, TFDistilBertForMultipleChoice
>>> import tensorflow as tf
>>> tokenizer = AutoTokenizer.from_pretrained("distilbert-base-uncased")
>>> model = TFDistilBertForMultipleChoice.from_pretrained("distilbert-base-uncased")
>>> prompt = "In Italy, pizza served in formal settings, such as at a restaurant, is presented unsliced."
>>> choice0 = "It is eaten with a fork and a knife."
>>> choice1 = "It is eaten while held in the hand."
>>> encoding = tokenizer([prompt, prompt], [choice0, choice1], return_tensors="tf", padding=True)
>>> inputs = {k: tf.expand_dims(v, 0) for k, v in encoding.items()}
>>> outputs = model(inputs) # batch size is 1
>>> # the linear classifier still needs to be trained
>>> logits = outputs.logitsTFDistilBertForTokenClassification
class transformers.TFDistilBertForTokenClassification
< 源 >( 配置 *輸入 **kwargs )
引數
- config (DistilBertConfig) — 模型的配置類，包含模型的所有引數。使用配置檔案初始化並不會載入與模型相關的權重，只加載配置。請檢視 from_pretrained() 方法以載入模型權重。
DistilBert 模型，頂部帶有 token 分類頭（隱藏狀態輸出頂部的一個線性層），例如用於命名實體識別（NER）任務。
此模型繼承自 TFPreTrainedModel。檢視超類文件，瞭解庫為其所有模型實現的一般方法（例如下載或儲存、調整輸入嵌入大小、修剪頭部等）。
此模型也是 keras.Model 的子類。將其作為常規 TF 2.0 Keras 模型使用，並參閱 TF 2.0 文件瞭解所有與一般使用和行為相關的事項。
transformers 中的 TensorFlow 模型和層接受兩種輸入格式
- 所有輸入作為關鍵字引數（如 PyTorch 模型），或
- 所有輸入作為第一個位置引數中的列表、元組或字典。
支援第二種格式的原因是 Keras 方法在將輸入傳遞給模型和層時更喜歡這種格式。由於這種支援，當使用 model.fit() 等方法時，一切都應該“正常工作”——只需以 model.fit() 支援的任何格式傳遞您的輸入和標籤即可！但是，如果您想在 fit() 和 predict() 等 Keras 方法之外使用第二種格式，例如在使用 Keras Functional API 建立自己的層或模型時，您可以使用三種可能性來將所有輸入張量收集到第一個位置引數中
- 只有一個
input_ids的單個張量，沒有其他：model(input_ids) - 長度可變的列表，包含一個或多個輸入張量，按文件字串中給出的順序：
model([input_ids, attention_mask])或model([input_ids, attention_mask, token_type_ids]) - 一個字典，其中包含一個或多個與文件字串中給出的輸入名稱關聯的輸入張量：
model({"input_ids": input_ids, "token_type_ids": token_type_ids})
請注意，當使用 子類化 建立模型和層時，您無需擔心這些，因為您可以像傳遞給任何其他 Python 函式一樣傳遞輸入！
呼叫
< 源 >( input_ids: TFModelInputType | None = None attention_mask: np.ndarray | tf.Tensor | None = None head_mask: np.ndarray | tf.Tensor | None = None inputs_embeds: np.ndarray | tf.Tensor | None = None output_attentions: Optional[bool] = None output_hidden_states: Optional[bool] = None return_dict: Optional[bool] = None labels: np.ndarray | tf.Tensor | None = None training: Optional[bool] = False ) → transformers.modeling_tf_outputs.TFTokenClassifierOutput 或 tuple(tf.Tensor)
引數
- input_ids (形狀為
(batch_size, sequence_length)的Numpy array或tf.Tensor) — 詞彙表中輸入序列 token 的索引。索引可以使用 AutoTokenizer 獲取。詳情請參閱 PreTrainedTokenizer.call() 和 PreTrainedTokenizer.encode()。
- attention_mask (形狀為
(batch_size, sequence_length)的Numpy array或tf.Tensor，可選) — 避免在填充 token 索引上執行注意力操作的掩碼。掩碼值選擇在[0, 1]之間：- 1 表示 token 未被掩蓋，
- 0 表示 token 已被掩蓋。
- head_mask (形狀為
(num_heads,)或(num_layers, num_heads)的Numpy array或tf.Tensor，可選) — 用於使自注意力模組的選定頭部無效的掩碼。掩碼值選擇在[0, 1]之間：- 1 表示頭部未被掩蓋，
- 0 表示頭部已被掩蓋。
- inputs_embeds (形狀為
(batch_size, sequence_length, hidden_size)的tf.Tensor，可選) — 可選地，您可以選擇直接傳入嵌入表示，而不是傳入input_ids。如果您希望對input_ids索引如何轉換為相關向量有更多控制，而不是模型內部的嵌入查詢矩陣，這會很有用。 - output_attentions (
bool, 可選) — 是否返回所有注意力層的注意力張量。更多詳情請參閱返回張量下的attentions。此引數只能在即時模式下使用，在圖模式下將使用配置中的值。 - output_hidden_states (
bool, 可選) — 是否返回所有層的隱藏狀態。更多詳情請參閱返回張量下的hidden_states。此引數只能在即時模式下使用，在圖模式下將使用配置中的值。 - return_dict (
bool, 可選) — 是否返回 ModelOutput 而不是普通的元組。此引數可在即時模式下使用，在圖模式下該值將始終設定為 True。 - training (
bool, 可選, 預設為False) — 是否在訓練模式下使用模型（某些模組，如 Dropout 模組，在訓練和評估之間有不同的行為）。 - labels (
tf.Tensor，形狀為(batch_size, sequence_length)，可選) — 用於計算 token 分類損失的標籤。索引應在[0, ..., config.num_labels - 1]範圍內。
返回
transformers.modeling_tf_outputs.TFTokenClassifierOutput 或 tuple(tf.Tensor)
一個 transformers.modeling_tf_outputs.TFTokenClassifierOutput 或一個 tf.Tensor 元組（如果傳入 return_dict=False 或 config.return_dict=False 時），包含根據配置 (DistilBertConfig) 和輸入的不同元素。
-
loss (
tf.Tensor，形狀為(n,)，可選，其中 n 是未被掩蓋的標籤數量，當提供labels時返回) — 分類損失。 -
logits (
tf.Tensor，形狀為(batch_size, sequence_length, config.num_labels)) — 分類分數（SoftMax 之前）。 -
hidden_states (
tuple(tf.Tensor), 可選, 當傳遞output_hidden_states=True或config.output_hidden_states=True時返回) — 形狀為(batch_size, sequence_length, hidden_size)的tf.Tensor元組（一個用於嵌入的輸出 + 一個用於每個層的輸出）。模型在每個層輸出的隱藏狀態加上初始嵌入輸出。
-
attentions (
tuple(tf.Tensor), 可選, 當傳遞output_attentions=True或config.output_attentions=True時返回) — 形狀為(batch_size, num_heads, sequence_length, sequence_length)的tf.Tensor元組（每個層一個）。注意力 softmax 後的注意力權重，用於計算自注意力頭中的加權平均值。
TFDistilBertForTokenClassification 前向方法，覆蓋了 __call__ 特殊方法。
雖然 forward pass 的配方需要在此函式中定義，但在此之後應該呼叫 Module 例項，而不是此函式，因為前者負責執行預處理和後處理步驟，而後者則默默地忽略它們。
示例
>>> from transformers import AutoTokenizer, TFDistilBertForTokenClassification
>>> import tensorflow as tf
>>> tokenizer = AutoTokenizer.from_pretrained("distilbert-base-uncased")
>>> model = TFDistilBertForTokenClassification.from_pretrained("distilbert-base-uncased")
>>> inputs = tokenizer(
... "HuggingFace is a company based in Paris and New York", add_special_tokens=False, return_tensors="tf"
... )
>>> logits = model(**inputs).logits
>>> predicted_token_class_ids = tf.math.argmax(logits, axis=-1)
>>> # Note that tokens are classified rather then input words which means that
>>> # there might be more predicted token classes than words.
>>> # Multiple token classes might account for the same word
>>> predicted_tokens_classes = [model.config.id2label[t] for t in predicted_token_class_ids[0].numpy().tolist()]TFDistilBertForQuestionAnswering
class transformers.TFDistilBertForQuestionAnswering
< 源 >( 配置 *輸入 **kwargs )
引數
- config (DistilBertConfig) — 模型的配置類，包含模型的所有引數。使用配置檔案初始化並不會載入與模型相關的權重，只加載配置。請檢視 from_pretrained() 方法以載入模型權重。
DistilBert 模型，頂部帶有 span 分類頭，用於抽取式問答任務，如 SQuAD（隱藏狀態輸出頂部的一個線性層，用於計算 span start logits 和 span end logits）。
此模型繼承自 TFPreTrainedModel。檢視超類文件，瞭解庫為其所有模型實現的一般方法（例如下載或儲存、調整輸入嵌入大小、修剪頭部等）。
此模型也是 keras.Model 的子類。將其作為常規 TF 2.0 Keras 模型使用，並參閱 TF 2.0 文件瞭解所有與一般使用和行為相關的事項。
transformers 中的 TensorFlow 模型和層接受兩種輸入格式
- 所有輸入作為關鍵字引數（如 PyTorch 模型），或
- 所有輸入作為第一個位置引數中的列表、元組或字典。
支援第二種格式的原因是 Keras 方法在將輸入傳遞給模型和層時更喜歡這種格式。由於這種支援，當使用 model.fit() 等方法時，一切都應該“正常工作”——只需以 model.fit() 支援的任何格式傳遞您的輸入和標籤即可！但是，如果您想在 fit() 和 predict() 等 Keras 方法之外使用第二種格式，例如在使用 Keras Functional API 建立自己的層或模型時，您可以使用三種可能性來將所有輸入張量收集到第一個位置引數中
- 只有一個
input_ids的單個張量，沒有其他：model(input_ids) - 長度可變的列表，包含一個或多個輸入張量，按文件字串中給出的順序：
model([input_ids, attention_mask])或model([input_ids, attention_mask, token_type_ids]) - 一個字典，其中包含一個或多個與文件字串中給出的輸入名稱關聯的輸入張量：
model({"input_ids": input_ids, "token_type_ids": token_type_ids})
請注意，當使用 子類化 建立模型和層時，您無需擔心這些，因為您可以像傳遞給任何其他 Python 函式一樣傳遞輸入！
呼叫
< 源 >( input_ids: TFModelInputType | None = None attention_mask: np.ndarray | tf.Tensor | None = None head_mask: np.ndarray | tf.Tensor | None = None inputs_embeds: np.ndarray | tf.Tensor | None = None output_attentions: Optional[bool] = None output_hidden_states: Optional[bool] = None return_dict: Optional[bool] = None start_positions: np.ndarray | tf.Tensor | None = None end_positions: np.ndarray | tf.Tensor | None = None training: Optional[bool] = False ) → transformers.modeling_tf_outputs.TFQuestionAnsweringModelOutput 或 tuple(tf.Tensor)
引數
- input_ids (形狀為
(batch_size, sequence_length)的Numpy array或tf.Tensor) — 詞彙表中輸入序列 token 的索引。索引可以使用 AutoTokenizer 獲取。詳情請參閱 PreTrainedTokenizer.call() 和 PreTrainedTokenizer.encode()。
- attention_mask (形狀為
(batch_size, sequence_length)的Numpy array或tf.Tensor，可選) — 避免在填充 token 索引上執行注意力操作的掩碼。掩碼值選擇在[0, 1]之間：- 1 表示 token 未被掩蓋，
- 0 表示 token 已被掩蓋。
- head_mask (形狀為
(num_heads,)或(num_layers, num_heads)的Numpy array或tf.Tensor，可選) — 用於使自注意力模組的選定頭部無效的掩碼。掩碼值選擇在[0, 1]之間：- 1 表示頭部未被掩蓋，
- 0 表示頭部已被掩蓋。
- inputs_embeds (形狀為
(batch_size, sequence_length, hidden_size)的tf.Tensor，可選) — 可選地，您可以選擇直接傳入嵌入表示，而不是傳入input_ids。如果您希望對input_ids索引如何轉換為相關向量有更多控制，而不是模型內部的嵌入查詢矩陣，這會很有用。 - output_attentions (
bool, 可選) — 是否返回所有注意力層的注意力張量。更多詳情請參閱返回張量下的attentions。此引數只能在即時模式下使用，在圖模式下將使用配置中的值。 - output_hidden_states (
bool, 可選) — 是否返回所有層的隱藏狀態。更多詳情請參閱返回張量下的hidden_states。此引數只能在即時模式下使用，在圖模式下將使用配置中的值。 - return_dict (
bool, optional) — 是否返回 ModelOutput 而不是普通元組。此引數可在即時模式下使用，在圖模式下該值將始終設定為 True。 - training (
bool, optional, defaults toFalse) — 是否在訓練模式下使用模型（某些模組如 dropout 模組在訓練和評估之間有不同的行為）。 - start_positions (形狀為
(batch_size,)的tf.Tensor, optional) — 用於計算令牌分類損失的標記跨度起始位置（索引）的標籤。位置被限制在序列的長度（sequence_length）範圍內。序列外部的位置不計入損失計算。 - end_positions (形狀為
(batch_size,)的tf.Tensor, optional) — 用於計算令牌分類損失的標記跨度結束位置（索引）的標籤。位置被限制在序列的長度（sequence_length）範圍內。序列外部的位置不計入損失計算。
返回
transformers.modeling_tf_outputs.TFQuestionAnsweringModelOutput 或 tuple(tf.Tensor)
一個 transformers.modeling_tf_outputs.TFQuestionAnsweringModelOutput 或一個 tf.Tensor 元組（如果傳入 return_dict=False 或當 config.return_dict=False 時），包含根據配置 (DistilBertConfig) 和輸入的不同元素。
-
loss (形狀為
(batch_size, )的tf.Tensor, optional, 當提供start_positions和end_positions時返回) — 總跨度提取損失是起始位置和結束位置的交叉熵之和。 -
start_logits (形狀為
(batch_size, sequence_length)的tf.Tensor) — 跨度起始分數（SoftMax 之前）。 -
end_logits (形狀為
(batch_size, sequence_length)的tf.Tensor) — 跨度結束分數（SoftMax 之前）。 -
hidden_states (
tuple(tf.Tensor), 可選, 當傳遞output_hidden_states=True或config.output_hidden_states=True時返回) — 形狀為(batch_size, sequence_length, hidden_size)的tf.Tensor元組（一個用於嵌入的輸出 + 一個用於每個層的輸出）。模型在每個層輸出的隱藏狀態加上初始嵌入輸出。
-
attentions (
tuple(tf.Tensor), 可選, 當傳遞output_attentions=True或config.output_attentions=True時返回) — 形狀為(batch_size, num_heads, sequence_length, sequence_length)的tf.Tensor元組（每個層一個）。注意力 softmax 後的注意力權重，用於計算自注意力頭中的加權平均值。
TFDistilBertForQuestionAnswering 的 forward 方法，覆蓋了 __call__ 特殊方法。
雖然 forward pass 的配方需要在此函式中定義，但在此之後應該呼叫 Module 例項，而不是此函式，因為前者負責執行預處理和後處理步驟，而後者則默默地忽略它們。
示例
>>> from transformers import AutoTokenizer, TFDistilBertForQuestionAnswering
>>> import tensorflow as tf
>>> tokenizer = AutoTokenizer.from_pretrained("distilbert-base-uncased")
>>> model = TFDistilBertForQuestionAnswering.from_pretrained("distilbert-base-uncased")
>>> question, text = "Who was Jim Henson?", "Jim Henson was a nice puppet"
>>> inputs = tokenizer(question, text, return_tensors="tf")
>>> outputs = model(**inputs)
>>> answer_start_index = int(tf.math.argmax(outputs.start_logits, axis=-1)[0])
>>> answer_end_index = int(tf.math.argmax(outputs.end_logits, axis=-1)[0])
>>> predict_answer_tokens = inputs.input_ids[0, answer_start_index : answer_end_index + 1]FlaxDistilBertModel
class transformers.FlaxDistilBertModel
< source >( config: DistilBertConfig input_shape: tuple = (1, 1) seed: int = 0 dtype: dtype = <class 'jax.numpy.float32'> _do_init: bool = True **kwargs )
引數
- config (DistilBertConfig) — 模型配置類，包含模型的所有引數。用配置檔案初始化不會載入與模型相關的權重，只加載配置。請檢視 from_pretrained() 方法來載入模型權重。
裸 DistilBert 模型轉換器，輸出原始隱藏狀態，頂部沒有任何特定頭。
該模型繼承自 FlaxPreTrainedModel。請檢視超類文件，瞭解庫為其所有模型實現的通用方法（例如從 PyTorch 模型下載、儲存和轉換權重）。
此模型也是 flax.linen.Module 的子類。將其作為常規的 Flax Linen 模組使用，並參考 Flax 文件瞭解所有與一般用法和行為相關的事項。
最後，此模型支援固有的 JAX 功能，例如
__call__
< source >( input_ids attention_mask = None head_mask = None params: typing.Optional[dict] = None dropout_rng: <function PRNGKey at 0x7effc7ad3a30> = None train: bool = False output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None )
引數
- input_ids (形狀為
(batch_size, sequence_length)的numpy.ndarray) — 詞彙表中輸入序列 token 的索引。可以使用 AutoTokenizer 獲取索引。有關詳細資訊，請參見 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (形狀為
(batch_size, sequence_length)的numpy.ndarray, optional) — 用於避免在填充 token 索引上執行注意力操作的掩碼。掩碼值選擇範圍為[0, 1]：- 1 表示 未被掩蓋 的 token，
- 0 表示 被掩蓋 的 token。
- output_attentions (
bool, optional) — 是否返回所有注意力層的注意力張量。有關更多詳細資訊，請參閱返回張量下的attentions。 - output_hidden_states (
bool, optional) — 是否返回所有層的隱藏狀態。有關更多詳細資訊，請參閱返回張量下的hidden_states。 - return_dict (
bool, optional) — 是否返回 ModelOutput 而不是普通元組。
FlaxDistilBertPreTrainedModel 的 forward 方法，覆蓋了 __call__ 特殊方法。
雖然 forward pass 的配方需要在此函式中定義，但在此之後應該呼叫 Module 例項，而不是此函式，因為前者負責執行預處理和後處理步驟，而後者則默默地忽略它們。
示例
>>> from transformers import AutoTokenizer, FlaxDistilBertModel
>>> tokenizer = AutoTokenizer.from_pretrained("distilbert-base-uncased")
>>> model = FlaxDistilBertModel.from_pretrained("distilbert-base-uncased")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="jax")
>>> outputs = model(**inputs)
>>> last_hidden_states = outputs.last_hidden_stateFlaxDistilBertForMaskedLM
class transformers.FlaxDistilBertForMaskedLM
< source >( config: DistilBertConfig input_shape: tuple = (1, 1) seed: int = 0 dtype: dtype = <class 'jax.numpy.float32'> _do_init: bool = True **kwargs )
引數
- config (DistilBertConfig) — 模型配置類，包含模型的所有引數。用配置檔案初始化不會載入與模型相關的權重，只加載配置。請檢視 from_pretrained() 方法來載入模型權重。
DistilBert 模型，頂部帶有 語言建模 頭。
該模型繼承自 FlaxPreTrainedModel。請檢視超類文件，瞭解庫為其所有模型實現的通用方法（例如從 PyTorch 模型下載、儲存和轉換權重）。
此模型也是 flax.linen.Module 的子類。將其作為常規的 Flax Linen 模組使用，並參考 Flax 文件瞭解所有與一般用法和行為相關的事項。
最後，此模型支援固有的 JAX 功能，例如
__call__
< source >( input_ids attention_mask = None head_mask = None params: typing.Optional[dict] = None dropout_rng: <function PRNGKey at 0x7effc7ad3a30> = None train: bool = False output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.modeling_flax_outputs.FlaxMaskedLMOutput 或 tuple(torch.FloatTensor)
引數
- input_ids (形狀為
(batch_size, sequence_length)的numpy.ndarray) — 詞彙表中輸入序列 token 的索引。可以使用 AutoTokenizer 獲取索引。有關詳細資訊，請參見 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (形狀為
(batch_size, sequence_length)的numpy.ndarray, optional) — 用於避免在填充 token 索引上執行注意力操作的掩碼。掩碼值選擇範圍為[0, 1]：- 1 表示 未被掩蓋 的 token，
- 0 表示 被掩蓋 的 token。
- output_attentions (
bool, optional) — 是否返回所有注意力層的注意力張量。有關更多詳細資訊，請參閱返回張量下的attentions。 - output_hidden_states (
bool, optional) — 是否返回所有層的隱藏狀態。有關更多詳細資訊，請參閱返回張量下的hidden_states。 - return_dict (
bool, optional) — 是否返回 ModelOutput 而不是普通元組。
返回
transformers.modeling_flax_outputs.FlaxMaskedLMOutput 或 tuple(torch.FloatTensor)
一個 transformers.modeling_flax_outputs.FlaxMaskedLMOutput 或一個 torch.FloatTensor 元組（如果傳入 return_dict=False 或當 config.return_dict=False 時），包含根據配置 (DistilBertConfig) 和輸入的不同元素。
-
logits (形狀為
(batch_size, sequence_length, config.vocab_size)的jnp.ndarray) — 語言建模頭的預測分數（SoftMax 之前每個詞彙 token 的分數）。 -
hidden_states (
tuple(jnp.ndarray), optional, 當傳入output_hidden_states=True或當config.output_hidden_states=True時返回) — 形狀為(batch_size, sequence_length, hidden_size)的jnp.ndarray元組（一個用於嵌入輸出 + 一個用於每層的輸出）。模型在每個層輸出的隱藏狀態加上初始嵌入輸出。
-
attentions (
tuple(jnp.ndarray), optional, 當傳入output_attentions=True或當config.output_attentions=True時返回) — 形狀為(batch_size, num_heads, sequence_length, sequence_length)的jnp.ndarray元組（每個層一個）。注意力 softmax 後的注意力權重，用於計算自注意力頭中的加權平均值。
FlaxDistilBertPreTrainedModel 的 forward 方法，覆蓋了 __call__ 特殊方法。
雖然 forward pass 的配方需要在此函式中定義，但在此之後應該呼叫 Module 例項，而不是此函式，因為前者負責執行預處理和後處理步驟，而後者則默默地忽略它們。
示例
>>> from transformers import AutoTokenizer, FlaxDistilBertForMaskedLM
>>> tokenizer = AutoTokenizer.from_pretrained("distilbert-base-uncased")
>>> model = FlaxDistilBertForMaskedLM.from_pretrained("distilbert-base-uncased")
>>> inputs = tokenizer("The capital of France is [MASK].", return_tensors="jax")
>>> outputs = model(**inputs)
>>> logits = outputs.logitsFlaxDistilBertForSequenceClassification
class transformers.FlaxDistilBertForSequenceClassification
< source >( config: DistilBertConfig input_shape: tuple = (1, 1) seed: int = 0 dtype: dtype = <class 'jax.numpy.float32'> _do_init: bool = True **kwargs )
引數
- config (DistilBertConfig) — 模型配置類，包含模型的所有引數。用配置檔案初始化不會載入與模型相關的權重，只加載配置。請檢視 from_pretrained() 方法來載入模型權重。
DistilBert 模型 Transformer，頂部帶有一個序列分類/迴歸頭（池化輸出頂部的一個線性層），例如用於 GLUE 任務。
該模型繼承自 FlaxPreTrainedModel。請檢視超類文件，瞭解庫為其所有模型實現的通用方法（例如從 PyTorch 模型下載、儲存和轉換權重）。
此模型也是 flax.linen.Module 的子類。將其作為常規的 Flax Linen 模組使用，並參考 Flax 文件瞭解所有與一般用法和行為相關的事項。
最後，此模型支援固有的 JAX 功能，例如
__call__
< source >( input_ids attention_mask = None head_mask = None params: typing.Optional[dict] = None dropout_rng: <function PRNGKey at 0x7effc7ad3a30> = None train: bool = False output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.modeling_flax_outputs.FlaxSequenceClassifierOutput 或 tuple(torch.FloatTensor)
引數
- input_ids (形狀為
(batch_size, sequence_length)的numpy.ndarray) — 詞彙表中輸入序列 token 的索引。可以使用 AutoTokenizer 獲取索引。有關詳細資訊，請參見 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (形狀為
(batch_size, sequence_length)的numpy.ndarray, optional) — 用於避免在填充 token 索引上執行注意力操作的掩碼。掩碼值選擇範圍為[0, 1]：- 1 表示 未被掩蓋 的 token，
- 0 表示 被掩蓋 的 token。
- output_attentions (
bool, optional) — 是否返回所有注意力層的注意力張量。有關更多詳細資訊，請參閱返回張量下的attentions。 - output_hidden_states (
bool, optional) — 是否返回所有層的隱藏狀態。有關更多詳細資訊，請參閱返回張量下的hidden_states。 - return_dict (
bool, optional) — 是否返回 ModelOutput 而不是普通元組。
返回
transformers.modeling_flax_outputs.FlaxSequenceClassifierOutput 或 tuple(torch.FloatTensor)
一個 transformers.modeling_flax_outputs.FlaxSequenceClassifierOutput 或一個 torch.FloatTensor 元組（如果傳入 return_dict=False 或當 config.return_dict=False 時），包含根據配置 (DistilBertConfig) 和輸入的不同元素。
-
logits (形狀為
(batch_size, config.num_labels)的jnp.ndarray) — 分類（如果 config.num_labels==1，則為迴歸）分數（SoftMax 之前）。 -
hidden_states (
tuple(jnp.ndarray), optional, 當傳入output_hidden_states=True或當config.output_hidden_states=True時返回) — 形狀為(batch_size, sequence_length, hidden_size)的jnp.ndarray元組（一個用於嵌入輸出 + 一個用於每層的輸出）。模型在每個層輸出的隱藏狀態加上初始嵌入輸出。
-
attentions (
tuple(jnp.ndarray), optional, 當傳入output_attentions=True或當config.output_attentions=True時返回) — 形狀為(batch_size, num_heads, sequence_length, sequence_length)的jnp.ndarray元組（每個層一個）。注意力 softmax 後的注意力權重，用於計算自注意力頭中的加權平均值。
FlaxDistilBertPreTrainedModel 的 forward 方法，覆蓋了 __call__ 特殊方法。
雖然 forward pass 的配方需要在此函式中定義，但在此之後應該呼叫 Module 例項，而不是此函式，因為前者負責執行預處理和後處理步驟，而後者則默默地忽略它們。
示例
>>> from transformers import AutoTokenizer, FlaxDistilBertForSequenceClassification
>>> tokenizer = AutoTokenizer.from_pretrained("distilbert-base-uncased")
>>> model = FlaxDistilBertForSequenceClassification.from_pretrained("distilbert-base-uncased")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="jax")
>>> outputs = model(**inputs)
>>> logits = outputs.logitsFlaxDistilBertForMultipleChoice
class transformers.FlaxDistilBertForMultipleChoice
< source >( config: DistilBertConfig input_shape: tuple = (1, 1) seed: int = 0 dtype: dtype = <class 'jax.numpy.float32'> _do_init: bool = True **kwargs )
引數
- config (DistilBertConfig) — 模型配置類，包含模型的所有引數。用配置檔案初始化不會載入與模型相關的權重，只加載配置。請檢視 from_pretrained() 方法來載入模型權重。
DistilBert 模型，頂部帶有多項選擇分類頭（池化輸出頂部的一個線性層和一個 softmax），例如用於 RocStories/SWAG 任務。
該模型繼承自 FlaxPreTrainedModel。請檢視超類文件，瞭解庫為其所有模型實現的通用方法（例如從 PyTorch 模型下載、儲存和轉換權重）。
此模型也是 flax.linen.Module 的子類。將其作為常規的 Flax Linen 模組使用，並參考 Flax 文件瞭解所有與一般用法和行為相關的事項。
最後，此模型支援固有的 JAX 功能，例如
__call__
< source >( input_ids attention_mask = None head_mask = None params: typing.Optional[dict] = None dropout_rng: <function PRNGKey at 0x7effc7ad3a30> = None train: bool = False output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.modeling_flax_outputs.FlaxMultipleChoiceModelOutput 或 tuple(torch.FloatTensor)
引數
- input_ids (形狀為
(batch_size, num_choices, sequence_length)的numpy.ndarray) — 詞彙表中輸入序列 token 的索引。可以使用 AutoTokenizer 獲取索引。有關詳細資訊，請參見 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (形狀為
(batch_size, num_choices, sequence_length)的numpy.ndarray, optional) — 用於避免在填充 token 索引上執行注意力操作的掩碼。掩碼值選擇範圍為[0, 1]：- 1 表示 未被掩蓋 的 token，
- 0 表示 被掩蓋 的 token。
- output_attentions (
bool, optional) — 是否返回所有注意力層的注意力張量。有關更多詳細資訊，請參閱返回張量下的attentions。 - output_hidden_states (
bool, optional) — 是否返回所有層的隱藏狀態。有關更多詳細資訊，請參閱返回張量下的hidden_states。 - return_dict (
bool, optional) — 是否返回 ModelOutput 而不是普通元組。
返回
transformers.modeling_flax_outputs.FlaxMultipleChoiceModelOutput 或 tuple(torch.FloatTensor)
一個 transformers.modeling_flax_outputs.FlaxMultipleChoiceModelOutput 或一個 torch.FloatTensor 元組（如果傳入 return_dict=False 或當 config.return_dict=False 時），包含根據配置 (DistilBertConfig) 和輸入的不同元素。
-
logits (形狀為
(batch_size, num_choices)的jnp.ndarray) — num_choices 是輸入張量的第二個維度。（請參閱上面的 input_ids）。分類分數（SoftMax 之前）。
-
hidden_states (
tuple(jnp.ndarray), optional, 當傳入output_hidden_states=True或當config.output_hidden_states=True時返回) — 形狀為(batch_size, sequence_length, hidden_size)的jnp.ndarray元組（一個用於嵌入輸出 + 一個用於每層的輸出）。模型在每個層輸出的隱藏狀態加上初始嵌入輸出。
-
attentions (
tuple(jnp.ndarray), optional, 當傳入output_attentions=True或當config.output_attentions=True時返回) — 形狀為(batch_size, num_heads, sequence_length, sequence_length)的jnp.ndarray元組（每個層一個）。注意力 softmax 後的注意力權重，用於計算自注意力頭中的加權平均值。
FlaxDistilBertPreTrainedModel 的 forward 方法，覆蓋了 __call__ 特殊方法。
雖然 forward pass 的配方需要在此函式中定義，但在此之後應該呼叫 Module 例項，而不是此函式，因為前者負責執行預處理和後處理步驟，而後者則默默地忽略它們。
示例
>>> from transformers import AutoTokenizer, FlaxDistilBertForMultipleChoice
>>> tokenizer = AutoTokenizer.from_pretrained("distilbert-base-uncased")
>>> model = FlaxDistilBertForMultipleChoice.from_pretrained("distilbert-base-uncased")
>>> prompt = "In Italy, pizza served in formal settings, such as at a restaurant, is presented unsliced."
>>> choice0 = "It is eaten with a fork and a knife."
>>> choice1 = "It is eaten while held in the hand."
>>> encoding = tokenizer([prompt, prompt], [choice0, choice1], return_tensors="jax", padding=True)
>>> outputs = model(**{k: v[None, :] for k, v in encoding.items()})
>>> logits = outputs.logitsFlaxDistilBertForTokenClassification
class transformers.FlaxDistilBertForTokenClassification
< source >( config: DistilBertConfig input_shape: tuple = (1, 1) seed: int = 0 dtype: dtype = <class 'jax.numpy.float32'> _do_init: bool = True **kwargs )
引數
- config (DistilBertConfig) — 模型配置類，包含模型的所有引數。用配置檔案初始化不會載入與模型相關的權重，只加載配置。請檢視 from_pretrained() 方法來載入模型權重。
DistilBert 模型，頂部帶有 token 分類頭（隱藏狀態輸出頂部的一個線性層），例如用於命名實體識別（NER）任務。
該模型繼承自 FlaxPreTrainedModel。請檢視超類文件，瞭解庫為其所有模型實現的通用方法（例如從 PyTorch 模型下載、儲存和轉換權重）。
此模型也是 flax.linen.Module 的子類。將其作為常規的 Flax Linen 模組使用，並參考 Flax 文件瞭解所有與一般用法和行為相關的事項。
最後，此模型支援固有的 JAX 功能，例如
__call__
< source >( input_ids attention_mask = None head_mask = None params: typing.Optional[dict] = None dropout_rng: <function PRNGKey at 0x7effc7ad3a30> = None train: bool = False output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.modeling_flax_outputs.FlaxTokenClassifierOutput 或 tuple(torch.FloatTensor)
引數
- input_ids (
numpy.ndarray，形狀為(batch_size, sequence_length)) — 詞彙表中輸入序列 token 的索引。可以使用 AutoTokenizer 獲取索引。有關詳細資訊，請參閱 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
numpy.ndarray，形狀為(batch_size, sequence_length)，可選) — 用於避免在填充 token 索引上執行注意力操作的掩碼。掩碼值選擇範圍為[0, 1]：- 1 表示 未被掩碼 的 token，
- 0 表示 被掩碼 的 token。
- output_attentions (
bool, 可選) — 是否返回所有注意力層的注意力張量。有關詳細資訊，請參閱返回張量中的attentions。 - output_hidden_states (
bool, 可選) — 是否返回所有層的隱藏狀態。有關詳細資訊，請參閱返回張量中的hidden_states。 - return_dict (
bool, 可選) — 是否返回 ModelOutput 而非普通元組。
返回
transformers.modeling_flax_outputs.FlaxTokenClassifierOutput 或 tuple(torch.FloatTensor)
一個 transformers.modeling_flax_outputs.FlaxTokenClassifierOutput 或一個 torch.FloatTensor 元組（如果傳遞 return_dict=False 或當 config.return_dict=False 時），包含取決於配置 (DistilBertConfig) 和輸入的不同元素。
-
logits (
jnp.ndarray，形狀為(batch_size, sequence_length, config.num_labels)) — 分類得分（SoftMax 之前）。 -
hidden_states (
tuple(jnp.ndarray), optional, 當傳入output_hidden_states=True或當config.output_hidden_states=True時返回) — 形狀為(batch_size, sequence_length, hidden_size)的jnp.ndarray元組（一個用於嵌入輸出 + 一個用於每層的輸出）。模型在每個層輸出的隱藏狀態加上初始嵌入輸出。
-
attentions (
tuple(jnp.ndarray), optional, 當傳入output_attentions=True或當config.output_attentions=True時返回) — 形狀為(batch_size, num_heads, sequence_length, sequence_length)的jnp.ndarray元組（每個層一個）。注意力 softmax 後的注意力權重，用於計算自注意力頭中的加權平均值。
FlaxDistilBertPreTrainedModel 的 forward 方法，覆蓋了 __call__ 特殊方法。
雖然 forward pass 的配方需要在此函式中定義，但在此之後應該呼叫 Module 例項，而不是此函式，因為前者負責執行預處理和後處理步驟，而後者則默默地忽略它們。
示例
>>> from transformers import AutoTokenizer, FlaxDistilBertForTokenClassification
>>> tokenizer = AutoTokenizer.from_pretrained("distilbert-base-uncased")
>>> model = FlaxDistilBertForTokenClassification.from_pretrained("distilbert-base-uncased")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="jax")
>>> outputs = model(**inputs)
>>> logits = outputs.logitsFlaxDistilBertForQuestionAnswering
class transformers.FlaxDistilBertForQuestionAnswering
< 源 >( config: DistilBertConfig input_shape: tuple = (1, 1) seed: int = 0 dtype: dtype = <class 'jax.numpy.float32'> _do_init: bool = True **kwargs )
引數
- config (DistilBertConfig) — 模型的配置類，包含模型的所有引數。用配置檔案初始化不會載入與模型相關的權重，只會載入配置。請檢視 from_pretrained() 方法來載入模型權重。
DistilBert 模型，頂部帶有一個用於抽取式問答任務（如 SQuAD）的跨度分類頭（在隱藏狀態輸出之上的一層線性層，用於計算 span start logits 和 span end logits）。
該模型繼承自 FlaxPreTrainedModel。請檢視超類文件，瞭解庫為其所有模型實現的通用方法（例如從 PyTorch 模型下載、儲存和轉換權重）。
此模型也是 flax.linen.Module 的子類。將其作為常規的 Flax Linen 模組使用，並參考 Flax 文件瞭解所有與一般用法和行為相關的事項。
最後，此模型支援固有的 JAX 功能，例如
__call__
< 源 >( input_ids attention_mask = None head_mask = None params: typing.Optional[dict] = None dropout_rng: <function PRNGKey at 0x7effc7ad3a30> = None train: bool = False output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.modeling_flax_outputs.FlaxQuestionAnsweringModelOutput 或 tuple(torch.FloatTensor)
引數
- input_ids (
numpy.ndarray，形狀為(batch_size, sequence_length)) — 詞彙表中輸入序列 token 的索引。可以使用 AutoTokenizer 獲取索引。有關詳細資訊，請參閱 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
numpy.ndarray，形狀為(batch_size, sequence_length)，可選) — 用於避免在填充 token 索引上執行注意力操作的掩碼。掩碼值選擇範圍為[0, 1]：- 1 表示 未被掩碼 的 token，
- 0 表示 被掩碼 的 token。
- output_attentions (
bool, 可選) — 是否返回所有注意力層的注意力張量。有關詳細資訊，請參閱返回張量中的attentions。 - output_hidden_states (
bool, 可選) — 是否返回所有層的隱藏狀態。有關詳細資訊，請參閱返回張量中的hidden_states。 - return_dict (
bool, 可選) — 是否返回 ModelOutput 而非普通元組。
返回
transformers.modeling_flax_outputs.FlaxQuestionAnsweringModelOutput 或 tuple(torch.FloatTensor)
一個 transformers.modeling_flax_outputs.FlaxQuestionAnsweringModelOutput 或一個 torch.FloatTensor 元組（如果傳遞 return_dict=False 或當 config.return_dict=False 時），包含取決於配置 (DistilBertConfig) 和輸入的不同元素。
-
start_logits (
jnp.ndarray，形狀為(batch_size, sequence_length)) — 跨度開始得分（SoftMax 之前）。 -
end_logits (
jnp.ndarray，形狀為(batch_size, sequence_length)) — 跨度結束得分（SoftMax 之前）。 -
hidden_states (
tuple(jnp.ndarray), optional, 當傳入output_hidden_states=True或當config.output_hidden_states=True時返回) — 形狀為(batch_size, sequence_length, hidden_size)的jnp.ndarray元組（一個用於嵌入輸出 + 一個用於每層的輸出）。模型在每個層輸出的隱藏狀態加上初始嵌入輸出。
-
attentions (
tuple(jnp.ndarray), optional, 當傳入output_attentions=True或當config.output_attentions=True時返回) — 形狀為(batch_size, num_heads, sequence_length, sequence_length)的jnp.ndarray元組（每個層一個）。注意力 softmax 後的注意力權重，用於計算自注意力頭中的加權平均值。
FlaxDistilBertPreTrainedModel 的 forward 方法，覆蓋了 __call__ 特殊方法。
雖然 forward pass 的配方需要在此函式中定義，但在此之後應該呼叫 Module 例項，而不是此函式，因為前者負責執行預處理和後處理步驟，而後者則默默地忽略它們。
示例
>>> from transformers import AutoTokenizer, FlaxDistilBertForQuestionAnswering
>>> tokenizer = AutoTokenizer.from_pretrained("distilbert-base-uncased")
>>> model = FlaxDistilBertForQuestionAnswering.from_pretrained("distilbert-base-uncased")
>>> question, text = "Who was Jim Henson?", "Jim Henson was a nice puppet"
>>> inputs = tokenizer(question, text, return_tensors="jax")
>>> outputs = model(**inputs)
>>> start_scores = outputs.start_logits
>>> end_scores = outputs.end_logits