Transformers 文件
RemBERT
並獲得增強的文件體驗
開始使用
RemBERT
概述
RemBERT 模型由 Hyung Won Chung、Thibault Févry、Henry Tsai、Melvin Johnson、Sebastian Ruder 在 重新思考預訓練語言模型中的嵌入耦合 中提出。
論文摘要如下：
我們重新評估了在最先進的預訓練語言模型中輸入和輸出嵌入之間共享權重的標準做法。我們表明，解耦嵌入提供了更高的建模靈活性，使我們能夠顯著提高多語言模型輸入嵌入中引數分配的效率。透過在 Transformer 層中重新分配輸入嵌入引數，我們可以在微調階段以相同數量的引數在標準自然語言理解任務上實現顯著更好的效能。我們還表明，為輸出嵌入分配額外容量對模型有益，這種益處在微調階段持續存在，即使輸出嵌入在預訓練後被丟棄。我們的分析表明，更大的輸出嵌入可以防止模型的最後一層對預訓練任務過度專業化，並鼓勵 Transformer 表示更通用且更容易轉移到其他任務和語言。利用這些發現，我們能夠訓練出在 XTREME 基準測試中表現出色的模型，而無需增加微調階段的引數數量。
使用技巧
對於微調，RemBERT 可以被認為是 mBERT 的一個更大版本，具有類似 ALBERT 的嵌入層分解。與 BERT 不同的是，在預訓練中嵌入沒有繫結，這使得輸入嵌入更小（在微調期間保留）和輸出嵌入更大（在微調時丟棄）。分詞器也與 Albert 的分詞器類似，而不是 BERT 的分詞器。
資源
RemBertConfig
class transformers.RemBertConfig
< 來源 >( vocab_size = 250300 hidden_size = 1152 num_hidden_layers = 32 num_attention_heads = 18 input_embedding_size = 256 output_embedding_size = 1664 intermediate_size = 4608 hidden_act = 'gelu' hidden_dropout_prob = 0.0 attention_probs_dropout_prob = 0.0 classifier_dropout_prob = 0.1 max_position_embeddings = 512 type_vocab_size = 2 initializer_range = 0.02 layer_norm_eps = 1e-12 use_cache = True pad_token_id = 0 bos_token_id = 312 eos_token_id = 313 **kwargs )
引數
- vocab_size (
int, 可選, 預設為 250300) — RemBERT 模型的詞彙表大小。定義了呼叫 RemBertModel 或 TFRemBertModel 時傳遞的inputs_ids可以表示的不同標記的數量。模型的詞彙表大小。定義了可以由 RemBertModel 的前向方法傳遞的 inputs_ids 表示的不同標記。 - hidden_size (
int, 可選, 預設為 1152) — 編碼器層和池化層維度。 - num_hidden_layers (
int, 可選, 預設為 32) — Transformer 編碼器中的隱藏層數量。 - num_attention_heads (
int, 可選, 預設為 18) — Transformer 編碼器中每個注意力層的注意力頭數量。 - input_embedding_size (
int, 可選, 預設為 256) — 輸入嵌入的維度。 - output_embedding_size (
int, 可選, 預設為 1664) — 輸出嵌入的維度。 - intermediate_size (
int, 可選, 預設為 4608) — Transformer 編碼器中“中間”（即前饋）層的維度。 - hidden_act (
str或function, 可選, 預設為"gelu") — 編碼器和池化器中的非線性啟用函式（函式或字串）。如果是字串，支援"gelu"、"relu"、"selu"和"gelu_new"。 - hidden_dropout_prob (
float, 可選, 預設為 0) — 嵌入、編碼器和池化器中所有全連線層的 dropout 機率。 - attention_probs_dropout_prob (
float, 可選, 預設為 0) — 注意力機率的 dropout 比率。 - classifier_dropout_prob (
float, 可選, 預設為 0.1) — 微調時分類器層的 dropout 比率。 - max_position_embeddings (
int, 可選, 預設為 512) — 此模型可能使用的最大序列長度。通常設定為一個較大的值以備不時之需（例如，512、1024 或 2048）。 - type_vocab_size (
int, 可選, 預設為 2) — 呼叫 RemBertModel 或 TFRemBertModel 時傳遞的token_type_ids的詞彙表大小。 - initializer_range (
float, 可選, 預設為 0.02) — 用於初始化所有權重矩陣的 truncated_normal_initializer 的標準差。 - layer_norm_eps (
float, 可選, 預設為 1e-12) — 層歸一化層使用的 epsilon 值。 - is_decoder (
bool, 可選, 預設為False) — 模型是否用作解碼器。如果為False，模型用作編碼器。 - use_cache (
bool, 可選, 預設為True) — 模型是否應返回最後一個 key/values 注意力（並非所有模型都使用）。僅當config.is_decoder=True時相關。
這是用於儲存 RemBertModel 配置的配置類。它用於根據指定引數例項化 RemBERT 模型，定義模型架構。使用預設值例項化配置將產生與 RemBERT google/rembert 架構類似的配置。
配置物件繼承自 PretrainedConfig，可用於控制模型輸出。有關更多資訊，請參閱 PretrainedConfig 的文件。
示例
>>> from transformers import RemBertModel, RemBertConfig
>>> # Initializing a RemBERT rembert style configuration
>>> configuration = RemBertConfig()
>>> # Initializing a model from the rembert style configuration
>>> model = RemBertModel(configuration)
>>> # Accessing the model configuration
>>> configuration = model.configRemBertTokenizer
class transformers.RemBertTokenizer
< 來源 >( vocab_file do_lower_case = False remove_space = True keep_accents = True bos_token = '[CLS]' eos_token = '[SEP]' unk_token = '[UNK]' sep_token = '[SEP]' pad_token = '[PAD]' cls_token = '[CLS]' mask_token = '[MASK]' **kwargs )
引數
- vocab_file (
str) — 包含例項化分詞器所需詞彙表的 SentencePiece 檔案（通常具有 .spm 副檔名）。 - bos_token (
str, 可選, 預設為"[CLS]") — 預訓練期間使用的序列開始標記。可用作序列分類器標記。使用特殊標記構建序列時，此標記並非序列開始標記。使用的標記是
cls_token。 - eos_token (
str, 可選, 預設為"[SEP]") — 序列結束標記。使用特殊標記構建序列時，此標記並非序列結束標記。使用的標記是
sep_token。 - unk_token (
str, 可選, 預設為"<unk>") — 未知標記。不在詞彙表中的標記不能轉換為 ID，而是設定為此標記。 - sep_token (
str, 可選, 預設為"[SEP]") — 分隔符標記，當從多個序列構建序列時使用，例如用於序列分類的兩個序列或用於問答的文字和問題。它也用作使用特殊標記構建的序列的最後一個標記。 - pad_token (
str, 可選, 預設為"<pad>") — 用於填充的標記，例如在批處理不同長度的序列時。 - cls_token (
str, 可選, 預設為"[CLS]") — 分類器標記，用於序列分類（對整個序列進行分類而非逐標記分類）。它是使用特殊標記構建序列時的第一個標記。 - mask_token (
str, 可選, 預設為"[MASK]") — 用於遮蔽值的標記。這是使用遮蔽語言建模訓練此模型時使用的標記。這是模型將嘗試預測的標記。 - sp_model (
SentencePieceProcessor) — 用於所有轉換（字串、詞元和 ID）的 SentencePiece 處理器。
構建 RemBERT 分詞器。基於 SentencePiece。
此分詞器繼承自 PreTrainedTokenizer，後者包含大部分主要方法。使用者應查閱此超類以獲取有關這些方法的更多資訊。
build_inputs_with_special_tokens
< source >( token_ids_0: list token_ids_1: typing.Optional[list[int]] = None ) → List[int]
透過連線和新增特殊詞元，從序列或序列對構建用於序列分類任務的模型輸入。RemBERT 序列具有以下格式
- 單個序列：
[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方法新增特殊標記時呼叫。
create_token_type_ids_from_sequences
< source >( token_ids_0: list token_ids_1: typing.Optional[list[int]] = None ) → list[int]
建立與傳入序列對應的標記型別 ID。什麼是標記型別 ID？
如果模型有特殊的構建方式，應在子類中重寫此方法。
RemBertTokenizerFast
class transformers.RemBertTokenizerFast
< source >( vocab_file = None tokenizer_file = None do_lower_case = True remove_space = True keep_accents = False bos_token = '[CLS]' eos_token = '[SEP]' unk_token = '<unk>' sep_token = '[SEP]' pad_token = '<pad>' cls_token = '[CLS]' mask_token = '[MASK]' **kwargs )
引數
- vocab_file (
str) — SentencePiece 檔案（通常具有 .spm 副檔名），其中包含例項化分詞器所需的詞彙表。 - do_lower_case (
bool, 可選，預設為True) — 分詞時是否將輸入轉換為小寫。 - remove_space (
bool, 可選，預設為True) — 分詞時是否去除文字（去除字串前後多餘的空格）。 - keep_accents (
bool, 可選，預設為False) — 分詞時是否保留重音。 - bos_token (
str, 可選，預設為"[CLS]") — 預訓練期間使用的序列開始詞元。可用作序列分類器詞元。使用特殊詞元構建序列時，這不是序列開頭使用的詞元。使用的詞元是
cls_token。 - eos_token (
str, 可選，預設為"[SEP]") — 序列結束詞元。 .. 注意:: 使用特殊詞元構建序列時，這不是序列結尾使用的詞元。使用的詞元是sep_token。 - unk_token (
str, 可選，預設為"<unk>") — 未知詞元。不在詞彙表中的詞元無法轉換為 ID，並被設定為此詞元。 - sep_token (
str, 可選，預設為"[SEP]") — 分隔符詞元，用於從多個序列構建序列時，例如用於序列分類的兩個序列或用於問答的文字和問題。它也用作使用特殊詞元構建的序列的最後一個詞元。 - pad_token (
str, 可選，預設為"<pad>") — 用於填充的詞元，例如在批處理不同長度的序列時。 - cls_token (
str, 可選，預設為"[CLS]") — 分類器詞元，用於序列分類（整個序列的分類而不是按詞元的分類）。它是使用特殊詞元構建的序列的第一個詞元。 - mask_token (
str, 可選，預設為"[MASK]") — 用於掩碼值的詞元。這是使用掩碼語言模型訓練此模型時使用的詞元。這是模型將嘗試預測的詞元。
構建一個“快速”RemBert 分詞器（由 HuggingFace 的 tokenizers 庫支援）。基於 Unigram。此分詞器繼承自 PreTrainedTokenizerFast，後者包含大部分主要方法。使用者應查閱此超類以獲取有關這些方法的更多資訊
build_inputs_with_special_tokens
< source >( token_ids_0: list token_ids_1: typing.Optional[list[int]] = None ) → List[int]
透過連線和新增特殊詞元，從序列或序列對構建用於序列分類任務的模型輸入。RemBERT 序列具有以下格式
- 單個序列：
[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 方法新增特殊詞元時呼叫。
create_token_type_ids_from_sequences
< source >( token_ids_0: list token_ids_1: typing.Optional[list[int]] = None ) → list[int]
建立與傳入序列對應的標記型別 ID。什麼是標記型別 ID？
如果模型有特殊的構建方式，應在子類中重寫此方法。
RemBertModel
class transformers.RemBertModel
< source >( config add_pooling_layer = True )
引數
- config (RemBertModel) — 模型的配置類，包含模型的所有引數。使用配置檔案初始化不會載入與模型關聯的權重，只會載入配置。請檢視 from_pretrained() 方法以載入模型權重。
- add_pooling_layer (
bool, 可選，預設為True) — 是否新增池化層
該模型可以作為編碼器（僅包含自注意力）以及解碼器，在這種情況下，在自注意力層之間新增一層交叉注意力，遵循 Ashish Vaswani、Noam Shazeer、Niki Parmar、Jakob Uszkoreit、Llion Jones、Aidan N. Gomez 和 Illia Polosukhin 的 Attention is all you need 中描述的架構。
要作為解碼器，模型需要使用配置的 is_decoder 引數設定為 True 進行初始化。要在 Seq2Seq 模型中使用，模型需要同時使用 is_decoder 引數和 add_cross_attention 設定為 True 進行初始化；然後期望 encoder_hidden_states 作為前向傳播的輸入。
該模型繼承自 PreTrainedModel。請檢視超類文件，瞭解庫為其所有模型實現的通用方法（例如下載或儲存、調整輸入嵌入大小、修剪頭部等）
該模型也是 PyTorch torch.nn.Module 子類。將其作為常規 PyTorch 模組使用，並參考 PyTorch 文件中有關通用用法和行為的所有事項。
forward
< source >( input_ids: typing.Optional[torch.LongTensor] = None attention_mask: typing.Optional[torch.LongTensor] = None token_type_ids: typing.Optional[torch.LongTensor] = None position_ids: typing.Optional[torch.LongTensor] = None head_mask: typing.Optional[torch.FloatTensor] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None encoder_hidden_states: typing.Optional[torch.FloatTensor] = None encoder_attention_mask: typing.Optional[torch.FloatTensor] = None past_key_values: typing.Optional[tuple[tuple[torch.FloatTensor]]] = None use_cache: typing.Optional[bool] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.modeling_outputs.BaseModelOutputWithPoolingAndCrossAttentions 或 tuple(torch.FloatTensor)
引數
- input_ids (
torch.LongTensor，形狀為(batch_size, sequence_length)，可選) — 詞彙表中輸入序列詞元的索引。預設情況下會忽略填充。可以使用 AutoTokenizer 獲取索引。有關詳細資訊，請參見 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.LongTensor，形狀為(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索引轉換為關聯向量的方式有更多控制，而不是模型的內部嵌入查詢矩陣，則這很有用。 - encoder_hidden_states (
torch.FloatTensor，形狀為(batch_size, sequence_length, hidden_size)，可選) — 編碼器最後一層的隱藏狀態序列輸出。如果模型配置為解碼器，則用於交叉注意力。 - encoder_attention_mask (
torch.FloatTensor，形狀為(batch_size, sequence_length)，可選) — 用於避免對編碼器輸入填充詞元索引執行注意力的掩碼。如果模型配置為解碼器，則此掩碼用於交叉注意力。掩碼值選擇在[0, 1]之間：- 1 表示詞元未被掩碼，
- 0 表示詞元已被掩碼。
- past_key_values (
tuple[tuple[torch.FloatTensor]], 可選) — 預先計算的隱藏狀態（自注意力塊和交叉注意力塊中的鍵和值），可用於加速順序解碼。這通常包括模型在解碼上一階段返回的past_key_values，當use_cache=True或config.use_cache=True時。允許兩種格式：
- Cache 例項，請參閱我們的 kv 快取指南；
- 長度為
config.n_layers的tuple(torch.FloatTensor)元組，每個元組包含 2 個形狀為(batch_size, num_heads, sequence_length, embed_size_per_head)的張量。這也稱為舊式快取格式。
模型將輸出與作為輸入饋送的快取格式相同的快取格式。如果沒有傳入
past_key_values，則將返回舊式快取格式。如果使用
past_key_values，使用者可以選擇僅輸入形狀為(batch_size, 1)的最後一個input_ids（那些沒有將其過去的鍵值狀態提供給此模型的）而不是所有形狀為(batch_size, sequence_length)的input_ids。 - use_cache (
bool, 可選) — 如果設定為True，則返回past_key_values鍵值狀態，可用於加速解碼（參見past_key_values）。 - output_attentions (
bool, optional) — 是否返回所有注意力層的注意力張量。更多詳細資訊請參閱返回張量中的attentions。 - output_hidden_states (
bool, optional) — 是否返回所有層的隱藏狀態。更多詳細資訊請參閱返回張量中的hidden_states。 - return_dict (
bool, optional) — 是否返回 ModelOutput 而不是普通的元組。
返回
transformers.modeling_outputs.BaseModelOutputWithPoolingAndCrossAttentions 或 tuple(torch.FloatTensor)
一個 transformers.modeling_outputs.BaseModelOutputWithPoolingAndCrossAttentions 或 torch.FloatTensor 元組（如果傳遞 return_dict=False 或 config.return_dict=False），包含根據配置（RemBertConfig）和輸入的不同元素。
-
last_hidden_state (
torch.FloatTensor, 形狀為(batch_size, sequence_length, hidden_size)) — 模型最後一層輸出的隱藏狀態序列。 -
pooler_output (形狀為
(batch_size, hidden_size)的torch.FloatTensor) — 經過輔助預訓練任務所用層進一步處理後，序列第一個詞元（分類詞元）的最後一層隱藏狀態。例如，對於 BERT 系列模型，這在經過線性層和 tanh 啟用函式處理後返回分類詞元。線性層權重在預訓練期間透過下一句預測（分類）目標進行訓練。 -
hidden_states (
tuple(torch.FloatTensor), optional, 在傳遞output_hidden_states=True或config.output_hidden_states=True時返回) — 形狀為(batch_size, sequence_length, hidden_size)的torch.FloatTensor元組（如果模型有嵌入層，則為嵌入層輸出一個，每個層輸出一個）。模型在每個層輸出的隱藏狀態以及可選的初始嵌入輸出。
-
attentions (
tuple(torch.FloatTensor), optional, 在傳遞output_attentions=True或config.output_attentions=True時返回) — 形狀為(batch_size, num_heads, sequence_length, sequence_length)的torch.FloatTensor元組（每個層一個）。注意力 softmax 後的注意力權重，用於計算自注意力頭中的加權平均值。
-
cross_attentions (
tuple(torch.FloatTensor), optional, 在傳遞output_attentions=True和config.add_cross_attention=True或config.output_attentions=True時返回) — 形狀為(batch_size, num_heads, sequence_length, sequence_length)的torch.FloatTensor元組（每個層一個）。解碼器交叉注意力層的注意力權重，在注意力 softmax 之後，用於計算交叉注意力頭中的加權平均。
-
past_key_values (
Cache, optional, 在傳遞use_cache=True或config.use_cache=True時返回) — 這是一個 Cache 例項。有關更多詳細資訊，請參閱我們的 kv 快取指南。包含預先計算的隱藏狀態（自注意力塊中的鍵和值，以及如果
config.is_encoder_decoder=True時交叉注意力塊中的鍵和值），可用於（參見past_key_values輸入）加速序列解碼。
RemBertModel 的 forward 方法，覆蓋了 __call__ 特殊方法。
儘管前向傳播的實現需要在該函式中定義，但在此之後應呼叫 Module 例項而不是此函式，因為前者負責執行預處理和後處理步驟，而後者則默默地忽略它們。
RemBertForCausalLM
class transformers.RemBertForCausalLM
< source >( config )
引數
- config (RemBertForCausalLM) — 模型配置類，包含模型的所有引數。使用配置檔案初始化並不會載入與模型相關的權重，只會載入配置。請檢視 from_pretrained() 方法來載入模型權重。
帶有語言建模頭的 RemBERT 模型，用於 CLM 微調。
該模型繼承自 PreTrainedModel。請檢視超類文件，瞭解庫為其所有模型實現的通用方法（例如下載或儲存、調整輸入嵌入大小、修剪頭部等）
該模型也是 PyTorch torch.nn.Module 子類。將其作為常規 PyTorch 模組使用，並參考 PyTorch 文件中有關通用用法和行為的所有事項。
forward
< source >( input_ids: typing.Optional[torch.LongTensor] = None attention_mask: typing.Optional[torch.LongTensor] = None token_type_ids: typing.Optional[torch.LongTensor] = None position_ids: typing.Optional[torch.LongTensor] = None head_mask: typing.Optional[torch.FloatTensor] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None encoder_hidden_states: typing.Optional[torch.FloatTensor] = None encoder_attention_mask: typing.Optional[torch.FloatTensor] = None past_key_values: typing.Optional[tuple[tuple[torch.FloatTensor]]] = None labels: typing.Optional[torch.LongTensor] = None use_cache: typing.Optional[bool] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None **kwargs ) → transformers.modeling_outputs.CausalLMOutputWithCrossAttentions or tuple(torch.FloatTensor)
引數
- input_ids (形狀為
(batch_size, sequence_length)的torch.LongTensor, 可選) — 詞彙表中輸入序列詞元的索引。預設情況下會忽略填充。可以使用 AutoTokenizer 獲取索引。有關詳細資訊，請參閱 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (形狀為
(batch_size, sequence_length)的torch.LongTensor, 可選) — 避免對填充詞元索引執行注意力的掩碼。掩碼值選擇在[0, 1]之間：- 1 表示詞元未被掩碼，
- 0 表示詞元已被掩碼。
- token_type_ids (形狀為
(batch_size, sequence_length)的torch.LongTensor, 可選) — 分段詞元索引，指示輸入的第一個和第二個部分。索引選擇在[0, 1]之間：- 0 對應於句子 A 詞元，
- 1 對應於句子 B 詞元。
- position_ids (形狀為
(batch_size, sequence_length)的torch.LongTensor, 可選) — 每個輸入序列詞元在位置嵌入中的位置索引。選擇範圍為[0, config.n_positions - 1]。 - head_mask (形狀為
(num_heads,)或(num_layers, num_heads)的torch.FloatTensor, 可選) — 用於使自注意力模組的選定頭部無效的掩碼。掩碼值選擇在[0, 1]之間：- 1 表示頭部未被掩碼，
- 0 表示頭部已被掩碼。
- inputs_embeds (形狀為
(batch_size, sequence_length, hidden_size)的torch.FloatTensor, 可選) — 可選地，除了傳遞input_ids，您還可以選擇直接傳遞嵌入表示。如果您希望對如何將input_ids索引轉換為相關向量有比模型內部嵌入查詢矩陣更多的控制，這將非常有用。 - encoder_hidden_states (形狀為
(batch_size, sequence_length, hidden_size)的torch.FloatTensor, 可選) — 編碼器最後一層輸出的隱藏狀態序列。如果模型被配置為解碼器，則用於交叉注意力。 - encoder_attention_mask (形狀為
(batch_size, sequence_length)的torch.FloatTensor, 可選) — 避免對編碼器輸入填充詞元索引執行注意力的掩碼。如果模型被配置為解碼器，則此掩碼用於交叉注意力。掩碼值選擇在[0, 1]之間：- 1 表示詞元未被掩碼，
- 0 表示詞元已被掩碼。
- past_key_values (
tuple[tuple[torch.FloatTensor]], 可選) — 預先計算的隱藏狀態（自注意力塊和交叉注意力塊中的鍵和值），可用於加速序列解碼。這通常包括模型在解碼上一階段返回的past_key_values，當use_cache=True或config.use_cache=True時。允許兩種格式：
- 一個 Cache 例項，請參閱我們的 kv 快取指南；
- 長度為
config.n_layers的tuple(torch.FloatTensor)元組，每個元組包含 2 個形狀為(batch_size, num_heads, sequence_length, embed_size_per_head)的張量。這也稱為舊版快取格式。
模型將輸出與輸入相同的快取格式。如果未傳遞
past_key_values，將返回舊版快取格式。如果使用
past_key_values，使用者可以選擇僅輸入最後一個input_ids（那些沒有將其過去的鍵值狀態提供給此模型的），形狀為(batch_size, 1)，而不是所有形狀為(batch_size, sequence_length)的input_ids。 - labels (形狀為
(batch_size, sequence_length)的torch.LongTensor, 可選) — 用於計算從左到右語言建模損失（下一個詞預測）的標籤。索引應在[-100, 0, ..., config.vocab_size]之間（參見input_ids文件字串）。索引設定為-100的詞元將被忽略（掩碼），損失僅針對標籤在[0, ..., config.vocab_size]中的詞元計算。 - use_cache (
bool, 可選) — 如果設定為True，將返回past_key_values鍵值狀態，可用於加速解碼（參見past_key_values）。 - output_attentions (
bool, 可選) — 是否返回所有注意力層的注意力張量。更多詳細資訊請參閱返回張量中的attentions。 - output_hidden_states (
bool, 可選) — 是否返回所有層的隱藏狀態。更多詳細資訊請參閱返回張量中的hidden_states。 - return_dict (
bool, 可選) — 是否返回 ModelOutput 而不是普通元組。
返回
transformers.modeling_outputs.CausalLMOutputWithCrossAttentions 或 tuple(torch.FloatTensor)
一個 transformers.modeling_outputs.CausalLMOutputWithCrossAttentions 或 torch.FloatTensor 元組（如果傳遞 return_dict=False 或 config.return_dict=False），包含根據配置（RemBertConfig）和輸入的不同元素。
-
loss (
torch.FloatTensor形狀為(1,)，可選，當提供labels時返回) — 語言建模損失（用於下一個 token 預測）。 -
logits (形狀為
(batch_size, sequence_length, config.vocab_size)的torch.FloatTensor) — 語言建模頭部的預測分數（SoftMax 之前的每個詞彙標記的分數）。 -
hidden_states (
tuple(torch.FloatTensor), optional, 在傳遞output_hidden_states=True或config.output_hidden_states=True時返回) — 形狀為(batch_size, sequence_length, hidden_size)的torch.FloatTensor元組（如果模型有嵌入層，則為嵌入層輸出一個，每個層輸出一個）。模型在每個層輸出的隱藏狀態以及可選的初始嵌入輸出。
-
attentions (
tuple(torch.FloatTensor), optional, 在傳遞output_attentions=True或config.output_attentions=True時返回) — 形狀為(batch_size, num_heads, sequence_length, sequence_length)的torch.FloatTensor元組（每個層一個）。注意力 softmax 後的注意力權重，用於計算自注意力頭中的加權平均值。
-
cross_attentions (
tuple(torch.FloatTensor), 可選, 在傳遞output_attentions=True或config.output_attentions=True時返回) — 形狀為(batch_size, num_heads, sequence_length, sequence_length)的torch.FloatTensor元組（每個層一個）。注意力 softmax 後的交叉注意力權重，用於計算交叉注意力頭中的加權平均。
-
past_key_values (
Cache, optional, 在傳遞use_cache=True或config.use_cache=True時返回) — 這是一個 Cache 例項。有關更多詳細資訊，請參閱我們的 kv 快取指南。包含預先計算的隱藏狀態（注意力塊中的鍵和值），可用於（參見
past_key_values輸入）加速順序解碼。
RemBertForCausalLM 的 forward 方法，覆蓋了 __call__ 特殊方法。
儘管前向傳播的實現需要在該函式中定義，但在此之後應呼叫 Module 例項而不是此函式，因為前者負責執行預處理和後處理步驟，而後者則默默地忽略它們。
示例
>>> from transformers import AutoTokenizer, RemBertForCausalLM, RemBertConfig
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("google/rembert")
>>> config = RemBertConfig.from_pretrained("google/rembert")
>>> config.is_decoder = True
>>> model = RemBertForCausalLM.from_pretrained("google/rembert", config=config)
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")
>>> outputs = model(**inputs)
>>> prediction_logits = outputs.logitsRemBertForMaskedLM
class transformers.RemBertForMaskedLM
< source >( config )
引數
- config (RemBertForMaskedLM) — 模型配置類，包含模型的所有引數。使用配置檔案初始化並不會載入與模型相關的權重，只會載入配置。請檢視 from_pretrained() 方法來載入模型權重。
Rembert 模型頂部帶有一個 `language modeling` 頭部。”
該模型繼承自 PreTrainedModel。請檢視超類文件，瞭解庫為其所有模型實現的通用方法（例如下載或儲存、調整輸入嵌入大小、修剪頭部等）
該模型也是 PyTorch torch.nn.Module 子類。將其作為常規 PyTorch 模組使用，並參考 PyTorch 文件中有關通用用法和行為的所有事項。
forward
< source >( input_ids: typing.Optional[torch.LongTensor] = None attention_mask: typing.Optional[torch.LongTensor] = None token_type_ids: typing.Optional[torch.LongTensor] = None position_ids: typing.Optional[torch.LongTensor] = None head_mask: typing.Optional[torch.FloatTensor] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None encoder_hidden_states: typing.Optional[torch.FloatTensor] = None encoder_attention_mask: typing.Optional[torch.FloatTensor] = None labels: typing.Optional[torch.LongTensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.modeling_outputs.MaskedLMOutput or tuple(torch.FloatTensor)
引數
- input_ids (形狀為
(batch_size, sequence_length)的torch.LongTensor, 可選) — 詞彙表中輸入序列詞元的索引。預設情況下會忽略填充。可以使用 AutoTokenizer 獲取索引。有關詳細資訊，請參閱 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (形狀為
(batch_size, sequence_length)的torch.LongTensor, 可選) — 避免對填充詞元索引執行注意力的掩碼。掩碼值選擇在[0, 1]之間：- 1 表示詞元未被掩碼，
- 0 表示詞元已被掩碼。
- token_type_ids (形狀為
(batch_size, sequence_length)的torch.LongTensor, 可選) — 分段詞元索引，指示輸入的第一個和第二個部分。索引選擇在[0, 1]之間：- 0 對應於句子 A 詞元，
- 1 對應於句子 B 詞元。
- position_ids (形狀為
(batch_size, sequence_length)的torch.LongTensor, 可選) — 每個輸入序列詞元在位置嵌入中的位置索引。選擇範圍為[0, config.n_positions - 1]。 - head_mask (形狀為
(num_heads,)或(num_layers, num_heads)的torch.FloatTensor, 可選) — 用於使自注意力模組的選定頭部無效的掩碼。掩碼值選擇在[0, 1]之間：- 1 表示頭部未被掩碼，
- 0 表示頭部已被掩碼。
- inputs_embeds (形狀為
(batch_size, sequence_length, hidden_size)的torch.FloatTensor, 可選) — 可選地，除了傳遞input_ids，您還可以選擇直接傳遞嵌入表示。如果您希望對如何將input_ids索引轉換為相關向量有比模型內部嵌入查詢矩陣更多的控制，這將非常有用。 - encoder_hidden_states (形狀為
(batch_size, sequence_length, hidden_size)的torch.FloatTensor, 可選) — 編碼器最後一層輸出的隱藏狀態序列。如果模型被配置為解碼器，則用於交叉注意力。 - encoder_attention_mask (形狀為
(batch_size, sequence_length)的torch.FloatTensor, 可選) — 避免對編碼器輸入填充詞元索引執行注意力的掩碼。如果模型被配置為解碼器，則此掩碼用於交叉注意力。掩碼值選擇在[0, 1]之間：- 1 表示詞元未被掩碼，
- 0 表示詞元已被掩碼。
- labels (形狀為
(batch_size, sequence_length)的torch.LongTensor, 可選) — 用於計算掩碼語言建模損失的標籤。索引應在[-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），包含根據配置（RemBertConfig）和輸入的不同元素。
-
loss (形狀為
(1,)的torch.FloatTensor，可選，當提供labels時返回) — 掩碼語言建模 (MLM) 損失。 -
logits (形狀為
(batch_size, sequence_length, config.vocab_size)的torch.FloatTensor) — 語言建模頭部的預測分數（SoftMax 之前的每個詞彙標記的分數）。 -
hidden_states (
tuple(torch.FloatTensor), optional, 在傳遞output_hidden_states=True或config.output_hidden_states=True時返回) — 形狀為(batch_size, sequence_length, hidden_size)的torch.FloatTensor元組（如果模型有嵌入層，則為嵌入層輸出一個，每個層輸出一個）。模型在每個層輸出的隱藏狀態以及可選的初始嵌入輸出。
-
attentions (
tuple(torch.FloatTensor), optional, 在傳遞output_attentions=True或config.output_attentions=True時返回) — 形狀為(batch_size, num_heads, sequence_length, sequence_length)的torch.FloatTensor元組（每個層一個）。注意力 softmax 後的注意力權重，用於計算自注意力頭中的加權平均值。
RemBertForMaskedLM 的 forward 方法，覆蓋了 __call__ 特殊方法。
儘管前向傳播的實現需要在該函式中定義，但在此之後應呼叫 Module 例項而不是此函式，因為前者負責執行預處理和後處理步驟，而後者則默默地忽略它們。
示例
>>> from transformers import AutoTokenizer, RemBertForMaskedLM
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("google/rembert")
>>> model = RemBertForMaskedLM.from_pretrained("google/rembert")
>>> 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)
...RemBertForSequenceClassification
class transformers.RemBertForSequenceClassification
< source >( config )
引數
- config (RemBertForSequenceClassification) — 模型配置類，包含模型的所有引數。使用配置檔案初始化並不會載入與模型相關的權重，只會載入配置。請檢視 from_pretrained() 方法來載入模型權重。
RemBERT 模型變壓器，頂部帶有序列分類/迴歸頭（在池化輸出頂部的線性層），例如用於 GLUE 任務。
該模型繼承自 PreTrainedModel。請檢視超類文件，瞭解庫為其所有模型實現的通用方法（例如下載或儲存、調整輸入嵌入大小、修剪頭部等）
該模型也是 PyTorch torch.nn.Module 子類。將其作為常規 PyTorch 模組使用，並參考 PyTorch 文件中有關通用用法和行為的所有事項。
forward
< 源 >( input_ids: typing.Optional[torch.FloatTensor] = None attention_mask: typing.Optional[torch.FloatTensor] = None token_type_ids: typing.Optional[torch.LongTensor] = None position_ids: typing.Optional[torch.FloatTensor] = None head_mask: typing.Optional[torch.FloatTensor] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None labels: typing.Optional[torch.LongTensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.modeling_outputs.SequenceClassifierOutput 或 tuple(torch.FloatTensor)
引數
- input_ids (
torch.FloatTensor，形狀為(batch_size, sequence_length)，可選) — 詞彙表中輸入序列 token 的索引。預設情況下會忽略填充。可以使用 AutoTokenizer 獲取索引。有關詳細資訊，請參見 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.FloatTensor，形狀為(batch_size, sequence_length)，可選) — 用於避免對填充 token 索引執行注意力操作的掩碼。掩碼值選擇在[0, 1]之間：- 1 表示 token 未被掩碼，
- 0 表示 token 被掩碼。
- token_type_ids (
torch.LongTensor，形狀為(batch_size, sequence_length)，可選) — Segment token 索引，用於指示輸入的第一個和第二個部分。索引選擇在[0, 1]之間：- 0 對應於 句子 A token，
- 1 對應於 句子 B token。
- position_ids (
torch.FloatTensor，形狀為(batch_size, sequence_length)，可選) — 每個輸入序列 token 在位置嵌入中的位置索引。選擇範圍為[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,)，可選) — 用於計算序列分類/迴歸損失的標籤。索引應在[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）包含根據配置 (RemBertConfig) 和輸入而定的各種元素。
-
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), optional, 在傳遞output_hidden_states=True或config.output_hidden_states=True時返回) — 形狀為(batch_size, sequence_length, hidden_size)的torch.FloatTensor元組（如果模型有嵌入層，則為嵌入層輸出一個，每個層輸出一個）。模型在每個層輸出的隱藏狀態以及可選的初始嵌入輸出。
-
attentions (
tuple(torch.FloatTensor), optional, 在傳遞output_attentions=True或config.output_attentions=True時返回) — 形狀為(batch_size, num_heads, sequence_length, sequence_length)的torch.FloatTensor元組（每個層一個）。注意力 softmax 後的注意力權重，用於計算自注意力頭中的加權平均值。
RemBertForSequenceClassification 的 forward 方法，重寫了 __call__ 特殊方法。
儘管前向傳播的實現需要在該函式中定義，但在此之後應呼叫 Module 例項而不是此函式，因為前者負責執行預處理和後處理步驟，而後者則默默地忽略它們。
單標籤分類示例
>>> import torch
>>> from transformers import AutoTokenizer, RemBertForSequenceClassification
>>> tokenizer = AutoTokenizer.from_pretrained("google/rembert")
>>> model = RemBertForSequenceClassification.from_pretrained("google/rembert")
>>> 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 = RemBertForSequenceClassification.from_pretrained("google/rembert", num_labels=num_labels)
>>> labels = torch.tensor([1])
>>> loss = model(**inputs, labels=labels).loss
>>> round(loss.item(), 2)
...多標籤分類示例
>>> import torch
>>> from transformers import AutoTokenizer, RemBertForSequenceClassification
>>> tokenizer = AutoTokenizer.from_pretrained("google/rembert")
>>> model = RemBertForSequenceClassification.from_pretrained("google/rembert", 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 = RemBertForSequenceClassification.from_pretrained(
... "google/rembert", 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).lossRemBertForMultipleChoice
class transformers.RemBertForMultipleChoice
< 源 >( config )
引數
- config (RemBertForMultipleChoice) — 模型的配置類，包含模型的所有引數。使用配置檔案初始化不載入與模型關聯的權重，只加載配置。請檢視 from_pretrained() 方法來載入模型權重。
Rembert 模型，頂部帶有多項選擇分類頭（在池化輸出頂部的線性層和 softmax），例如用於 RocStories/SWAG 任務。
該模型繼承自 PreTrainedModel。請檢視超類文件，瞭解庫為其所有模型實現的通用方法（例如下載或儲存、調整輸入嵌入大小、修剪頭部等）
該模型也是 PyTorch torch.nn.Module 子類。將其作為常規 PyTorch 模組使用，並參考 PyTorch 文件中有關通用用法和行為的所有事項。
forward
< 源 >( input_ids: typing.Optional[torch.FloatTensor] = None attention_mask: typing.Optional[torch.FloatTensor] = None token_type_ids: typing.Optional[torch.LongTensor] = None position_ids: typing.Optional[torch.FloatTensor] = None head_mask: typing.Optional[torch.FloatTensor] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None labels: typing.Optional[torch.LongTensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.modeling_outputs.MultipleChoiceModelOutput 或 tuple(torch.FloatTensor)
引數
- input_ids (
torch.LongTensor，形狀為(batch_size, num_choices, sequence_length)) — 詞彙表中輸入序列 token 的索引。可以使用 AutoTokenizer 獲取索引。有關詳細資訊，請參見 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.FloatTensor，形狀為(batch_size, sequence_length)，可選) — 用於避免對填充 token 索引執行注意力操作的掩碼。掩碼值選擇在[0, 1]之間：- 1 表示 token 未被掩碼，
- 0 表示 token 被掩碼。
- token_type_ids (
torch.LongTensor，形狀為(batch_size, num_choices, sequence_length)，可選) — Segment token 索引，用於指示輸入的第一個和第二個部分。索引選擇在[0, 1]之間：- 0 對應於 句子 A token，
- 1 對應於 句子 B token。
- position_ids (
torch.LongTensor，形狀為(batch_size, num_choices, sequence_length)，可選) — 每個輸入序列 token 在位置嵌入中的位置索引。選擇範圍為[0, config.max_position_embeddings - 1]。 - head_mask (
torch.FloatTensor，形狀為(num_heads,)或(num_layers, num_heads)，可選) — 用於使自注意力模組的選定頭部無效的掩碼。掩碼值選擇在[0, 1]之間：- 1 表示頭部未被掩碼，
- 0 表示頭部被掩碼。
- inputs_embeds (
torch.FloatTensor，形狀為(batch_size, num_choices, sequence_length, hidden_size)，可選) — 可選地，您可以選擇直接傳遞嵌入表示而不是傳遞input_ids。如果您希望對如何將 input_ids 索引轉換為關聯向量具有比模型內部嵌入查詢矩陣更多的控制權，則此功能很有用。 - 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）包含根據配置 (RemBertConfig) 和輸入而定的各種元素。
-
loss (形狀為 (1,) 的
torch.FloatTensor，可選，當提供labels時返回) — 分類損失。 -
logits (形狀為
(batch_size, num_choices)的torch.FloatTensor) — num_choices 是輸入張量的第二維大小。（請參閱上面的 input_ids）。分類分數（SoftMax 之前）。
-
hidden_states (
tuple(torch.FloatTensor), optional, 在傳遞output_hidden_states=True或config.output_hidden_states=True時返回) — 形狀為(batch_size, sequence_length, hidden_size)的torch.FloatTensor元組（如果模型有嵌入層，則為嵌入層輸出一個，每個層輸出一個）。模型在每個層輸出的隱藏狀態以及可選的初始嵌入輸出。
-
attentions (
tuple(torch.FloatTensor), optional, 在傳遞output_attentions=True或config.output_attentions=True時返回) — 形狀為(batch_size, num_heads, sequence_length, sequence_length)的torch.FloatTensor元組（每個層一個）。注意力 softmax 後的注意力權重，用於計算自注意力頭中的加權平均值。
RemBertForMultipleChoice 的 forward 方法，重寫了 __call__ 特殊方法。
儘管前向傳播的實現需要在該函式中定義，但在此之後應呼叫 Module 例項而不是此函式，因為前者負責執行預處理和後處理步驟，而後者則默默地忽略它們。
示例
>>> from transformers import AutoTokenizer, RemBertForMultipleChoice
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("google/rembert")
>>> model = RemBertForMultipleChoice.from_pretrained("google/rembert")
>>> 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.logitsRemBertForTokenClassification
class transformers.RemBertForTokenClassification
< 源 >( config )
引數
- config (RemBertForTokenClassification) — 模型的配置類，包含模型的所有引數。使用配置檔案初始化不載入與模型關聯的權重，只加載配置。請檢視 from_pretrained() 方法來載入模型權重。
Rembert 變壓器，頂部帶有一個 token 分類頭（在隱藏狀態輸出頂部的線性層），例如用於命名實體識別 (NER) 任務。
該模型繼承自 PreTrainedModel。請檢視超類文件，瞭解庫為其所有模型實現的通用方法（例如下載或儲存、調整輸入嵌入大小、修剪頭部等）
該模型也是 PyTorch torch.nn.Module 子類。將其作為常規 PyTorch 模組使用，並參考 PyTorch 文件中有關通用用法和行為的所有事項。
forward
< 源 >( input_ids: typing.Optional[torch.FloatTensor] = None attention_mask: typing.Optional[torch.FloatTensor] = None token_type_ids: typing.Optional[torch.LongTensor] = None position_ids: typing.Optional[torch.FloatTensor] = None head_mask: typing.Optional[torch.FloatTensor] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None labels: typing.Optional[torch.LongTensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.modeling_outputs.TokenClassifierOutput 或 tuple(torch.FloatTensor)
引數
- input_ids (
torch.FloatTensor，形狀為(batch_size, sequence_length)，可選) — 詞彙表中輸入序列 token 的索引。預設情況下會忽略填充。可以使用 AutoTokenizer 獲取索引。有關詳細資訊，請參見 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.FloatTensor，形狀為(batch_size, sequence_length)，可選) — 用於避免對填充 token 索引執行注意力操作的掩碼。掩碼值選擇在[0, 1]之間：- 1 表示 token 未被掩碼，
- 0 表示 token 被掩碼。
- token_type_ids (
torch.LongTensor，形狀為(batch_size, sequence_length)，可選) — Segment token 索引，用於指示輸入的第一個和第二個部分。索引選擇在[0, 1]之間：- 0 對應於 句子 A token，
- 1 對應於 句子 B token。
- position_ids (
torch.FloatTensor，形狀為(batch_size, sequence_length)，可選) — 每個輸入序列 token 在位置嵌入中的位置索引。選擇範圍為[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)，可選) — 用於計算 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）包含根據配置 (RemBertConfig) 和輸入而定的各種元素。
-
loss (形狀為
(1,)的torch.FloatTensor，可選，當提供labels時返回) — 分類損失。 -
logits (形狀為
(batch_size, sequence_length, config.num_labels)的torch.FloatTensor) — 分類分數（SoftMax 之前）。 -
hidden_states (
tuple(torch.FloatTensor), optional, 在傳遞output_hidden_states=True或config.output_hidden_states=True時返回) — 形狀為(batch_size, sequence_length, hidden_size)的torch.FloatTensor元組（如果模型有嵌入層，則為嵌入層輸出一個，每個層輸出一個）。模型在每個層輸出的隱藏狀態以及可選的初始嵌入輸出。
-
attentions (
tuple(torch.FloatTensor), optional, 在傳遞output_attentions=True或config.output_attentions=True時返回) — 形狀為(batch_size, num_heads, sequence_length, sequence_length)的torch.FloatTensor元組（每個層一個）。注意力 softmax 後的注意力權重，用於計算自注意力頭中的加權平均值。
RemBertForTokenClassification 的 forward 方法，重寫了 __call__ 特殊方法。
儘管前向傳播的實現需要在該函式中定義，但在此之後應呼叫 Module 例項而不是此函式，因為前者負責執行預處理和後處理步驟，而後者則默默地忽略它們。
示例
>>> from transformers import AutoTokenizer, RemBertForTokenClassification
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("google/rembert")
>>> model = RemBertForTokenClassification.from_pretrained("google/rembert")
>>> 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)
...RemBertForQuestionAnswering
class transformers.RemBertForQuestionAnswering
< 源 >( config )
引數
- config (RemBertForQuestionAnswering) — 模型的配置類，包含模型的所有引數。使用配置檔案初始化不載入與模型關聯的權重，只加載配置。請檢視 from_pretrained() 方法來載入模型權重。
Rembert 變壓器，頂部帶有一個 span 分類頭，用於抽取式問答任務（如 SQuAD）（在隱藏狀態輸出頂部的線性層，用於計算 span start logits 和 span end logits）。
該模型繼承自 PreTrainedModel。請檢視超類文件，瞭解庫為其所有模型實現的通用方法（例如下載或儲存、調整輸入嵌入大小、修剪頭部等）
該模型也是 PyTorch torch.nn.Module 子類。將其作為常規 PyTorch 模組使用，並參考 PyTorch 文件中有關通用用法和行為的所有事項。
forward
< 源 >( input_ids: typing.Optional[torch.FloatTensor] = None attention_mask: typing.Optional[torch.FloatTensor] = None token_type_ids: typing.Optional[torch.LongTensor] = None position_ids: typing.Optional[torch.FloatTensor] = None head_mask: typing.Optional[torch.FloatTensor] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None start_positions: typing.Optional[torch.LongTensor] = None end_positions: typing.Optional[torch.LongTensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.modeling_outputs.QuestionAnsweringModelOutput 或 tuple(torch.FloatTensor)
引數
- input_ids (
torch.FloatTensor，形狀為(batch_size, sequence_length)，可選) — 詞彙表中輸入序列 token 的索引。預設情況下會忽略填充。可以使用 AutoTokenizer 獲取索引。有關詳細資訊，請參見 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.FloatTensor，形狀為(batch_size, sequence_length)，可選) — 用於避免對填充 token 索引執行注意力操作的掩碼。掩碼值選擇在[0, 1]之間：- 1 表示 token 未被掩碼，
- 0 表示 token 被掩碼。
- token_type_ids (
torch.LongTensor，形狀為(batch_size, sequence_length)，可選) — Segment token 索引，用於指示輸入的第一個和第二個部分。索引選擇在[0, 1]之間：- 0 對應於 句子 A token，
- 1 對應於 句子 B token。
- position_ids (
torch.FloatTensor，形狀為(batch_size, sequence_length)，可選) — 每個輸入序列 token 在位置嵌入中的位置索引。選擇範圍為[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索引轉換為關聯向量有比模型內部嵌入查詢矩陣更多的控制，這將非常有用。 - start_positions (
torch.LongTensor，形狀為(batch_size,)，可選) — 用於計算標記分類損失的標記範圍起始位置（索引）的標籤。位置將被限制在序列長度（sequence_length）內。序列外的位置不計入損失計算。 - end_positions (
torch.LongTensor，形狀為(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 時），包含根據配置（RemBertConfig）和輸入而定的各種元素。
-
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), optional, 在傳遞output_hidden_states=True或config.output_hidden_states=True時返回) — 形狀為(batch_size, sequence_length, hidden_size)的torch.FloatTensor元組（如果模型有嵌入層，則為嵌入層輸出一個，每個層輸出一個）。模型在每個層輸出的隱藏狀態以及可選的初始嵌入輸出。
-
attentions (
tuple(torch.FloatTensor), optional, 在傳遞output_attentions=True或config.output_attentions=True時返回) — 形狀為(batch_size, num_heads, sequence_length, sequence_length)的torch.FloatTensor元組（每個層一個）。注意力 softmax 後的注意力權重，用於計算自注意力頭中的加權平均值。
RemBertForQuestionAnswering 的 forward 方法，覆蓋了 __call__ 特殊方法。
儘管前向傳播的實現需要在該函式中定義，但在此之後應呼叫 Module 例項而不是此函式，因為前者負責執行預處理和後處理步驟，而後者則默默地忽略它們。
示例
>>> from transformers import AutoTokenizer, RemBertForQuestionAnswering
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("google/rembert")
>>> model = RemBertForQuestionAnswering.from_pretrained("google/rembert")
>>> 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)
...TFRemBertModel
class transformers.TFRemBertModel
< 源 >( config: RemBertConfig *inputs **kwargs )
引數
- config (RemBertConfig) — 包含模型所有引數的模型配置類。使用配置檔案初始化並不會載入與模型相關的權重，只加載配置。請檢視 from_pretrained() 方法來載入模型權重。
裸露的 RemBERT 模型，輸出原始隱藏狀態，頂部沒有任何特定頭部。
此模型繼承自 TFPreTrainedModel。請檢視超類文件，瞭解庫為其所有模型實現的通用方法（如下載或儲存、調整輸入嵌入大小、修剪頭部等）。
此模型也是 keras.Model 的子類。請將其作為常規的 TF 2.0 Keras 模型使用，並參考 TF 2.0 文件瞭解所有與通用用法和行為相關的事項。
transformers 中的 TensorFlow 模型和層接受兩種輸入格式
- 所有輸入作為關鍵字引數（如 PyTorch 模型），或
- 所有輸入作為第一個位置引數中的列表、元組或字典。
支援第二種格式的原因是，在將輸入傳遞給模型和層時，Keras 方法偏好這種格式。由於這種支援，當使用 model.fit() 等方法時，一切都應該“正常工作”——只需以 model.fit() 支援的任何格式傳遞你的輸入和標籤即可！但是，如果你想在 Keras 方法（如 fit() 和 predict()）之外使用第二種格式，例如在使用 Keras Functional API 建立自己的層或模型時，可以使用三種可能性來將所有輸入張量收集到第一個位置引數中。
- 只有一個
input_ids的單個張量，沒有其他：model(input_ids) - 長度可變的列表，包含一個或多個輸入張量，按文件字串中給出的順序：
model([input_ids, attention_mask])或model([input_ids, attention_mask, token_type_ids]) - 一個字典，其中包含一個或多個與文件字串中給出的輸入名稱關聯的輸入張量：
model({"input_ids": input_ids, "token_type_ids": token_type_ids})
請注意，當使用子類化建立模型和層時，你無需擔心這些，因為你可以像對任何其他 Python 函式一樣傳遞輸入！
呼叫
< 源 >( 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 encoder_hidden_states: np.ndarray | tf.Tensor | None = None encoder_attention_mask: np.ndarray | tf.Tensor | None = None past_key_values: Optional[tuple[tuple[Union[np.ndarray, tf.Tensor]]]] = None use_cache: Optional[bool] = 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.TFBaseModelOutputWithPoolingAndCrossAttentions 或 tuple(tf.Tensor)
引數
- input_ids (
np.ndarray,tf.Tensor,list[tf.Tensor]`dict[str, tf.Tensor]或dict[str, np.ndarray]，且每個示例的形狀必須為(batch_size, sequence_length)) — 詞彙表中輸入序列標記的索引。可以使用 AutoTokenizer 獲取索引。有關詳情，請參閱 PreTrainedTokenizer.call() 和 PreTrainedTokenizer.encode()。
- attention_mask (
np.ndarray或tf.Tensor，形狀為(batch_size, sequence_length)，可選) — 避免對填充標記索引執行注意力操作的掩碼。掩碼值選擇在[0, 1]之間：- 1 表示**未被遮蓋**的標記，
- 0 表示**被遮蓋**的標記。
- token_type_ids (
np.ndarray或tf.Tensor，形狀為(batch_size, sequence_length)，可選) — 表示輸入第一部分和第二部分的分段標記索引。索引選擇在[0, 1]之間：- 0 對應於*句子 A* 標記，
- 1 對應於*句子 B* 標記。
- position_ids (
np.ndarray或tf.Tensor，形狀為(batch_size, sequence_length)，可選) — 輸入序列中每個標記在位置嵌入中的位置索引。選擇範圍為[0, config.max_position_embeddings - 1]。 - head_mask (
np.ndarray或tf.Tensor，形狀為(num_heads,)或(num_layers, num_heads)，可選) — 用於使自注意力模組的選定頭部無效的掩碼。掩碼值選擇在[0, 1]之間：- 1 表示頭部**未被遮蓋**，
- 0 表示頭部**被遮蓋**。
- inputs_embeds (
np.ndarray或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 模組在訓練和評估之間有不同的行為）。 - encoder_hidden_states (
tf.Tensor，形狀為(batch_size, sequence_length, hidden_size)，可選) — 編碼器最後一層輸出的隱藏狀態序列。如果模型被配置為解碼器，則用於交叉注意力。 - encoder_attention_mask (
tf.Tensor，形狀為(batch_size, sequence_length)，可選) — 避免在編碼器輸入的填充標記索引上執行注意力的掩碼。如果模型配置為解碼器，則此掩碼用於交叉注意力。掩碼值選擇在[0, 1]之間：- 1 表示**未被遮蓋**的標記，
- 0 表示**被遮蓋**的標記。
- past_key_values (
tuple[tuple[tf.Tensor]]，長度為config.n_layers) — 包含注意力塊預先計算的鍵和值隱藏狀態。可用於加快解碼。如果使用past_key_values，使用者可以選擇只輸入最後一個decoder_input_ids（那些沒有將其過去的鍵值狀態提供給此模型的）的形狀(batch_size, 1)，而不是所有decoder_input_ids的形狀(batch_size, sequence_length)。 - use_cache (
bool，可選，預設為True) — 如果設定為True，將返回past_key_values鍵值狀態，可用於加快解碼（參閱past_key_values）。訓練期間設定為False，生成期間設定為True
返回
transformers.modeling_tf_outputs.TFBaseModelOutputWithPoolingAndCrossAttentions 或 tuple(tf.Tensor)
一個 transformers.modeling_tf_outputs.TFBaseModelOutputWithPoolingAndCrossAttentions 或一個 tf.Tensor 元組（如果傳入 return_dict=False 或當 config.return_dict=False 時），包含根據配置（RemBertConfig）和輸入而定的各種元素。
-
last_hidden_state (
tf.Tensorof shape(batch_size, sequence_length, hidden_size)) — 模型最後一層輸出的隱藏狀態序列。 -
pooler_output (
tf.Tensor，形狀為(batch_size, hidden_size)) — 序列第一個標記（分類標記）的最後一層隱藏狀態，經線性層和 Tanh 啟用函式進一步處理。線性層權重在預訓練期間透過下一個句子預測（分類）目標進行訓練。此輸出通常不是輸入語義內容的良好摘要，通常最好對整個輸入序列的隱藏狀態進行平均或池化。
-
past_key_values (
list[tf.Tensor]，可選，當傳入use_cache=True或config.use_cache=True時返回) — 長度為config.n_layers的tf.Tensor列表，每個張量的形狀為(2, batch_size, num_heads, sequence_length, embed_size_per_head))。包含預先計算的隱藏狀態（注意力塊中的鍵和值），可用於（參見
past_key_values輸入）加速順序解碼。 -
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 後的注意力權重，用於計算自注意力頭中的加權平均值。
-
cross_attentions (
tuple(tf.Tensor)，可選，當傳入output_attentions=True或config.output_attentions=True時返回) —tf.Tensor元組（每層一個），形狀為(batch_size, num_heads, sequence_length, sequence_length)。解碼器交叉注意力層的注意力權重，在注意力 softmax 之後，用於計算交叉注意力頭中的加權平均。
TFRemBertModel 的 forward 方法覆蓋了 `__call__` 特殊方法。
儘管前向傳播的實現需要在該函式中定義，但在此之後應呼叫 Module 例項而不是此函式，因為前者負責執行預處理和後處理步驟，而後者則默默地忽略它們。
示例
>>> from transformers import AutoTokenizer, TFRemBertModel
>>> import tensorflow as tf
>>> tokenizer = AutoTokenizer.from_pretrained("google/rembert")
>>> model = TFRemBertModel.from_pretrained("google/rembert")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="tf")
>>> outputs = model(inputs)
>>> last_hidden_states = outputs.last_hidden_stateTFRemBertForMaskedLM
class transformers.TFRemBertForMaskedLM
< 源 >( config: RemBertConfig *inputs **kwargs )
引數
- config (RemBertConfig) — 包含模型所有引數的模型配置類。使用配置檔案初始化並不會載入與模型相關的權重，只加載配置。請檢視 from_pretrained() 方法來載入模型權重。
RemBERT 模型，頂部帶有 語言建模 頭。
此模型繼承自 TFPreTrainedModel。請檢視超類文件，瞭解庫為其所有模型實現的通用方法（如下載或儲存、調整輸入嵌入大小、修剪頭部等）。
此模型也是 keras.Model 的子類。請將其作為常規的 TF 2.0 Keras 模型使用，並參考 TF 2.0 文件瞭解所有與通用用法和行為相關的事項。
transformers 中的 TensorFlow 模型和層接受兩種輸入格式
- 所有輸入作為關鍵字引數（如 PyTorch 模型），或
- 所有輸入作為第一個位置引數中的列表、元組或字典。
支援第二種格式的原因是，在將輸入傳遞給模型和層時，Keras 方法偏好這種格式。由於這種支援，當使用 model.fit() 等方法時，一切都應該“正常工作”——只需以 model.fit() 支援的任何格式傳遞你的輸入和標籤即可！但是，如果你想在 Keras 方法（如 fit() 和 predict()）之外使用第二種格式，例如在使用 Keras Functional API 建立自己的層或模型時，可以使用三種可能性來將所有輸入張量收集到第一個位置引數中。
- 只有一個
input_ids的單個張量，沒有其他：model(input_ids) - 長度可變的列表，包含一個或多個輸入張量，按文件字串中給出的順序：
model([input_ids, attention_mask])或model([input_ids, attention_mask, token_type_ids]) - 一個字典，其中包含一個或多個與文件字串中給出的輸入名稱關聯的輸入張量：
model({"input_ids": input_ids, "token_type_ids": token_type_ids})
請注意，當使用子類化建立模型和層時，你無需擔心這些，因為你可以像對任何其他 Python 函式一樣傳遞輸入！
呼叫
< 源 >( 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 (
np.ndarray,tf.Tensor,list[tf.Tensor]`dict[str, tf.Tensor]或dict[str, np.ndarray]，且每個示例的形狀必須為(batch_size, sequence_length)) — 詞彙表中輸入序列標記的索引。可以使用 AutoTokenizer 獲取索引。有關詳情，請參閱 PreTrainedTokenizer.call() 和 PreTrainedTokenizer.encode()。
- attention_mask (
np.ndarray或tf.Tensor，形狀為(batch_size, sequence_length)，可選) — 避免對填充標記索引執行注意力操作的掩碼。掩碼值選擇在[0, 1]之間：- 1 表示**未被遮蓋**的標記，
- 0 表示**被遮蓋**的標記。
- token_type_ids (
np.ndarray或tf.Tensor，形狀為(batch_size, sequence_length)，可選) — 表示輸入第一部分和第二部分的分段標記索引。索引選擇在[0, 1]之間：- 0 對應於*句子 A* 標記，
- 1 對應於*句子 B* 標記。
- position_ids (
np.ndarray或tf.Tensor，形狀為(batch_size, sequence_length)，可選) — 輸入序列中每個標記在位置嵌入中的位置索引。選擇範圍為[0, config.max_position_embeddings - 1]。 - head_mask (
np.ndarray或tf.Tensor，形狀為(num_heads,)或(num_layers, num_heads)，可選) — 用於使自注意力模組的選定頭部無效的掩碼。掩碼值選擇在[0, 1]之間：- 1 表示頭部**未被遮蓋**，
- 0 表示頭部**被遮蓋**。
- inputs_embeds (
np.ndarray或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或np.ndarray，形狀為(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 時），包含根據配置（RemBertConfig）和輸入而定的各種元素。
-
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 後的注意力權重，用於計算自注意力頭中的加權平均值。
TFRemBertForMaskedLM 的 forward 方法覆蓋了 `__call__` 特殊方法。
儘管前向傳播的實現需要在該函式中定義，但在此之後應呼叫 Module 例項而不是此函式，因為前者負責執行預處理和後處理步驟，而後者則默默地忽略它們。
示例
>>> from transformers import AutoTokenizer, TFRemBertForMaskedLM
>>> import tensorflow as tf
>>> tokenizer = AutoTokenizer.from_pretrained("google/rembert")
>>> model = TFRemBertForMaskedLM.from_pretrained("google/rembert")
>>> 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)TFRemBertForCausalLM
class transformers.TFRemBertForCausalLM
< 源 >( config: RemBertConfig *inputs **kwargs )
引數
- config (RemBertConfig) — 包含模型所有引數的模型配置類。使用配置檔案初始化並不會載入與模型相關的權重，只加載配置。請檢視 from_pretrained() 方法來載入模型權重。
帶有語言建模頭的 RemBERT 模型，用於 CLM 微調。
此模型繼承自 TFPreTrainedModel。請檢視超類文件，瞭解庫為其所有模型實現的通用方法（如下載或儲存、調整輸入嵌入大小、修剪頭部等）。
此模型也是 keras.Model 的子類。請將其作為常規的 TF 2.0 Keras 模型使用，並參考 TF 2.0 文件瞭解所有與通用用法和行為相關的事項。
transformers 中的 TensorFlow 模型和層接受兩種輸入格式
- 所有輸入作為關鍵字引數（如 PyTorch 模型），或
- 所有輸入作為第一個位置引數中的列表、元組或字典。
支援第二種格式的原因是，在將輸入傳遞給模型和層時，Keras 方法偏好這種格式。由於這種支援，當使用 model.fit() 等方法時，一切都應該“正常工作”——只需以 model.fit() 支援的任何格式傳遞你的輸入和標籤即可！但是，如果你想在 Keras 方法（如 fit() 和 predict()）之外使用第二種格式，例如在使用 Keras Functional API 建立自己的層或模型時，可以使用三種可能性來將所有輸入張量收集到第一個位置引數中。
- 只有一個
input_ids的單個張量，沒有其他：model(input_ids) - 長度可變的列表，包含一個或多個輸入張量，按文件字串中給出的順序：
model([input_ids, attention_mask])或model([input_ids, attention_mask, token_type_ids]) - 一個字典，其中包含一個或多個與文件字串中給出的輸入名稱關聯的輸入張量：
model({"input_ids": input_ids, "token_type_ids": token_type_ids})
請注意，當使用子類化建立模型和層時，你無需擔心這些，因為你可以像對任何其他 Python 函式一樣傳遞輸入！
呼叫
< 源 >( 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 encoder_hidden_states: np.ndarray | tf.Tensor | None = None encoder_attention_mask: np.ndarray | tf.Tensor | None = None past_key_values: Optional[tuple[tuple[Union[np.ndarray, tf.Tensor]]]] = None use_cache: Optional[bool] = 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.TFCausalLMOutputWithCrossAttentions 或 tuple(tf.Tensor)
返回
transformers.modeling_tf_outputs.TFCausalLMOutputWithCrossAttentions 或 tuple(tf.Tensor)
一個 transformers.modeling_tf_outputs.TFCausalLMOutputWithCrossAttentions 或一個 tf.Tensor 元組（如果傳入 return_dict=False 或當 config.return_dict=False 時），包含根據配置（RemBertConfig）和輸入而定的各種元素。
-
loss (形狀為
(n,)的tf.Tensor，可選，其中n是非掩碼標籤的數量，當提供了labels時返回) — 語言建模損失（用於下一標記預測）。 -
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 後的注意力權重，用於計算自注意力頭中的加權平均值。
-
cross_attentions (
tuple(tf.Tensor)，可選，當傳入output_attentions=True或config.output_attentions=True時返回) —tf.Tensor元組（每層一個），形狀為(batch_size, num_heads, sequence_length, sequence_length)。解碼器交叉注意力層的注意力權重，在注意力 softmax 之後，用於計算交叉注意力頭中的加權平均。
-
past_key_values (
list[tf.Tensor]，可選，當傳入use_cache=True或config.use_cache=True時返回) — 長度為config.n_layers的tf.Tensor列表，每個張量的形狀為(2, batch_size, num_heads, sequence_length, embed_size_per_head))。包含預先計算的隱藏狀態（注意力塊中的鍵和值），可用於（參見
past_key_values輸入）加速順序解碼。
encoder_hidden_states (tf.Tensor，形狀為 (batch_size, sequence_length, hidden_size)，可選): 編碼器最後一層輸出的隱藏狀態序列。如果模型被配置為解碼器，則用於交叉注意力。encoder_attention_mask (tf.Tensor，形狀為 (batch_size, sequence_length)，可選): 避免在編碼器輸入的填充標記索引上執行注意力的掩碼。如果模型配置為解碼器，則此掩碼用於交叉注意力。掩碼值選擇在 [0, 1] 之間
- 1 表示 未被掩蓋 的標記，
- 0 代表**被掩碼**的標記。
past_key_values (tuple[tuple[tf.Tensor]]，長度為 config.n_layers) — 包含注意力塊預先計算的鍵和值隱藏狀態。可用於加快解碼。如果使用 past_key_values，使用者可以選擇只輸入最後一個 decoder_input_ids（那些沒有將其過去的鍵值狀態提供給此模型的）的形狀 (batch_size, 1)，而不是所有 decoder_input_ids 的形狀 (batch_size, sequence_length)。use_cache (bool，可選，預設為 True): 如果設定為 True，將返回 past_key_values 鍵值狀態，可用於加快解碼（參閱 past_key_values）。訓練期間設定為 False，生成期間設定為 True。labels (tf.Tensor 或 np.ndarray，形狀為 (batch_size, sequence_length)，可選): 用於計算交叉熵分類損失的標籤。索引應在 [0, ..., config.vocab_size - 1] 範圍內。
示例
>>> from transformers import AutoTokenizer, TFRemBertForCausalLM
>>> import tensorflow as tf
>>> tokenizer = AutoTokenizer.from_pretrained("google/rembert")
>>> model = TFRemBertForCausalLM.from_pretrained("google/rembert")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="tf")
>>> outputs = model(inputs)
>>> logits = outputs.logitsTFRemBertForSequenceClassification
class transformers.TFRemBertForSequenceClassification
< 源 >( config: RemBertConfig *inputs **kwargs )
引數
- config (RemBertConfig) — 包含模型所有引數的模型配置類。使用配置檔案初始化並不會載入與模型相關的權重，只加載配置。請檢視 from_pretrained() 方法來載入模型權重。
RemBERT 模型變壓器，頂部帶有序列分類/迴歸頭部，例如用於 GLUE 任務。
此模型繼承自 TFPreTrainedModel。請檢視超類文件，瞭解庫為其所有模型實現的通用方法（如下載或儲存、調整輸入嵌入大小、修剪頭部等）。
此模型也是 keras.Model 的子類。請將其作為常規的 TF 2.0 Keras 模型使用，並參考 TF 2.0 文件瞭解所有與通用用法和行為相關的事項。
transformers 中的 TensorFlow 模型和層接受兩種輸入格式
- 所有輸入作為關鍵字引數（如 PyTorch 模型），或
- 所有輸入作為第一個位置引數中的列表、元組或字典。
支援第二種格式的原因是，在將輸入傳遞給模型和層時，Keras 方法偏好這種格式。由於這種支援，當使用 model.fit() 等方法時，一切都應該“正常工作”——只需以 model.fit() 支援的任何格式傳遞你的輸入和標籤即可！但是，如果你想在 Keras 方法（如 fit() 和 predict()）之外使用第二種格式，例如在使用 Keras Functional API 建立自己的層或模型時，可以使用三種可能性來將所有輸入張量收集到第一個位置引數中。
- 只有一個
input_ids的單個張量，沒有其他：model(input_ids) - 長度可變的列表，包含一個或多個輸入張量，按文件字串中給出的順序：
model([input_ids, attention_mask])或model([input_ids, attention_mask, token_type_ids]) - 一個字典，其中包含一個或多個與文件字串中給出的輸入名稱關聯的輸入張量：
model({"input_ids": input_ids, "token_type_ids": token_type_ids})
請注意，當使用子類化建立模型和層時，你無需擔心這些，因為你可以像對任何其他 Python 函式一樣傳遞輸入！
呼叫
< 源 >( 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 (
np.ndarray,tf.Tensor,list[tf.Tensor]`dict[str, tf.Tensor]或dict[str, np.ndarray]且每個示例必須具有形狀(batch_size, sequence_length)) — 詞彙表中輸入序列標記的索引。索引可以使用 AutoTokenizer 獲取。有關詳細資訊，請參見 PreTrainedTokenizer.call() 和 PreTrainedTokenizer.encode()。
- attention_mask (形狀為
(batch_size, sequence_length)的np.ndarray或tf.Tensor，可選) — 掩碼，用於避免對填充標記索引執行注意力。掩碼值選擇在[0, 1]中:- 1 表示**未被掩碼**的標記，
- 0 表示**被掩碼**的標記。
- token_type_ids (形狀為
(batch_size, sequence_length)的np.ndarray或tf.Tensor，可選) — 分段標記索引，用於指示輸入的第一個和第二個部分。索引在[0, 1]中選擇:- 0 對應於句子 A 標記，
- 1 對應於句子 B 標記。
- position_ids (形狀為
(batch_size, sequence_length)的np.ndarray或tf.Tensor，可選) — 輸入序列中每個標記在位置嵌入中的位置索引。選擇範圍為[0, config.max_position_embeddings - 1]。 - head_mask (形狀為
(num_heads,)或(num_layers, num_heads)的np.ndarray或tf.Tensor，可選) — 掩碼，用於使自注意力模組的選定頭部無效。掩碼值選擇在[0, 1]中:- 1 表示頭部**未被掩碼**，
- 0 表示頭部**被掩碼**。
- inputs_embeds (形狀為
(batch_size, sequence_length, hidden_size)的np.ndarray或tf.Tensor，可選) — 或者，你可以選擇直接傳遞嵌入表示，而不是傳遞input_ids。如果你想更精細地控制如何將input_ids索引轉換為關聯向量，而不是模型內部的嵌入查詢矩陣，這會很有用。 - output_attentions (
bool，可選) — 是否返回所有注意力層的注意力張量。有關更多詳細資訊，請參見返回張量下的attentions。此引數只能在 eager 模式下使用，在圖模式下將使用配置中的值。 - output_hidden_states (
bool，可選) — 是否返回所有層的隱藏狀態。有關更多詳細資訊，請參見返回張量下的hidden_states。此引數只能在 eager 模式下使用，在圖模式下將使用配置中的值。 - return_dict (
bool，可選) — 是否返回 ModelOutput 而不是普通的元組。此引數可在 eager 模式下使用，在圖模式下，該值始終設定為 True。 - training (
bool，可選，預設為 `False“) — 是否在訓練模式下使用模型（某些模組，如 dropout 模組，在訓練和評估之間有不同的行為）。 - labels (形狀為
(batch_size,)的tf.Tensor或np.ndarray，可選) — 用於計算序列分類/迴歸損失的標籤。索引應在[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 時），包含根據配置 (RemBertConfig) 和輸入的不同元素。
-
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 後的注意力權重，用於計算自注意力頭中的加權平均值。
TFRemBertForSequenceClassification 的前向方法，重寫了 __call__ 特殊方法。
儘管前向傳播的實現需要在該函式中定義，但在此之後應呼叫 Module 例項而不是此函式，因為前者負責執行預處理和後處理步驟，而後者則默默地忽略它們。
示例
>>> from transformers import AutoTokenizer, TFRemBertForSequenceClassification
>>> import tensorflow as tf
>>> tokenizer = AutoTokenizer.from_pretrained("google/rembert")
>>> model = TFRemBertForSequenceClassification.from_pretrained("google/rembert")
>>> 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 = TFRemBertForSequenceClassification.from_pretrained("google/rembert", num_labels=num_labels)
>>> labels = tf.constant(1)
>>> loss = model(**inputs, labels=labels).lossTFRemBertForMultipleChoice
class transformers.TFRemBertForMultipleChoice
< source >( config: RemBertConfig *inputs **kwargs )
引數
- config (RemBertConfig) — 模型配置類，包含模型的所有引數。使用配置檔案初始化不載入與模型關聯的權重，僅載入配置。請檢視 from_pretrained() 方法以載入模型權重。
RemBERT 模型，頂部帶有多項選擇分類頭（在池化輸出之上有一個線性層和一個 softmax），例如用於 RocStories/SWAG 任務。
此模型繼承自 TFPreTrainedModel。請檢視超類文件，瞭解庫為其所有模型實現的通用方法（如下載或儲存、調整輸入嵌入大小、修剪頭部等）。
此模型也是 keras.Model 的子類。請將其作為常規的 TF 2.0 Keras 模型使用，並參考 TF 2.0 文件瞭解所有與通用用法和行為相關的事項。
transformers 中的 TensorFlow 模型和層接受兩種輸入格式
- 所有輸入作為關鍵字引數（如 PyTorch 模型），或
- 所有輸入作為第一個位置引數中的列表、元組或字典。
支援第二種格式的原因是，在將輸入傳遞給模型和層時，Keras 方法偏好這種格式。由於這種支援，當使用 model.fit() 等方法時，一切都應該“正常工作”——只需以 model.fit() 支援的任何格式傳遞你的輸入和標籤即可！但是，如果你想在 Keras 方法（如 fit() 和 predict()）之外使用第二種格式，例如在使用 Keras Functional API 建立自己的層或模型時，可以使用三種可能性來將所有輸入張量收集到第一個位置引數中。
- 只有一個
input_ids的單個張量，沒有其他：model(input_ids) - 長度可變的列表，包含一個或多個輸入張量，按文件字串中給出的順序：
model([input_ids, attention_mask])或model([input_ids, attention_mask, token_type_ids]) - 一個字典，其中包含一個或多個與文件字串中給出的輸入名稱關聯的輸入張量：
model({"input_ids": input_ids, "token_type_ids": token_type_ids})
請注意，當使用子類化建立模型和層時，你無需擔心這些，因為你可以像對任何其他 Python 函式一樣傳遞輸入！
呼叫
< source >( 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 (
np.ndarray,tf.Tensor,list[tf.Tensor]`dict[str, tf.Tensor]或dict[str, np.ndarray]，且每個示例必須具有形狀(batch_size, num_choices, sequence_length)) — 詞彙表中輸入序列標記的索引。索引可以使用 AutoTokenizer 獲取。有關詳細資訊，請參見 PreTrainedTokenizer.call() 和 PreTrainedTokenizer.encode()。
- attention_mask (形狀為
(batch_size, num_choices, sequence_length)的np.ndarray或tf.Tensor，可選) — 掩碼，用於避免對填充標記索引執行注意力。掩碼值選擇在[0, 1]中:- 1 表示**未被掩碼**的標記，
- 0 表示**被掩碼**的標記。
- token_type_ids (形狀為
(batch_size, num_choices, sequence_length)的np.ndarray或tf.Tensor，可選) — 分段標記索引，用於指示輸入的第一個和第二個部分。索引在[0, 1]中選擇:- 0 對應於句子 A 標記，
- 1 對應於句子 B 標記。
- position_ids (形狀為
(batch_size, num_choices, sequence_length)的np.ndarray或tf.Tensor，可選) — 輸入序列中每個標記在位置嵌入中的位置索引。選擇範圍為[0, config.max_position_embeddings - 1]。 - head_mask (形狀為
(num_heads,)或(num_layers, num_heads)的np.ndarray或tf.Tensor，可選) — 掩碼，用於使自注意力模組的選定頭部無效。掩碼值選擇在[0, 1]中:- 1 表示頭部**未被掩碼**，
- 0 表示頭部**被掩碼**。
- inputs_embeds (形狀為
(batch_size, num_choices, sequence_length, hidden_size)的np.ndarray或tf.Tensor，可選) — 或者，你可以選擇直接傳遞嵌入表示，而不是傳遞input_ids。如果你想更精細地控制如何將input_ids索引轉換為關聯向量，而不是模型內部的嵌入查詢矩陣，這會很有用。 - output_attentions (
bool，可選) — 是否返回所有注意力層的注意力張量。有關更多詳細資訊，請參見返回張量下的attentions。此引數只能在 eager 模式下使用，在圖模式下將使用配置中的值。 - output_hidden_states (
bool，可選) — 是否返回所有層的隱藏狀態。有關更多詳細資訊，請參見返回張量下的hidden_states。此引數只能在 eager 模式下使用，在圖模式下將使用配置中的值。 - return_dict (
bool，可選) — 是否返回 ModelOutput 而不是普通的元組。此引數可在 eager 模式下使用，在圖模式下，該值始終設定為 True。 - training (
bool，可選，預設為 `False“) — 是否在訓練模式下使用模型（某些模組，如 dropout 模組，在訓練和評估之間有不同的行為）。 - labels (形狀為
(batch_size,)的tf.Tensor或np.ndarray，可選) — 用於計算多項選擇分類損失的標籤。索引應在[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 時），包含根據配置 (RemBertConfig) 和輸入的不同元素。
-
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 後的注意力權重，用於計算自注意力頭中的加權平均值。
TFRemBertForMultipleChoice 的前向方法，重寫了 __call__ 特殊方法。
儘管前向傳播的實現需要在該函式中定義，但在此之後應呼叫 Module 例項而不是此函式，因為前者負責執行預處理和後處理步驟，而後者則默默地忽略它們。
示例
>>> from transformers import AutoTokenizer, TFRemBertForMultipleChoice
>>> import tensorflow as tf
>>> tokenizer = AutoTokenizer.from_pretrained("google/rembert")
>>> model = TFRemBertForMultipleChoice.from_pretrained("google/rembert")
>>> 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.logitsTFRemBertForTokenClassification
class transformers.TFRemBertForTokenClassification
< source >( config: RemBertConfig *inputs **kwargs )
引數
- config (RemBertConfig) — 模型配置類，包含模型的所有引數。使用配置檔案初始化不載入與模型關聯的權重，僅載入配置。請檢視 from_pretrained() 方法以載入模型權重。
RemBERT 模型，頂部帶有標記分類頭（在隱藏狀態輸出之上有一個線性層），例如用於命名實體識別（NER）任務。
此模型繼承自 TFPreTrainedModel。請檢視超類文件，瞭解庫為其所有模型實現的通用方法（如下載或儲存、調整輸入嵌入大小、修剪頭部等）。
此模型也是 keras.Model 的子類。請將其作為常規的 TF 2.0 Keras 模型使用，並參考 TF 2.0 文件瞭解所有與通用用法和行為相關的事項。
transformers 中的 TensorFlow 模型和層接受兩種輸入格式
- 所有輸入作為關鍵字引數（如 PyTorch 模型），或
- 所有輸入作為第一個位置引數中的列表、元組或字典。
支援第二種格式的原因是，在將輸入傳遞給模型和層時，Keras 方法偏好這種格式。由於這種支援，當使用 model.fit() 等方法時，一切都應該“正常工作”——只需以 model.fit() 支援的任何格式傳遞你的輸入和標籤即可！但是，如果你想在 Keras 方法（如 fit() 和 predict()）之外使用第二種格式，例如在使用 Keras Functional API 建立自己的層或模型時，可以使用三種可能性來將所有輸入張量收集到第一個位置引數中。
- 只有一個
input_ids的單個張量，沒有其他：model(input_ids) - 長度可變的列表，包含一個或多個輸入張量，按文件字串中給出的順序：
model([input_ids, attention_mask])或model([input_ids, attention_mask, token_type_ids]) - 一個字典，其中包含一個或多個與文件字串中給出的輸入名稱關聯的輸入張量：
model({"input_ids": input_ids, "token_type_ids": token_type_ids})
請注意，當使用子類化建立模型和層時，你無需擔心這些，因為你可以像對任何其他 Python 函式一樣傳遞輸入！
呼叫
< source >( 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 (
np.ndarray,tf.Tensor,list[tf.Tensor]`dict[str, tf.Tensor]或dict[str, np.ndarray]，且每個示例必須具有形狀(batch_size, sequence_length)) — 詞彙表中輸入序列標記的索引。索引可以使用 AutoTokenizer 獲取。有關詳細資訊，請參見 PreTrainedTokenizer.call() 和 PreTrainedTokenizer.encode()。
- attention_mask (形狀為
(batch_size, sequence_length)的np.ndarray或tf.Tensor，可選) — 掩碼，用於避免對填充標記索引執行注意力。掩碼值選擇在[0, 1]中:- 1 表示**未被掩碼**的標記，
- 0 表示**被掩碼**的標記。
- token_type_ids (形狀為
(batch_size, sequence_length)的np.ndarray或tf.Tensor，可選) — 分段標記索引，用於指示輸入的第一個和第二個部分。索引在[0, 1]中選擇:- 0 對應於句子 A 標記，
- 1 對應於句子 B 標記。
- position_ids (形狀為
(batch_size, sequence_length)的np.ndarray或tf.Tensor，可選) — 輸入序列中每個標記在位置嵌入中的位置索引。選擇範圍為[0, config.max_position_embeddings - 1]。 - head_mask (形狀為
(num_heads,)或(num_layers, num_heads)的np.ndarray或tf.Tensor，可選) — 掩碼，用於使自注意力模組的選定頭部無效。掩碼值選擇在[0, 1]中:- 1 表示頭部**未被掩碼**，
- 0 表示頭部**被掩碼**。
- inputs_embeds (形狀為
(batch_size, sequence_length, hidden_size)的np.ndarray或tf.Tensor，可選) — 或者，你可以選擇直接傳遞嵌入表示，而不是傳遞input_ids。如果你想更精細地控制如何將input_ids索引轉換為關聯向量，而不是模型內部的嵌入查詢矩陣，這會很有用。 - output_attentions (
bool，可選) — 是否返回所有注意力層的注意力張量。有關更多詳細資訊，請參見返回張量下的attentions。此引數只能在 eager 模式下使用，在圖模式下將使用配置中的值。 - output_hidden_states (
bool，可選) — 是否返回所有層的隱藏狀態。有關更多詳細資訊，請參見返回張量下的hidden_states。此引數只能在 eager 模式下使用，在圖模式下將使用配置中的值。 - return_dict (
bool，可選) — 是否返回 ModelOutput 而不是普通的元組。此引數可在 eager 模式下使用，在圖模式下，該值始終設定為 True。 - training (
bool，可選，預設為 `False“) — 是否在訓練模式下使用模型（某些模組，如 dropout 模組，在訓練和評估之間有不同的行為）。 - labels (形狀為
(batch_size, sequence_length)的tf.Tensor或np.ndarray，可選) — 用於計算標記分類損失的標籤。索引應在[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 時），包含根據配置 (RemBertConfig) 和輸入的不同元素。
-
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 後的注意力權重，用於計算自注意力頭中的加權平均值。
TFRemBertForTokenClassification 的前向方法，重寫了 __call__ 特殊方法。
儘管前向傳播的實現需要在該函式中定義，但在此之後應呼叫 Module 例項而不是此函式，因為前者負責執行預處理和後處理步驟，而後者則默默地忽略它們。
示例
>>> from transformers import AutoTokenizer, TFRemBertForTokenClassification
>>> import tensorflow as tf
>>> tokenizer = AutoTokenizer.from_pretrained("google/rembert")
>>> model = TFRemBertForTokenClassification.from_pretrained("google/rembert")
>>> 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()]TFRemBertForQuestionAnswering
class transformers.TFRemBertForQuestionAnswering
< source >( config: RemBertConfig *inputs **kwargs )
引數
- config (RemBertConfig) — 模型配置類，包含模型的所有引數。使用配置檔案初始化不載入與模型關聯的權重，僅載入配置。請檢視 from_pretrained() 方法以載入模型權重。
RemBERT 模型，頂部帶有用於 SQuAD 等抽取式問答任務的跨度分類頭（在隱藏狀態輸出之上有一個線性層，用於計算 span start logits 和 span end logits）。
此模型繼承自 TFPreTrainedModel。請檢視超類文件，瞭解庫為其所有模型實現的通用方法（如下載或儲存、調整輸入嵌入大小、修剪頭部等）。
此模型也是 keras.Model 的子類。請將其作為常規的 TF 2.0 Keras 模型使用，並參考 TF 2.0 文件瞭解所有與通用用法和行為相關的事項。
transformers 中的 TensorFlow 模型和層接受兩種輸入格式
- 所有輸入作為關鍵字引數（如 PyTorch 模型），或
- 所有輸入作為第一個位置引數中的列表、元組或字典。
支援第二種格式的原因是，在將輸入傳遞給模型和層時，Keras 方法偏好這種格式。由於這種支援，當使用 model.fit() 等方法時，一切都應該“正常工作”——只需以 model.fit() 支援的任何格式傳遞你的輸入和標籤即可！但是，如果你想在 Keras 方法（如 fit() 和 predict()）之外使用第二種格式，例如在使用 Keras Functional API 建立自己的層或模型時，可以使用三種可能性來將所有輸入張量收集到第一個位置引數中。
- 只有一個
input_ids的單個張量，沒有其他：model(input_ids) - 長度可變的列表，包含一個或多個輸入張量，按文件字串中給出的順序：
model([input_ids, attention_mask])或model([input_ids, attention_mask, token_type_ids]) - 一個字典，其中包含一個或多個與文件字串中給出的輸入名稱關聯的輸入張量：
model({"input_ids": input_ids, "token_type_ids": token_type_ids})
請注意，當使用子類化建立模型和層時，你無需擔心這些，因為你可以像對任何其他 Python 函式一樣傳遞輸入！
呼叫
< source >( 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 (
np.ndarray,tf.Tensor,list[tf.Tensor]`dict[str, tf.Tensor]或dict[str, np.ndarray]，且每個示例必須具有形狀(batch_size, sequence_length)) — 詞彙表中輸入序列標記的索引。索引可以使用 AutoTokenizer 獲取。有關詳細資訊，請參見 PreTrainedTokenizer.call() 和 PreTrainedTokenizer.encode()。
- attention_mask (形狀為
(batch_size, sequence_length)的np.ndarray或tf.Tensor，可選) — 掩碼，用於避免對填充標記索引執行注意力。掩碼值選擇在[0, 1]中:- 1 表示**未被掩碼**的標記，
- 0 表示**被掩碼**的標記。
- token_type_ids (形狀為
(batch_size, sequence_length)的np.ndarray或tf.Tensor，可選) — 分段標記索引，用於指示輸入的第一個和第二個部分。索引在[0, 1]中選擇:- 0 對應於句子 A 標記，
- 1 對應於句子 B 標記。
- position_ids (
np.ndarray或tf.Tensor，形狀為(batch_size, sequence_length)，可選) — 每個輸入序列中令牌的位置在位置嵌入中的索引。選擇範圍為[0, config.max_position_embeddings - 1]。 - head_mask (
np.ndarray或tf.Tensor，形狀為(num_heads,)或(num_layers, num_heads)，可選) — 用於使自注意力模組的選定頭部失效的掩碼。掩碼值選擇範圍為[0, 1]：- 1表示頭部未被掩碼，
- 0表示頭部被掩碼。
- inputs_embeds (
np.ndarray或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模組在訓練和評估之間有不同的行為）。 - start_positions (
tf.Tensor或np.ndarray，形狀為(batch_size,)，可選) — 用於計算令牌分類損失的標記範圍起始位置（索引）的標籤。位置被限制在序列長度（sequence_length）內。序列外的位置不計入損失計算。 - end_positions (
tf.Tensor或np.ndarray，形狀為(batch_size,)，可選) — 用於計算令牌分類損失的標記範圍結束位置（索引）的標籤。位置被限制在序列長度（sequence_length）內。序列外的位置不計入損失計算。
返回
transformers.modeling_tf_outputs.TFQuestionAnsweringModelOutput 或 tuple(tf.Tensor)
一個transformers.modeling_tf_outputs.TFQuestionAnsweringModelOutput或一個tf.Tensor的元組（如果傳入return_dict=False或當config.return_dict=False時），包含根據配置（RemBertConfig）和輸入的不同元素。
-
loss (
tf.Tensor，形狀為(batch_size, )，可選，當提供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時返回) —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 後的注意力權重，用於計算自注意力頭中的加權平均值。
TFRemBertForQuestionAnswering的forward方法，重寫了__call__特殊方法。
儘管前向傳播的實現需要在該函式中定義，但在此之後應呼叫 Module 例項而不是此函式，因為前者負責執行預處理和後處理步驟，而後者則默默地忽略它們。
示例
>>> from transformers import AutoTokenizer, TFRemBertForQuestionAnswering
>>> import tensorflow as tf
>>> tokenizer = AutoTokenizer.from_pretrained("google/rembert")
>>> model = TFRemBertForQuestionAnswering.from_pretrained("google/rembert")
>>> 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]