Transformers 文件
MobileBERT
並獲得增強的文件體驗
開始使用
MobileBERT
MobileBERT 是 BERT 的一種輕量級、高效的變體，專為手機等資源受限的裝置設計。它保留了 BERT 的架構，但在顯著減小模型大小和推理延遲的同時，在自然語言處理任務上保持了強大的效能。MobileBERT 透過瓶頸結構以及精心平衡的自注意力和前饋網路實現了這一點。該模型透過從具有倒置瓶頸結構的大型 BERT 模型中進行知識遷移來訓練。
你可以在 Google 組織下找到原始的 MobileBERT 檢查點。
點選右側邊欄中的 MobileBERT 模型，檢視更多關於如何將 MobileBERT 應用於不同語言任務的示例。
以下示例演示瞭如何使用 Pipeline、AutoModel 以及從命令列預測 [MASK] 詞元。
import torch
from transformers import pipeline
pipeline = pipeline(
task="fill-mask",
model="google/mobilebert-uncased",
torch_dtype=torch.float16,
device=0
)
pipeline("The capital of France is [MASK].")註釋
- 輸入應在右側進行填充，因為 BERT 使用絕對位置嵌入。
MobileBertConfig
class transformers.MobileBertConfig
< 原始碼 >( vocab_size = 30522 hidden_size = 512 num_hidden_layers = 24 num_attention_heads = 4 intermediate_size = 512 hidden_act = 'relu' hidden_dropout_prob = 0.0 attention_probs_dropout_prob = 0.1 max_position_embeddings = 512 type_vocab_size = 2 initializer_range = 0.02 layer_norm_eps = 1e-12 pad_token_id = 0 embedding_size = 128 trigram_input = True use_bottleneck = True intra_bottleneck_size = 128 use_bottleneck_attention = False key_query_shared_bottleneck = True num_feedforward_networks = 4 normalization_type = 'no_norm' classifier_activation = True classifier_dropout = None **kwargs )
引數
- vocab_size (
int, 可選, 預設為 30522) — MobileBERT 模型的詞彙表大小。定義了在呼叫 MobileBertModel 或 TFMobileBertModel 時，可以透過inputs_ids傳遞的不同詞元的數量。 - hidden_size (
int, 可選, 預設為 512) — 編碼器層和池化層的維度。 - num_hidden_layers (
int, 可選, 預設為 24) — Transformer 編碼器中的隱藏層數量。 - num_attention_heads (
int, 可選, 預設為 4) — Transformer 編碼器中每個注意力層的注意力頭數量。 - intermediate_size (
int, 可選, 預設為 512) — Transformer 編碼器中“中間”（通常稱為前饋）層的維度。 - hidden_act (
str或function, 可選, 預設為"relu") — 編碼器和池化層中的非線性啟用函式（函式或字串）。如果為字串，支援"gelu"、"relu"、"silu"和"gelu_new"。 - hidden_dropout_prob (
float, 可選, 預設為 0.0) — 嵌入層、編碼器和池化層中所有全連線層的丟棄機率。 - attention_probs_dropout_prob (
float, 可選, 預設為 0.1) — 注意力機率的丟棄率。 - max_position_embeddings (
int, 可選, 預設為 512) — 此模型可能使用的最大序列長度。通常，為防止意外情況，應設定一個較大的值（例如 512、1024 或 2048）。 - type_vocab_size (
int, 可選, 預設為 2) — 在呼叫 MobileBertModel 或 TFMobileBertModel 時傳遞的token_type_ids的詞彙表大小。 - initializer_range (
float, 可選, 預設為 0.02) — 用於初始化所有權重矩陣的 truncated_normal_initializer 的標準差。 - layer_norm_eps (
float, 可選, 預設為 1e-12) — 層歸一化層使用的 epsilon 值。 - pad_token_id (
int, 可選, 預設為 0) — 詞嵌入中用作填充的詞元 ID。 - embedding_size (
int, 可選, 預設為 128) — 詞嵌入向量的維度。 - trigram_input (
bool, 可選, 預設為True) — 是否使用三元組的卷積作為輸入。 - use_bottleneck (
bool, 可選, 預設為True) — 是否在 BERT 中使用瓶頸層。 - intra_bottleneck_size (
int, 可選, 預設為 128) — 瓶頸層輸出的大小。 - use_bottleneck_attention (
bool, 可選, 預設為False) — 是否使用來自瓶頸變換的注意力輸入。 - key_query_shared_bottleneck (
bool, 可選, 預設為True) — 是否在瓶頸層中為查詢和鍵使用相同的線性變換。 - num_feedforward_networks (
int, 可選, 預設為 4) — 一個塊中前饋網路（FFN）的數量。 - normalization_type (
str, 可選, 預設為"no_norm") — MobileBERT 中的歸一化型別。 - classifier_dropout (
float, 可選) — 分類頭的丟棄率。
這是一個配置類，用於儲存 MobileBertModel 或 TFMobileBertModel 的配置。它用於根據指定的引數例項化一個 MobileBERT 模型，並定義模型架構。使用預設值例項化一個配置將產生一個與 MobileBERT google/mobilebert-uncased 架構相似的配置。
配置物件繼承自 PretrainedConfig，可用於控制模型的輸出。更多資訊請閱讀 PretrainedConfig 的文件。
示例
>>> from transformers import MobileBertConfig, MobileBertModel
>>> # Initializing a MobileBERT configuration
>>> configuration = MobileBertConfig()
>>> # Initializing a model (with random weights) from the configuration above
>>> model = MobileBertModel(configuration)
>>> # Accessing the model configuration
>>> configuration = model.configMobileBertTokenizer
class transformers.MobileBertTokenizer
< 原始碼 >( 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, 可選) — 在分詞過程中永遠不會被分割的詞元集合。僅在 `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` 的值決定（與原始 MobileBERT 中一樣）。 - clean_up_tokenization_spaces (
bool, 可選, 預設為True) — 是否在解碼後清理空格，清理工作包括移除可能的多餘空格等偽影。
構建一個 MobileBERT 分詞器。基於 WordPiece。
該分詞器繼承自 PreTrainedTokenizer，其中包含了大部分主要方法。使用者應參考此超類以獲取有關這些方法的更多資訊。
build_inputs_with_special_tokens
< source >( token_ids_0: list token_ids_1: typing.Optional[list[int]] = None ) → List[int]
透過連線並新增特殊詞元，從一個序列或一對序列為序列分類任務構建模型輸入。一個 MobileBERT 序列具有以下格式：
- 單個序列：
[CLS] X [SEP] - 序列對：
[CLS] A [SEP] B [SEP]
將標記序列（字串）轉換為單個字串。
get_special_tokens_mask
< source >( token_ids_0: list token_ids_1: typing.Optional[list[int]] = None already_has_special_tokens: bool = False ) → List[int]
從沒有新增特殊標記的標記列表中檢索序列ID。此方法在使用分詞器prepare_for_model方法新增特殊標記時呼叫。
MobileBertTokenizerFast
class transformers.MobileBertTokenizerFast
< source >( 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` 的值決定（與原始 MobileBERT 中一樣）。 - wordpieces_prefix (
str, 可選, 預設為 `"##"`) — 子詞的字首。
構建一個“快速”的 MobileBERT 分詞器（由 HuggingFace 的 *tokenizers* 庫支援）。基於 WordPiece。
該分詞器繼承自 PreTrainedTokenizerFast，其中包含了大部分主要方法。使用者應參考此超類以獲取有關這些方法的更多資訊。
build_inputs_with_special_tokens
< source >( token_ids_0 token_ids_1 = None ) → List[int]
透過連線並新增特殊詞元，從一個序列或一對序列為序列分類任務構建模型輸入。一個 MobileBERT 序列具有以下格式：
- 單個序列：
[CLS] X [SEP] - 序列對：
[CLS] A [SEP] B [SEP]
MobileBert 特定輸出
class transformers.models.mobilebert.modeling_mobilebert.MobileBertForPreTrainingOutput
< source >( loss: typing.Optional[torch.FloatTensor] = None prediction_logits: typing.Optional[torch.FloatTensor] = None seq_relationship_logits: typing.Optional[torch.FloatTensor] = None hidden_states: typing.Optional[tuple[torch.FloatTensor]] = None attentions: typing.Optional[tuple[torch.FloatTensor]] = None )
引數
- loss (`*可選*`, 在提供 `labels` 時返回, `torch.FloatTensor` 型別，形狀為 `(1,)`) — 掩碼語言建模損失和下一句預測（分類）損失之和的總損失。
- prediction_logits (`torch.FloatTensor` 型別，形狀為 `(batch_size, sequence_length, config.vocab_size)`) — 語言建模頭的預測分數（SoftMax 之前每個詞彙表詞元的分數）。
- seq_relationship_logits (`torch.FloatTensor` 型別，形狀為 `(batch_size, 2)`) — 下一句預測（分類）頭的預測分數（SoftMax 之前 True/False 連續的分數）。
- hidden_states (`tuple[torch.FloatTensor]`, *可選*, 在傳遞 `output_hidden_states=True` 或 `config.output_hidden_states=True` 時返回) — `torch.FloatTensor` 的元組（如果模型有嵌入層，則一個用於嵌入層的輸出，外加每個層的輸出），形狀為 `(batch_size, sequence_length, hidden_size)`。
模型在每層輸出處的隱藏狀態以及可選的初始嵌入輸出。
- attentions (`tuple[torch.FloatTensor]`, *可選*, 在傳遞 `output_attentions=True` 或 `config.output_attentions=True` 時返回) — `torch.FloatTensor` 的元組（每層一個），形狀為 `(batch_size, num_heads, sequence_length, sequence_length)`。
注意力 softmax 之後的注意力權重，用於計算自注意力頭中的加權平均值。
MobileBertForPreTraining 的輸出型別。
class transformers.models.mobilebert.modeling_tf_mobilebert.TFMobileBertForPreTrainingOutput
< source >( loss: tf.Tensor | None = None prediction_logits: Optional[tf.Tensor] = None seq_relationship_logits: Optional[tf.Tensor] = None hidden_states: tuple[tf.Tensor] | None = None attentions: tuple[tf.Tensor] | None = None )
引數
- prediction_logits (`tf.Tensor` 型別，形狀為 `(batch_size, sequence_length, config.vocab_size)`) — 語言建模頭的預測分數（SoftMax 之前每個詞彙表詞元的分數）。
- seq_relationship_logits (`tf.Tensor` 型別，形狀為 `(batch_size, 2)`) — 下一句預測（分類）頭的預測分數（SoftMax 之前 True/False 連續的分數）。
- hidden_states (`tuple(tf.Tensor)`, *可選*, 在傳遞 `output_hidden_states=True` 或 `config.output_hidden_states=True` 時返回) — `tf.Tensor` 的元組（一個用於嵌入層的輸出，外加每個層的輸出），形狀為 `(batch_size, sequence_length, hidden_size)`。
模型在每層輸出處的隱藏狀態以及初始嵌入輸出。
- attentions (`tuple(tf.Tensor)`, *可選*, 在傳遞 `output_attentions=True` 或 `config.output_attentions=True` 時返回) — `tf.Tensor` 的元組（每層一個），形狀為 `(batch_size, num_heads, sequence_length, sequence_length)`。
注意力 softmax 之後的注意力權重，用於計算自注意力頭中的加權平均值。
TFMobileBertForPreTraining 的輸出型別。
MobileBertModel
class transformers.MobileBertModel
< source >( config add_pooling_layer = True )
引數
- config (MobileBertModel) — 模型配置類，包含模型的所有引數。使用配置檔案初始化不會載入與模型關聯的權重，只會載入配置。請查閱 from_pretrained() 方法來載入模型權重。
- add_pooling_layer (
bool, 可選, 預設為True) — 是否新增池化層。
基礎的 Mobilebert 模型，輸出原始的隱藏狀態，頂部沒有任何特定的頭。
該模型繼承自 PreTrainedModel。查閱超類文件以瞭解該庫為所有模型實現的通用方法（例如下載或儲存、調整輸入嵌入大小、修剪頭部等）。
該模型也是 PyTorch 的 torch.nn.Module 子類。可以像常規 PyTorch 模組一樣使用它，並參考 PyTorch 文件瞭解所有與通用用法和行為相關的事項。
forward
< source >( 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 output_hidden_states: typing.Optional[bool] = None output_attentions: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.modeling_outputs.BaseModelOutputWithPooling 或 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.n_positions - 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_hidden_states (
bool，可選) — 是否返回所有層的隱藏狀態。有關更多詳細資訊，請參閱返回張量下的 `hidden_states`。 - output_attentions (
bool，可選) — 是否返回所有注意力層的注意力張量。有關更多詳細資訊，請參閱返回張量下的 `attentions`。 - return_dict (
bool，可選) — 是否返回一個 ModelOutput 而不是一個普通的元組。
返回
transformers.modeling_outputs.BaseModelOutputWithPooling 或 tuple(torch.FloatTensor)
一個 transformers.modeling_outputs.BaseModelOutputWithPooling 或一個 `torch.FloatTensor` 的元組（如果傳遞了 `return_dict=False` 或者 `config.return_dict=False`），根據配置（MobileBertConfig）和輸入，包含各種元素。
-
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 後的注意力權重，用於計算自注意力頭中的加權平均值。
MobileBertModel 的前向方法覆蓋了 `__call__` 特殊方法。
儘管前向傳遞的流程需要在此函式內定義，但之後應該呼叫 `Module` 例項而不是這個函式，因為前者會處理執行前處理和後處理步驟，而後者會靜默地忽略它們。
MobileBertForPreTraining
class transformers.MobileBertForPreTraining
< 原始碼 >( config )
引數
- config (MobileBertForPreTraining) — 包含模型所有引數的模型配置類。使用配置檔案初始化不會載入與模型相關的權重，只會載入配置。請檢視 from_pretrained() 方法來載入模型權重。
MobileBert 模型在頂部帶有兩個頭，如同預訓練時一樣：一個“掩碼語言建模”頭和一個“下一句預測（分類）”頭。
該模型繼承自 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 next_sentence_label: typing.Optional[torch.LongTensor] = None output_attentions: typing.Optional[torch.FloatTensor] = None output_hidden_states: typing.Optional[torch.FloatTensor] = None return_dict: typing.Optional[torch.FloatTensor] = None ) → transformers.models.mobilebert.modeling_mobilebert.MobileBertForPreTrainingOutput 或 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.n_positions - 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` 索引轉換為相關聯的向量，這會很有用。 - labels (
torch.LongTensor，形狀為(batch_size, sequence_length)，可選) — 用於計算掩碼語言建模損失的標籤。索引應在 `[-100, 0, ..., config.vocab_size]` 中（請參閱 `input_ids` 文件字串）。索引設定為 `-100` 的詞元將被忽略（掩碼），損失僅對標籤在 `[0, ..., config.vocab_size]` 中的詞元計算。 - next_sentence_label (
torch.LongTensor，形狀為(batch_size,)，可選) — 用於計算下一序列預測（分類）損失的標籤。輸入應該是一個序列對（請參閱 `input_ids` 文件字串）。索引應在 `[0, 1]` 中：- 0 表示序列 B 是序列 A 的延續，
- 1 表示序列 B 是一個隨機序列。
- output_attentions (
torch.FloatTensor，可選) — 是否返回所有注意力層的注意力張量。有關更多詳細資訊，請參閱返回張量下的 `attentions`。 - output_hidden_states (
torch.FloatTensor，可選) — 是否返回所有層的隱藏狀態。有關更多詳細資訊，請參閱返回張量下的 `hidden_states`。 - return_dict (
torch.FloatTensor，可選) — 是否返回一個 ModelOutput 而不是一個普通的元組。
返回
transformers.models.mobilebert.modeling_mobilebert.MobileBertForPreTrainingOutput 或 tuple(torch.FloatTensor)
一個 transformers.models.mobilebert.modeling_mobilebert.MobileBertForPreTrainingOutput 或一個 `torch.FloatTensor` 的元組（如果傳遞了 `return_dict=False` 或者 `config.return_dict=False`），根據配置（MobileBertConfig）和輸入，包含各種元素。
-
loss (
*可選*，當提供了 `labels` 時返回，torch.FloatTensor，形狀為(1,)) — 總損失，是掩碼語言建模損失和下一序列預測（分類）損失的和。 -
prediction_logits (
torch.FloatTensor形狀為(batch_size, sequence_length, config.vocab_size)) — 語言建模頭的預測分數（SoftMax 之前的每個詞彙 token 的分數）。 -
seq_relationship_logits (
torch.FloatTensor形狀為(batch_size, 2)) — 下一序列預測（分類）頭的預測分數（SoftMax 之前的 True/False 延續分數）。 -
hidden_states (
tuple[torch.FloatTensor]，可選，當傳遞 `output_hidden_states=True` 或 `config.output_hidden_states=True` 時返回) — `torch.FloatTensor` 的元組（如果模型有嵌入層，則第一個是嵌入層的輸出，然後是每一層的輸出），形狀為 `(batch_size, sequence_length, hidden_size)`。模型在每個層輸出的隱藏狀態以及可選的初始嵌入輸出。
-
attentions (
tuple[torch.FloatTensor]，可選，當傳遞 `output_attentions=True` 或 `config.output_attentions=True` 時返回) — `torch.FloatTensor` 的元組（每層一個），形狀為 `(batch_size, num_heads, sequence_length, sequence_length)`。注意力 softmax 後的注意力權重，用於計算自注意力頭中的加權平均值。
MobileBertForPreTraining 的前向方法覆蓋了 `__call__` 特殊方法。
儘管前向傳遞的流程需要在此函式內定義，但之後應該呼叫 `Module` 例項而不是這個函式，因為前者會處理執行前處理和後處理步驟，而後者會靜默地忽略它們。
示例
>>> from transformers import AutoTokenizer, MobileBertForPreTraining
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("google/mobilebert-uncased")
>>> model = MobileBertForPreTraining.from_pretrained("google/mobilebert-uncased")
>>> input_ids = torch.tensor(tokenizer.encode("Hello, my dog is cute", add_special_tokens=True)).unsqueeze(0)
>>> # Batch size 1
>>> outputs = model(input_ids)
>>> prediction_logits = outputs.prediction_logits
>>> seq_relationship_logits = outputs.seq_relationship_logitsMobileBertForMaskedLM
class transformers.MobileBertForMaskedLM
< 原始碼 >( config )
引數
- config (MobileBertForMaskedLM) — 包含模型所有引數的模型配置類。使用配置檔案初始化不會載入與模型相關的權重，只會載入配置。請檢視 from_pretrained() 方法來載入模型權重。
帶有一個“語言建模”頭的 Mobilebert 模型。”
該模型繼承自 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.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.n_positions - 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` 索引轉換為相關聯的向量，這會很有用。 - 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`），根據配置（MobileBertConfig）和輸入，包含各種元素。
-
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 後的注意力權重，用於計算自注意力頭中的加權平均值。
MobileBertForMaskedLM 的前向方法覆蓋了 `__call__` 特殊方法。
儘管前向傳遞的流程需要在此函式內定義，但之後應該呼叫 `Module` 例項而不是這個函式，因為前者會處理執行前處理和後處理步驟，而後者會靜默地忽略它們。
示例
>>> from transformers import AutoTokenizer, MobileBertForMaskedLM
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("google/mobilebert-uncased")
>>> model = MobileBertForMaskedLM.from_pretrained("google/mobilebert-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)
...MobileBertForNextSentencePrediction
class transformers.MobileBertForNextSentencePrediction
< 原始碼 >( config )
引數
- config (MobileBertForNextSentencePrediction) — 包含模型所有引數的模型配置類。使用配置檔案初始化不會載入與模型相關的權重，只會載入配置。請檢視 from_pretrained() 方法來載入模型權重。
帶有一個“下一句預測（分類）”頭的 MobileBert 模型。
該模型繼承自 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.n_positions - 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` 索引轉換為相關聯的向量，這會很有用。 - labels (
torch.LongTensor，形狀為(batch_size,)，可選) — 用於計算下一序列預測（分類）損失的標籤。輸入應該是一個序列對（請參閱 `input_ids` 文件字串）。索引應在 `[0, 1]` 中。- 0 表示序列 B 是序列 A 的延續，
- 1 表示序列 B 是一個隨機序列。
- output_attentions (
bool，可選) — 是否返回所有注意力層的注意力張量。有關更多詳細資訊，請參閱返回張量下的 `attentions`。 - output_hidden_states (
bool，可選) — 是否返回所有層的隱藏狀態。有關更多詳細資訊，請參閱返回張量下的 `hidden_states`。 - return_dict (
bool，可選) — 是否返回一個 ModelOutput 而不是一個普通的元組。
返回
transformers.modeling_outputs.NextSentencePredictorOutput 或 tuple(torch.FloatTensor)
一個 transformers.modeling_outputs.NextSentencePredictorOutput 或一個 `torch.FloatTensor` 的元組（如果傳遞了 `return_dict=False` 或者 `config.return_dict=False`），根據配置（MobileBertConfig）和輸入，包含各種元素。
-
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 後的注意力權重，用於計算自注意力頭中的加權平均值。
MobileBertForNextSentencePrediction 的前向方法覆蓋了 `__call__` 特殊方法。
儘管前向傳遞的流程需要在此函式內定義，但之後應該呼叫 `Module` 例項而不是這個函式，因為前者會處理執行前處理和後處理步驟，而後者會靜默地忽略它們。
示例
>>> from transformers import AutoTokenizer, MobileBertForNextSentencePrediction
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("google/mobilebert-uncased")
>>> model = MobileBertForNextSentencePrediction.from_pretrained("google/mobilebert-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]))
>>> loss = outputs.loss
>>> logits = outputs.logitsMobileBertForSequenceClassification
class transformers.MobileBertForSequenceClassification
< 源 >( config )
引數
- config (MobileBertForSequenceClassification) — 包含模型所有引數的模型配置類。使用配置檔案進行初始化不會載入與模型相關的權重，只會載入配置。請檢視 from_pretrained() 方法以載入模型權重。
MobileBert 模型轉換器，其頂部帶有一個序列分類/迴歸頭（在池化輸出之上是一個線性層），例如用於 GLUE 任務。
該模型繼承自 PreTrainedModel。查閱超類文件以瞭解該庫為所有模型實現的通用方法（例如下載或儲存、調整輸入嵌入大小、修剪頭部等）。
該模型也是 PyTorch 的 torch.nn.Module 子類。可以像常規 PyTorch 模組一樣使用它，並參考 PyTorch 文件瞭解所有與通用用法和行為相關的事項。
forward
< 源 >( input_ids: typing.Optional[torch.Tensor] = None attention_mask: typing.Optional[torch.Tensor] = None token_type_ids: typing.Optional[torch.Tensor] = None position_ids: typing.Optional[torch.Tensor] = None head_mask: typing.Optional[torch.Tensor] = None inputs_embeds: typing.Optional[torch.Tensor] = None labels: 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.SequenceClassifierOutput 或 tuple(torch.FloatTensor)
引數
- input_ids (
torch.Tensor，形狀為(batch_size, sequence_length)，可選) — 詞彙表中輸入序列標記的索引。預設情況下將忽略填充。索引可以使用 AutoTokenizer 獲得。有關詳細資訊，請參閱 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensor，形狀為(batch_size, sequence_length)，可選) — 用於避免在填充標記索引上執行注意力的掩碼。掩碼值在[0, 1]中選擇：- 1 表示標記未被遮蓋，
- 0 表示標記被遮蓋。
- token_type_ids (
torch.Tensor，形狀為(batch_size, sequence_length)，可選) — 段標記索引，用於指示輸入的第一和第二部分。索引在[0, 1]中選擇：- 0 對應於 句子 A 的標記，
- 1 對應於 句子 B 的標記。
- position_ids (
torch.Tensor，形狀為(batch_size, sequence_length)，可選) — 每個輸入序列標記在位置嵌入中的位置索引。選擇範圍為[0, config.n_positions - 1]。 - head_mask (
torch.Tensor，形狀為(num_heads,)或(num_layers, num_heads)，可選) — 用於使自注意力模組的選定頭無效的掩碼。掩碼值在[0, 1]中選擇：- 1 表示頭未被遮蓋，
- 0 表示頭被遮蓋。
- inputs_embeds (
torch.Tensor，形狀為(batch_size, sequence_length, hidden_size)，可選) — 可選地，你可以選擇直接傳遞嵌入表示，而不是傳遞 `input_ids`。如果你希望比模型的內部嵌入查詢矩陣更多地控制如何將 `input_ids` 索引轉換為關聯向量，這會很有用。 - labels (
torch.LongTensor，形狀為(batch_size,)，可選) — 用於計算序列分類/迴歸損失的標籤。索引應在[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 時），根據配置 (MobileBertConfig) 和輸入包含各種元素。
-
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 後的注意力權重，用於計算自注意力頭中的加權平均值。
MobileBertForSequenceClassification 的 forward 方法重寫了 `__call__` 特殊方法。
儘管前向傳遞的流程需要在此函式內定義，但之後應該呼叫 `Module` 例項而不是這個函式，因為前者會處理執行前處理和後處理步驟，而後者會靜默地忽略它們。
單標籤分類示例
>>> import torch
>>> from transformers import AutoTokenizer, MobileBertForSequenceClassification
>>> tokenizer = AutoTokenizer.from_pretrained("google/mobilebert-uncased")
>>> model = MobileBertForSequenceClassification.from_pretrained("google/mobilebert-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 = MobileBertForSequenceClassification.from_pretrained("google/mobilebert-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, MobileBertForSequenceClassification
>>> tokenizer = AutoTokenizer.from_pretrained("google/mobilebert-uncased")
>>> model = MobileBertForSequenceClassification.from_pretrained("google/mobilebert-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 = MobileBertForSequenceClassification.from_pretrained(
... "google/mobilebert-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).lossMobileBertForMultipleChoice
class transformers.MobileBertForMultipleChoice
< 源 >( config )
引數
- config (MobileBertForMultipleChoice) — 包含模型所有引數的模型配置類。使用配置檔案進行初始化不會載入與模型相關的權重，只會載入配置。請檢視 from_pretrained() 方法以載入模型權重。
Mobilebert 模型，其頂部帶有多項選擇分類頭（在池化輸出之上是一個線性層和一個 softmax），例如用於 RocStories/SWAG 任務。
該模型繼承自 PreTrainedModel。查閱超類文件以瞭解該庫為所有模型實現的通用方法（例如下載或儲存、調整輸入嵌入大小、修剪頭部等）。
該模型也是 PyTorch 的 torch.nn.Module 子類。可以像常規 PyTorch 模組一樣使用它，並參考 PyTorch 文件瞭解所有與通用用法和行為相關的事項。
forward
< 源 >( input_ids: typing.Optional[torch.Tensor] = None attention_mask: typing.Optional[torch.Tensor] = None token_type_ids: typing.Optional[torch.Tensor] = None position_ids: typing.Optional[torch.Tensor] = None head_mask: typing.Optional[torch.Tensor] = None inputs_embeds: typing.Optional[torch.Tensor] = None labels: 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.MultipleChoiceModelOutput 或 tuple(torch.FloatTensor)
引數
- input_ids (
torch.LongTensor，形狀為(batch_size, num_choices, sequence_length)) — 詞彙表中輸入序列標記的索引。索引可以使用 AutoTokenizer 獲得。有關詳細資訊，請參閱 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensor，形狀為(batch_size, 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.Tensor，形狀為(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` 索引轉換為關聯向量，這會很有用。 - labels (
torch.LongTensor，形狀為(batch_size,)，可選) — 用於計算多項選擇分類損失的標籤。索引應在[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 時），根據配置 (MobileBertConfig) 和輸入包含各種元素。
-
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 後的注意力權重，用於計算自注意力頭中的加權平均值。
MobileBertForMultipleChoice 的 forward 方法重寫了 `__call__` 特殊方法。
儘管前向傳遞的流程需要在此函式內定義，但之後應該呼叫 `Module` 例項而不是這個函式，因為前者會處理執行前處理和後處理步驟，而後者會靜默地忽略它們。
示例
>>> from transformers import AutoTokenizer, MobileBertForMultipleChoice
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("google/mobilebert-uncased")
>>> model = MobileBertForMultipleChoice.from_pretrained("google/mobilebert-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.logitsMobileBertForTokenClassification
class transformers.MobileBertForTokenClassification
< 源 >( config )
引數
- config (MobileBertForTokenClassification) — 包含模型所有引數的模型配置類。使用配置檔案進行初始化不會載入與模型相關的權重，只會載入配置。請檢視 from_pretrained() 方法以載入模型權重。
Mobilebert 轉換器，其頂部帶有一個標記分類頭（在隱藏狀態輸出之上是一個線性層），例如用於命名實體識別（NER）任務。
該模型繼承自 PreTrainedModel。查閱超類文件以瞭解該庫為所有模型實現的通用方法（例如下載或儲存、調整輸入嵌入大小、修剪頭部等）。
該模型也是 PyTorch 的 torch.nn.Module 子類。可以像常規 PyTorch 模組一樣使用它，並參考 PyTorch 文件瞭解所有與通用用法和行為相關的事項。
forward
< 源 >( input_ids: typing.Optional[torch.Tensor] = None attention_mask: typing.Optional[torch.Tensor] = None token_type_ids: typing.Optional[torch.Tensor] = None position_ids: typing.Optional[torch.Tensor] = None head_mask: typing.Optional[torch.Tensor] = None inputs_embeds: typing.Optional[torch.Tensor] = None labels: 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.TokenClassifierOutput 或 tuple(torch.FloatTensor)
引數
- input_ids (
torch.Tensor，形狀為(batch_size, sequence_length)，可選) — 詞彙表中輸入序列標記的索引。預設情況下將忽略填充。索引可以使用 AutoTokenizer 獲得。有關詳細資訊，請參閱 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensor，形狀為(batch_size, sequence_length)，可選) — 用於避免在填充標記索引上執行注意力的掩碼。掩碼值在[0, 1]中選擇：- 1 表示標記未被遮蓋，
- 0 表示標記被遮蓋。
- token_type_ids (
torch.Tensor，形狀為(batch_size, sequence_length)，可選) — 段標記索引，用於指示輸入的第一和第二部分。索引在[0, 1]中選擇：- 0 對應於 句子 A 的標記，
- 1 對應於 句子 B 的標記。
- position_ids (
torch.Tensor，形狀為(batch_size, sequence_length)，可選) — 每個輸入序列標記在位置嵌入中的位置索引。選擇範圍為[0, config.n_positions - 1]。 - head_mask (
torch.Tensor，形狀為(num_heads,)或(num_layers, num_heads)，可選) — 用於使自注意力模組的選定頭無效的掩碼。掩碼值在[0, 1]中選擇：- 1 表示頭未被遮蓋，
- 0 表示頭被遮蓋。
- inputs_embeds (
torch.Tensor，形狀為(batch_size, sequence_length, hidden_size)，可選) — 可選地，你可以選擇直接傳遞嵌入表示，而不是傳遞 `input_ids`。如果你希望比模型的內部嵌入查詢矩陣更多地控制如何將 `input_ids` 索引轉換為關聯向量，這會很有用。 - labels (
torch.LongTensor，形狀為(batch_size, sequence_length)，可選) — 用於計算標記分類損失的標籤。索引應在[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 時），根據配置 (MobileBertConfig) 和輸入包含各種元素。
-
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 後的注意力權重，用於計算自注意力頭中的加權平均值。
MobileBertForTokenClassification 的 forward 方法重寫了 `__call__` 特殊方法。
儘管前向傳遞的流程需要在此函式內定義，但之後應該呼叫 `Module` 例項而不是這個函式，因為前者會處理執行前處理和後處理步驟，而後者會靜默地忽略它們。
示例
>>> from transformers import AutoTokenizer, MobileBertForTokenClassification
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("google/mobilebert-uncased")
>>> model = MobileBertForTokenClassification.from_pretrained("google/mobilebert-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)
...MobileBertForQuestionAnswering
class transformers.MobileBertForQuestionAnswering
< 原始碼 >( config )
引數
- config (MobileBertForQuestionAnswering) — 包含模型所有引數的模型配置類。使用配置檔案進行初始化時，不會載入與模型相關的權重，只會載入配置。請檢視 from_pretrained() 方法以載入模型權重。
Mobilebert Transformer 模型，其頂部帶有一個用於抽取式問答任務（如SQuAD）的片段分類頭（一個位於隱藏狀態輸出之上的線性層，用於計算`span start logits`和`span end logits`）。
該模型繼承自 PreTrainedModel。查閱超類文件以瞭解該庫為所有模型實現的通用方法（例如下載或儲存、調整輸入嵌入大小、修剪頭部等）。
該模型也是 PyTorch 的 torch.nn.Module 子類。可以像常規 PyTorch 模組一樣使用它，並參考 PyTorch 文件瞭解所有與通用用法和行為相關的事項。
forward
< 原始碼 >( input_ids: typing.Optional[torch.Tensor] = None attention_mask: typing.Optional[torch.Tensor] = None token_type_ids: typing.Optional[torch.Tensor] = None position_ids: 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 或 tuple(torch.FloatTensor)
引數
- input_ids (
torch.Tensor，形狀為(batch_size, sequence_length)，可選) — 詞彙表中輸入序列標記的索引。預設情況下，填充將被忽略。可以使用 AutoTokenizer 獲取索引。有關詳細資訊，請參閱 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensor，形狀為(batch_size, sequence_length)，可選) — 用於避免對填充標記索引執行注意力計算的掩碼。掩碼值在[0, 1]中選擇：- 1 表示標記未被掩碼，
- 0 表示標記已被掩碼。
- token_type_ids (
torch.Tensor，形狀為(batch_size, sequence_length)，可選) — 用於指示輸入的第一部分和第二部分的片段標記索引。索引在[0, 1]中選擇：- 0 對應於 *A 句子* 的標記，
- 1 對應於 *B 句子* 的標記。
- position_ids (
torch.Tensor，形狀為(batch_size, sequence_length)，可選) — 每個輸入序列標記在位置嵌入中的位置索引。值在 `[0, config.n_positions - 1]` 範圍內選擇。 - head_mask (
torch.Tensor，形狀為(num_heads,)或(num_layers, num_heads)，可選) — 用於置零自注意力模組中選定頭的掩碼。掩碼值在[0, 1]中選擇：- 1 表示頭未被掩碼，
- 0 表示頭已被掩碼。
- inputs_embeds (
torch.Tensor，形狀為(batch_size, sequence_length, hidden_size)，可選) — 可以選擇直接傳遞嵌入表示，而不是傳遞 `input_ids`。如果你想比模型內部嵌入查詢矩陣更多地控制如何將 `input_ids` 索引轉換為關聯向量，這會很有用。 - start_positions (
torch.Tensor，形狀為(batch_size,)，可選) — 標記片段開始位置（索引）的標籤，用於計算標記分類損失。位置被限制在序列長度（`sequence_length`）內。序列之外的位置在計算損失時不被考慮。 - end_positions (
torch.Tensor，形狀為(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`），根據配置（MobileBertConfig）和輸入的不同，包含不同的元素。
-
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 後的注意力權重，用於計算自注意力頭中的加權平均值。
MobileBertForQuestionAnswering 的 forward 方法重寫了 `__call__` 特殊方法。
儘管前向傳遞的流程需要在此函式內定義，但之後應該呼叫 `Module` 例項而不是這個函式，因為前者會處理執行前處理和後處理步驟，而後者會靜默地忽略它們。
示例
>>> from transformers import AutoTokenizer, MobileBertForQuestionAnswering
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("google/mobilebert-uncased")
>>> model = MobileBertForQuestionAnswering.from_pretrained("google/mobilebert-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)
...TFMobileBertModel
class transformers.TFMobileBertModel
< 原始碼 >( config *inputs **kwargs )
引數
- config (MobileBertConfig) — 包含模型所有引數的模型配置類。使用配置檔案進行初始化時，不會載入與模型相關的權重，只會載入配置。請檢視 from_pretrained() 方法以載入模型權重。
基礎的 MobileBert Transformer 模型，輸出原始的隱藏狀態，頂部沒有任何特定的頭。
該模型繼承自 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 token_type_ids: np.ndarray | tf.Tensor | None = None position_ids: 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.TFBaseModelOutputWithPooling 或 tuple(tf.Tensor)
引數
- input_ids (
Numpy array或tf.Tensor，形狀為(batch_size, sequence_length)) — 詞彙表中輸入序列標記的索引。可以使用 AutoTokenizer 獲取索引。有關詳細資訊，請參閱 PreTrainedTokenizer.call() 和 PreTrainedTokenizer.encode()。
- attention_mask (
Numpy array或tf.Tensor，形狀為(batch_size, sequence_length)，可選) — 用於避免對填充標記索引執行注意力計算的掩碼。掩碼值在[0, 1]中選擇：- 1 表示標記未被掩碼，
- 0 表示標記已被掩碼。
- token_type_ids (
Numpy array或tf.Tensor，形狀為(batch_size, sequence_length)，可選) — 用於指示輸入的第一部分和第二部分的片段標記索引。索引在[0, 1]中選擇：- 0 對應於 *A 句子* 的標記，
- 1 對應於 *B 句子* 的標記。
- position_ids (
Numpy array或tf.Tensor，形狀為(batch_size, sequence_length)，可選) — 每個輸入序列標記在位置嵌入中的位置索引。值在 `[0, config.max_position_embeddings - 1]` 範圍內選擇。 - head_mask (
Numpy array或tf.Tensor，形狀為(num_heads,)或(num_layers, num_heads)，可選) — 用於置零自注意力模組中選定頭的掩碼。掩碼值在[0, 1]中選擇：- 1 表示頭未被掩碼，
- 0 表示頭已被掩碼。
- inputs_embeds (
tf.Tensor，形狀為(batch_size, sequence_length, hidden_size)，可選) — 可以選擇直接傳遞嵌入表示，而不是傳遞 `input_ids`。如果你想比模型內部嵌入查詢矩陣更多地控制如何將 `input_ids` 索引轉換為關聯向量，這會很有用。 - output_attentions (
bool，可選) — 是否返回所有注意力層的注意力張量。有關更多詳細資訊，請參閱返回張量下的 `attentions`。此引數只能在即時模式下使用，在圖模式下將使用配置中的值。 - output_hidden_states (
bool，可選) — 是否返回所有層的隱藏狀態。有關更多詳細資訊，請參閱返回張量下的 `hidden_states`。此引數只能在即時模式下使用，在圖模式下將使用配置中的值。 - return_dict (
bool，可選) — 是否返回一個 ModelOutput 而不是一個普通的元組。此引數可以在即時模式下使用，在圖模式下，該值將始終設定為 True。 - training (
bool，可選，預設為False) — 是否在訓練模式下使用模型（一些模組如 dropout 模組在訓練和評估之間有不同的行為）。
返回
transformers.modeling_tf_outputs.TFBaseModelOutputWithPooling 或 tuple(tf.Tensor)
一個 transformers.modeling_tf_outputs.TFBaseModelOutputWithPooling 或一個 `tf.Tensor` 的元組（如果傳遞了 `return_dict=False` 或者 `config.return_dict=False`），根據配置（MobileBertConfig）和輸入的不同，包含不同的元素。
-
last_hidden_state (
tf.Tensorof shape(batch_size, sequence_length, hidden_size)) — 模型最後一層輸出的隱藏狀態序列。 -
pooler_output (
tf.Tensor，形狀為(batch_size, hidden_size)) — 序列第一個標記（分類標記）的最後一層隱藏狀態，經過一個線性層和一個 Tanh 啟用函式進一步處理。線性層的權重是在預訓練期間從下一句預測（分類）目標中訓練的。此輸出通常不是輸入語義內容的良好摘要，通常最好對整個輸入序列的隱藏狀態進行平均或池化。
-
hidden_states (
tuple(tf.Tensor)，可選，在傳遞 `output_hidden_states=True` 或 `config.output_hidden_states=True` 時返回) — `tf.Tensor` 的元組（一個用於嵌入的輸出 + 一個用於每層的輸出），形狀為(batch_size, sequence_length, hidden_size)。模型在每個層輸出的隱藏狀態加上初始嵌入輸出。
-
attentions (
tuple(tf.Tensor)，可選，在傳遞 `output_attentions=True` 或 `config.output_attentions=True` 時返回) — `tf.Tensor` 的元組（每層一個），形狀為(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 後的注意力權重，用於計算自注意力頭中的加權平均值。
TFMobileBertModel 的 forward 方法重寫了 `__call__` 特殊方法。
儘管前向傳遞的流程需要在此函式內定義，但之後應該呼叫 `Module` 例項而不是這個函式，因為前者會處理執行前處理和後處理步驟，而後者會靜默地忽略它們。
示例
>>> from transformers import AutoTokenizer, TFMobileBertModel
>>> import tensorflow as tf
>>> tokenizer = AutoTokenizer.from_pretrained("google/mobilebert-uncased")
>>> model = TFMobileBertModel.from_pretrained("google/mobilebert-uncased")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="tf")
>>> outputs = model(inputs)
>>> last_hidden_states = outputs.last_hidden_stateTFMobileBertForPreTraining
class transformers.TFMobileBertForPreTraining
< 原始碼 >( config *inputs **kwargs )
引數
- config (MobileBertConfig) — 包含模型所有引數的模型配置類。使用配置檔案進行初始化時，不會載入與模型相關的權重，只會載入配置。請檢視 from_pretrained() 方法以載入模型權重。
MobileBert 模型在頂部帶有兩個頭，如同預訓練時一樣：一個“掩碼語言建模”頭和一個“下一句預測（分類）”頭。
該模型繼承自 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 token_type_ids: np.ndarray | tf.Tensor | None = None position_ids: 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 next_sentence_label: np.ndarray | tf.Tensor | None = None training: Optional[bool] = False ) → transformers.models.mobilebert.modeling_tf_mobilebert.TFMobileBertForPreTrainingOutput 或 tuple(tf.Tensor)
引數
- input_ids (
Numpy array或tf.Tensor，形狀為(batch_size, sequence_length)) — 詞彙表中輸入序列標記的索引。可以使用 AutoTokenizer 獲取索引。有關詳細資訊，請參閱 PreTrainedTokenizer.call() 和 PreTrainedTokenizer.encode()。
- attention_mask (
Numpy array或tf.Tensor，形狀為(batch_size, sequence_length)，可選) — 用於避免對填充標記索引執行注意力計算的掩碼。掩碼值在[0, 1]中選擇：- 1 表示標記未被掩碼，
- 0 表示標記已被掩碼。
- token_type_ids (
Numpy array或tf.Tensor，形狀為(batch_size, sequence_length)，可選) — 用於指示輸入的第一部分和第二部分的片段標記索引。索引在[0, 1]中選擇：- 0 對應於 *A 句子* 的標記，
- 1 對應於 *B 句子* 的標記。
- position_ids (
Numpy array或tf.Tensor，形狀為(batch_size, sequence_length)，可選) — 每個輸入序列標記在位置嵌入中的位置索引。值在 `[0, config.max_position_embeddings - 1]` 範圍內選擇。 - head_mask (
Numpy array或tf.Tensor，形狀為(num_heads,)或(num_layers, num_heads)，可選) — 用於置零自注意力模組中選定頭的掩碼。掩碼值在[0, 1]中選擇：- 1 表示頭未被掩碼，
- 0 表示頭已被掩碼。
- inputs_embeds (
tf.Tensor，形狀為(batch_size, sequence_length, hidden_size)，可選) — 可以選擇直接傳遞嵌入表示，而不是傳遞 `input_ids`。如果你想比模型內部嵌入查詢矩陣更多地控制如何將 `input_ids` 索引轉換為關聯向量，這會很有用。 - output_attentions (
bool，可選) — 是否返回所有注意力層的注意力張量。有關更多詳細資訊，請參閱返回張量下的 `attentions`。此引數只能在即時模式下使用，在圖模式下將使用配置中的值。 - output_hidden_states (
bool，可選) — 是否返回所有層的隱藏狀態。有關更多詳細資訊，請參閱返回張量下的 `hidden_states`。此引數只能在即時模式下使用，在圖模式下將使用配置中的值。 - return_dict (
bool，可選) — 是否返回一個 ModelOutput 而不是一個普通的元組。此引數可以在即時模式下使用，在圖模式下，該值將始終設定為 True。 - training (
bool，可選，預設為False) — 是否在訓練模式下使用模型（一些模組如 dropout 模組在訓練和評估之間有不同的行為）。
返回
transformers.models.mobilebert.modeling_tf_mobilebert.TFMobileBertForPreTrainingOutput 或 tuple(tf.Tensor)
一個 transformers.models.mobilebert.modeling_tf_mobilebert.TFMobileBertForPreTrainingOutput 或一個 `tf.Tensor` 的元組（如果傳遞了 `return_dict=False` 或者 `config.return_dict=False`），根據配置（MobileBertConfig）和輸入的不同，包含不同的元素。
-
prediction_logits (
tf.Tensor，形狀為(batch_size, sequence_length, config.vocab_size)) — 語言模型頭部的預測分數（SoftMax 之前的每個詞彙標記的分數）。 -
seq_relationship_logits (
tf.Tensor，形狀為(batch_size, 2)) — 下一句預測（分類）頭的預測分數（SoftMax 前的 True/False 連續性分數）。 -
hidden_states (
tuple(tf.Tensor)，可選，在傳遞 `output_hidden_states=True` 或 `config.output_hidden_states=True` 時返回) — `tf.Tensor` 的元組（一個用於嵌入的輸出 + 一個用於每層的輸出），形狀為(batch_size, sequence_length, hidden_size)。模型在每個層輸出的隱藏狀態加上初始嵌入輸出。
-
attentions (
tuple(tf.Tensor)，可選，在傳遞 `output_attentions=True` 或 `config.output_attentions=True` 時返回) — `tf.Tensor` 的元組（每層一個），形狀為(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 後的注意力權重，用於計算自注意力頭中的加權平均值。
TFMobileBertForPreTraining 的 forward 方法重寫了 `__call__` 特殊方法。
儘管前向傳遞的流程需要在此函式內定義，但之後應該呼叫 `Module` 例項而不是這個函式，因為前者會處理執行前處理和後處理步驟，而後者會靜默地忽略它們。
示例
>>> import tensorflow as tf
>>> from transformers import AutoTokenizer, TFMobileBertForPreTraining
>>> tokenizer = AutoTokenizer.from_pretrained("google/mobilebert-uncased")
>>> model = TFMobileBertForPreTraining.from_pretrained("google/mobilebert-uncased")
>>> input_ids = tf.constant(tokenizer.encode("Hello, my dog is cute"))[None, :] # Batch size 1
>>> outputs = model(input_ids)
>>> prediction_scores, seq_relationship_scores = outputs[:2]TFMobileBertForMaskedLM
class transformers.TFMobileBertForMaskedLM
< 原始碼 >( config *inputs **kwargs )
引數
- config (MobileBertConfig) — 包含模型所有引數的模型配置類。使用配置檔案進行初始化時，不會載入與模型相關的權重，只會載入配置。請檢視 from_pretrained() 方法來載入模型權重。
MobileBert 模型，頂部帶有一個“語言建模”頭。
該模型繼承自 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 token_type_ids: np.ndarray | tf.Tensor | None = None position_ids: 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.Tensor，形狀為(batch_size, sequence_length)) — 詞彙表中輸入序列詞元的索引。可以使用 AutoTokenizer 獲取索引。有關詳細資訊，請參閱 PreTrainedTokenizer.call() 和 PreTrainedTokenizer.encode()。
- attention_mask (
Numpy array或tf.Tensor，形狀為(batch_size, sequence_length)，可選) — 用於避免對填充詞元索引執行注意力操作的掩碼。掩碼值在[0, 1]中選擇：- 1 表示詞元未被遮蔽，
- 0 表示詞元已被遮蔽。
- token_type_ids (
Numpy array或tf.Tensor，形狀為(batch_size, sequence_length)，可選) — 用於指示輸入的第一部分和第二部分的片段詞元索引。索引在[0, 1]中選擇：- 0 對應於 *A 句* 詞元，
- 1 對應於 *B 句* 詞元。
- position_ids (
Numpy array或tf.Tensor，形狀為(batch_size, sequence_length)，可選) — 位置嵌入中每個輸入序列詞元的位置索引。在[0, config.max_position_embeddings - 1]範圍內選擇。 - head_mask (
Numpy array或tf.Tensor，形狀為(num_heads,)或(num_layers, num_heads)，可選) — 用於使自注意力模組中選定的頭無效的掩碼。掩碼值在[0, 1]中選擇：- 1 表示頭未被遮蔽，
- 0 表示頭已被遮蔽。
- inputs_embeds (
tf.Tensor，形狀為(batch_size, sequence_length, hidden_size)，可選) — （可選）不傳遞input_ids，而是直接傳遞嵌入表示。如果你想比模型的內部嵌入查詢矩陣更好地控制如何將input_ids索引轉換為關聯向量，這會很有用。 - output_attentions (
bool，可選) — 是否返回所有注意力層的注意力張量。有關更多詳細資訊，請參閱返回的張量下的attentions。此引數只能在即時模式下使用，在圖模式下將使用配置中的值。 - output_hidden_states (
bool，可選) — 是否返回所有層的隱藏狀態。有關更多詳細資訊，請參閱返回的張量下的hidden_states。此引數只能在即時模式下使用，在圖模式下將使用配置中的值。 - return_dict (
bool，可選) — 是否返回 ModelOutput 而不是普通元組。此引數可在即時模式下使用，在圖模式下該值將始終設定為 True。 - training (
bool，可選，預設為False) — 是否在訓練模式下使用模型（某些模組如 dropout 模組在訓練和評估之間有不同的行為）。 - labels (
tf.Tensor，形狀為(batch_size, sequence_length)，可選) — 用於計算掩碼語言建模損失的標籤。索引應在[-100, 0, ..., config.vocab_size]中（請參閱input_ids文件字串）。索引設定為-100的詞元將被忽略（遮蔽），僅對有標籤的詞元計算損失。
返回
transformers.modeling_tf_outputs.TFMaskedLMOutput 或 tuple(tf.Tensor)
一個 transformers.modeling_tf_outputs.TFMaskedLMOutput 或一個 tf.Tensor 的元組（如果傳遞了 return_dict=False 或當 config.return_dict=False 時），根據配置（MobileBertConfig）和輸入，包含各種元素。
-
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` 時返回) — `tf.Tensor` 的元組（一個用於嵌入的輸出 + 一個用於每層的輸出），形狀為(batch_size, sequence_length, hidden_size)。模型在每個層輸出的隱藏狀態加上初始嵌入輸出。
-
attentions (
tuple(tf.Tensor)，可選，在傳遞 `output_attentions=True` 或 `config.output_attentions=True` 時返回) — `tf.Tensor` 的元組（每層一個），形狀為(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 後的注意力權重，用於計算自注意力頭中的加權平均值。
TFMobileBertForMaskedLM 的前向方法，重寫了 __call__ 特殊方法。
儘管前向傳遞的流程需要在此函式內定義，但之後應該呼叫 `Module` 例項而不是這個函式，因為前者會處理執行前處理和後處理步驟，而後者會靜默地忽略它們。
示例
>>> from transformers import AutoTokenizer, TFMobileBertForMaskedLM
>>> import tensorflow as tf
>>> tokenizer = AutoTokenizer.from_pretrained("google/mobilebert-uncased")
>>> model = TFMobileBertForMaskedLM.from_pretrained("google/mobilebert-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)
>>> tokenizer.decode(predicted_token_id)
'paris'TFMobileBertForNextSentencePrediction
class transformers.TFMobileBertForNextSentencePrediction
< 原始碼 >( config *inputs **kwargs )
引數
- config (MobileBertConfig) — 包含模型所有引數的模型配置類。使用配置檔案進行初始化時，不會載入與模型相關的權重，只會載入配置。請檢視 from_pretrained() 方法來載入模型權重。
帶有一個“下一句預測（分類）”頭的 MobileBert 模型。
該模型繼承自 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 token_type_ids: np.ndarray | tf.Tensor | None = None position_ids: 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 next_sentence_label: np.ndarray | tf.Tensor | None = None training: Optional[bool] = False ) → transformers.modeling_tf_outputs.TFNextSentencePredictorOutput 或 tuple(tf.Tensor)
引數
- input_ids (
Numpy array或tf.Tensor，形狀為(batch_size, sequence_length)) — 詞彙表中輸入序列詞元的索引。可以使用 AutoTokenizer 獲取索引。有關詳細資訊，請參閱 PreTrainedTokenizer.call() 和 PreTrainedTokenizer.encode()。
- attention_mask (
Numpy array或tf.Tensor，形狀為(batch_size, sequence_length)，可選) — 用於避免對填充詞元索引執行注意力操作的掩碼。掩碼值在[0, 1]中選擇：- 1 表示詞元未被遮蔽，
- 0 表示詞元已被遮蔽。
- token_type_ids (
Numpy array或tf.Tensor，形狀為(batch_size, sequence_length)，可選) — 用於指示輸入的第一部分和第二部分的片段詞元索引。索引在[0, 1]中選擇：- 0 對應於 *A 句* 詞元，
- 1 對應於 *B 句* 詞元。
- position_ids (
Numpy array或tf.Tensor，形狀為(batch_size, sequence_length)，可選) — 位置嵌入中每個輸入序列詞元的位置索引。在[0, config.max_position_embeddings - 1]範圍內選擇。 - head_mask (
Numpy array或tf.Tensor，形狀為(num_heads,)或(num_layers, num_heads)，可選) — 用於使自注意力模組中選定的頭無效的掩碼。掩碼值在[0, 1]中選擇：- 1 表示頭未被遮蔽，
- 0 表示頭已被遮蔽。
- inputs_embeds (
tf.Tensor，形狀為(batch_size, sequence_length, hidden_size)，可選) — （可選）不傳遞input_ids，而是直接傳遞嵌入表示。如果你想比模型的內部嵌入查詢矩陣更好地控制如何將input_ids索引轉換為關聯向量，這會很有用。 - output_attentions (
bool，可選) — 是否返回所有注意力層的注意力張量。有關更多詳細資訊，請參閱返回的張量下的attentions。此引數只能在即時模式下使用，在圖模式下將使用配置中的值。 - output_hidden_states (
bool，可選) — 是否返回所有層的隱藏狀態。有關更多詳細資訊，請參閱返回的張量下的hidden_states。此引數只能在即時模式下使用，在圖模式下將使用配置中的值。 - return_dict (
bool，可選) — 是否返回 ModelOutput 而不是普通元組。此引數可在即時模式下使用，在圖模式下該值將始終設定為 True。 - training (
bool，可選，預設為False) — 是否在訓練模式下使用模型（某些模組如 dropout 模組在訓練和評估之間有不同的行為）。
返回
transformers.modeling_tf_outputs.TFNextSentencePredictorOutput 或 tuple(tf.Tensor)
一個 transformers.modeling_tf_outputs.TFNextSentencePredictorOutput 或一個 tf.Tensor 的元組（如果傳遞了 return_dict=False 或當 config.return_dict=False 時），根據配置（MobileBertConfig）和輸入，包含各種元素。
-
loss (
tf.Tensor，形狀為(n,)，可選，其中 n 是非遮蔽標籤的數量，當提供了next_sentence_label時返回) — 下一句預測損失。 -
logits (
tf.Tensor，形狀為(batch_size, 2)) — 下一句序列預測（分類）頭的預測分數（SoftMax 之前的 True/False 連續性分數）。 -
hidden_states (
tuple(tf.Tensor)，可選，在傳遞 `output_hidden_states=True` 或 `config.output_hidden_states=True` 時返回) — `tf.Tensor` 的元組（一個用於嵌入的輸出 + 一個用於每層的輸出），形狀為(batch_size, sequence_length, hidden_size)。模型在每個層輸出的隱藏狀態加上初始嵌入輸出。
-
attentions (
tuple(tf.Tensor)，可選，在傳遞 `output_attentions=True` 或 `config.output_attentions=True` 時返回) — `tf.Tensor` 的元組（每層一個），形狀為(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 後的注意力權重，用於計算自注意力頭中的加權平均值。
TFMobileBertForNextSentencePrediction 的前向方法，重寫了 __call__ 特殊方法。
儘管前向傳遞的流程需要在此函式內定義，但之後應該呼叫 `Module` 例項而不是這個函式，因為前者會處理執行前處理和後處理步驟，而後者會靜默地忽略它們。
示例
>>> import tensorflow as tf
>>> from transformers import AutoTokenizer, TFMobileBertForNextSentencePrediction
>>> tokenizer = AutoTokenizer.from_pretrained("google/mobilebert-uncased")
>>> model = TFMobileBertForNextSentencePrediction.from_pretrained("google/mobilebert-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="tf")
>>> logits = model(encoding["input_ids"], token_type_ids=encoding["token_type_ids"])[0]TFMobileBertForSequenceClassification
class transformers.TFMobileBertForSequenceClassification
< 原始碼 >( config *inputs **kwargs )
引數
- config (MobileBertConfig) — 包含模型所有引數的模型配置類。使用配置檔案進行初始化時，不會載入與模型相關的權重，只會載入配置。請檢視 from_pretrained() 方法來載入模型權重。
MobileBert 模型轉換器，其頂部帶有一個序列分類/迴歸頭（在池化輸出之上是一個線性層），例如用於 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 token_type_ids: np.ndarray | tf.Tensor | None = None position_ids: 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.Tensor，形狀為(batch_size, sequence_length)) — 詞彙表中輸入序列詞元的索引。可以使用 AutoTokenizer 獲取索引。有關詳細資訊，請參閱 PreTrainedTokenizer.call() 和 PreTrainedTokenizer.encode()。
- attention_mask (
Numpy array或tf.Tensor，形狀為(batch_size, sequence_length)，可選) — 用於避免對填充詞元索引執行注意力操作的掩碼。掩碼值在[0, 1]中選擇：- 1 表示詞元未被遮蔽，
- 0 表示詞元已被遮蔽。
- token_type_ids (
Numpy array或tf.Tensor，形狀為(batch_size, sequence_length)，可選) — 用於指示輸入的第一部分和第二部分的片段詞元索引。索引在[0, 1]中選擇：- 0 對應於 *A 句* 詞元，
- 1 對應於 *B 句* 詞元。
- position_ids (
Numpy array或tf.Tensor，形狀為(batch_size, sequence_length)，可選) — 位置嵌入中每個輸入序列詞元的位置索引。在[0, config.max_position_embeddings - 1]範圍內選擇。 - head_mask (
Numpy array或tf.Tensor，形狀為(num_heads,)或(num_layers, num_heads)，可選) — 用於使自注意力模組中選定的頭無效的掩碼。掩碼值在[0, 1]中選擇：- 1 表示頭未被遮蔽，
- 0 表示頭已被遮蔽。
- inputs_embeds (
tf.Tensor，形狀為(batch_size, sequence_length, hidden_size)，可選) — （可選）不傳遞input_ids，而是直接傳遞嵌入表示。如果你想比模型的內部嵌入查詢矩陣更好地控制如何將input_ids索引轉換為關聯向量，這會很有用。 - output_attentions (
bool，可選) — 是否返回所有注意力層的注意力張量。有關更多詳細資訊，請參閱返回的張量下的attentions。此引數只能在即時模式下使用，在圖模式下將使用配置中的值。 - output_hidden_states (
bool，可選) — 是否返回所有層的隱藏狀態。有關更多詳細資訊，請參閱返回的張量下的hidden_states。此引數只能在即時模式下使用，在圖模式下將使用配置中的值。 - return_dict (
bool，可選) — 是否返回 ModelOutput 而不是普通元組。此引數可在即時模式下使用，在圖模式下該值將始終設定為 True。 - training (
bool，可選，預設為False) — 是否在訓練模式下使用模型（某些模組如 dropout 模組在訓練和評估之間有不同的行為）。 - 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 時），根據配置（MobileBertConfig）和輸入，包含各種元素。
-
loss (
tf.Tensor，形狀為(batch_size, )，可選，當提供labels時返回) — 分類損失（如果 config.num_labels==1，則為迴歸損失）。 -
logits (
tf.Tensor，形狀為(batch_size, config.num_labels)) — 分類（或迴歸，如果 config.num_labels==1）分數（SoftMax 之前）。 -
hidden_states (
tuple(tf.Tensor)，可選，在傳遞 `output_hidden_states=True` 或 `config.output_hidden_states=True` 時返回) — `tf.Tensor` 的元組（一個用於嵌入的輸出 + 一個用於每層的輸出），形狀為(batch_size, sequence_length, hidden_size)。模型在每個層輸出的隱藏狀態加上初始嵌入輸出。
-
attentions (
tuple(tf.Tensor)，可選，在傳遞 `output_attentions=True` 或 `config.output_attentions=True` 時返回) — `tf.Tensor` 的元組（每層一個），形狀為(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 後的注意力權重，用於計算自注意力頭中的加權平均值。
TFMobileBertForSequenceClassification 的前向方法，重寫了 __call__ 特殊方法。
儘管前向傳遞的流程需要在此函式內定義，但之後應該呼叫 `Module` 例項而不是這個函式，因為前者會處理執行前處理和後處理步驟，而後者會靜默地忽略它們。
示例
>>> from transformers import AutoTokenizer, TFMobileBertForSequenceClassification
>>> import tensorflow as tf
>>> tokenizer = AutoTokenizer.from_pretrained("vumichien/emo-mobilebert")
>>> model = TFMobileBertForSequenceClassification.from_pretrained("vumichien/emo-mobilebert")
>>> 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])
>>> model.config.id2label[predicted_class_id]
'others'>>> # 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 = TFMobileBertForSequenceClassification.from_pretrained("vumichien/emo-mobilebert", num_labels=num_labels)
>>> labels = tf.constant(1)
>>> loss = model(**inputs, labels=labels).loss
>>> round(float(loss), 2)
4.72TFMobileBertForMultipleChoice
class transformers.TFMobileBertForMultipleChoice
< 原始碼 >( config *inputs **kwargs )
引數
- config (MobileBertConfig) — 包含模型所有引數的模型配置類。使用配置檔案進行初始化時，不會載入與模型相關的權重，只會載入配置。請檢視 from_pretrained() 方法來載入模型權重。
MobileBert 模型，頂部帶有一個多項選擇分類頭（在池化輸出之上是一個線性層和一個 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 token_type_ids: np.ndarray | tf.Tensor | None = None position_ids: 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 (
Numpy array或tf.Tensor，形狀為(batch_size, num_choices, sequence_length)) — 詞彙表中輸入序列詞元的索引。可以使用 AutoTokenizer 獲取索引。有關詳細資訊，請參閱 PreTrainedTokenizer.call() 和 PreTrainedTokenizer.encode()。
- attention_mask (
Numpy arrayortf.Tensorof shape(batch_size, num_choices, sequence_length), optional) — 用於避免對填充標記索引執行注意力操作的掩碼。掩碼值選自[0, 1]：- 1 表示標記未被掩碼，
- 0 表示標記已被掩碼。
- token_type_ids (
Numpy arrayortf.Tensorof shape(batch_size, num_choices, sequence_length), optional) — 片段標記索引，用於指示輸入的第一和第二部分。索引選自[0, 1]：- 0 對應於 *A 句子* 的標記，
- 1 對應於 *B 句子* 的標記。
- position_ids (
Numpy arrayortf.Tensorof shape(batch_size, num_choices, sequence_length), optional) — 每個輸入序列標記在位置嵌入中的位置索引。選自範圍[0, config.max_position_embeddings - 1]。 - head_mask (
Numpy arrayortf.Tensorof shape(num_heads,)or(num_layers, num_heads), optional) — 用於使自注意力模組中選定的頭無效的掩碼。掩碼值選自[0, 1]：- 1 表示該頭未被掩碼，
- 0 表示該頭已被掩碼。
- inputs_embeds (
tf.Tensorof shape(batch_size, num_choices, sequence_length, hidden_size), optional) — 可選地，你可以選擇直接傳遞嵌入表示，而不是傳遞input_ids。如果你想比模型內部的嵌入查詢矩陣更好地控制如何將input_ids索引轉換為相關向量，這會非常有用。 - output_attentions (
bool, optional) — 是否返回所有注意力層的注意力張量。有關更多詳細資訊，請參閱返回張量下的attentions。此引數只能在 Eager 模式下使用，在 Graph 模式下將使用配置中的值。 - output_hidden_states (
bool, optional) — 是否返回所有層的隱藏狀態。有關更多詳細資訊，請參閱返回張量下的hidden_states。此引數只能在 Eager 模式下使用，在 Graph 模式下將使用配置中的值。 - return_dict (
bool, optional) — 是否返回 ModelOutput 而不是普通的元組。此引數可在 Eager 模式下使用，在 Graph 模式下該值將始終設定為 True。 - training (
bool, optional, defaults toFalse) — 是否以訓練模式使用模型（某些模組，如 dropout 模組，在訓練和評估之間有不同的行為）。 - labels (
tf.Tensorof shape(batch_size,), optional) — 用於計算多項選擇分類損失的標籤。索引應在[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 時），根據配置（MobileBertConfig）和輸入，包含各種元素。
-
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` 時返回) — `tf.Tensor` 的元組（一個用於嵌入的輸出 + 一個用於每層的輸出），形狀為(batch_size, sequence_length, hidden_size)。模型在每個層輸出的隱藏狀態加上初始嵌入輸出。
-
attentions (
tuple(tf.Tensor)，可選，在傳遞 `output_attentions=True` 或 `config.output_attentions=True` 時返回) — `tf.Tensor` 的元組（每層一個），形狀為(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 後的注意力權重，用於計算自注意力頭中的加權平均值。
TFMobileBertForMultipleChoice 的前向方法，重寫了 __call__ 特殊方法。
儘管前向傳遞的流程需要在此函式內定義，但之後應該呼叫 `Module` 例項而不是這個函式，因為前者會處理執行前處理和後處理步驟，而後者會靜默地忽略它們。
示例
>>> from transformers import AutoTokenizer, TFMobileBertForMultipleChoice
>>> import tensorflow as tf
>>> tokenizer = AutoTokenizer.from_pretrained("google/mobilebert-uncased")
>>> model = TFMobileBertForMultipleChoice.from_pretrained("google/mobilebert-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.logitsTFMobileBertForTokenClassification
class transformers.TFMobileBertForTokenClassification
< 原始碼 >( config *inputs **kwargs )
引數
- config (MobileBertConfig) — 模型配置類，包含模型的所有引數。使用配置檔案初始化不會載入與模型關聯的權重，只會載入配置。請檢視 from_pretrained() 方法來載入模型權重。
MobileBert 模型，其頂部帶有一個標記分類頭（一個在隱藏狀態輸出之上的線性層），例如用於命名實體識別（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 token_type_ids: np.ndarray | tf.Tensor | None = None position_ids: 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 (
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), optional) — 用於避免對填充標記索引執行注意力操作的掩碼。掩碼值選自[0, 1]：- 1 表示標記未被掩碼，
- 0 表示標記已被掩碼。
- token_type_ids (
Numpy array或tf.Tensorof shape(batch_size, sequence_length), optional) — 片段標記索引，用於指示輸入的第一和第二部分。索引選自[0, 1]：- 0 對應於 *A 句子* 的標記，
- 1 對應於 *B 句子* 的標記。
- position_ids (
Numpy array或tf.Tensorof shape(batch_size, sequence_length), optional) — 每個輸入序列標記在位置嵌入中的位置索引。選自範圍[0, config.max_position_embeddings - 1]。 - head_mask (
Numpy array或tf.Tensorof shape(num_heads,)or(num_layers, num_heads), optional) — 用於使自注意力模組中選定的頭無效的掩碼。掩碼值選自[0, 1]：- 1 表示該頭未被掩碼，
- 0 表示該頭已被掩碼。
- inputs_embeds (
tf.Tensorof shape(batch_size, sequence_length, hidden_size), optional) — 可選地，你可以選擇直接傳遞嵌入表示，而不是傳遞input_ids。如果你想比模型內部的嵌入查詢矩陣更好地控制如何將input_ids索引轉換為相關向量，這會非常有用。 - output_attentions (
bool, optional) — 是否返回所有注意力層的注意力張量。有關更多詳細資訊，請參閱返回張量下的attentions。此引數只能在 Eager 模式下使用，在 Graph 模式下將使用配置中的值。 - output_hidden_states (
bool, optional) — 是否返回所有層的隱藏狀態。有關更多詳細資訊，請參閱返回張量下的hidden_states。此引數只能在 Eager 模式下使用，在 Graph 模式下將使用配置中的值。 - return_dict (
bool, optional) — 是否返回 ModelOutput 而不是普通的元組。此引數可在 Eager 模式下使用，在 Graph 模式下該值將始終設定為 True。 - training (
bool, optional, defaults toFalse) — 是否以訓練模式使用模型（某些模組，如 dropout 模組，在訓練和評估之間有不同的行為）。 - labels (
tf.Tensorof shape(batch_size, sequence_length), optional) — 用於計算標記分類損失的標籤。索引應在[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 時），根據配置（MobileBertConfig）和輸入，包含各種元素。
-
loss (
tf.Tensor，形狀為(n,)，可選，其中 n 是未被掩蓋的標籤數量，當提供labels時返回) — 分類損失。 -
logits (
tf.Tensor，形狀為(batch_size, sequence_length, config.num_labels)) — 分類分數（SoftMax 之前）。 -
hidden_states (
tuple(tf.Tensor)，可選，在傳遞 `output_hidden_states=True` 或 `config.output_hidden_states=True` 時返回) — `tf.Tensor` 的元組（一個用於嵌入的輸出 + 一個用於每層的輸出），形狀為(batch_size, sequence_length, hidden_size)。模型在每個層輸出的隱藏狀態加上初始嵌入輸出。
-
attentions (
tuple(tf.Tensor)，可選，在傳遞 `output_attentions=True` 或 `config.output_attentions=True` 時返回) — `tf.Tensor` 的元組（每層一個），形狀為(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 後的注意力權重，用於計算自注意力頭中的加權平均值。
TFMobileBertForTokenClassification 的前向方法，重寫了 __call__ 特殊方法。
儘管前向傳遞的流程需要在此函式內定義，但之後應該呼叫 `Module` 例項而不是這個函式，因為前者會處理執行前處理和後處理步驟，而後者會靜默地忽略它們。
示例
>>> from transformers import AutoTokenizer, TFMobileBertForTokenClassification
>>> import tensorflow as tf
>>> tokenizer = AutoTokenizer.from_pretrained("vumichien/mobilebert-finetuned-ner")
>>> model = TFMobileBertForTokenClassification.from_pretrained("vumichien/mobilebert-finetuned-ner")
>>> 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()]
>>> predicted_tokens_classes
['I-ORG', 'I-ORG', 'O', 'O', 'O', 'O', 'O', 'I-LOC', 'O', 'I-LOC', 'I-LOC']TFMobileBertForQuestionAnswering
class transformers.TFMobileBertForQuestionAnswering
< 原始碼 >( config *inputs **kwargs )
引數
- config (MobileBertConfig) — 模型配置類，包含模型的所有引數。使用配置檔案初始化不會載入與模型關聯的權重，只會載入配置。請檢視 from_pretrained() 方法來載入模型權重。
MobileBert 模型，其頂部帶有一個片段分類頭，用於像 SQuAD 這樣的抽取式問答任務（在隱藏狀態輸出之上有一層線性層，用於計算 `片段開始 logits` 和 `片段結束 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 token_type_ids: np.ndarray | tf.Tensor | None = None position_ids: np.ndarray | tf.Tensor | None = None head_mask: np.ndarray | tf.Tensor | None = None inputs_embeds: np.ndarray | tf.Tensor | None = None output_attentions: Optional[bool] = None output_hidden_states: Optional[bool] = None return_dict: Optional[bool] = None start_positions: np.ndarray | tf.Tensor | None = None end_positions: np.ndarray | tf.Tensor | None = None training: Optional[bool] = False ) → transformers.modeling_tf_outputs.TFQuestionAnsweringModelOutput 或 tuple(tf.Tensor)
引數
- input_ids (
Numpy array或tf.Tensorof shape(batch_size, sequence_length)) — 詞彙表中輸入序列標記的索引。可以使用 AutoTokenizer 獲取索引。有關詳細資訊，請參閱 PreTrainedTokenizer.call() 和 PreTrainedTokenizer.encode()。
- attention_mask (
Numpy array或tf.Tensorof shape(batch_size, sequence_length), optional) — 用於避免對填充標記索引執行注意力操作的掩碼。掩碼值選自[0, 1]：- 1 表示標記未被掩碼，
- 0 表示標記已被掩碼。
- token_type_ids (
Numpy array或tf.Tensorof shape(batch_size, sequence_length), optional) — 片段標記索引，用於指示輸入的第一和第二部分。索引選自[0, 1]：- 0 對應於 *A 句子* 的標記，
- 1 對應於 *B 句子* 的標記。
- position_ids (
Numpy array或tf.Tensorof shape(batch_size, sequence_length), optional) — 每個輸入序列標記在位置嵌入中的位置索引。選自範圍[0, config.max_position_embeddings - 1]。 - head_mask (
Numpy array或tf.Tensorof shape(num_heads,)or(num_layers, num_heads), optional) — 用於使自注意力模組中選定的頭無效的掩碼。掩碼值選自[0, 1]：- 1 表示該頭未被掩碼，
- 0 表示該頭已被掩碼。
- inputs_embeds (
tf.Tensorof shape(batch_size, sequence_length, hidden_size), optional) — 可選地，你可以選擇直接傳遞嵌入表示，而不是傳遞input_ids。如果你想比模型內部的嵌入查詢矩陣更好地控制如何將input_ids索引轉換為相關向量，這會非常有用。 - output_attentions (
bool, optional) — 是否返回所有注意力層的注意力張量。有關更多詳細資訊，請參閱返回張量下的attentions。此引數只能在 Eager 模式下使用，在 Graph 模式下將使用配置中的值。 - output_hidden_states (
bool, optional) — 是否返回所有層的隱藏狀態。有關更多詳細資訊，請參閱返回張量下的hidden_states。此引數只能在 Eager 模式下使用，在 Graph 模式下將使用配置中的值。 - return_dict (
bool, optional) — 是否返回 ModelOutput 而不是普通的元組。此引數可在 Eager 模式下使用，在 Graph 模式下該值將始終設定為 True。 - training (
bool, optional, defaults toFalse) — 是否以訓練模式使用模型（某些模組，如 dropout 模組，在訓練和評估之間有不同的行為）。 - start_positions (
tf.Tensorof shape(batch_size,), optional) — 用於計算標記分類損失的標籤片段開始位置（索引）的標籤。位置被限制在序列長度（sequence_length）內。序列之外的位置不計入損失計算。 - end_positions (
tf.Tensorof shape(batch_size,), 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 時），根據配置（MobileBertConfig）和輸入，包含各種元素。
-
loss (
tf.Tensorof shape(batch_size, ), optional, returned whenstart_positionsandend_positionsare provided) — 總片段抽取損失是開始位置和結束位置的交叉熵損失之和。 -
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` 時返回) — `tf.Tensor` 的元組（一個用於嵌入的輸出 + 一個用於每層的輸出），形狀為(batch_size, sequence_length, hidden_size)。模型在每個層輸出的隱藏狀態加上初始嵌入輸出。
-
attentions (
tuple(tf.Tensor)，可選，在傳遞 `output_attentions=True` 或 `config.output_attentions=True` 時返回) — `tf.Tensor` 的元組（每層一個），形狀為(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 後的注意力權重，用於計算自注意力頭中的加權平均值。
TFMobileBertForQuestionAnswering 的前向方法，重寫了 __call__ 特殊方法。
儘管前向傳遞的流程需要在此函式內定義，但之後應該呼叫 `Module` 例項而不是這個函式，因為前者會處理執行前處理和後處理步驟，而後者會靜默地忽略它們。
示例
>>> from transformers import AutoTokenizer, TFMobileBertForQuestionAnswering
>>> import tensorflow as tf
>>> tokenizer = AutoTokenizer.from_pretrained("vumichien/mobilebert-uncased-squad-v2")
>>> model = TFMobileBertForQuestionAnswering.from_pretrained("vumichien/mobilebert-uncased-squad-v2")
>>> 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]
>>> tokenizer.decode(predict_answer_tokens)
'a nice puppet'