Transformers 文件
X-MOD
並獲得增強的文件體驗
開始使用
X-MOD
概述
X-MOD 模型是由 Jonas Pfeiffer、Naman Goyal、Xi Lin、Xian Li、James Cross、Sebastian Riedel 和 Mikel Artetxe 在論文 Lifting the Curse of Multilinguality by Pre-training Modular Transformers 中提出的。X-MOD 擴充套件了多語言掩碼語言模型，如 XLM-R，在預訓練過程中加入了特定語言的模組（*語言介面卡*）。在微調時，每個 Transformer 層中的語言介面卡都被凍結。
論文摘要如下：
眾所周知，多語言預訓練模型會受到多語言詛咒的影響，這會導致隨著覆蓋語言的增加，每種語言的效能下降。我們透過引入特定語言的模組來解決這個問題，這允許我們增加模型的總容量，同時保持每種語言的可訓練引數總數不變。與之前在事後學習特定語言元件的工作不同，我們從一開始就預訓練了我們的跨語言模組化 (X-MOD) 模型的模組。我們對自然語言推理、命名實體識別和問答的實驗表明，我們的方法不僅減輕了語言之間的負面干擾，還實現了積極的遷移，從而改善了單語言和跨語言效能。此外，我們的方法允許在事後新增語言，而效能沒有可衡量的下降，不再將模型使用限制在預訓練的語言集上。
該模型由 jvamvas 貢獻。原始程式碼可在此處找到，原始文件可在此處找到。
使用技巧
技巧
- X-MOD 與 XLM-R 類似，但不同之處在於需要指定輸入語言，以便啟用正確的語言介面卡。
- 主要模型——基礎版和大型版——具有 81 種語言的介面卡。
介面卡使用
輸入語言
有兩種方式指定輸入語言：
- 在使用模型前設定預設語言
from transformers import XmodModel
model = XmodModel.from_pretrained("facebook/xmod-base")
model.set_default_language("en_XX")- 為每個樣本顯式傳遞語言介面卡的索引
import torch
input_ids = torch.tensor(
[
[0, 581, 10269, 83, 99942, 136, 60742, 23, 70, 80583, 18276, 2],
[0, 1310, 49083, 443, 269, 71, 5486, 165, 60429, 660, 23, 2],
]
)
lang_ids = torch.LongTensor(
[
0, # en_XX
8, # de_DE
]
)
output = model(input_ids, lang_ids=lang_ids)微調
該論文建議在微調過程中凍結嵌入層和語言介面卡。提供了一種實現此目的的方法：
model.freeze_embeddings_and_language_adapters()
# Fine-tune the model ...跨語言遷移
微調後，可以透過啟用目標語言的語言介面卡來測試零樣本跨語言遷移。
model.set_default_language("de_DE")
# Evaluate the model on German examples ...資源
XmodConfig
class transformers.XmodConfig
< 來源 >( 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 pre_norm = False adapter_reduction_factor = 2 adapter_layer_norm = False adapter_reuse_layer_norm = True ln_before_adapter = True languages = ('en_XX',) default_language = None **kwargs )
引數
- vocab_size (
int, 可選, 預設為 30522) — X-MOD 模型的詞彙表大小。定義了呼叫 XmodModel 時可由inputs_ids表示的不同 token 的數量。 - hidden_size (
int, 可選, 預設為 768) — 編碼器層和池化器層的維度。 - num_hidden_layers (
int, 可選, 預設為 12) — Transformer 編碼器中的隱藏層數量。 - num_attention_heads (
int, 可選, 預設為 12) — Transformer 編碼器中每個注意力層的注意力頭數量。 - intermediate_size (
int, 可選, 預設為 3072) — Transformer 編碼器中“中間”（通常稱為前饋）層的維度。 - hidden_act (
str或Callable, 可選, 預設為"gelu") — 編碼器和池化器中的非線性啟用函式（函式或字串）。如果為字串，則支援"gelu"、"relu"、"silu"和"gelu_new"。 - hidden_dropout_prob (
float, 可選, 預設為 0.1) — 嵌入層、編碼器和池化器中所有全連線層的 dropout 機率。 - attention_probs_dropout_prob (
float, 可選, 預設為 0.1) — 注意力機率的 dropout 比率。 - max_position_embeddings (
int, 可選, 預設為 512) — 此模型可能使用的最大序列長度。通常為了以防萬一設定為較大值（例如 512 或 1024 或 2048）。 - type_vocab_size (
int, 可選, 預設為 2) — 呼叫 XmodModel 時傳遞的token_type_ids的詞彙表大小。 - initializer_range (
float, 可選, 預設為 0.02) — 用於初始化所有權重矩陣的截斷正態初始化器的標準差。 - layer_norm_eps (
float, 可選, 預設為 1e-12) — 層歸一化層使用的 epsilon。 - position_embedding_type (
str, 可選, 預設為"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.) 中的*方法 4*。 - is_decoder (
bool, 可選, 預設為False) — 模型是否用作解碼器。如果為False，則模型用作編碼器。 - use_cache (
bool, 可選, 預設為True) — 模型是否應返回最後一個 key/values attentions (並非所有模型都使用)。僅在config.is_decoder=True時相關。 - classifier_dropout (
float, 可選) — 分類頭的 dropout 比率。 - pre_norm (
bool, 可選, 預設為False) — 是否在每個塊之前應用層歸一化。 - adapter_reduction_factor (
int或float, 可選, 預設為 2) — 介面卡維度相對於hidden_size減小的因子。 - adapter_layer_norm (
bool, 可選, 預設為False) — 是否在介面卡模組之前應用新的層歸一化（所有介面卡共享）。 - adapter_reuse_layer_norm (
bool, 可選, 預設為True) — 是否重用第二個層歸一化並將其應用於介面卡模組之前。 - ln_before_adapter (
bool, 可選, 預設為True) — 是否在介面卡模組周圍的殘差連線之前應用層歸一化。 - languages (
Iterable[str], 可選, 預設為["en_XX"]) — 一個可迭代的語言程式碼，介面卡模組應為其初始化。 - default_language (
str, 可選) — 預設語言的語言程式碼。如果未明確將語言程式碼傳遞給前向方法，則假定輸入為此語言。
這是用於儲存 XmodModel 配置的配置類。它用於根據指定引數例項化 X-MOD 模型，定義模型架構。使用預設值例項化配置將生成與 facebook/xmod-base 架構相似的配置。
配置物件繼承自 PretrainedConfig，可用於控制模型輸出。有關更多資訊，請閱讀 PretrainedConfig 的文件。
示例
>>> from transformers import XmodConfig, XmodModel
>>> # Initializing an X-MOD facebook/xmod-base style configuration
>>> configuration = XmodConfig()
>>> # Initializing a model (with random weights) from the facebook/xmod-base style configuration
>>> model = XmodModel(configuration)
>>> # Accessing the model configuration
>>> configuration = model.configXmodModel
class transformers.XmodModel
< source >( config add_pooling_layer = True )
引數
- config (XmodModel) — 包含模型所有引數的模型配置類。用配置檔案初始化不會載入與模型相關的權重，只加載配置。請檢視 from_pretrained() 方法以載入模型權重。
- add_pooling_layer (
bool, 可選, 預設為True) — 是否新增池化層
該模型可以充當編碼器（僅自注意力）以及解碼器，在這種情況下，在自注意力層之間新增一層交叉注意力，遵循 Ashish Vaswani、Noam Shazeer、Niki Parmar、Jakob Uszkoreit、Llion Jones、Aidan N. Gomez 和 Illia Polosukhin 在《Attention Is All You Need》_ 中描述的架構。
為了充當解碼器，模型需要使用配置引數 is_decoder 設定為 True 進行初始化。要在 Seq2Seq 模型中使用，模型需要使用 is_decoder 引數和 add_cross_attention 都設定為 True 進行初始化；然後期望 encoder_hidden_states 作為前向傳遞的輸入。
.. _Attention is all you need: https://huggingface.co/papers/1706.03762
該模型繼承自 PreTrainedModel。請檢視超類文件以獲取庫為其所有模型實現的一般方法（例如下載或儲存、調整輸入嵌入大小、修剪頭部等）。
該模型也是 PyTorch torch.nn.Module 子類。將其作為常規 PyTorch 模組使用，並參考 PyTorch 文件以獲取所有與一般用法和行為相關的事項。
forward
< source >( input_ids: typing.Optional[torch.Tensor] = None lang_ids: typing.Optional[torch.LongTensor] = 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 或 tuple(torch.FloatTensor)
引數
- input_ids (形狀為
(batch_size, sequence_length)的torch.Tensor, 可選) — 詞彙表中輸入序列標記的索引。預設情況下，填充將被忽略。可以使用 AutoTokenizer 獲取索引。有關詳細資訊，請參閱 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- lang_ids (形狀為
(batch_size, sequence_length)的torch.LongTensor, 可選) — 分別啟用每個樣本的語言介面卡的索引。預設值：對應於self.config.default_language的索引。 - attention_mask (形狀為
(batch_size, sequence_length)的torch.Tensor, 可選) — 用於避免對填充標記索引執行注意力的掩碼。在[0, 1]中選擇掩碼值：- 1 表示**未被遮蔽**的標記，
- 0 表示**被遮蔽**的標記。
- token_type_ids (形狀為
(batch_size, sequence_length)的torch.Tensor, 可選) — 用於指示輸入的第一部分和第二部分的段標記索引。索引在[0, 1]中選擇：- 0 對應於 *句子 A* 標記，
- 1 對應於 *句子 B* 標記。
- position_ids (形狀為
(batch_size, sequence_length)的torch.Tensor, 可選) — 每個輸入序列標記在位置嵌入中的位置索引。在[0, config.n_positions - 1]範圍內選擇。 - head_mask (形狀為
(num_heads,)或(num_layers, num_heads)的torch.Tensor, 可選) — 用於使自注意力模組的選定頭部無效的掩碼。掩碼值在[0, 1]中選擇：- 1 表示頭部**未被遮蔽**，
- 0 表示頭部**被遮蔽**。
- inputs_embeds (形狀為
(batch_size, sequence_length, hidden_size)的torch.Tensor, 可選) — 可選地，您可以透過嵌入表示直接傳遞，而不是傳遞input_ids。如果您想對如何將input_ids索引轉換為相關向量比模型的內部嵌入查詢矩陣有更多的控制，這將很有用。 - encoder_hidden_states (形狀為
(batch_size, sequence_length, hidden_size)的torch.Tensor, 可選) — 編碼器最後一層輸出的隱藏狀態序列。如果模型配置為解碼器，則用於交叉注意力。 - encoder_attention_mask (形狀為
(batch_size, sequence_length)的torch.Tensor, 可選) — 用於避免對編碼器輸入中的填充標記索引執行注意力的掩碼。如果模型配置為解碼器，則此掩碼用於交叉注意力。掩碼值在[0, 1]中選擇：- 1 表示**未被遮蔽**的標記，
- 0 表示**被遮蔽**的標記。
- past_key_values (
list[torch.FloatTensor], 可選) — 預先計算的隱藏狀態（自注意力塊和交叉注意力塊中的鍵和值），可用於加速順序解碼。這通常包括模型在解碼上一階段返回的past_key_values，當use_cache=True或config.use_cache=True時。允許兩種格式：
- 一個 Cache 例項，請參閱我們的 kv 快取指南；
- 長度為
config.n_layers的tuple(torch.FloatTensor)元組，每個元組包含 2 個形狀為(batch_size, num_heads, sequence_length, embed_size_per_head)的張量）。這也稱為舊版快取格式。
模型將輸出與輸入相同的快取格式。如果沒有傳遞
past_key_values，將返回舊版快取格式。如果使用
past_key_values，使用者可以可選地只輸入最後input_ids（那些沒有將其過去鍵值狀態提供給此模型的）的形狀(batch_size, 1)，而不是所有input_ids的形狀(batch_size, sequence_length)。 - 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），包含根據配置 (XmodConfig) 和輸入而變化的各種元素。
-
last_hidden_state (
torch.FloatTensor, 形狀為(batch_size, sequence_length, hidden_size)) — 模型最後一層輸出的隱藏狀態序列。 -
pooler_output (形狀為
(batch_size, hidden_size)的torch.FloatTensor) — 序列第一個標記（分類標記）在經過用於輔助預訓練任務的層進一步處理後的最後一層隱藏狀態。例如，對於 BERT 家族模型，這會在經過線性層和 tanh 啟用函式處理後返回分類標記。線性層權重在預訓練期間根據下一個句子預測（分類）目標進行訓練。 -
hidden_states (
tuple(torch.FloatTensor), 可選, 當傳遞output_hidden_states=True或config.output_hidden_states=True時返回) —torch.FloatTensor元組（一個用於嵌入層的輸出（如果模型有嵌入層），+ 每個層的一個輸出），形狀為(batch_size, sequence_length, hidden_size)。模型在每個層輸出的隱藏狀態以及可選的初始嵌入輸出。
-
attentions (
tuple(torch.FloatTensor), 可選, 當傳遞output_attentions=True或config.output_attentions=True時返回) —torch.FloatTensor元組（每個層一個），形狀為(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 後的注意力權重，用於計算自注意力頭中的加權平均值。
-
cross_attentions (
tuple(torch.FloatTensor), 可選, 當傳遞output_attentions=True和config.add_cross_attention=True或config.output_attentions=True時返回) —torch.FloatTensor元組（每個層一個），形狀為(batch_size, num_heads, sequence_length, sequence_length)。解碼器交叉注意力層的注意力權重，在注意力 softmax 之後，用於計算交叉注意力頭中的加權平均。
-
past_key_values (
Cache, 可選, 當傳遞use_cache=True或config.use_cache=True時返回) — 這是一個 Cache 例項。有關更多詳細資訊，請參閱我們的 kv 快取指南。包含預先計算的隱藏狀態（自注意力塊中的鍵和值，如果
config.is_encoder_decoder=True則可選地在交叉注意力塊中），可用於（參見past_key_values輸入）加速順序解碼。
XmodModel 前向方法覆蓋了 __call__ 特殊方法。
雖然前向傳遞的配方需要在此函式中定義，但隨後應呼叫 Module 例項，而不是此函式，因為前者負責執行預處理和後處理步驟，而後者則默默地忽略它們。
XmodForCausalLM
class transformers.XmodForCausalLM
< source >( config )
引數
- config (XmodForCausalLM) — 包含模型所有引數的模型配置類。用配置檔案初始化不會載入與模型相關的權重，只加載配置。請檢視 from_pretrained() 方法以載入模型權重。
X-MOD 模型，頂部帶有一個用於因果語言建模（CLM）微調的 language modeling 頭部。
該模型繼承自 PreTrainedModel。請檢視超類文件以獲取庫為其所有模型實現的一般方法（例如下載或儲存、調整輸入嵌入大小、修剪頭部等）。
該模型也是 PyTorch torch.nn.Module 子類。將其作為常規 PyTorch 模組使用，並參考 PyTorch 文件以獲取所有與一般用法和行為相關的事項。
forward
< source >( input_ids: typing.Optional[torch.LongTensor] = None lang_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 (形狀為
(batch_size, sequence_length)的torch.LongTensor, 可選) — 詞彙表中輸入序列標記的索引。預設情況下，填充將被忽略。可以使用 AutoTokenizer 獲取索引。有關詳細資訊，請參閱 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- lang_ids (形狀為
(batch_size, sequence_length)的torch.LongTensor, 可選) — 分別啟用每個樣本的語言介面卡的索引。預設值：對應於self.config.default_language的索引。 - attention_mask (形狀為
(batch_size, sequence_length)的torch.FloatTensor, 可選) — 用於避免對填充標記索引執行注意力的掩碼。在[0, 1]中選擇掩碼值：- 1 表示**未被遮蔽**的標記，
- 0 表示**被遮蔽**的標記。
- token_type_ids (形狀為
(batch_size, sequence_length)的torch.LongTensor, 可選) — 用於指示輸入的第一部分和第二部分的段標記索引。索引在[0, 1]中選擇：- 0 對應於 *句子 A* 標記，
- 1 對應於 *句子 B* 標記。
- position_ids (形狀為
(batch_size, sequence_length)的torch.LongTensor, 可選) — 每個輸入序列標記在位置嵌入中的位置索引。在[0, config.n_positions - 1]範圍內選擇。 - head_mask (形狀為
(num_heads,)或(num_layers, num_heads)的torch.FloatTensor, 可選) — 用於使自注意力模組的選定頭部無效的掩碼。掩碼值在[0, 1]中選擇：- 1 表示頭部**未被遮蔽**，
- 0 表示頭部**被遮蔽**。
- inputs_embeds (形狀為
(batch_size, sequence_length, hidden_size)的torch.FloatTensor, 可選) — 可選地，您可以透過嵌入表示直接傳遞，而不是傳遞input_ids。如果您想對如何將input_ids索引轉換為相關向量比模型的內部嵌入查詢矩陣有更多的控制，這將很有用。 - encoder_hidden_states (形狀為
(batch_size, sequence_length, hidden_size)的torch.FloatTensor, 可選) — 編碼器最後一層輸出的隱藏狀態序列。如果模型配置為解碼器，則用於交叉注意力。 - encoder_attention_mask (形狀為
(batch_size, sequence_length)的torch.FloatTensor, 可選) — 用於避免對編碼器輸入中的填充標記索引執行注意力的掩碼。如果模型配置為解碼器，則此掩碼用於交叉注意力。掩碼值在[0, 1]中選擇：- 1 表示**未被遮蔽**的標記，
- 0 表示**被遮蔽**的標記。
- labels (形狀為
(batch_size, sequence_length)的torch.LongTensor, 可選) — 用於計算從左到右語言建模損失（下一個詞預測）的標籤。索引應在[-100, 0, ..., config.vocab_size]中（請參閱input_ids文件字串）。索引設定為-100的標記將被忽略（被遮蔽），損失僅針對標籤在[0, ..., config.vocab_size]中的標記計算。 - past_key_values (
tuple[tuple[torch.FloatTensor]], 可選) — 預先計算的隱藏狀態（自注意力塊和交叉注意力塊中的鍵和值），可用於加速順序解碼。這通常包括模型在解碼上一階段返回的past_key_values，當use_cache=True或config.use_cache=True時。允許兩種格式：
- 一個 Cache 例項，請參閱我們的 kv 快取指南；
- 長度為
config.n_layers的tuple(torch.FloatTensor)元組，每個元組包含 2 個形狀為(batch_size, num_heads, sequence_length, embed_size_per_head)的張量）。這也稱為舊版快取格式。
模型將輸出與輸入相同的快取格式。如果沒有傳遞
past_key_values，將返回舊版快取格式。如果使用
past_key_values，使用者可以可選地只輸入最後input_ids（那些沒有將其過去鍵值狀態提供給此模型的）的形狀(batch_size, 1)，而不是所有input_ids的形狀(batch_size, sequence_length)。 - 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），包含根據配置（XmodConfig）和輸入而定的各種元素。
-
loss (
torch.FloatTensor形狀為(1,)，可選，當提供labels時返回) — 語言建模損失（用於下一個 token 預測）。 -
logits (形狀為
(batch_size, sequence_length, config.vocab_size)的torch.FloatTensor) — 語言建模頭部的預測分數（SoftMax 之前的每個詞彙標記的分數）。 -
hidden_states (
tuple(torch.FloatTensor), 可選, 當傳遞output_hidden_states=True或config.output_hidden_states=True時返回) —torch.FloatTensor元組（一個用於嵌入層的輸出（如果模型有嵌入層），+ 每個層的一個輸出），形狀為(batch_size, sequence_length, hidden_size)。模型在每個層輸出的隱藏狀態以及可選的初始嵌入輸出。
-
attentions (
tuple(torch.FloatTensor), 可選, 當傳遞output_attentions=True或config.output_attentions=True時返回) —torch.FloatTensor元組（每個層一個），形狀為(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 後的注意力權重，用於計算自注意力頭中的加權平均值。
-
cross_attentions (
tuple(torch.FloatTensor), 可選, 當傳入output_attentions=True或config.output_attentions=True時返回) —torch.FloatTensor的元組（每個層一個），形狀為(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 後的交叉注意力權重，用於計算交叉注意力頭中的加權平均。
-
past_key_values (
Cache, 可選, 當傳遞use_cache=True或config.use_cache=True時返回) — 這是一個 Cache 例項。有關更多詳細資訊，請參閱我們的 kv 快取指南。包含預先計算的隱藏狀態（注意力塊中的鍵和值），可用於（參見
past_key_values輸入）加速順序解碼。
XmodForCausalLM 的 forward 方法，覆蓋了 __call__ 特殊方法。
雖然前向傳遞的配方需要在此函式中定義，但隨後應呼叫 Module 例項，而不是此函式，因為前者負責執行預處理和後處理步驟，而後者則默默地忽略它們。
示例
>>> from transformers import AutoTokenizer, XmodForCausalLM, AutoConfig
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("FacebookAI/xlm-roberta-base")
>>> config = AutoConfig.from_pretrained("facebook/xmod-base")
>>> config.is_decoder = True
>>> model = XmodForCausalLM.from_pretrained("facebook/xmod-base", config=config)
>>> model.set_default_language("en_XX")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")
>>> outputs = model(**inputs)
>>> prediction_logits = outputs.logitsXmodForMaskedLM
class transformers.XmodForMaskedLM
< source >( config )
引數
- config (XmodForMaskedLM) — 包含模型所有引數的模型配置類。使用配置檔案初始化並不會載入與模型相關的權重，只會載入配置。要載入模型權重，請檢視 from_pretrained() 方法。
Xmod 模型，頂部帶有一個 語言建模 頭。
該模型繼承自 PreTrainedModel。請檢視超類文件以獲取庫為其所有模型實現的一般方法（例如下載或儲存、調整輸入嵌入大小、修剪頭部等）。
該模型也是 PyTorch torch.nn.Module 子類。將其作為常規 PyTorch 模組使用，並參考 PyTorch 文件以獲取所有與一般用法和行為相關的事項。
forward
< source >( input_ids: typing.Optional[torch.LongTensor] = None lang_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()。
- lang_ids (
torch.LongTensor形狀為(batch_size, sequence_length), 可選) — 分別表示每個樣本應啟用的語言介面卡索引。預設值：對應self.config.default_language的索引。 - attention_mask (
torch.FloatTensor形狀為(batch_size, sequence_length), 可選) — 用於避免對填充標記索引執行注意力操作的掩碼。掩碼值選擇在[0, 1]之間：- 1 表示**未被掩碼**的標記，
- 0 表示**被掩碼**的標記。
- token_type_ids (
torch.LongTensor形狀為(batch_size, sequence_length), 可選) — 分段標記索引，用於指示輸入的第一個和第二個部分。索引選擇在[0, 1]之間：- 0 對應於 句子 A 標記，
- 1 對應於 句子 B 標記。
- position_ids (
torch.LongTensor形狀為(batch_size, sequence_length), 可選) — 每個輸入序列標記在位置嵌入中的位置索引。選擇範圍在[0, config.n_positions - 1]之間。 - head_mask (
torch.FloatTensor形狀為(num_heads,)或(num_layers, num_heads), 可選) — 用於使自注意力模組的選定頭無效的掩碼。掩碼值選擇在[0, 1]之間：- 1 表示頭**未被掩碼**，
- 0 表示頭**被掩碼**。
- inputs_embeds (
torch.FloatTensor形狀為(batch_size, sequence_length, hidden_size), 可選) — 可選地，你可以選擇直接傳遞嵌入表示，而不是傳遞input_ids。如果你想對如何將input_ids索引轉換為相關向量有比模型內部嵌入查詢矩陣更多的控制，這會很有用。 - 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），包含根據配置（XmodConfig）和輸入而定的各種元素。
-
loss (形狀為
(1,)的torch.FloatTensor，可選，當提供labels時返回) — 掩碼語言建模 (MLM) 損失。 -
logits (形狀為
(batch_size, sequence_length, config.vocab_size)的torch.FloatTensor) — 語言建模頭部的預測分數（SoftMax 之前的每個詞彙標記的分數）。 -
hidden_states (
tuple(torch.FloatTensor), 可選, 當傳遞output_hidden_states=True或config.output_hidden_states=True時返回) —torch.FloatTensor元組（一個用於嵌入層的輸出（如果模型有嵌入層），+ 每個層的一個輸出），形狀為(batch_size, sequence_length, hidden_size)。模型在每個層輸出的隱藏狀態以及可選的初始嵌入輸出。
-
attentions (
tuple(torch.FloatTensor), 可選, 當傳遞output_attentions=True或config.output_attentions=True時返回) —torch.FloatTensor元組（每個層一個），形狀為(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 後的注意力權重，用於計算自注意力頭中的加權平均值。
XmodForMaskedLM 的 forward 方法，覆蓋了 __call__ 特殊方法。
雖然前向傳遞的配方需要在此函式中定義，但隨後應呼叫 Module 例項，而不是此函式，因為前者負責執行預處理和後處理步驟，而後者則默默地忽略它們。
示例
>>> from transformers import AutoTokenizer, XmodForMaskedLM
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("facebook/xmod-base")
>>> model = XmodForMaskedLM.from_pretrained("facebook/xmod-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)
...XmodForSequenceClassification
class transformers.XmodForSequenceClassification
< source >( config )
引數
- config (XmodForSequenceClassification) — 包含模型所有引數的模型配置類。使用配置檔案初始化並不會載入與模型相關的權重，只會載入配置。要載入模型權重，請檢視 from_pretrained() 方法。
X-MOD 模型 Transformer，頂部帶有一個序列分類/迴歸頭（在池化輸出之上的一層線性層），例如用於 GLUE 任務。
該模型繼承自 PreTrainedModel。請檢視超類文件以獲取庫為其所有模型實現的一般方法（例如下載或儲存、調整輸入嵌入大小、修剪頭部等）。
該模型也是 PyTorch torch.nn.Module 子類。將其作為常規 PyTorch 模組使用，並參考 PyTorch 文件以獲取所有與一般用法和行為相關的事項。
forward
< source >( input_ids: typing.Optional[torch.LongTensor] = None lang_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()。
- lang_ids (
torch.LongTensor形狀為(batch_size, sequence_length), 可選) — 分別表示每個樣本應啟用的語言介面卡索引。預設值：對應self.config.default_language的索引。 - attention_mask (
torch.FloatTensor形狀為(batch_size, sequence_length), 可選) — 用於避免對填充標記索引執行注意力操作的掩碼。掩碼值選擇在[0, 1]之間：- 1 表示**未被掩碼**的標記，
- 0 表示**被掩碼**的標記。
- token_type_ids (
torch.LongTensor形狀為(batch_size, sequence_length), 可選) — 分段標記索引，用於指示輸入的第一個和第二個部分。索引選擇在[0, 1]之間：- 0 對應於 句子 A 標記，
- 1 對應於 句子 B 標記。
- position_ids (
torch.LongTensor形狀為(batch_size, sequence_length), 可選) — 每個輸入序列標記在位置嵌入中的位置索引。選擇範圍在[0, config.n_positions - 1]之間。 - head_mask (
torch.FloatTensor形狀為(num_heads,)或(num_layers, num_heads), 可選) — 用於使自注意力模組的選定頭無效的掩碼。掩碼值選擇在[0, 1]之間：- 1 表示頭**未被掩碼**，
- 0 表示頭**被掩碼**。
- inputs_embeds (
torch.FloatTensor形狀為(batch_size, sequence_length, hidden_size), 可選) — 可選地，你可以選擇直接傳遞嵌入表示，而不是傳遞input_ids。如果你想對如何將input_ids索引轉換為相關向量有比模型內部嵌入查詢矩陣更多的控制，這會很有用。 - labels (
torch.LongTensor形狀為(batch_size,), 可選) — 用於計算序列分類/迴歸損失的標籤。索引應在[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），包含根據配置（XmodConfig）和輸入而定的各種元素。
-
loss (形狀為
(1,)的torch.FloatTensor，可選，當提供labels時返回) — 分類損失（如果 config.num_labels==1，則為迴歸損失）。 -
logits (形狀為
(batch_size, config.num_labels)的torch.FloatTensor) — 分類（如果 config.num_labels==1，則為迴歸）分數（SoftMax 之前）。 -
hidden_states (
tuple(torch.FloatTensor), 可選, 當傳遞output_hidden_states=True或config.output_hidden_states=True時返回) —torch.FloatTensor元組（一個用於嵌入層的輸出（如果模型有嵌入層），+ 每個層的一個輸出），形狀為(batch_size, sequence_length, hidden_size)。模型在每個層輸出的隱藏狀態以及可選的初始嵌入輸出。
-
attentions (
tuple(torch.FloatTensor), 可選, 當傳遞output_attentions=True或config.output_attentions=True時返回) —torch.FloatTensor元組（每個層一個），形狀為(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 後的注意力權重，用於計算自注意力頭中的加權平均值。
XmodForSequenceClassification 的 forward 方法，覆蓋了 __call__ 特殊方法。
雖然前向傳遞的配方需要在此函式中定義，但隨後應呼叫 Module 例項，而不是此函式，因為前者負責執行預處理和後處理步驟，而後者則默默地忽略它們。
單標籤分類示例
>>> import torch
>>> from transformers import AutoTokenizer, XmodForSequenceClassification
>>> tokenizer = AutoTokenizer.from_pretrained("facebook/xmod-base")
>>> model = XmodForSequenceClassification.from_pretrained("facebook/xmod-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 = XmodForSequenceClassification.from_pretrained("facebook/xmod-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, XmodForSequenceClassification
>>> tokenizer = AutoTokenizer.from_pretrained("facebook/xmod-base")
>>> model = XmodForSequenceClassification.from_pretrained("facebook/xmod-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 = XmodForSequenceClassification.from_pretrained(
... "facebook/xmod-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).lossXmodForMultipleChoice
class transformers.XmodForMultipleChoice
< source >( config )
引數
- config (XmodForMultipleChoice) — 包含模型所有引數的模型配置類。使用配置檔案初始化並不會載入與模型相關的權重，只會載入配置。要載入模型權重，請檢視 from_pretrained() 方法。
Xmod 模型，頂部帶有多項選擇分類頭（池化輸出之上的線性層和 softmax），例如用於 RocStories/SWAG 任務。
該模型繼承自 PreTrainedModel。請檢視超類文件以獲取庫為其所有模型實現的一般方法（例如下載或儲存、調整輸入嵌入大小、修剪頭部等）。
該模型也是 PyTorch torch.nn.Module 子類。將其作為常規 PyTorch 模組使用，並參考 PyTorch 文件以獲取所有與一般用法和行為相關的事項。
forward
< source >( input_ids: typing.Optional[torch.LongTensor] = None lang_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()。
- lang_ids (
torch.LongTensor形狀為(batch_size, num_choices, sequence_length), 可選) — 分別表示每個樣本應啟用的語言介面卡索引。預設值：對應self.config.default_language的索引。 - token_type_ids (
torch.LongTensor形狀為(batch_size, num_choices, sequence_length), 可選) — 分段標記索引，用於指示輸入的第一個和第二個部分。索引選擇在[0, 1]之間：- 0 對應於 句子 A 標記，
- 1 對應於 句子 B 標記。
- 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]之間。 - 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），包含根據配置（XmodConfig）和輸入而定的各種元素。
-
loss (形狀為 (1,) 的
torch.FloatTensor，可選，當提供labels時返回) — 分類損失。 -
logits (形狀為
(batch_size, num_choices)的torch.FloatTensor) — num_choices 是輸入張量的第二維大小。（請參閱上面的 input_ids）。分類分數（SoftMax 之前）。
-
hidden_states (
tuple(torch.FloatTensor), 可選, 當傳遞output_hidden_states=True或config.output_hidden_states=True時返回) —torch.FloatTensor元組（一個用於嵌入層的輸出（如果模型有嵌入層），+ 每個層的一個輸出），形狀為(batch_size, sequence_length, hidden_size)。模型在每個層輸出的隱藏狀態以及可選的初始嵌入輸出。
-
attentions (
tuple(torch.FloatTensor), 可選, 當傳遞output_attentions=True或config.output_attentions=True時返回) —torch.FloatTensor元組（每個層一個），形狀為(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 後的注意力權重，用於計算自注意力頭中的加權平均值。
XmodForMultipleChoice 的 forward 方法，覆蓋了 __call__ 特殊方法。
雖然前向傳遞的配方需要在此函式中定義，但隨後應呼叫 Module 例項，而不是此函式，因為前者負責執行預處理和後處理步驟，而後者則默默地忽略它們。
示例
>>> from transformers import AutoTokenizer, XmodForMultipleChoice
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("facebook/xmod-base")
>>> model = XmodForMultipleChoice.from_pretrained("facebook/xmod-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.logitsXmodForTokenClassification
class transformers.XmodForTokenClassification
< source >( config )
引數
- config (XmodForTokenClassification) — 包含模型所有引數的模型配置類。使用配置檔案初始化並不會載入與模型相關的權重，只會載入配置。要載入模型權重，請檢視 from_pretrained() 方法。
Xmod Transformer，頂部帶有一個標記分類頭（在隱藏狀態輸出之上的線性層），例如用於命名實體識別（NER）任務。
該模型繼承自 PreTrainedModel。請檢視超類文件以獲取庫為其所有模型實現的一般方法（例如下載或儲存、調整輸入嵌入大小、修剪頭部等）。
該模型也是 PyTorch torch.nn.Module 子類。將其作為常規 PyTorch 模組使用，並參考 PyTorch 文件以獲取所有與一般用法和行為相關的事項。
forward
< source >( input_ids: typing.Optional[torch.LongTensor] = None lang_ids: typing.Optional[torch.LongTensor] = None attention_mask: typing.Optional[torch.FloatTensor] = None token_type_ids: typing.Optional[torch.LongTensor] = None position_ids: typing.Optional[torch.LongTensor] = None head_mask: typing.Optional[torch.FloatTensor] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None labels: typing.Optional[torch.LongTensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.modeling_outputs.TokenClassifierOutput 或 tuple(torch.FloatTensor)
引數
- input_ids (
torch.LongTensor，形狀為(batch_size, sequence_length)，可選) — 詞彙表中輸入序列 token 的索引。預設情況下，填充將被忽略。索引可以透過 AutoTokenizer 獲取。詳情請參閱 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- lang_ids (
torch.LongTensor，形狀為(batch_size, sequence_length)，可選) — 對應於每個樣本應啟用的語言介面卡的索引。預設值：與self.config.default_language對應的索引。 - attention_mask (
torch.FloatTensor，形狀為(batch_size, sequence_length)，可選) — 遮罩，用於避免對填充 token 索引執行注意力操作。遮罩值選擇在[0, 1]之間：- 1 表示 token 未被遮罩，
- 0 表示 token 已被遮罩。
- token_type_ids (
torch.LongTensor，形狀為(batch_size, sequence_length)，可選) — 分段 token 索引，用於指示輸入的第一個和第二個部分。索引在[0, 1]中選擇：- 0 對應於 句子 A 的 token，
- 1 對應於 句子 B 的 token。
- position_ids (
torch.LongTensor，形狀為(batch_size, sequence_length)，可選) — 每個輸入序列 token 在位置嵌入中的位置索引。選擇範圍為[0, config.n_positions - 1]。 - head_mask (
torch.FloatTensor，形狀為(num_heads,)或(num_layers, num_heads)，可選) — 遮罩，用於將自注意力模組的選定頭部置零。遮罩值選擇在[0, 1]之間：- 1 表示頭部未被遮罩，
- 0 表示頭部已被遮罩。
- inputs_embeds (
torch.FloatTensor，形狀為(batch_size, sequence_length, hidden_size)，可選) — 可選地，您可以選擇直接傳入嵌入表示，而不是傳入input_ids。如果您希望對如何將input_ids索引轉換為相關向量有比模型內部嵌入查詢矩陣更多的控制，這會很有用。 - labels (
torch.LongTensor，形狀為(batch_size, sequence_length)，可選) — 用於計算 token 分類損失的標籤。索引應在[0, ..., config.num_labels - 1]之間。 - output_attentions (
bool，可選) — 是否返回所有注意力層的注意力張量。更多詳情請參閱返回張量中的attentions。 - output_hidden_states (
bool，可選) — 是否返回所有層的隱藏狀態。更多詳情請參閱返回張量中的hidden_states。 - return_dict (
bool，可選) — 是否返回 ModelOutput 而不是普通的元組。
返回
transformers.modeling_outputs.TokenClassifierOutput 或 tuple(torch.FloatTensor)
一個 transformers.modeling_outputs.TokenClassifierOutput 或 torch.FloatTensor 的元組（如果傳入 return_dict=False 或當 config.return_dict=False 時），包含根據配置（XmodConfig）和輸入的不同元素。
-
loss (形狀為
(1,)的torch.FloatTensor，可選，當提供labels時返回) — 分類損失。 -
logits (形狀為
(batch_size, sequence_length, config.num_labels)的torch.FloatTensor) — 分類分數（SoftMax 之前）。 -
hidden_states (
tuple(torch.FloatTensor), 可選, 當傳遞output_hidden_states=True或config.output_hidden_states=True時返回) —torch.FloatTensor元組（一個用於嵌入層的輸出（如果模型有嵌入層），+ 每個層的一個輸出），形狀為(batch_size, sequence_length, hidden_size)。模型在每個層輸出的隱藏狀態以及可選的初始嵌入輸出。
-
attentions (
tuple(torch.FloatTensor), 可選, 當傳遞output_attentions=True或config.output_attentions=True時返回) —torch.FloatTensor元組（每個層一個），形狀為(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 後的注意力權重，用於計算自注意力頭中的加權平均值。
XmodForTokenClassification 的 forward 方法，覆蓋了 __call__ 特殊方法。
雖然前向傳遞的配方需要在此函式中定義，但隨後應呼叫 Module 例項，而不是此函式，因為前者負責執行預處理和後處理步驟，而後者則默默地忽略它們。
示例
>>> from transformers import AutoTokenizer, XmodForTokenClassification
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("facebook/xmod-base")
>>> model = XmodForTokenClassification.from_pretrained("facebook/xmod-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)
...XmodForQuestionAnswering
class transformers.XmodForQuestionAnswering
< 源 >( config )
引數
- config (XmodForQuestionAnswering) — 模型的配置類，包含模型的所有引數。使用配置檔案初始化並不會載入與模型相關的權重，只加載配置。請檢視 from_pretrained() 方法來載入模型權重。
Xmod Transformer，頂部帶有用於 SQuAD 等抽取式問答任務的 span 分類頭（在隱藏狀態輸出之上有一個線性層，用於計算 span start logits 和 span end logits）。
該模型繼承自 PreTrainedModel。請檢視超類文件以獲取庫為其所有模型實現的一般方法（例如下載或儲存、調整輸入嵌入大小、修剪頭部等）。
該模型也是 PyTorch torch.nn.Module 子類。將其作為常規 PyTorch 模組使用，並參考 PyTorch 文件以獲取所有與一般用法和行為相關的事項。
forward
< 源 >( input_ids: typing.Optional[torch.LongTensor] = None lang_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)，可選) — 詞彙表中輸入序列 token 的索引。預設情況下，填充將被忽略。索引可以透過 AutoTokenizer 獲取。詳情請參閱 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- lang_ids (
torch.LongTensor，形狀為(batch_size, sequence_length)，可選) — 對應於每個樣本應啟用的語言介面卡的索引。預設值：與self.config.default_language對應的索引。 - attention_mask (
torch.FloatTensor，形狀為(batch_size, sequence_length)，可選) — 遮罩，用於避免對填充 token 索引執行注意力操作。遮罩值選擇在[0, 1]之間：- 1 表示 token 未被遮罩，
- 0 表示 token 已被遮罩。
- token_type_ids (
torch.LongTensor，形狀為(batch_size, sequence_length)，可選) — 分段 token 索引，用於指示輸入的第一個和第二個部分。索引在[0, 1]中選擇：- 0 對應於 句子 A 的 token，
- 1 對應於 句子 B 的 token。
- position_ids (
torch.LongTensor，形狀為(batch_size, sequence_length)，可選) — 每個輸入序列 token 在位置嵌入中的位置索引。選擇範圍為[0, config.n_positions - 1]。 - head_mask (
torch.FloatTensor，形狀為(num_heads,)或(num_layers, num_heads)，可選) — 遮罩，用於將自注意力模組的選定頭部置零。遮罩值選擇在[0, 1]之間：- 1 表示頭部未被遮罩，
- 0 表示頭部已被遮罩。
- inputs_embeds (
torch.FloatTensor，形狀為(batch_size, sequence_length, hidden_size)，可選) — 可選地，您可以選擇直接傳入嵌入表示，而不是傳入input_ids。如果您希望對如何將input_ids索引轉換為相關向量有比模型內部嵌入查詢矩陣更多的控制，這會很有用。 - start_positions (
torch.LongTensor，形狀為(batch_size,)，可選) — 用於計算 token 分類損失的標註 span 起始位置（索引）的標籤。位置將被限制為序列的長度（sequence_length）。序列外的位置在計算損失時不予考慮。 - end_positions (
torch.LongTensor，形狀為(batch_size,)，可選) — 用於計算 token 分類損失的標註 span 結束位置（索引）的標籤。位置將被限制為序列的長度（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 時），包含根據配置（XmodConfig）和輸入的不同元素。
-
loss (
torch.FloatTensorof shape(1,), 可選, 當提供labels時返回) — 總範圍提取損失是起始位置和結束位置的交叉熵之和。 -
start_logits (
torch.FloatTensorof shape(batch_size, sequence_length)) — 範圍起始分數（SoftMax 之前）。 -
end_logits (
torch.FloatTensorof shape(batch_size, sequence_length)) — 範圍結束分數（SoftMax 之前）。 -
hidden_states (
tuple(torch.FloatTensor), 可選, 當傳遞output_hidden_states=True或config.output_hidden_states=True時返回) —torch.FloatTensor元組（一個用於嵌入層的輸出（如果模型有嵌入層），+ 每個層的一個輸出），形狀為(batch_size, sequence_length, hidden_size)。模型在每個層輸出的隱藏狀態以及可選的初始嵌入輸出。
-
attentions (
tuple(torch.FloatTensor), 可選, 當傳遞output_attentions=True或config.output_attentions=True時返回) —torch.FloatTensor元組（每個層一個），形狀為(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 後的注意力權重，用於計算自注意力頭中的加權平均值。
XmodForQuestionAnswering 的 forward 方法，覆蓋了 __call__ 特殊方法。
雖然前向傳遞的配方需要在此函式中定義，但隨後應呼叫 Module 例項，而不是此函式，因為前者負責執行預處理和後處理步驟，而後者則默默地忽略它們。
示例
>>> from transformers import AutoTokenizer, XmodForQuestionAnswering
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("facebook/xmod-base")
>>> model = XmodForQuestionAnswering.from_pretrained("facebook/xmod-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)
...