Transformers

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

引數

vocab_size (int, optional, defaults to 30522) — XLM-RoBERTa 模型的詞彙表大小。定義了在呼叫 XLMRobertaModel 或 TFXLMRobertaModel 時，可以透過 inputs_ids 表示的不同標記的數量。
hidden_size (int, optional, defaults to 768) — 編碼器層和池化層的維度。
num_hidden_layers (int, optional, defaults to 12) — Transformer 編碼器中的隱藏層數量。
num_attention_heads (int, optional, defaults to 12) — Transformer 編碼器中每個注意力層的注意力頭數量。
intermediate_size (int, optional, defaults to 3072) — Transformer 編碼器中“中間”（通常稱為前饋）層的維度。
hidden_act (str or Callable, optional, defaults to "gelu") — 編碼器和池化層中的非線性啟用函式（函式或字串）。如果為字串，支援 "gelu"、"relu"、"silu" 和 "gelu_new"。
hidden_dropout_prob (float, optional, defaults to 0.1) — 嵌入層、編碼器和池化層中所有全連線層的丟棄機率。
attention_probs_dropout_prob (float, optional, defaults to 0.1) — 注意力機率的丟棄率。
max_position_embeddings (int, optional, defaults to 512) — 此模型可能使用的最大序列長度。通常將其設定為較大的值，以防萬一（例如 512、1024 或 2048）。
type_vocab_size (int, optional, defaults to 2) — 呼叫 XLMRobertaModel 或 TFXLMRobertaModel 時傳遞的 token_type_ids 的詞彙表大小。
initializer_range (float, optional, defaults to 0.02) — 用於初始化所有權重矩陣的 truncated_normal_initializer 的標準差。
layer_norm_eps (float, optional, defaults to 1e-12) — 層歸一化層使用的 epsilon 值。
position_embedding_type (str, optional, defaults to "absolute") — 位置嵌入的型別。選擇 "absolute"、"relative_key"、"relative_key_query" 之一。對於位置嵌入，使用 "absolute"。有關 "relative_key" 的更多資訊，請參閱 Self-Attention with Relative Position Representations (Shaw et al.)。有關 "relative_key_query" 的更多資訊，請參閱 Improve Transformer Models with Better Relative Position Embeddings (Huang et al.) 中的 Method 4。
is_decoder (bool, 可選, 預設為 False) — 模型是否用作解碼器。如果為 False，則模型用作編碼器。
use_cache (bool, 可選, 預設為 True) — 模型是否應返回最後一個鍵/值注意力（並非所有模型都使用）。僅在 config.is_decoder=True 時相關。
classifier_dropout (float, 可選) — 分類頭的 dropout 比率。

這是用於儲存 XLMRobertaModel 或 TFXLMRobertaModel 配置的配置類。它用於根據指定的引數例項化一個 XLM-RoBERTa 模型，定義模型架構。使用預設值例項化配置將產生與 XLMRoBERTa FacebookAI/xlm-roberta-base 架構類似的配置。

配置物件繼承自 PretrainedConfig，可用於控制模型輸出。有關更多資訊，請閱讀 PretrainedConfig 的文件。

示例

>>> from transformers import XLMRobertaConfig, XLMRobertaModel

>>> # Initializing a XLM-RoBERTa FacebookAI/xlm-roberta-base style configuration
>>> configuration = XLMRobertaConfig()

>>> # Initializing a model (with random weights) from the FacebookAI/xlm-roberta-base style configuration
>>> model = XLMRobertaModel(configuration)

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

XLMRobertaTokenizer

class transformers.XLMRobertaTokenizer

( vocab_file bos_token = '<s>' eos_token = '</s>' sep_token = '</s>' cls_token = '<s>' unk_token = '<unk>' pad_token = '<pad>' mask_token = '<mask>' sp_model_kwargs: typing.Optional[dict[str, typing.Any]] = None **kwargs )

引數

vocab_file (str) — 詞彙表文件的路徑。
bos_token (str, 可選, 預設為 "<s>") — 序列開始標記，在預訓練期間使用。可用作序列分類器標記。

當使用特殊標記構建序列時，這不是用於序列開始的標記。使用的標記是 cls_token。
eos_token (str, 可選, 預設為 "</s>") — 序列結束標記。

當使用特殊標記構建序列時，這不是用於序列結束的標記。使用的標記是 sep_token。
sep_token (str, 可選, 預設為 "</s>") — 分隔符標記，用於從多個序列構建一個序列，例如，用於序列分類的兩個序列，或用於問答的文字和問題。它也用作使用特殊標記構建的序列的最後一個標記。
cls_token (str, 可選, 預設為 "<s>") — 分類器標記，用於進行序列分類（對整個序列進行分類，而不是逐個標記分類）。當使用特殊標記構建時，它是序列的第一個標記。
unk_token (str, 可選, 預設為 "<unk>") — 未知標記。不在詞彙表中的標記無法轉換為 ID，而是設定為此標記。
pad_token (str, 可選, 預設為 "<pad>") — 用於填充的標記，例如在批處理不同長度的序列時使用。
mask_token (str, 可選, 預設為 "<mask>") — 用於掩碼值的標記。這是在使用掩碼語言模型訓練此模型時使用的標記。這是模型將嘗試預測的標記。
sp_model_kwargs (dict, 可選) — 將傳遞給 SentencePieceProcessor.__init__() 方法。可使用 SentencePiece 的 Python 封裝來設定以下內容：
- enable_sampling: 啟用子詞正則化。
- nbest_size: Unigram 的取樣引數。對 BPE-Dropout 無效。
  - nbest_size = {0,1}: 不執行取樣。
  - nbest_size > 1: 從 nbest_size 個結果中取樣。
  - nbest_size < 0: 假設 nbest_size 是無限的，並使用前向過濾和後向取樣演算法從所有假設（格）中取樣。
- alpha: Unigram 取樣的平滑引數，以及 BPE-dropout 的合併操作的 dropout 機率。
sp_model (SentencePieceProcessor) — 用於每次轉換（字串、標記和 ID）的 SentencePiece 處理器。

改編自 RobertaTokenizer 和 XLNetTokenizer。基於 SentencePiece。

此分詞器繼承自 PreTrainedTokenizer，其中包含大多數主要方法。使用者應參考此超類以獲取有關這些方法的更多資訊。

build_inputs_with_special_tokens

( token_ids_0: list token_ids_1: typing.Optional[list[int]] = None ) → list[int]

引數

token_ids_0 (list[int]) — 將要新增特殊標記的 ID 列表。
token_ids_1 (list[int], 可選) — 用於序列對的可選的第二個 ID 列表。

list[int]

帶有適當特殊標記的輸入ID列表。

透過連線和新增特殊 token，為序列分類任務從序列或序列對構建模型輸入。XLM-RoBERTa 序列的格式如下：

單個序列：<s> X </s>
序列對：<s> A </s></s> B </s>

get_special_tokens_mask

( token_ids_0: list token_ids_1: typing.Optional[list[int]] = None already_has_special_tokens: bool = False ) → list[int]

引數

token_ids_0 (list[int]) — ID 列表。
token_ids_1 (list[int], 可選) — 用於序列對的可選的第二個 ID 列表。
already_has_special_tokens (bool, 可選, 預設為 False) — 標記列表是否已使用模型的特殊標記進行格式化。

list[int]

一個範圍為 [0, 1] 的整數列表：1 表示特殊標記，0 表示序列標記。

從沒有新增特殊標記的標記列表中檢索序列ID。此方法在使用分詞器prepare_for_model方法新增特殊標記時呼叫。

create_token_type_ids_from_sequences

( token_ids_0: list token_ids_1: typing.Optional[list[int]] = None ) → list[int]

引數

token_ids_0 (list[int]) — ID 列表。
token_ids_1 (list[int], 可選) — 用於序列對的可選的第二個 ID 列表。

list[int]

零列表。

根據傳入的兩個序列建立用於序列對分類任務的掩碼。XLM-RoBERTa 不使用 token 型別 ID，因此返回一個全零列表。

save_vocabulary

( save_directory: str filename_prefix: typing.Optional[str] = None )

XLMRobertaTokenizerFast

class transformers.XLMRobertaTokenizerFast

( vocab_file = None tokenizer_file = None bos_token = '<s>' eos_token = '</s>' sep_token = '</s>' cls_token = '<s>' unk_token = '<unk>' pad_token = '<pad>' mask_token = '<mask>' **kwargs )

引數

vocab_file (str) — 詞彙表文件的路徑。
bos_token (str, 可選, 預設為 "<s>") — 序列開始標記，在預訓練期間使用。可用作序列分類器標記。

當使用特殊標記構建序列時，這不是用於序列開始的標記。使用的標記是 cls_token。
eos_token (str, 可選, 預設為 "</s>") — 序列結束標記。

當使用特殊標記構建序列時，這不是用於序列結束的標記。使用的標記是 sep_token。
sep_token (str, 可選, 預設為 "</s>") — 分隔符標記，用於從多個序列構建一個序列，例如，用於序列分類的兩個序列，或用於問答的文字和問題。它也用作使用特殊標記構建的序列的最後一個標記。
cls_token (str, 可選, 預設為 "<s>") — 分類器標記，用於進行序列分類（對整個序列進行分類，而不是逐個標記分類）。當使用特殊標記構建時，它是序列的第一個標記。
unk_token (str, 可選, 預設為 "<unk>") — 未知標記。不在詞彙表中的標記無法轉換為 ID，而是設定為此標記。
pad_token (str, 可選, 預設為 "<pad>") — 用於填充的標記，例如在批處理不同長度的序列時使用。
mask_token (str, 可選, 預設為 "<mask>") — 用於掩碼值的標記。這是在使用掩碼語言模型訓練此模型時使用的標記。這是模型將嘗試預測的標記。
additional_special_tokens (list[str], 可選, 預設為 ["<s>NOTUSED", "</s>NOTUSED"]) — 分詞器使用的附加特殊標記。

構建一個“快速”的 XLM-RoBERTa 分詞器（由 HuggingFace 的 tokenizers 庫支援）。改編自 RobertaTokenizer 和 XLNetTokenizer。基於 BPE。

此分詞器繼承自 PreTrainedTokenizerFast，其中包含大多數主要方法。使用者應參考此超類以獲取有關這些方法的更多資訊。

build_inputs_with_special_tokens

( token_ids_0: list token_ids_1: typing.Optional[list[int]] = None ) → list[int]

引數

token_ids_0 (list[int]) — 將要新增特殊標記的 ID 列表。
token_ids_1 (list[int], 可選) — 用於序列對的可選的第二個 ID 列表。

list[int]

帶有適當特殊標記的輸入ID列表。

透過連線和新增特殊 token，為序列分類任務從序列或序列對構建模型輸入。XLM-RoBERTa 序列的格式如下：

單個序列：<s> X </s>
序列對：<s> A </s></s> B </s>

create_token_type_ids_from_sequences

( token_ids_0: list token_ids_1: typing.Optional[list[int]] = None ) → list[int]

引數

token_ids_0 (list[int]) — ID 列表。
token_ids_1 (list[int], 可選) — 用於序列對的可選的第二個 ID 列表。

list[int]

零列表。

根據傳入的兩個序列建立用於序列對分類任務的掩碼。XLM-RoBERTa 不使用 token 型別 ID，因此返回一個全零列表。

Pytorch

隱藏 Pytorch 內容

XLMRobertaModel

class transformers.XLMRobertaModel

( config add_pooling_layer = True )

引數

config (XLMRobertaModel) — 包含模型所有引數的模型配置類。使用配置檔案進行初始化不會載入與模型相關的權重，只會載入配置。請檢視 from_pretrained() 方法以載入模型權重。
add_pooling_layer (bool, 可選, 預設為 True) — 是否新增池化層

原始的 Xlm Roberta 模型，輸出原始的隱藏狀態，頂部沒有任何特定的頭部。

此模型繼承自 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 encoder_hidden_states: typing.Optional[torch.Tensor] = None encoder_attention_mask: typing.Optional[torch.Tensor] = None past_key_values: typing.Optional[list[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 or tuple(torch.FloatTensor)

引數

input_ids (torch.Tensor，形狀為 (batch_size, sequence_length), 可選) — 詞彙表中輸入序列標記的索引。預設情況下將忽略填充。

可以使用 AutoTokenizer 獲取索引。有關詳細資訊，請參閱 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。

什麼是輸入 ID？
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* 的標記。
什麼是標記型別 ID？
position_ids (torch.Tensor，形狀為 (batch_size, sequence_length), 可選) — 位置嵌入中每個輸入序列標記的位置索引。在範圍 [0, config.n_positions - 1] 內選擇。

什麼是位置 ID？
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 索引轉換為相關聯的向量，這會很有用。
encoder_hidden_states (torch.Tensor，形狀為 (batch_size, sequence_length, hidden_size)，可選) — 編碼器最後一層輸出的隱藏狀態序列。如果模型被配置為解碼器，則在交叉注意力機制中使用。
encoder_attention_mask (torch.Tensor，形狀為 (batch_size, sequence_length)，可選) — 用於避免對編碼器輸入的填充標記索引執行注意力的掩碼。如果模型被配置為解碼器，則在交叉注意力機制中使用此掩碼。掩碼值從 [0, 1] 中選擇：
- 1 表示標記未被掩蓋，
- 0 表示標記已被掩蓋。
past_key_values (list[torch.FloatTensor]，可選) — 預先計算的隱藏狀態（自注意力和交叉注意力塊中的鍵和值），可用於加速序列解碼。這通常包含在解碼的前一階段，當 use_cache=True 或 config.use_cache=True 時，由模型返回的 past_key_values。

允許兩種格式：
- 一個 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（那些沒有給出其過去鍵值狀態的 input_ids），形狀為 (batch_size, 1)，而不是所有形狀為 (batch_size, sequence_length) 的 input_ids。
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.BaseModelOutputWithPoolingAndCrossAttentions 或 tuple(torch.FloatTensor)

一個 transformers.modeling_outputs.BaseModelOutputWithPoolingAndCrossAttentions 或一個 torch.FloatTensor 的元組（如果傳遞了 return_dict=False 或當 config.return_dict=False 時），根據配置（XLMRobertaConfig）和輸入包含各種元素。

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 時返回) — 形狀為 (batch_size, sequence_length, hidden_size) 的 torch.FloatTensor 元組（一個用於嵌入層的輸出，如果模型有嵌入層，+ 一個用於每一層的輸出）。

模型在每個層輸出的隱藏狀態以及可選的初始嵌入輸出。
attentions (tuple(torch.FloatTensor)，可選，在傳遞 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.add_cross_attention=True 或 config.output_attentions=True 時返回) — 形狀為 (batch_size, num_heads, sequence_length, sequence_length) 的 torch.FloatTensor 元組（每層一個）。

解碼器交叉注意力層的注意力權重，在注意力 softmax 之後，用於計算交叉注意力頭中的加權平均。
past_key_values (Cache，可選，在傳遞 use_cache=True 或 config.use_cache=True 時返回) — 這是一個 Cache 例項。有關更多詳細資訊，請參閱我們的 kv 快取指南。

包含預先計算的隱藏狀態（自注意力塊中的鍵和值，如果 config.is_encoder_decoder=True，則可選地包含在交叉注意力塊中），可用於（參見 past_key_values 輸入）加速序列解碼。

XLMRobertaModel 的 forward 方法重寫了 __call__ 特殊方法。

雖然前向傳播的流程需要在此函式內定義，但之後應該呼叫 Module 例項而不是這個函式，因為前者會負責執行預處理和後處理步驟，而後者會靜默地忽略它們。

XLMRobertaForCausalLM

class transformers.XLMRobertaForCausalLM

( config )

引數

config (XLMRobertaForCausalLM) — 包含模型所有引數的模型配置類。使用配置檔案初始化不會載入與模型關聯的權重，只會載入配置。請檢視 from_pretrained() 方法來載入模型權重。

帶有 語言建模 頭的 XLM-RoBERTa 模型，用於 CLM 微調。

此模型繼承自 PreTrainedModel。請檢視超類的文件，瞭解庫為所有模型實現的通用方法（如下載或儲存、調整輸入嵌入大小、修剪頭部等）。

該模型也是 PyTorch torch.nn.Module 的子類。可以像常規 PyTorch 模組一樣使用它，並參考 PyTorch 文件瞭解所有與常規用法和行為相關的事項。

forward

( input_ids: typing.Optional[torch.LongTensor] = None attention_mask: typing.Optional[torch.FloatTensor] = None token_type_ids: typing.Optional[torch.LongTensor] = None position_ids: typing.Optional[torch.LongTensor] = None head_mask: typing.Optional[torch.FloatTensor] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None encoder_hidden_states: typing.Optional[torch.FloatTensor] = None encoder_attention_mask: typing.Optional[torch.FloatTensor] = None labels: typing.Optional[torch.LongTensor] = None 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 **kwargs ) → transformers.modeling_outputs.CausalLMOutputWithCrossAttentions 或 tuple(torch.FloatTensor)

引數

input_ids (torch.LongTensor，形狀為 (batch_size, sequence_length)，可選) — 詞彙表中輸入序列標記的索引。預設情況下，填充將被忽略。

可以使用 AutoTokenizer 獲取索引。有關詳細資訊，請參閱 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。

什麼是輸入 ID？
attention_mask (torch.FloatTensor，形狀為 (batch_size, sequence_length)，可選) — 用於避免對填充標記索引執行注意力的掩碼。掩碼值從 [0, 1] 中選擇：
- 1 表示標記未被掩蓋，
- 0 表示標記已被掩蓋。
什麼是注意力掩碼？
token_type_ids (torch.LongTensor，形狀為 (batch_size, sequence_length)，可選) — 用於指示輸入的第一部分和第二部分的片段標記索引。索引在 [0,1] 中選擇：
- 0 對應於 *句子 A* 標記，
- 1 對應於 *句子 B* 標記。只有當模型使用值為 type_vocab_size 引數初始化時，才能使用此引數
  
  = 2。此張量中的所有值應始終小於 type_vocab_size。
什麼是標記型別 ID？
position_ids (torch.LongTensor，形狀為 (batch_size, sequence_length)，可選) — 每個輸入序列標記在位置嵌入中的位置索引。在 [0, config.n_positions - 1] 範圍內選擇。

什麼是位置 ID？
head_mask (torch.FloatTensor，形狀為 (num_heads,) 或 (num_layers, num_heads)，可選) — 用於使自注意力模組的選定頭無效的掩碼。掩碼值從 [0, 1] 中選擇：
- 1 表示頭未被掩蓋，
- 0 表示頭已被掩蓋。
inputs_embeds (torch.FloatTensor，形狀為 (batch_size, sequence_length, hidden_size)，可選) — 可選引數，你可以選擇不傳遞 input_ids，而是直接傳遞嵌入表示。如果你想比模型內部的嵌入查詢矩陣更好地控制如何將 input_ids 索引轉換為相關聯的向量，這會很有用。
encoder_hidden_states (torch.FloatTensor，形狀為 (batch_size, sequence_length, hidden_size)，可選) — 編碼器最後一層輸出的隱藏狀態序列。如果模型被配置為解碼器，則在交叉注意力機制中使用。
encoder_attention_mask (torch.FloatTensor，形狀為 (batch_size, sequence_length)，可選) — 用於避免對編碼器輸入的填充標記索引執行注意力的掩碼。如果模型被配置為解碼器，則在交叉注意力機制中使用此掩碼。掩碼值從 [0, 1] 中選擇：
- 1 表示標記未被掩蓋，
- 0 表示標記已被掩蓋。
labels (torch.LongTensor，形狀為 (batch_size, sequence_length)，可選) — 用於計算從左到右語言建模損失（下一個詞預測）的標籤。索引應在 [-100, 0, ..., config.vocab_size] 中（請參閱 input_ids 文件字串）。索引設定為 -100 的標記將被忽略（掩蓋），損失僅對標籤在 [0, ..., config.vocab_size] 中的標記進行計算。
past_key_values (tuple[tuple[torch.FloatTensor]]，可選) — 預先計算的隱藏狀態（自注意力和交叉注意力塊中的鍵和值），可用於加速序列解碼。這通常包含在解碼的前一階段，當 use_cache=True 或 config.use_cache=True 時，由模型返回的 past_key_values。

允許兩種格式：
- 一個 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（那些沒有給出其過去鍵值狀態的 input_ids），形狀為 (batch_size, 1)，而不是所有形狀為 (batch_size, sequence_length) 的 input_ids。
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 時），根據配置（XLMRobertaConfig）和輸入包含各種元素。

loss (torch.FloatTensor 形狀為 (1,)，可選，當提供 labels 時返回) — 語言建模損失（用於下一個 token 預測）。
logits (形狀為 (batch_size, sequence_length, config.vocab_size) 的 torch.FloatTensor) — 語言建模頭部的預測分數（SoftMax 之前的每個詞彙標記的分數）。
hidden_states (tuple(torch.FloatTensor)，可選，在傳遞 output_hidden_states=True 或 config.output_hidden_states=True 時返回) — 形狀為 (batch_size, sequence_length, hidden_size) 的 torch.FloatTensor 元組（一個用於嵌入層的輸出，如果模型有嵌入層，+ 一個用於每一層的輸出）。

模型在每個層輸出的隱藏狀態以及可選的初始嵌入輸出。
attentions (tuple(torch.FloatTensor)，可選，在傳遞 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，可選，在傳遞 use_cache=True 或 config.use_cache=True 時返回) — 這是一個 Cache 例項。有關更多詳細資訊，請參閱我們的 kv 快取指南。

包含預先計算的隱藏狀態（注意力塊中的鍵和值），可用於（參見 past_key_values 輸入）加速順序解碼。

XLMRobertaForCausalLM 的 forward 方法重寫了 __call__ 特殊方法。

示例

>>> from transformers import AutoTokenizer, XLMRobertaForCausalLM, AutoConfig
>>> import torch

>>> tokenizer = AutoTokenizer.from_pretrained("FacebookAI/roberta-base")
>>> config = AutoConfig.from_pretrained("FacebookAI/roberta-base")
>>> config.is_decoder = True
>>> model = XLMRobertaForCausalLM.from_pretrained("FacebookAI/roberta-base", config=config)

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

>>> prediction_logits = outputs.logits

XLMRobertaForMaskedLM

class transformers.XLMRobertaForMaskedLM

( config )

引數

config (XLMRobertaForMaskedLM) — 包含模型所有引數的模型配置類。使用配置檔案初始化不會載入與模型關聯的權重，只會載入配置。請檢視 from_pretrained() 方法來載入模型權重。

帶有 語言建模 頭的 Xlm Roberta 模型。

此模型繼承自 PreTrainedModel。請檢視超類的文件，瞭解庫為所有模型實現的通用方法（如下載或儲存、調整輸入嵌入大小、修剪頭部等）。

該模型也是 PyTorch torch.nn.Module 的子類。可以像常規 PyTorch 模組一樣使用它，並參考 PyTorch 文件瞭解所有與常規用法和行為相關的事項。

forward

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

引數

input_ids (torch.LongTensor，形狀為 (batch_size, sequence_length)，可選) — 詞彙表中輸入序列標記的索引。預設情況下，填充將被忽略。

可以使用 AutoTokenizer 獲取索引。有關詳細資訊，請參閱 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。

什麼是輸入 ID？
attention_mask (torch.FloatTensor，形狀為 (batch_size, sequence_length)，可選) — 用於避免對填充標記索引執行注意力的掩碼。掩碼值從 [0, 1] 中選擇：
- 1 表示標記未被掩蓋，
- 0 表示標記已被掩蓋。
什麼是注意力掩碼？
token_type_ids (torch.LongTensor，形狀為 (batch_size, sequence_length)，可選) — 用於指示輸入的第一部分和第二部分的片段標記索引。索引在 [0,1] 中選擇：
- 0 對應於 *句子 A* 標記，
- 1 對應於 *句子 B* 標記。只有當模型使用值為 type_vocab_size 引數初始化時，才能使用此引數
  
  = 2。此張量中的所有值應始終小於 type_vocab_size。
什麼是標記型別 ID？
position_ids (torch.LongTensor，形狀為 (batch_size, sequence_length)，可選) — 每個輸入序列標記在位置嵌入中的位置索引。在 [0, config.n_positions - 1] 範圍內選擇。

什麼是位置 ID？
head_mask (torch.FloatTensor，形狀為 (num_heads,) 或 (num_layers, num_heads)，可選) — 用於使自注意力模組的選定頭無效的掩碼。掩碼值從 [0, 1] 中選擇：
- 1 表示頭未被掩蓋，
- 0 表示頭已被掩蓋。
inputs_embeds (torch.FloatTensor，形狀為 (batch_size, sequence_length, hidden_size)，可選) — 可選引數，你可以選擇不傳遞 input_ids，而是直接傳遞嵌入表示。如果你想比模型內部的嵌入查詢矩陣更好地控制如何將 input_ids 索引轉換為相關聯的向量，這會很有用。
encoder_hidden_states (torch.FloatTensor，形狀為 (batch_size, sequence_length, hidden_size)，可選) — 編碼器最後一層輸出的隱藏狀態序列。如果模型被配置為解碼器，則在交叉注意力機制中使用。
encoder_attention_mask (torch.FloatTensor，形狀為 (batch_size, sequence_length)，可選) — 用於避免對編碼器輸入的填充標記索引執行注意力的掩碼。如果模型被配置為解碼器，則在交叉注意力機制中使用此掩碼。掩碼值從 [0, 1] 中選擇：
- 1 表示標記未被掩蓋，
- 0 表示標記已被掩蓋。
labels (torch.LongTensor，形狀為 (batch_size, sequence_length)，可選) — 用於計算掩碼語言建模損失的標籤。索引應在 [-100, 0, ..., config.vocab_size] 中（請參閱 input_ids 文件字串）。索引設定為 -100 的標記將被忽略（掩蓋），損失僅對標籤在 [0, ..., config.vocab_size] 中的標記進行計算。
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 時），根據配置（XLMRobertaConfig）和輸入包含各種元素。

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 時返回) — 形狀為 (batch_size, sequence_length, hidden_size) 的 torch.FloatTensor 元組（一個用於嵌入層的輸出，如果模型有嵌入層，+ 一個用於每一層的輸出）。

模型在每個層輸出的隱藏狀態以及可選的初始嵌入輸出。
attentions (tuple(torch.FloatTensor)，可選，在傳遞 output_attentions=True 或 config.output_attentions=True 時返回) — 形狀為 (batch_size, num_heads, sequence_length, sequence_length) 的 torch.FloatTensor 元組（每層一個）。

注意力 softmax 後的注意力權重，用於計算自注意力頭中的加權平均值。

XLMRobertaForMaskedLM 的 forward 方法重寫了 __call__ 特殊方法。

示例

>>> from transformers import AutoTokenizer, XLMRobertaForMaskedLM
>>> import torch

>>> tokenizer = AutoTokenizer.from_pretrained("FacebookAI/xlm-roberta-base")
>>> model = XLMRobertaForMaskedLM.from_pretrained("FacebookAI/xlm-roberta-base")

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

XLMRobertaForSequenceClassification

class transformers.XLMRobertaForSequenceClassification

( config )

引數

config (XLMRobertaForSequenceClassification) — 包含模型所有引數的模型配置類。使用配置檔案初始化不會載入與模型關聯的權重，只會載入配置。請檢視 from_pretrained() 方法來載入模型權重。

帶有序列分類/迴歸頭的 XLM-RoBERTa 模型轉換器（池化輸出之上有一個線性層），例如用於 GLUE 任務。

此模型繼承自 PreTrainedModel。請檢視超類的文件，瞭解庫為所有模型實現的通用方法（如下載或儲存、調整輸入嵌入大小、修剪頭部等）。

該模型也是 PyTorch torch.nn.Module 的子類。可以像常規 PyTorch 模組一樣使用它，並參考 PyTorch 文件瞭解所有與常規用法和行為相關的事項。

forward

( input_ids: typing.Optional[torch.LongTensor] = None attention_mask: typing.Optional[torch.FloatTensor] = None token_type_ids: typing.Optional[torch.LongTensor] = None position_ids: typing.Optional[torch.LongTensor] = None head_mask: typing.Optional[torch.FloatTensor] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None labels: typing.Optional[torch.LongTensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.modeling_outputs.SequenceClassifierOutput 或 tuple(torch.FloatTensor)

引數

input_ids (torch.LongTensor，形狀為 (batch_size, sequence_length)，可選) — 詞彙表中輸入序列標記的索引。預設情況下，填充將被忽略。

可以使用 AutoTokenizer 獲取索引。有關詳細資訊，請參閱 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。

什麼是輸入 ID？
attention_mask (torch.FloatTensor，形狀為 (batch_size, sequence_length)，可選) — 用於避免對填充標記索引執行注意力的掩碼。掩碼值選自 [0, 1]：
- 1 表示標記未被遮蔽，
- 0 表示標記被遮蔽。
什麼是注意力掩碼？
token_type_ids (torch.LongTensor，形狀為 (batch_size, sequence_length)，可選) — 分段標記索引，用於指示輸入的第一和第二部分。索引選自 [0, 1]：
- 0 對應於 *A 句* 標記，
- 1 對應於 *B 句* 標記。只有當模型使用值為 `type_vocab_size` 的引數進行初始化時，才能使用此引數
  
  = 2。此張量中的所有值應始終 < type_vocab_size。
什麼是標記型別 ID？
position_ids (torch.LongTensor，形狀為 (batch_size, sequence_length)，可選) — 位置嵌入中每個輸入序列標記的位置索引。選自範圍 [0, config.n_positions - 1]。

什麼是位置 ID？
head_mask (torch.FloatTensor，形狀為 (num_heads,) 或 (num_layers, num_heads)，可選) — 用於置零自注意力模組中選定頭的掩碼。掩碼值選自 [0, 1]：
- 1 表示頭未被遮蔽，
- 0 表示頭被遮蔽。
inputs_embeds (torch.FloatTensor，形狀為 (batch_size, sequence_length, hidden_size)，可選) — 可以選擇直接傳遞嵌入表示，而不是傳遞 `input_ids`。如果你想比模型的內部嵌入查詢矩陣更多地控制如何將 `input_ids` 索引轉換為關聯向量，這很有用。
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` 時)，包含根據配置 (XLMRobertaConfig) 和輸入而定的各種元素。

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 時返回) — 形狀為 (batch_size, sequence_length, hidden_size) 的 torch.FloatTensor 元組（一個用於嵌入層的輸出，如果模型有嵌入層，+ 一個用於每一層的輸出）。

模型在每個層輸出的隱藏狀態以及可選的初始嵌入輸出。
attentions (tuple(torch.FloatTensor)，可選，在傳遞 output_attentions=True 或 config.output_attentions=True 時返回) — 形狀為 (batch_size, num_heads, sequence_length, sequence_length) 的 torch.FloatTensor 元組（每層一個）。

注意力 softmax 後的注意力權重，用於計算自注意力頭中的加權平均值。

XLMRobertaForSequenceClassification 的前向方法會覆蓋 `__call__` 特殊方法。

單標籤分類示例

>>> import torch
>>> from transformers import AutoTokenizer, XLMRobertaForSequenceClassification

>>> tokenizer = AutoTokenizer.from_pretrained("FacebookAI/xlm-roberta-base")
>>> model = XLMRobertaForSequenceClassification.from_pretrained("FacebookAI/xlm-roberta-base")

>>> 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 = XLMRobertaForSequenceClassification.from_pretrained("FacebookAI/xlm-roberta-base", num_labels=num_labels)

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

多標籤分類示例

>>> import torch
>>> from transformers import AutoTokenizer, XLMRobertaForSequenceClassification

>>> tokenizer = AutoTokenizer.from_pretrained("FacebookAI/xlm-roberta-base")
>>> model = XLMRobertaForSequenceClassification.from_pretrained("FacebookAI/xlm-roberta-base", 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 = XLMRobertaForSequenceClassification.from_pretrained(
...     "FacebookAI/xlm-roberta-base", num_labels=num_labels, problem_type="multi_label_classification"
... )

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

XLMRobertaForMultipleChoice

class transformers.XLMRobertaForMultipleChoice

( config )

引數

config (XLMRobertaForMultipleChoice) — 模型配置類，包含模型的所有引數。使用配置檔案初始化不會載入與模型相關的權重，只會載入配置。請檢視 from_pretrained() 方法來載入模型權重。

Xlm Roberta 模型，頂部帶有多項選擇分類頭 (在池化輸出之上是一個線性層和一個 softmax)，例如用於 RocStories/SWAG 任務。

此模型繼承自 PreTrainedModel。請檢視超類的文件，瞭解庫為所有模型實現的通用方法（如下載或儲存、調整輸入嵌入大小、修剪頭部等）。

該模型也是 PyTorch torch.nn.Module 的子類。可以像常規 PyTorch 模組一樣使用它，並參考 PyTorch 文件瞭解所有與常規用法和行為相關的事項。

forward

( input_ids: typing.Optional[torch.LongTensor] = None token_type_ids: typing.Optional[torch.LongTensor] = None attention_mask: typing.Optional[torch.FloatTensor] = None labels: 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_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()。

什麼是輸入 ID？
token_type_ids (torch.LongTensor，形狀為 (batch_size, num_choices, sequence_length)，可選) — 分段標記索引，用於指示輸入的第一和第二部分。索引選自 [0, 1]：
- 0 對應於 *A 句* 標記，
- 1 對應於 *B 句* 標記。只有當模型使用值為 `type_vocab_size` 的引數進行初始化時，才能使用此引數
  
  = 2。此張量中的所有值應始終 < type_vocab_size。
什麼是標記型別 ID？
attention_mask (torch.FloatTensor，形狀為 (batch_size, sequence_length)，可選) — 用於避免對填充標記索引執行注意力的掩碼。掩碼值選自 [0, 1]：
- 1 表示標記未被遮蔽，
- 0 表示標記被遮蔽。
什麼是注意力掩碼？
labels (torch.LongTensor，形狀為 (batch_size,)，可選) — 用於計算多項選擇分類損失的標籤。索引應在 `[0, ..., num_choices-1]` 範圍內，其中 `num_choices` 是輸入張量第二維的大小。(參見上面的 `input_ids`)
position_ids (torch.LongTensor，形狀為 (batch_size, num_choices, sequence_length)，可選) — 位置嵌入中每個輸入序列標記的位置索引。選自範圍 [0, config.max_position_embeddings - 1]。

什麼是位置 ID？
head_mask (torch.FloatTensor，形狀為 (num_heads,) 或 (num_layers, num_heads)，可選) — 用於置零自注意力模組中選定頭的掩碼。掩碼值選自 [0, 1]：
- 1 表示頭未被遮蔽，
- 0 表示頭被遮蔽。
inputs_embeds (torch.FloatTensor，形狀為 (batch_size, num_choices, sequence_length, hidden_size)，可選) — 可以選擇直接傳遞嵌入表示，而不是傳遞 `input_ids`。如果你想比模型的內部嵌入查詢矩陣更多地控制如何將 `input_ids` 索引轉換為關聯向量，這很有用。
output_attentions (bool，可選) — 是否返回所有注意力層的注意力張量。有關更多詳細資訊，請參閱返回張量下的 `attentions`。
output_hidden_states (bool，可選) — 是否返回所有層的隱藏狀態。有關更多詳細資訊，請參閱返回張量下的 `hidden_states`。
return_dict (bool，可選) — 是否返回 ModelOutput 而不是普通的元組。

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

一個 transformers.modeling_outputs.MultipleChoiceModelOutput 或一個 torch.FloatTensor 元組 (如果傳遞了 `return_dict=False` 或當 `config.return_dict=False` 時)，包含根據配置 (XLMRobertaConfig) 和輸入而定的各種元素。

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 時返回) — 形狀為 (batch_size, sequence_length, hidden_size) 的 torch.FloatTensor 元組（一個用於嵌入層的輸出，如果模型有嵌入層，+ 一個用於每一層的輸出）。

模型在每個層輸出的隱藏狀態以及可選的初始嵌入輸出。
attentions (tuple(torch.FloatTensor)，可選，在傳遞 output_attentions=True 或 config.output_attentions=True 時返回) — 形狀為 (batch_size, num_heads, sequence_length, sequence_length) 的 torch.FloatTensor 元組（每層一個）。

注意力 softmax 後的注意力權重，用於計算自注意力頭中的加權平均值。

XLMRobertaForMultipleChoice 的前向方法會覆蓋 `__call__` 特殊方法。

示例

>>> from transformers import AutoTokenizer, XLMRobertaForMultipleChoice
>>> import torch

>>> tokenizer = AutoTokenizer.from_pretrained("FacebookAI/xlm-roberta-base")
>>> model = XLMRobertaForMultipleChoice.from_pretrained("FacebookAI/xlm-roberta-base")

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

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

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

XLMRobertaForTokenClassification

class transformers.XLMRobertaForTokenClassification

( config )

引數

config (XLMRobertaForTokenClassification) — 模型配置類，包含模型的所有引數。使用配置檔案初始化不會載入與模型相關的權重，只會載入配置。請檢視 from_pretrained() 方法來載入模型權重。

Xlm Roberta Transformer，頂部帶有一個標記分類頭 (在隱藏狀態輸出之上是一個線性層)，例如用於命名實體識別 (NER) 任務。

此模型繼承自 PreTrainedModel。請檢視超類的文件，瞭解庫為所有模型實現的通用方法（如下載或儲存、調整輸入嵌入大小、修剪頭部等）。

該模型也是 PyTorch torch.nn.Module 的子類。可以像常規 PyTorch 模組一樣使用它，並參考 PyTorch 文件瞭解所有與常規用法和行為相關的事項。

forward

引數

input_ids (torch.LongTensor，形狀為 (batch_size, sequence_length)，可選) — 詞彙表中輸入序列標記的索引。預設情況下，填充將被忽略。

可以使用 AutoTokenizer 獲取索引。有關詳細資訊，請參閱 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。

什麼是輸入 ID？
attention_mask (torch.FloatTensor，形狀為 (batch_size, sequence_length)，可選) — 用於避免對填充標記索引執行注意力的掩碼。掩碼值選自 [0, 1]：
- 1 表示標記未被遮蔽，
- 0 表示標記被遮蔽。
什麼是注意力掩碼？
token_type_ids (torch.LongTensor，形狀為 (batch_size, sequence_length)，可選) — 分段標記索引，用於指示輸入的第一和第二部分。索引選自 [0, 1]：
- 0 對應於 *A 句* 標記，
- 1 對應於 *B 句* 標記。只有當模型使用值為 `type_vocab_size` 的引數進行初始化時，才能使用此引數
  
  = 2。此張量中的所有值應始終 < type_vocab_size。
什麼是標記型別 ID？
position_ids (torch.LongTensor，形狀為 (batch_size, sequence_length)，可選) — 位置嵌入中每個輸入序列標記的位置索引。選自範圍 [0, config.n_positions - 1]。

什麼是位置 ID？
head_mask (torch.FloatTensor，形狀為 (num_heads,) 或 (num_layers, num_heads)，可選) — 用於置零自注意力模組中選定頭的掩碼。掩碼值選自 [0, 1]：
- 1 表示頭未被遮蔽，
- 0 表示頭被遮蔽。
inputs_embeds (torch.FloatTensor，形狀為 (batch_size, sequence_length, hidden_size)，可選) — 可以選擇直接傳遞嵌入表示，而不是傳遞 `input_ids`。如果你想比模型的內部嵌入查詢矩陣更多地控制如何將 `input_ids` 索引轉換為關聯向量，這很有用。
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` 時)，包含根據配置 (XLMRobertaConfig) 和輸入而定的各種元素。

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 時返回) — 形狀為 (batch_size, sequence_length, hidden_size) 的 torch.FloatTensor 元組（一個用於嵌入層的輸出，如果模型有嵌入層，+ 一個用於每一層的輸出）。

模型在每個層輸出的隱藏狀態以及可選的初始嵌入輸出。
attentions (tuple(torch.FloatTensor)，可選，在傳遞 output_attentions=True 或 config.output_attentions=True 時返回) — 形狀為 (batch_size, num_heads, sequence_length, sequence_length) 的 torch.FloatTensor 元組（每層一個）。

注意力 softmax 後的注意力權重，用於計算自注意力頭中的加權平均值。

XLMRobertaForTokenClassification 的前向方法會覆蓋 `__call__` 特殊方法。

示例

>>> from transformers import AutoTokenizer, XLMRobertaForTokenClassification
>>> import torch

>>> tokenizer = AutoTokenizer.from_pretrained("FacebookAI/xlm-roberta-base")
>>> model = XLMRobertaForTokenClassification.from_pretrained("FacebookAI/xlm-roberta-base")

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

XLMRobertaForQuestionAnswering

class transformers.XLMRobertaForQuestionAnswering

( config )

引數

config (XLMRobertaForQuestionAnswering) — 模型配置類，包含模型的所有引數。使用配置檔案初始化不會載入與模型相關的權重，只會載入配置。請檢視 from_pretrained() 方法來載入模型權重。

Xlm Roberta Transformer，頂部帶有一個用於抽取式問答任務 (如 SQuAD) 的片段分類頭 (在隱藏狀態輸出之上是一個線性層，用於計算 `span start logits` 和 `span end logits`)。

此模型繼承自 PreTrainedModel。請檢視超類的文件，瞭解庫為所有模型實現的通用方法（如下載或儲存、調整輸入嵌入大小、修剪頭部等）。

該模型也是 PyTorch torch.nn.Module 的子類。可以像常規 PyTorch 模組一樣使用它，並參考 PyTorch 文件瞭解所有與常規用法和行為相關的事項。

forward

( input_ids: typing.Optional[torch.LongTensor] = None attention_mask: typing.Optional[torch.FloatTensor] = None token_type_ids: typing.Optional[torch.LongTensor] = None position_ids: typing.Optional[torch.LongTensor] = None head_mask: typing.Optional[torch.FloatTensor] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None start_positions: typing.Optional[torch.LongTensor] = None end_positions: typing.Optional[torch.LongTensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.modeling_outputs.QuestionAnsweringModelOutput 或 tuple(torch.FloatTensor)

引數

input_ids (torch.LongTensor，形狀為 (batch_size, sequence_length)，可選) — 詞彙表中輸入序列標記的索引。預設情況下，填充將被忽略。

可以使用 AutoTokenizer 獲取索引。有關詳細資訊，請參閱 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。

什麼是輸入 ID？
attention_mask (torch.FloatTensor，形狀為 (batch_size, sequence_length)，可選) — 用於避免對填充標記索引執行注意力操作的掩碼。掩碼值的選擇範圍為 [0, 1]：
- 1 表示標記未被掩碼，
- 0 表示標記已被掩碼。
什麼是注意力掩碼？
token_type_ids (torch.LongTensor，形狀為 (batch_size, sequence_length)，可選) — 段標記索引，用於指示輸入的第一部分和第二部分。索引的選擇範圍為 [0, 1]：
- 0 對應於 句子 A 的標記，
- 1 對應於 句子 B 的標記。該引數僅在模型初始化時使用 type_vocab_size 引數且其值
  = 2 時才能使用。此張量中的所有值應始終 < type_vocab_size。
什麼是標記型別 ID？
position_ids (torch.LongTensor，形狀為 (batch_size, sequence_length)，可選) — 每個輸入序列標記在位置嵌入中的位置索引。選擇範圍為 [0, config.n_positions - 1]。

什麼是位置 ID？
head_mask (torch.FloatTensor，形狀為 (num_heads,) 或 (num_layers, num_heads)，可選) — 用於置零自注意力模組中選定頭的掩碼。掩碼值的選擇範圍為 [0, 1]：
- 1 表示頭未被掩碼，
- 0 表示頭已被掩碼。
inputs_embeds (torch.FloatTensor，形狀為 (batch_size, sequence_length, hidden_size)，可選) — 可選地，你可以選擇直接傳遞嵌入表示，而不是傳遞 input_ids。如果你想比模型內部嵌入查詢矩陣更好地控制如何將 input_ids 索引轉換為相關向量，這會很有用。
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 時），根據配置（XLMRobertaConfig）和輸入的不同，包含各種元素。

loss (torch.FloatTensor of shape (1,), 可選, 當提供 labels 時返回) — 總範圍提取損失是起始位置和結束位置的交叉熵之和。
start_logits (torch.FloatTensor of shape (batch_size, sequence_length)) — 範圍起始分數（SoftMax 之前）。
end_logits (torch.FloatTensor of shape (batch_size, sequence_length)) — 範圍結束分數（SoftMax 之前）。
hidden_states (tuple(torch.FloatTensor)，可選，在傳遞 output_hidden_states=True 或 config.output_hidden_states=True 時返回) — 形狀為 (batch_size, sequence_length, hidden_size) 的 torch.FloatTensor 元組（一個用於嵌入層的輸出，如果模型有嵌入層，+ 一個用於每一層的輸出）。

模型在每個層輸出的隱藏狀態以及可選的初始嵌入輸出。
attentions (tuple(torch.FloatTensor)，可選，在傳遞 output_attentions=True 或 config.output_attentions=True 時返回) — 形狀為 (batch_size, num_heads, sequence_length, sequence_length) 的 torch.FloatTensor 元組（每層一個）。

注意力 softmax 後的注意力權重，用於計算自注意力頭中的加權平均值。

XLMRobertaForQuestionAnswering 的前向方法，覆蓋了 __call__ 特殊方法。

示例

>>> from transformers import AutoTokenizer, XLMRobertaForQuestionAnswering
>>> import torch

>>> tokenizer = AutoTokenizer.from_pretrained("FacebookAI/xlm-roberta-base")
>>> model = XLMRobertaForQuestionAnswering.from_pretrained("FacebookAI/xlm-roberta-base")

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

TensorFlow

隱藏 TensorFlow 內容

TFXLMRobertaModel

class transformers.TFXLMRobertaModel

( config *inputs **kwargs )

引數

config (XLMRobertaConfig) — 模型配置類，包含模型的所有引數。使用配置檔案進行初始化不會載入與模型相關的權重，只會載入配置。請檢視 from_pretrained() 方法以載入模型權重。

裸 XLM RoBERTa 模型 Transformer，輸出原始隱藏狀態，頂部沒有任何特定的頭。

該模型繼承自 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 (Numpy array 或 tf.Tensor，形狀為 (batch_size, sequence_length)) — 詞彙表中輸入序列標記的索引。可以使用 AutoTokenizer 獲取索引。有關詳細資訊，請參閱 PreTrainedTokenizer.call() 和 PreTrainedTokenizer.encode()。什麼是輸入 ID？
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 的標記。什麼是標記型別 ID？
position_ids (Numpy array 或 tf.Tensor，形狀為 (batch_size, sequence_length)，可選) — 每個輸入序列標記在位置嵌入中的位置索引。選擇範圍為 [0, config.max_position_embeddings - 1]。什麼是位置 ID？
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 模組，在訓練和評估之間的行為不同）。
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 (長度為 config.n_layers 的 tuple[tuple[tf.Tensor]]) — 包含預先計算的注意力塊的鍵和值隱藏狀態。可用於加速解碼。如果使用 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 時），根據配置（XLMRobertaConfig）和輸入的不同，包含各種元素。

last_hidden_state (tf.Tensor of 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 之後，用於計算交叉注意力頭中的加權平均。

TFXLMRobertaModel 的前向方法，覆蓋了 __call__ 特殊方法。

示例

>>> from transformers import AutoTokenizer, TFXLMRobertaModel
>>> import tensorflow as tf

>>> tokenizer = AutoTokenizer.from_pretrained("FacebookAI/xlm-roberta-base")
>>> model = TFXLMRobertaModel.from_pretrained("FacebookAI/xlm-roberta-base")

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

>>> last_hidden_states = outputs.last_hidden_state

TFXLMRobertaForCausalLM

class transformers.TFXLMRobertaForCausalLM

( config: XLMRobertaConfig *inputs **kwargs )

引數

config (XLMRobertaConfig) — 模型配置類，包含模型的所有引數。使用配置檔案進行初始化不會載入與模型相關的權重，只會載入配置。請檢視 from_pretrained() 方法以載入模型權重。

帶有 語言建模 頭的 XLM-RoBERTa 模型，用於 CLM 微調。

該模型繼承自 TFPreTrainedModel。請檢視超類文件，瞭解該庫為其所有模型實現的通用方法（例如下載或儲存、調整輸入嵌入的大小、修剪頭等）。

該模型也是 keras.Model 的子類。可以像常規 TF 2.0 Keras 模型一樣使用它，並參考 TF 2.0 文件瞭解所有與常規用法和行為相關的事項。

transformers 中的 TensorFlow 模型和層接受兩種輸入格式

所有輸入作為關鍵字引數（如 PyTorch 模型），或
所有輸入作為第一個位置引數中的列表、元組或字典。

只有一個 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)

引數

input_ids (Numpy array 或 tf.Tensor，形狀為 (batch_size, sequence_length)) — 詞彙表中輸入序列標記的索引。可以使用 AutoTokenizer 獲取索引。有關詳細資訊，請參閱 PreTrainedTokenizer.call() 和 PreTrainedTokenizer.encode()。什麼是輸入 ID？
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 的標記。什麼是標記型別 ID？
position_ids (Numpy array 或 tf.Tensor，形狀為 (batch_size, sequence_length)，可選) — 每個輸入序列標記在位置嵌入中的位置索引。選擇範圍為 [0, config.max_position_embeddings - 1]。什麼是位置 ID？
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 模組，在訓練和評估之間的行為不同）。
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 (長度為 config.n_layers 的 tuple[tuple[tf.Tensor]]) — 包含預先計算的注意力塊的鍵和值隱藏狀態。可用於加速解碼。如果使用 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] 範圍內。

transformers.modeling_tf_outputs.TFCausalLMOutputWithCrossAttentions 或 tuple(tf.Tensor)

一個 transformers.modeling_tf_outputs.TFCausalLMOutputWithCrossAttentions 或一個 tf.Tensor 的元組（如果傳遞了 return_dict=False 或當 config.return_dict=False 時），包含的各種元素取決於配置（XLMRobertaConfig）和輸入。

loss (形狀為(n,)的tf.Tensor，可選，其中n是非掩碼標籤的數量，當提供了labels時返回) — 語言建模損失（用於下一標記預測）。
logits (tf.Tensor of 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 輸入）加速順序解碼。

TFXLMRobertaForCausalLM 的前向方法重寫了 __call__ 特殊方法。

示例

>>> from transformers import AutoTokenizer, TFXLMRobertaForCausalLM
>>> import tensorflow as tf

>>> tokenizer = AutoTokenizer.from_pretrained("FacebookAI/xlm-roberta-base")
>>> model = TFXLMRobertaForCausalLM.from_pretrained("FacebookAI/xlm-roberta-base")

>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="tf")
>>> outputs = model(inputs)
>>> logits = outputs.logits

TFXLMRobertaForMaskedLM

class transformers.TFXLMRobertaForMaskedLM

( config *inputs **kwargs )

引數

config (XLMRobertaConfig) — 包含模型所有引數的模型配置類。使用配置檔案進行初始化不會載入與模型相關的權重，只會載入配置。請檢視 from_pretrained() 方法以載入模型權重。

帶有一個 `language modeling` 頭的 XLM RoBERTa 模型。

該模型繼承自 TFPreTrainedModel。請檢視超類文件，瞭解該庫為其所有模型實現的通用方法（例如下載或儲存、調整輸入嵌入的大小、修剪頭等）。

該模型也是 keras.Model 的子類。可以像常規 TF 2.0 Keras 模型一樣使用它，並參考 TF 2.0 文件瞭解所有與常規用法和行為相關的事項。

transformers 中的 TensorFlow 模型和層接受兩種輸入格式

所有輸入作為關鍵字引數（如 PyTorch 模型），或
所有輸入作為第一個位置引數中的列表、元組或字典。

只有一個 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 (Numpy 陣列或 tf.Tensor，形狀為 (batch_size, sequence_length)) — 詞彙表中輸入序列標記的索引。可以使用 AutoTokenizer 獲取索引。有關詳細資訊，請參閱 PreTrainedTokenizer.call() 和 PreTrainedTokenizer.encode()。什麼是輸入 ID？
attention_mask (Numpy 陣列或 tf.Tensor，形狀為 (batch_size, sequence_length)，可選) — 用於避免在填充標記索引上執行注意力的掩碼。掩碼值在 [0, 1] 中選擇：
- 1 表示標記未被遮蓋，
- 0 表示標記被遮蓋。什麼是注意力掩碼？
token_type_ids (Numpy 陣列或 tf.Tensor，形狀為 (batch_size, sequence_length)，可選) — 段標記索引，用於指示輸入的第一和第二部分。索引在 [0, 1] 中選擇：
- 0 對應於*句子 A* 的標記，
- 1 對應於*句子 B* 的標記。什麼是標記型別 ID？
position_ids (Numpy 陣列或 tf.Tensor，形狀為 (batch_size, sequence_length)，可選) — 每個輸入序列標記在位置嵌入中的位置索引。在 [0, config.max_position_embeddings - 1] 範圍內選擇。什麼是位置 ID？
head_mask (Numpy 陣列或 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 的標記將被忽略（遮蓋），損失僅對標籤在 [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 時），包含的各種元素取決於配置（XLMRobertaConfig）和輸入。

loss (tf.Tensor of shape (n,), 可選, 其中 n 是非掩碼標籤的數量，當提供 labels 時返回) — 掩碼語言模型 (MLM) 損失。
logits (tf.Tensor of 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 後的注意力權重，用於計算自注意力頭中的加權平均值。

TFXLMRobertaForMaskedLM 的前向方法重寫了 __call__ 特殊方法。

示例

>>> from transformers import AutoTokenizer, TFXLMRobertaForMaskedLM
>>> import tensorflow as tf

>>> tokenizer = AutoTokenizer.from_pretrained("FacebookAI/xlm-roberta-base")
>>> model = TFXLMRobertaForMaskedLM.from_pretrained("FacebookAI/xlm-roberta-base")

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

>>> labels = tokenizer("The capital of France is Paris.", return_tensors="tf")["input_ids"]
>>> # mask labels of non-<mask> tokens
>>> labels = tf.where(inputs.input_ids == tokenizer.mask_token_id, labels, -100)

>>> outputs = model(**inputs, labels=labels)
>>> round(float(outputs.loss), 2)
0.1

TFXLMRobertaForSequenceClassification

class transformers.TFXLMRobertaForSequenceClassification

( config *inputs **kwargs )

引數

config (XLMRobertaConfig) — 包含模型所有引數的模型配置類。使用配置檔案進行初始化不會載入與模型相關的權重，只會載入配置。請檢視 from_pretrained() 方法以載入模型權重。

帶有一個序列分類/迴歸頭的 XLM RoBERTa 模型轉換器（一個位於池化輸出之上的線性層），例如用於 GLUE 任務。

該模型繼承自 TFPreTrainedModel。請檢視超類文件，瞭解該庫為其所有模型實現的通用方法（例如下載或儲存、調整輸入嵌入的大小、修剪頭等）。

該模型也是 keras.Model 的子類。可以像常規 TF 2.0 Keras 模型一樣使用它，並參考 TF 2.0 文件瞭解所有與常規用法和行為相關的事項。

transformers 中的 TensorFlow 模型和層接受兩種輸入格式

所有輸入作為關鍵字引數（如 PyTorch 模型），或
所有輸入作為第一個位置引數中的列表、元組或字典。

只有一個 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 (Numpy 陣列或 tf.Tensor，形狀為 (batch_size, sequence_length)) — 詞彙表中輸入序列標記的索引。可以使用 AutoTokenizer 獲取索引。有關詳細資訊，請參閱 PreTrainedTokenizer.call() 和 PreTrainedTokenizer.encode()。什麼是輸入 ID？
attention_mask (Numpy 陣列或 tf.Tensor，形狀為 (batch_size, sequence_length)，可選) — 用於避免在填充標記索引上執行注意力的掩碼。掩碼值在 [0, 1] 中選擇：
- 1 表示標記未被遮蓋，
- 0 表示標記被遮蓋。什麼是注意力掩碼？
token_type_ids (Numpy 陣列或 tf.Tensor，形狀為 (batch_size, sequence_length)，可選) — 段標記索引，用於指示輸入的第一和第二部分。索引在 [0, 1] 中選擇：
- 0 對應於*句子 A* 的標記，
- 1 對應於*句子 B* 的標記。什麼是標記型別 ID？
position_ids (Numpy 陣列或 tf.Tensor，形狀為 (batch_size, sequence_length)，可選) — 每個輸入序列標記在位置嵌入中的位置索引。在 [0, config.max_position_embeddings - 1] 範圍內選擇。什麼是位置 ID？
head_mask (Numpy 陣列或 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 時），包含的各種元素取決於配置（XLMRobertaConfig）和輸入。

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 後的注意力權重，用於計算自注意力頭中的加權平均值。

TFXLMRobertaForSequenceClassification 的前向方法重寫了 __call__ 特殊方法。

示例

>>> from transformers import AutoTokenizer, TFXLMRobertaForSequenceClassification
>>> import tensorflow as tf

>>> tokenizer = AutoTokenizer.from_pretrained("cardiffnlp/twitter-roberta-base-emotion")
>>> model = TFXLMRobertaForSequenceClassification.from_pretrained("cardiffnlp/twitter-roberta-base-emotion")

>>> 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]
'optimism'

>>> # 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 = TFXLMRobertaForSequenceClassification.from_pretrained("cardiffnlp/twitter-roberta-base-emotion", num_labels=num_labels)

>>> labels = tf.constant(1)
>>> loss = model(**inputs, labels=labels).loss
>>> round(float(loss), 2)
0.08

TFXLMRobertaForMultipleChoice

class transformers.TFXLMRobertaForMultipleChoice

( config *inputs **kwargs )

引數

config (XLMRobertaConfig) — 包含模型所有引數的模型配置類。使用配置檔案進行初始化不會載入與模型相關的權重，只會載入配置。請檢視 from_pretrained() 方法以載入模型權重。

帶有多項選擇分類頭的 XLM Roberta 模型（一個位於池化輸出之上的線性層和一個 softmax），例如用於 RocStories/SWAG 任務。

該模型繼承自 TFPreTrainedModel。請檢視超類文件，瞭解該庫為其所有模型實現的通用方法（例如下載或儲存、調整輸入嵌入的大小、修剪頭等）。

該模型也是 keras.Model 的子類。可以像常規 TF 2.0 Keras 模型一樣使用它，並參考 TF 2.0 文件瞭解所有與常規用法和行為相關的事項。

transformers 中的 TensorFlow 模型和層接受兩種輸入格式

所有輸入作為關鍵字引數（如 PyTorch 模型），或
所有輸入作為第一個位置引數中的列表、元組或字典。

只有一個 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 (Numpy 陣列或 tf.Tensor，形狀為 (batch_size, num_choices, sequence_length)) — 詞彙表中輸入序列標記的索引。可以使用 AutoTokenizer 獲取索引。有關詳細資訊，請參閱 PreTrainedTokenizer.call() 和 PreTrainedTokenizer.encode()。什麼是輸入 ID？
attention_mask (Numpy 陣列或 tf.Tensor，形狀為 (batch_size, num_choices, sequence_length)，可選) — 用於避免在填充標記索引上執行注意力的掩碼。掩碼值在 [0, 1] 中選擇：
- 1 表示標記未被遮蓋，
- 0 表示標記被遮蓋。什麼是注意力掩碼？
token_type_ids (Numpy 陣列或 tf.Tensor，形狀為 (batch_size, num_choices, sequence_length)，可選) — 段標記索引，用於指示輸入的第一和第二部分。索引在 [0, 1] 中選擇：
- 0 對應於*句子 A* 的標記，
- 1 對應於*句子 B* 的標記。什麼是標記型別 ID？
position_ids (Numpy 陣列或 tf.Tensor，形狀為 (batch_size, num_choices, sequence_length)，可選) — 每個輸入序列標記在位置嵌入中的位置索引。在 [0, config.max_position_embeddings - 1] 範圍內選擇。什麼是位置 ID？
head_mask (Numpy 陣列或 tf.Tensor，形狀為 (num_heads,) 或 (num_layers, num_heads)，可選) — 用於使自注意力模組的選定頭無效的掩碼。掩碼值在 [0, 1] 中選擇：
- 1 表示頭未被遮蓋，
- 0 表示頭被遮蓋。
inputs_embeds (tf.Tensor，形狀為 (batch_size, num_choices, sequence_length, hidden_size)，可選) — 可選地，你可以不傳遞 input_ids，而是直接傳遞嵌入表示。如果你想對如何將 input_ids 索引轉換為關聯向量進行更多控制，而不是使用模型內部的嵌入查詢矩陣，這會很有用。
output_attentions (bool, optional) — 是否返回所有注意力層的注意力張量。有關更多詳細資訊，請參閱返回張量下的 attentions。此引數只能在 Eager 模式下使用，在圖模式下將使用配置中的值。
output_hidden_states (bool, optional) — 是否返回所有層的隱藏狀態。有關更多詳細資訊，請參閱返回張量下的 hidden_states。此引數只能在 Eager 模式下使用，在圖模式下將使用配置中的值。
return_dict (bool, optional) — 是否返回一個 ModelOutput 而不是一個普通的元組。此引數可在 Eager 模式下使用，在圖模式下，該值將始終設定為 True。
training (bool, optional, 預設為 False) — 是否在訓練模式下使用模型（某些模組如 dropout 模組在訓練和評估之間有不同的行為）。
labels (tf.Tensor of 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 時），根據配置（XLMRobertaConfig）和輸入包含各種元素。

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 後的注意力權重，用於計算自注意力頭中的加權平均值。

TFXLMRobertaForMultipleChoice 的前向方法，覆蓋了 __call__ 特殊方法。

示例

>>> from transformers import AutoTokenizer, TFXLMRobertaForMultipleChoice
>>> import tensorflow as tf

>>> tokenizer = AutoTokenizer.from_pretrained("FacebookAI/xlm-roberta-base")
>>> model = TFXLMRobertaForMultipleChoice.from_pretrained("FacebookAI/xlm-roberta-base")

>>> 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.logits

TFXLMRobertaForTokenClassification

class transformers.TFXLMRobertaForTokenClassification

( config *inputs **kwargs )

引數

config (XLMRobertaConfig) — 模型配置類，包含模型的所有引數。使用配置檔案初始化不會載入與模型相關的權重，只會載入配置。檢視 from_pretrained() 方法以載入模型權重。

XLM RoBERTa 模型，頂部帶有 token 分類頭（隱藏狀態輸出頂部的線性層），例如用於命名實體識別（NER）任務。

該模型繼承自 TFPreTrainedModel。請檢視超類文件，瞭解該庫為其所有模型實現的通用方法（例如下載或儲存、調整輸入嵌入的大小、修剪頭等）。

該模型也是 keras.Model 的子類。可以像常規 TF 2.0 Keras 模型一樣使用它，並參考 TF 2.0 文件瞭解所有與常規用法和行為相關的事項。

transformers 中的 TensorFlow 模型和層接受兩種輸入格式

所有輸入作為關鍵字引數（如 PyTorch 模型），或
所有輸入作為第一個位置引數中的列表、元組或字典。

只有一個 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 (Numpy 陣列或 tf.Tensor，形狀為 (batch_size, sequence_length)) — 詞彙表中輸入序列標記的索引。可以使用 AutoTokenizer 獲取索引。有關詳細資訊，請參閱 PreTrainedTokenizer.call() 和 PreTrainedTokenizer.encode()。什麼是輸入 ID？
attention_mask (Numpy 陣列或 tf.Tensor，形狀為 (batch_size, sequence_length), optional) — 用於避免對填充標記索引執行注意力的掩碼。掩碼值在 [0, 1] 中選擇：
- 1 表示標記未被遮蓋，
- 0 表示標記被遮蓋。什麼是注意力掩碼？
token_type_ids (Numpy 陣列或 tf.Tensor，形狀為 (batch_size, sequence_length), optional) — 用於指示輸入的第一部分和第二部分的段標記索引。索引在 [0, 1] 中選擇：
- 0 對應於 *句子 A* 標記，
- 1 對應於 *句子 B* 標記。什麼是 token 型別 ID？
position_ids (Numpy 陣列或 tf.Tensor，形狀為 (batch_size, sequence_length), optional) — 位置嵌入中每個輸入序列標記的位置索引。在 [0, config.max_position_embeddings - 1] 範圍內選擇。什麼是位置 ID？
head_mask (Numpy 陣列或 tf.Tensor，形狀為 (num_heads,) 或 (num_layers, num_heads), optional) — 用於置零自注意力模組中選定頭的掩碼。掩碼值在 [0, 1] 中選擇：
- 1 表示頭未被遮蓋，
- 0 表示頭被遮蓋。
inputs_embeds (tf.Tensor of shape (batch_size, sequence_length, hidden_size), optional) — 可選地，你可以選擇直接傳遞嵌入表示，而不是傳遞 input_ids。如果你希望比模型的內部嵌入查詢矩陣更好地控制如何將 input_ids 索引轉換為關聯向量，這將非常有用。
output_attentions (bool, optional) — 是否返回所有注意力層的注意力張量。有關更多詳細資訊，請參閱返回張量下的 attentions。此引數只能在 Eager 模式下使用，在圖模式下將使用配置中的值。
output_hidden_states (bool, optional) — 是否返回所有層的隱藏狀態。有關更多詳細資訊，請參閱返回張量下的 hidden_states。此引數只能在 Eager 模式下使用，在圖模式下將使用配置中的值。
return_dict (bool, optional) — 是否返回一個 ModelOutput 而不是一個普通的元組。此引數可在 Eager 模式下使用，在圖模式下，該值將始終設定為 True。
training (bool, optional, 預設為 False) — 是否在訓練模式下使用模型（某些模組如 dropout 模組在訓練和評估之間有不同的行為）。
labels (tf.Tensor of shape (batch_size, sequence_length), optional) — 用於計算 token 分類損失的標籤。索引應在 [0, ..., config.num_labels - 1] 範圍內。

transformers.modeling_tf_outputs.TFTokenClassifierOutput 或 tuple(tf.Tensor)

一個 transformers.modeling_tf_outputs.TFTokenClassifierOutput 或一個 tf.Tensor 的元組（如果傳遞了 return_dict=False 或當 config.return_dict=False 時），根據配置（XLMRobertaConfig）和輸入包含各種元素。

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 後的注意力權重，用於計算自注意力頭中的加權平均值。

TFXLMRobertaForTokenClassification 的前向方法，覆蓋了 __call__ 特殊方法。

示例

>>> from transformers import AutoTokenizer, TFXLMRobertaForTokenClassification
>>> import tensorflow as tf

>>> tokenizer = AutoTokenizer.from_pretrained("ydshieh/roberta-large-ner-english")
>>> model = TFXLMRobertaForTokenClassification.from_pretrained("ydshieh/roberta-large-ner-english")

>>> 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
['O', 'ORG', 'ORG', 'O', 'O', 'O', 'O', 'O', 'LOC', 'O', 'LOC', 'LOC']

>>> labels = predicted_token_class_ids
>>> loss = tf.math.reduce_mean(model(**inputs, labels=labels).loss)
>>> round(float(loss), 2)
0.01

TFXLMRobertaForQuestionAnswering

class transformers.TFXLMRobertaForQuestionAnswering

( config *inputs **kwargs )

引數

config (XLMRobertaConfig) — 模型配置類，包含模型的所有引數。使用配置檔案初始化不會載入與模型相關的權重，只會載入配置。檢視 from_pretrained() 方法以載入模型權重。

XLM RoBERTa 模型，頂部帶有一個 span 分類頭，用於抽取式問答任務，如 SQuAD（在隱藏狀態輸出的頂部有線性層，用於計算 span start logits 和 span end logits）。

該模型繼承自 TFPreTrainedModel。請檢視超類文件，瞭解該庫為其所有模型實現的通用方法（例如下載或儲存、調整輸入嵌入的大小、修剪頭等）。

該模型也是 keras.Model 的子類。可以像常規 TF 2.0 Keras 模型一樣使用它，並參考 TF 2.0 文件瞭解所有與常規用法和行為相關的事項。

transformers 中的 TensorFlow 模型和層接受兩種輸入格式

所有輸入作為關鍵字引數（如 PyTorch 模型），或
所有輸入作為第一個位置引數中的列表、元組或字典。

只有一個 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 (Numpy 陣列或 tf.Tensor，形狀為 (batch_size, sequence_length)) — 詞彙表中輸入序列標記的索引。可以使用 AutoTokenizer 獲取索引。有關詳細資訊，請參閱 PreTrainedTokenizer.call() 和 PreTrainedTokenizer.encode()。什麼是輸入 ID？
attention_mask (Numpy 陣列或 tf.Tensor，形狀為 (batch_size, sequence_length), optional) — 用於避免對填充標記索引執行注意力的掩碼。掩碼值在 [0, 1] 中選擇：
- 1 表示標記未被遮蓋，
- 0 表示標記被遮蓋。什麼是注意力掩碼？
token_type_ids (Numpy 陣列或 tf.Tensor，形狀為 (batch_size, sequence_length), optional) — 用於指示輸入的第一部分和第二部分的段標記索引。索引在 [0, 1] 中選擇：
- 0 對應於 *句子 A* 標記，
- 1 對應於 *句子 B* 標記。什麼是 token 型別 ID？
position_ids (Numpy 陣列或 tf.Tensor，形狀為 (batch_size, sequence_length), optional) — 位置嵌入中每個輸入序列標記的位置索引。在 [0, config.max_position_embeddings - 1] 範圍內選擇。什麼是位置 ID？
head_mask (Numpy 陣列或 tf.Tensor，形狀為 (num_heads,) 或 (num_layers, num_heads), optional) — 用於置零自注意力模組中選定頭的掩碼。掩碼值在 [0, 1] 中選擇：
- 1 表示頭未被遮蓋，
- 0 表示頭被遮蓋。
inputs_embeds (tf.Tensor of shape (batch_size, sequence_length, hidden_size), optional) — 可選地，你可以選擇直接傳遞嵌入表示，而不是傳遞 input_ids。如果你希望比模型的內部嵌入查詢矩陣更好地控制如何將 input_ids 索引轉換為關聯向量，這將非常有用。
output_attentions (bool, optional) — 是否返回所有注意力層的注意力張量。有關更多詳細資訊，請參閱返回張量下的 attentions。此引數只能在 Eager 模式下使用，在圖模式下將使用配置中的值。
output_hidden_states (bool, optional) — 是否返回所有層的隱藏狀態。有關更多詳細資訊，請參閱返回張量下的 hidden_states。此引數只能在 Eager 模式下使用，在圖模式下將使用配置中的值。
return_dict (bool, optional) — 是否返回一個 ModelOutput 而不是一個普通的元組。此引數可在 Eager 模式下使用，在圖模式下，該值將始終設定為 True。
training (bool, optional, 預設為 False) — 是否在訓練模式下使用模型（某些模組如 dropout 模組在訓練和評估之間有不同的行為）。
start_positions (tf.Tensor of shape (batch_size,), optional) — 用於計算 token 分類損失的標記區間的起始位置（索引）標籤。位置被限制在序列長度（sequence_length）內。序列之外的位置在計算損失時不予考慮。
end_positions (tf.Tensor of shape (batch_size,), optional) — 用於計算 token 分類損失的標記區間的結束位置（索引）標籤。位置被限制在序列長度（sequence_length）內。序列之外的位置在計算損失時不予考慮。

transformers.modeling_tf_outputs.TFQuestionAnsweringModelOutput 或 tuple(tf.Tensor)

一個 transformers.modeling_tf_outputs.TFQuestionAnsweringModelOutput 或一個 tf.Tensor 的元組（如果傳遞了 return_dict=False 或當 config.return_dict=False 時），根據配置（XLMRobertaConfig）和輸入包含各種元素。

loss (tf.Tensor of shape (batch_size, ), optional, 當提供 start_positions 和 end_positions 時返回) — 總的 span 抽取損失是起始和結束位置的交叉熵損失之和。
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 後的注意力權重，用於計算自注意力頭中的加權平均值。

TFXLMRobertaForQuestionAnswering 的前向方法，覆蓋了 __call__ 特殊方法。

示例

>>> from transformers import AutoTokenizer, TFXLMRobertaForQuestionAnswering
>>> import tensorflow as tf

>>> tokenizer = AutoTokenizer.from_pretrained("ydshieh/roberta-base-squad2")
>>> model = TFXLMRobertaForQuestionAnswering.from_pretrained("ydshieh/roberta-base-squad2")

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

>>> # target is "nice puppet"
>>> target_start_index = tf.constant([14])
>>> target_end_index = tf.constant([15])

>>> outputs = model(**inputs, start_positions=target_start_index, end_positions=target_end_index)
>>> loss = tf.math.reduce_mean(outputs.loss)
>>> round(float(loss), 2)
0.86

JAX

隱藏 JAX 內容

FlaxXLMRobertaModel

class transformers.FlaxXLMRobertaModel

( config: XLMRobertaConfig input_shape: tuple = (1, 1) seed: int = 0 dtype: dtype = <class 'jax.numpy.float32'> _do_init: bool = True gradient_checkpointing: bool = False **kwargs )

引數

config (XLMRobertaConfig) — 模型配置類，包含模型的所有引數。使用配置檔案初始化不會載入與模型相關的權重，只會載入配置。檢視 from_pretrained() 方法以載入模型權重。

裸 XLM RoBERTa 模型 Transformer，輸出原始隱藏狀態，頂部沒有任何特定的頭。

此模型繼承自 FlaxPreTrainedModel。請檢視超類文件，瞭解庫為所有模型實現的通用方法（例如下載、儲存和轉換 PyTorch 模型的權重）。

此模型也是 flax.linen.Module 的子類。可以像常規 Flax linen 模組一樣使用它，並參考 Flax 文件瞭解所有與一般用法和行為相關的事項。

最後，此模型支援固有的 JAX 功能，例如

call

( input_ids attention_mask = None token_type_ids = None position_ids = None head_mask = None encoder_hidden_states = None encoder_attention_mask = None params: typing.Optional[dict] = None dropout_rng: <function PRNGKey at 0x7effc7ad3a30> = None train: bool = False output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None past_key_values: typing.Optional[dict] = None ) → transformers.modeling_flax_outputs.FlaxBaseModelOutputWithPooling 或 tuple(torch.FloatTensor)

引數

input_ids (numpy.ndarray，形狀為 (batch_size, sequence_length)) — 詞彙表中輸入序列標記的索引。

可以使用 AutoTokenizer 獲取索引。有關詳細資訊，請參閱 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。

什麼是輸入 ID？
attention_mask (numpy.ndarray，形狀為 (batch_size, sequence_length), optional) — 用於避免對填充標記索引執行注意力的掩碼。掩碼值在 [0, 1] 中選擇：
- 1 表示標記未被遮蓋，
- 0 表示標記被遮蓋。
什麼是注意力掩碼？
token_type_ids (numpy.ndarray，形狀為 (batch_size, sequence_length), optional) — 用於指示輸入的第一部分和第二部分的段標記索引。索引在 [0, 1] 中選擇：
- 0 對應於 *句子 A* 標記，
- 1 對應於 *句子 B* 標記。
什麼是 token 型別 ID？
position_ids (numpy.ndarray，形狀為 (batch_size, sequence_length), optional) — 位置嵌入中每個輸入序列標記的位置索引。在 [0, config.max_position_embeddings - 1] 範圍內選擇。
head_mask (numpy.ndarray，形狀為 (batch_size, sequence_length), optional) -- 用於置零注意力模組中選定頭的掩碼。掩碼值在 [0, 1]` 中選擇：
- 1 表示頭未被遮蓋，
- 0 表示頭被遮蓋。
return_dict (bool, optional) — 是否返回一個 ModelOutput 而不是一個普通的元組。

transformers.modeling_flax_outputs.FlaxBaseModelOutputWithPooling 或 tuple(torch.FloatTensor)

一個 transformers.modeling_flax_outputs.FlaxBaseModelOutputWithPooling 或一個 torch.FloatTensor 的元組（如果傳遞了 return_dict=False 或當 config.return_dict=False 時），根據配置（XLMRobertaConfig）和輸入包含各種元素。

last_hidden_state (形狀為 (batch_size, sequence_length, hidden_size) 的 jnp.ndarray) — 模型最後一層輸出的隱藏狀態序列。
pooler_output (jnp.ndarray，形狀為 (batch_size, hidden_size)) — 序列第一個標記（分類標記）的最後一層隱藏狀態，再經過線性層和 Tanh 啟用函式處理。線性層的權重在預訓練期間透過下一句預測（分類）目標進行訓練。
hidden_states (tuple(jnp.ndarray), optional, 當傳遞 output_hidden_states=True 或當 config.output_hidden_states=True 時返回) — jnp.ndarray 的元組（一個用於嵌入層的輸出，一個用於每個層的輸出），形狀為 (batch_size, sequence_length, hidden_size)。

模型在每個層輸出的隱藏狀態加上初始嵌入輸出。
attentions (tuple(jnp.ndarray), optional, 當傳遞 output_attentions=True 或當 config.output_attentions=True 時返回) — jnp.ndarray 的元組（每層一個），形狀為 (batch_size, num_heads, sequence_length, sequence_length)。

注意力 softmax 後的注意力權重，用於計算自注意力頭中的加權平均值。

FlaxXLMRobertaPreTrainedModel 的前向方法，覆蓋了 __call__ 特殊方法。

示例

>>> from transformers import AutoTokenizer, FlaxXLMRobertaModel

>>> tokenizer = AutoTokenizer.from_pretrained("FacebookAI/xlm-roberta-base")
>>> model = FlaxXLMRobertaModel.from_pretrained("FacebookAI/xlm-roberta-base")

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

>>> last_hidden_states = outputs.last_hidden_state

## FlaxXLMRobertaForCausalLM

class transformers.FlaxXLMRobertaForCausalLM

( config: XLMRobertaConfig input_shape: tuple = (1, 1) seed: int = 0 dtype: dtype = <class 'jax.numpy.float32'> _do_init: bool = True gradient_checkpointing: bool = False **kwargs )

引數

config (XLMRobertaConfig) — 包含模型所有引數的模型配置類。使用配置檔案進行初始化時，不會載入與模型相關的權重，只會載入配置。請檢視 from_pretrained() 方法來載入模型權重。

帶有語言模型頭的 XLM-RoBERTa 模型（在隱藏狀態輸出之上有一個線性層），例如用於自迴歸任務。

此模型繼承自 FlaxPreTrainedModel。請檢視超類文件，瞭解庫為所有模型實現的通用方法（例如下載、儲存和轉換 PyTorch 模型的權重）。

此模型也是 flax.linen.Module 的子類。可以像常規 Flax linen 模組一樣使用它，並參考 Flax 文件瞭解所有與一般用法和行為相關的事項。

最後，此模型支援固有的 JAX 功能，例如

call

( input_ids attention_mask = None token_type_ids = None position_ids = None head_mask = None encoder_hidden_states = None encoder_attention_mask = None params: typing.Optional[dict] = None dropout_rng: <function PRNGKey at 0x7effc7ad3a30> = None train: bool = False output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None past_key_values: typing.Optional[dict] = None ) → transformers.modeling_flax_outputs.FlaxCausalLMOutputWithCrossAttentions or tuple(torch.FloatTensor)

引數

input_ids (numpy.ndarray，形狀為 (batch_size, sequence_length)) — 詞彙表中輸入序列標記的索引。

可以使用 AutoTokenizer 獲取索引。有關詳細資訊，請參閱 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。

什麼是輸入ID？
attention_mask (numpy.ndarray，形狀為 (batch_size, sequence_length)，可選) — 用於避免在填充標記索引上執行注意力操作的掩碼。掩碼值在 [0, 1] 中選擇：
- 1 表示標記未被遮蓋，
- 0 表示標記被遮蓋。
什麼是注意力掩碼？
token_type_ids (numpy.ndarray，形狀為 (batch_size, sequence_length)，可選) — 分段標記索引，用於指示輸入的第一部分和第二部分。索引在 [0, 1] 中選擇：
- 0 對應於 *句子 A* 的標記，
- 1 對應於 *句子 B* 的標記。
什麼是標記型別ID？
position_ids (numpy.ndarray，形狀為 (batch_size, sequence_length)，可選) — 位置嵌入中每個輸入序列標記的位置索引。在 [0, config.max_position_embeddings - 1] 範圍內選擇。
head_mask (numpy.ndarray，形狀為 (batch_size, sequence_length)，可選) -- 用於置零注意力模組中選定頭的掩碼。掩碼值在 [0, 1]` 中選擇：
- 1 表示頭未被遮蓋，
- 0 表示頭被遮蓋。
return_dict (bool，可選) — 是否返回 ModelOutput 而不是普通的元組。

transformers.modeling_flax_outputs.FlaxCausalLMOutputWithCrossAttentions 或 tuple(torch.FloatTensor)

一個 transformers.modeling_flax_outputs.FlaxCausalLMOutputWithCrossAttentions 或一個 torch.FloatTensor 的元組（如果傳遞 return_dict=False 或當 config.return_dict=False 時），包含各種元素，具體取決於配置（XLMRobertaConfig）和輸入。

logits (形狀為 (batch_size, sequence_length, config.vocab_size) 的 jnp.ndarray) — 語言建模頭的預測分數（SoftMax 之前每個詞彙 token 的分數）。
hidden_states (tuple(jnp.ndarray), optional, 當傳遞 output_hidden_states=True 或當 config.output_hidden_states=True 時返回) — jnp.ndarray 的元組（一個用於嵌入層的輸出，一個用於每個層的輸出），形狀為 (batch_size, sequence_length, hidden_size)。

模型在每個層輸出的隱藏狀態加上初始嵌入輸出。
attentions (tuple(jnp.ndarray), optional, 當傳遞 output_attentions=True 或當 config.output_attentions=True 時返回) — jnp.ndarray 的元組（每層一個），形狀為 (batch_size, num_heads, sequence_length, sequence_length)。

注意力 softmax 後的注意力權重，用於計算自注意力頭中的加權平均值。
cross_attentions (tuple(jnp.ndarray)，可選，當傳遞 output_attentions=True 或 config.output_attentions=True 時返回) — jnp.ndarray 的元組（每層一個），形狀為 (batch_size, num_heads, sequence_length, sequence_length)。

注意力 softmax 後的交叉注意力權重，用於計算交叉注意力頭中的加權平均。
past_key_values (tuple(tuple(jnp.ndarray))，可選，當傳遞 use_cache=True 或 config.use_cache=True 時返回) — jnp.ndarray 元組的元組，長度為 config.n_layers，每個元組包含自注意力和交叉注意力層的快取鍵、值狀態（如果模型在編碼器-解碼器設定中使用）。僅在 config.is_decoder = True 時相關。

包含預先計算的隱藏狀態（注意力塊中的鍵和值），可用於（參見 past_key_values 輸入）加速順序解碼。

FlaxXLMRobertaPreTrainedModel 的前向方法，覆蓋了 __call__ 特殊方法。

示例

>>> from transformers import AutoTokenizer, FlaxXLMRobertaForCausalLM

>>> tokenizer = AutoTokenizer.from_pretrained("FacebookAI/xlm-roberta-base")
>>> model = FlaxXLMRobertaForCausalLM.from_pretrained("FacebookAI/xlm-roberta-base")

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

>>> # retrieve logts for next token
>>> next_token_logits = outputs.logits[:, -1]

FlaxXLMRobertaForMaskedLM

class transformers.FlaxXLMRobertaForMaskedLM

( config: XLMRobertaConfig input_shape: tuple = (1, 1) seed: int = 0 dtype: dtype = <class 'jax.numpy.float32'> _do_init: bool = True gradient_checkpointing: bool = False **kwargs )

引數

config (XLMRobertaConfig) — 包含模型所有引數的模型配置類。使用配置檔案進行初始化時，不會載入與模型相關的權重，只會載入配置。請檢視 from_pretrained() 方法來載入模型權重。

帶有一個 `language modeling` 頭的 XLM RoBERTa 模型。

此模型繼承自 FlaxPreTrainedModel。請檢視超類文件，瞭解庫為所有模型實現的通用方法（例如下載、儲存和轉換 PyTorch 模型的權重）。

此模型也是 flax.linen.Module 的子類。可以像常規 Flax linen 模組一樣使用它，並參考 Flax 文件瞭解所有與一般用法和行為相關的事項。

最後，此模型支援固有的 JAX 功能，例如

call

引數

input_ids (numpy.ndarray，形狀為 (batch_size, sequence_length)) — 詞彙表中輸入序列標記的索引。

可以使用 AutoTokenizer 獲取索引。有關詳細資訊，請參閱 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。

什麼是輸入ID？
attention_mask (numpy.ndarray，形狀為 (batch_size, sequence_length)，可選) — 用於避免在填充標記索引上執行注意力操作的掩碼。掩碼值在 [0, 1] 中選擇：
- 1 表示標記未被遮蓋，
- 0 表示標記被遮蓋。
什麼是注意力掩碼？
token_type_ids (numpy.ndarray，形狀為 (batch_size, sequence_length)，可選) — 分段標記索引，用於指示輸入的第一部分和第二部分。索引在 [0, 1] 中選擇：
- 0 對應於 *句子 A* 的標記，
- 1 對應於 *句子 B* 的標記。
什麼是標記型別ID？
position_ids (numpy.ndarray，形狀為 (batch_size, sequence_length)，可選) — 位置嵌入中每個輸入序列標記的位置索引。在 [0, config.max_position_embeddings - 1] 範圍內選擇。
head_mask (numpy.ndarray，形狀為 (batch_size, sequence_length)，可選) -- 用於置零注意力模組中選定頭的掩碼。掩碼值在 [0, 1]` 中選擇：
- 1 表示頭未被遮蓋，
- 0 表示頭被遮蓋。
return_dict (bool，可選) — 是否返回 ModelOutput 而不是普通的元組。

transformers.modeling_flax_outputs.FlaxBaseModelOutputWithPooling 或 tuple(torch.FloatTensor)

last_hidden_state (形狀為 (batch_size, sequence_length, hidden_size) 的 jnp.ndarray) — 模型最後一層輸出的隱藏狀態序列。
pooler_output (jnp.ndarray，形狀為 (batch_size, hidden_size)) — 序列第一個標記（分類標記）的最後一層隱藏狀態，再經過線性層和 Tanh 啟用函式處理。線性層的權重在預訓練期間透過下一句預測（分類）目標進行訓練。
hidden_states (tuple(jnp.ndarray), optional, 當傳遞 output_hidden_states=True 或當 config.output_hidden_states=True 時返回) — jnp.ndarray 的元組（一個用於嵌入層的輸出，一個用於每個層的輸出），形狀為 (batch_size, sequence_length, hidden_size)。

模型在每個層輸出的隱藏狀態加上初始嵌入輸出。
attentions (tuple(jnp.ndarray), optional, 當傳遞 output_attentions=True 或當 config.output_attentions=True 時返回) — jnp.ndarray 的元組（每層一個），形狀為 (batch_size, num_heads, sequence_length, sequence_length)。

注意力 softmax 後的注意力權重，用於計算自注意力頭中的加權平均值。

FlaxXLMRobertaPreTrainedModel 的前向方法，覆蓋了 __call__ 特殊方法。

示例

>>> from transformers import AutoTokenizer, FlaxXLMRobertaForMaskedLM

>>> tokenizer = AutoTokenizer.from_pretrained("FacebookAI/xlm-roberta-base")
>>> model = FlaxXLMRobertaForMaskedLM.from_pretrained("FacebookAI/xlm-roberta-base")

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

>>> outputs = model(**inputs)
>>> logits = outputs.logits

## FlaxXLMRobertaForSequenceClassification

class transformers.FlaxXLMRobertaForSequenceClassification

( config: XLMRobertaConfig input_shape: tuple = (1, 1) seed: int = 0 dtype: dtype = <class 'jax.numpy.float32'> _do_init: bool = True gradient_checkpointing: bool = False **kwargs )

引數

config (XLMRobertaConfig) — 包含模型所有引數的模型配置類。使用配置檔案進行初始化時，不會載入與模型相關的權重，只會載入配置。請檢視 from_pretrained() 方法來載入模型權重。

帶有序列分類/迴歸頭的 XLM-RoBERTa 模型轉換器（在池化輸出之上有一個線性層），例如用於 GLUE 任務。

此模型繼承自 FlaxPreTrainedModel。請檢視超類文件，瞭解庫為所有模型實現的通用方法（例如下載、儲存和轉換 PyTorch 模型的權重）。

此模型也是 flax.linen.Module 的子類。可以像常規 Flax linen 模組一樣使用它，並參考 Flax 文件瞭解所有與一般用法和行為相關的事項。

最後，此模型支援固有的 JAX 功能，例如

call

( input_ids attention_mask = None token_type_ids = None position_ids = None head_mask = None encoder_hidden_states = None encoder_attention_mask = None params: typing.Optional[dict] = None dropout_rng: <function PRNGKey at 0x7effc7ad3a30> = None train: bool = False output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None past_key_values: typing.Optional[dict] = None ) → transformers.modeling_flax_outputs.FlaxSequenceClassifierOutput or tuple(torch.FloatTensor)

引數

input_ids (numpy.ndarray，形狀為 (batch_size, sequence_length)) — 詞彙表中輸入序列標記的索引。

可以使用 AutoTokenizer 獲取索引。有關詳細資訊，請參閱 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。

什麼是輸入ID？
attention_mask (numpy.ndarray，形狀為 (batch_size, sequence_length)，可選) — 用於避免在填充標記索引上執行注意力操作的掩碼。掩碼值在 [0, 1] 中選擇：
- 1 表示標記未被遮蓋，
- 0 表示標記被遮蓋。
什麼是注意力掩碼？
token_type_ids (numpy.ndarray，形狀為 (batch_size, sequence_length)，可選) — 分段標記索引，用於指示輸入的第一部分和第二部分。索引在 [0, 1] 中選擇：
- 0 對應於 *句子 A* 的標記，
- 1 對應於 *句子 B* 的標記。
什麼是標記型別ID？
position_ids (numpy.ndarray，形狀為 (batch_size, sequence_length)，可選) — 位置嵌入中每個輸入序列標記的位置索引。在 [0, config.max_position_embeddings - 1] 範圍內選擇。
head_mask (numpy.ndarray，形狀為 (batch_size, sequence_length)，可選) -- 用於置零注意力模組中選定頭的掩碼。掩碼值在 [0, 1]` 中選擇：
- 1 表示頭未被遮蓋，
- 0 表示頭被遮蓋。
return_dict (bool，可選) — 是否返回 ModelOutput 而不是普通的元組。

transformers.modeling_flax_outputs.FlaxSequenceClassifierOutput 或 tuple(torch.FloatTensor)

一個 transformers.modeling_flax_outputs.FlaxSequenceClassifierOutput 或一個 torch.FloatTensor 的元組（如果傳遞 return_dict=False 或當 config.return_dict=False 時），包含各種元素，具體取決於配置（XLMRobertaConfig）和輸入。

logits (形狀為 (batch_size, config.num_labels) 的 jnp.ndarray) — 分類（如果 config.num_labels==1，則為迴歸）分數（SoftMax 之前）。
hidden_states (tuple(jnp.ndarray), optional, 當傳遞 output_hidden_states=True 或當 config.output_hidden_states=True 時返回) — jnp.ndarray 的元組（一個用於嵌入層的輸出，一個用於每個層的輸出），形狀為 (batch_size, sequence_length, hidden_size)。

模型在每個層輸出的隱藏狀態加上初始嵌入輸出。
attentions (tuple(jnp.ndarray), optional, 當傳遞 output_attentions=True 或當 config.output_attentions=True 時返回) — jnp.ndarray 的元組（每層一個），形狀為 (batch_size, num_heads, sequence_length, sequence_length)。

注意力 softmax 後的注意力權重，用於計算自注意力頭中的加權平均值。

FlaxXLMRobertaPreTrainedModel 的前向方法，覆蓋了 __call__ 特殊方法。

示例

>>> from transformers import AutoTokenizer, FlaxXLMRobertaForSequenceClassification

>>> tokenizer = AutoTokenizer.from_pretrained("FacebookAI/xlm-roberta-base")
>>> model = FlaxXLMRobertaForSequenceClassification.from_pretrained("FacebookAI/xlm-roberta-base")

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

>>> outputs = model(**inputs)
>>> logits = outputs.logits

FlaxXLMRobertaForMultipleChoice

class transformers.FlaxXLMRobertaForMultipleChoice

( config: XLMRobertaConfig input_shape: tuple = (1, 1) seed: int = 0 dtype: dtype = <class 'jax.numpy.float32'> _do_init: bool = True gradient_checkpointing: bool = False **kwargs )

引數

config (XLMRobertaConfig) — 包含模型所有引數的模型配置類。使用配置檔案進行初始化時，不會載入與模型相關的權重，只會載入配置。請檢視 from_pretrained() 方法來載入模型權重。

帶有多項選擇分類頭的 XLM Roberta 模型（一個位於池化輸出之上的線性層和一個 softmax），例如用於 RocStories/SWAG 任務。

此模型繼承自 FlaxPreTrainedModel。請檢視超類文件，瞭解庫為所有模型實現的通用方法（例如下載、儲存和轉換 PyTorch 模型的權重）。

此模型也是 flax.linen.Module 的子類。可以像常規 Flax linen 模組一樣使用它，並參考 Flax 文件瞭解所有與一般用法和行為相關的事項。

最後，此模型支援固有的 JAX 功能，例如

call

( input_ids attention_mask = None token_type_ids = None position_ids = None head_mask = None encoder_hidden_states = None encoder_attention_mask = None params: typing.Optional[dict] = None dropout_rng: <function PRNGKey at 0x7effc7ad3a30> = None train: bool = False output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None past_key_values: typing.Optional[dict] = None ) → transformers.modeling_flax_outputs.FlaxMultipleChoiceModelOutput or tuple(torch.FloatTensor)

引數

input_ids (numpy.ndarray，形狀為 (batch_size, num_choices, sequence_length)) — 詞彙表中輸入序列標記的索引。

可以使用 AutoTokenizer 獲取索引。有關詳細資訊，請參閱 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。

什麼是輸入ID？
attention_mask (numpy.ndarray，形狀為 (batch_size, num_choices, sequence_length)，可選) — 用於避免在填充標記索引上執行注意力操作的掩碼。掩碼值在 [0, 1] 中選擇：
- 1 表示標記未被遮蓋，
- 0 表示標記被遮蓋。
什麼是注意力掩碼？
token_type_ids (numpy.ndarray，形狀為 (batch_size, num_choices, sequence_length)，可選) — 分段標記索引，用於指示輸入的第一部分和第二部分。索引在 [0, 1] 中選擇：
- 0 對應於 *句子 A* 的標記，
- 1 對應於 *句子 B* 的標記。
什麼是標記型別ID？
position_ids (numpy.ndarray，形狀為 (batch_size, num_choices, sequence_length)，可選) — 位置嵌入中每個輸入序列標記的位置索引。在 [0, config.max_position_embeddings - 1] 範圍內選擇。
head_mask (numpy.ndarray，形狀為 (batch_size, num_choices, sequence_length)，可選) -- 用於置零注意力模組中選定頭的掩碼。掩碼值在 [0, 1]` 中選擇：
- 1 表示頭未被遮蓋，
- 0 表示頭被遮蓋。
return_dict (bool，可選) — 是否返回 ModelOutput 而不是普通的元組。

transformers.modeling_flax_outputs.FlaxMultipleChoiceModelOutput 或 tuple(torch.FloatTensor)

一個 transformers.modeling_flax_outputs.FlaxMultipleChoiceModelOutput 或一個 torch.FloatTensor 的元組（如果傳遞 return_dict=False 或當 config.return_dict=False 時），包含各種元素，具體取決於配置（XLMRobertaConfig）和輸入。

logits (形狀為 (batch_size, num_choices) 的 jnp.ndarray) — num_choices 是輸入張量的第二個維度。（請參閱上面的 input_ids）。

分類分數（SoftMax 之前）。
hidden_states (tuple(jnp.ndarray), optional, 當傳遞 output_hidden_states=True 或當 config.output_hidden_states=True 時返回) — jnp.ndarray 的元組（一個用於嵌入層的輸出，一個用於每個層的輸出），形狀為 (batch_size, sequence_length, hidden_size)。

模型在每個層輸出的隱藏狀態加上初始嵌入輸出。
attentions (tuple(jnp.ndarray), optional, 當傳遞 output_attentions=True 或當 config.output_attentions=True 時返回) — jnp.ndarray 的元組（每層一個），形狀為 (batch_size, num_heads, sequence_length, sequence_length)。

注意力 softmax 後的注意力權重，用於計算自注意力頭中的加權平均值。

FlaxXLMRobertaPreTrainedModel 的前向方法，覆蓋了 __call__ 特殊方法。

示例

>>> from transformers import AutoTokenizer, FlaxXLMRobertaForMultipleChoice

>>> tokenizer = AutoTokenizer.from_pretrained("FacebookAI/xlm-roberta-base")
>>> model = FlaxXLMRobertaForMultipleChoice.from_pretrained("FacebookAI/xlm-roberta-base")

>>> prompt = "In Italy, pizza served in formal settings, such as at a restaurant, is presented unsliced."
>>> choice0 = "It is eaten with a fork and a knife."
>>> choice1 = "It is eaten while held in the hand."

>>> encoding = tokenizer([prompt, prompt], [choice0, choice1], return_tensors="jax", padding=True)
>>> outputs = model(**{k: v[None, :] for k, v in encoding.items()})

>>> logits = outputs.logits

## FlaxXLMRobertaForTokenClassification

class transformers.FlaxXLMRobertaForTokenClassification

( config: XLMRobertaConfig input_shape: tuple = (1, 1) seed: int = 0 dtype: dtype = <class 'jax.numpy.float32'> _do_init: bool = True gradient_checkpointing: bool = False **kwargs )

引數

config (XLMRobertaConfig) — 包含模型所有引數的模型配置類。使用配置檔案進行初始化時，不會載入與模型相關的權重，只會載入配置。請檢視 from_pretrained() 方法來載入模型權重。

帶有標記分類頭的 XLM-RoBERTa 模型（在隱藏狀態輸出之上有一個線性層），例如用於命名實體識別（NER）任務。

此模型繼承自 FlaxPreTrainedModel。請檢視超類文件，瞭解庫為所有模型實現的通用方法（例如下載、儲存和轉換 PyTorch 模型的權重）。

此模型也是 flax.linen.Module 的子類。可以像常規 Flax linen 模組一樣使用它，並參考 Flax 文件瞭解所有與一般用法和行為相關的事項。

最後，此模型支援固有的 JAX 功能，例如

call

( input_ids attention_mask = None token_type_ids = None position_ids = None head_mask = None encoder_hidden_states = None encoder_attention_mask = None params: typing.Optional[dict] = None dropout_rng: <function PRNGKey at 0x7effc7ad3a30> = None train: bool = False output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None past_key_values: typing.Optional[dict] = None ) → transformers.modeling_flax_outputs.FlaxTokenClassifierOutput or tuple(torch.FloatTensor)

引數

input_ids (numpy.ndarray，形狀為 (batch_size, sequence_length)) — 詞彙表中輸入序列標記的索引。

可以使用 AutoTokenizer 獲取索引。有關詳細資訊，請參閱 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。

什麼是輸入ID？
attention_mask (numpy.ndarray，形狀為 (batch_size, sequence_length)，可選) — 用於避免在填充標記索引上執行注意力機制的掩碼。掩碼值在 [0, 1] 中選擇：
- 1 表示標記未被掩碼，
- 0 表示標記已被掩碼。
什麼是注意力掩碼？
token_type_ids (numpy.ndarray，形狀為 (batch_size, sequence_length)，可選) — 段標記索引，用於指示輸入的第一部分和第二部分。索引在 [0, 1] 中選擇：
- 0 對應於 *A 句子* 的標記，
- 1 對應於 *B 句子* 的標記。
什麼是標記型別 ID？
position_ids (numpy.ndarray，形狀為 (batch_size, sequence_length)，可選) — 每個輸入序列標記在位置嵌入中的位置索引。選擇範圍為 [0, config.max_position_embeddings - 1]。
head_mask (numpy.ndarray，形狀為 (batch_size, sequence_length)，可選) -- 用於置零注意力模組中選定頭的掩碼。掩碼值在 [0, 1]` 中選擇：
- 1 表示該頭未被掩碼，
- 0 表示該頭已被掩碼。
return_dict (bool，可選) — 是否返回一個 ModelOutput 而不是一個普通的元組。

transformers.modeling_flax_outputs.FlaxTokenClassifierOutput 或 tuple(torch.FloatTensor)

一個 transformers.modeling_flax_outputs.FlaxTokenClassifierOutput 或一個 torch.FloatTensor 的元組（如果傳遞了 return_dict=False 或當 config.return_dict=False 時），根據配置（XLMRobertaConfig）和輸入的不同，包含各種元素。

logits (jnp.ndarray，形狀為 (batch_size, sequence_length, config.num_labels)) — 分類得分（SoftMax 之前）。
hidden_states (tuple(jnp.ndarray), optional, 當傳遞 output_hidden_states=True 或當 config.output_hidden_states=True 時返回) — jnp.ndarray 的元組（一個用於嵌入層的輸出，一個用於每個層的輸出），形狀為 (batch_size, sequence_length, hidden_size)。

模型在每個層輸出的隱藏狀態加上初始嵌入輸出。
attentions (tuple(jnp.ndarray), optional, 當傳遞 output_attentions=True 或當 config.output_attentions=True 時返回) — jnp.ndarray 的元組（每層一個），形狀為 (batch_size, num_heads, sequence_length, sequence_length)。

注意力 softmax 後的注意力權重，用於計算自注意力頭中的加權平均值。

FlaxXLMRobertaPreTrainedModel 的前向方法，覆蓋了 __call__ 特殊方法。

示例

>>> from transformers import AutoTokenizer, FlaxXLMRobertaForTokenClassification

>>> tokenizer = AutoTokenizer.from_pretrained("FacebookAI/xlm-roberta-base")
>>> model = FlaxXLMRobertaForTokenClassification.from_pretrained("FacebookAI/xlm-roberta-base")

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

>>> outputs = model(**inputs)
>>> logits = outputs.logits

FlaxXLMRobertaForQuestionAnswering

class transformers.FlaxXLMRobertaForQuestionAnswering

( config: XLMRobertaConfig input_shape: tuple = (1, 1) seed: int = 0 dtype: dtype = <class 'jax.numpy.float32'> _do_init: bool = True gradient_checkpointing: bool = False **kwargs )

引數

config (XLMRobertaConfig) — 包含模型所有引數的模型配置類。使用配置檔案初始化不會載入與模型相關的權重，只會載入配置。請檢視 from_pretrained() 方法來載入模型權重。

XLM Roberta 模型，頂部帶有一個用於抽取式問答任務（如 SQuAD）的片段分類頭（在隱藏狀態輸出之上是用於計算 span start logits 和 span end logits 的線性層）。

此模型繼承自 FlaxPreTrainedModel。請檢視超類文件，瞭解庫為所有模型實現的通用方法（例如下載、儲存和轉換 PyTorch 模型的權重）。

此模型也是 flax.linen.Module 的子類。可以像常規 Flax linen 模組一樣使用它，並參考 Flax 文件瞭解所有與一般用法和行為相關的事項。

最後，此模型支援固有的 JAX 功能，例如

call