Transformers 文件
DeBERTa
並獲得增強的文件體驗
開始使用
DeBERTa
概述
DeBERTa 模型由 Pengcheng He、Xiaodong Liu、Jianfeng Gao 和 Weizhu Chen 在論文 DeBERTa: Decoding-enhanced BERT with Disentangled Attention 中提出。它基於谷歌於 2018 年釋出的 BERT 模型和 Facebook 於 2019 年釋出的 RoBERTa 模型。
它在 RoBERTa 的基礎上,增加了解耦注意力機制和增強的掩碼解碼器,並使用 RoBERTa 一半的資料進行訓練。
論文摘要如下:
預訓練神經語言模型的最新進展顯著提高了許多自然語言處理 (NLP) 任務的效能。在本文中,我們提出了一種新的模型架構 DeBERTa (Decoding-enhanced BERT with disentangled attention),它透過兩種新穎的技術改進了 BERT 和 RoBERTa 模型。第一種是解耦注意力機制,其中每個詞都由兩個向量表示,分別編碼其內容和位置,詞之間的注意力權重是使用其內容和相對位置上的解耦矩陣計算的。第二種是使用增強型掩碼解碼器來替換輸出的 softmax 層,以預測被掩蓋的詞元進行模型預訓練。我們證明了這兩種技術顯著提高了模型預訓練的效率和下游任務的效能。與 RoBERTa-Large 相比,使用一半訓練資料訓練的 DeBERTa 模型在一系列 NLP 任務上始終表現更優,在 MNLI 上提升了 0.9% (90.2% vs. 91.1%),在 SQuAD v2.0 上提升了 2.3% (88.4% vs. 90.7%),在 RACE 上提升了 3.6% (83.2% vs. 86.8%)。DeBERTa 的程式碼和預訓練模型將在 https://github.com/microsoft/DeBERTa 上公開發布。
該模型由 DeBERTa 貢獻。該模型的 TF 2.0 實現由 kamalkraj 貢獻。原始程式碼可以在這裡找到。
資源
一份 Hugging Face 官方和社群(以 🌎 標識)的資源列表,幫助您開始使用 DeBERTa。如果您有興趣提交資源以包含在此處,請隨時發起 Pull Request,我們將進行稽核!資源最好能展示一些新東西,而不是重複現有資源。
- 一篇關於如何使用 DeBERTa 透過 DeepSpeed 加速大模型訓練 的博文。
- 一篇關於如何使用 DeBERTa 透過機器學習增強客戶服務 的博文。
- DebertaForSequenceClassification 受此示例指令碼和筆記本支援。
- TFDebertaForSequenceClassification 受此示例指令碼和筆記本支援。
- 文字分類任務指南
- DebertaForTokenClassification 受此示例指令碼和筆記本支援。
- TFDebertaForTokenClassification 受此示例指令碼和筆記本支援。
- 🤗 Hugging Face課程的詞元分類章節。
- 🤗 Hugging Face 課程的位元組對編碼 (Byte-Pair Encoding) 分詞章節。
- Token分類任務指南
- DebertaForMaskedLM 受此示例指令碼和筆記本支援。
- TFDebertaForMaskedLM 受此示例指令碼和筆記本支援。
- 🤗 Hugging Face課程的掩碼語言建模章節。
- 掩碼語言建模任務指南
- DebertaForQuestionAnswering 受此示例指令碼和筆記本支援。
- TFDebertaForQuestionAnswering 受此示例指令碼和筆記本支援。
- 🤗 Hugging Face課程的問答章節。
- 問答任務指南
DebertaConfig
class transformers.DebertaConfig
< 來源 >( vocab_size = 50265 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 = 0 initializer_range = 0.02 layer_norm_eps = 1e-07 relative_attention = False max_relative_positions = -1 pad_token_id = 0 position_biased_input = True pos_att_type = None pooler_dropout = 0 pooler_hidden_act = 'gelu' legacy = True **kwargs )
引數
- vocab_size (
int
, 可選, 預設為 50265) — DeBERTa 模型的詞彙表大小。定義了在呼叫 DebertaModel 或 TFDebertaModel 時傳入的 `inputs_ids` 可以表示的不同詞元的數量。 - 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"
,"tanh"
,"gelu_fast"
,"mish"
,"linear"
,"sigmoid"
和"gelu_new"
。 - hidden_dropout_prob (
float
, 可選, 預設為 0.1) — 嵌入層、編碼器和池化層中所有全連線層的丟棄機率。 - attention_probs_dropout_prob (
float
, 可選, 預設為 0.1) — 注意力機率的丟棄率。 - max_position_embeddings (
int
, 可選, 預設為 512) — 該模型可能使用的最大序列長度。通常將其設定為較大的值以備不時之需(例如 512、1024 或 2048)。 - type_vocab_size (
int
, 可選, 預設為 0) — 呼叫 DebertaModel 或 TFDebertaModel 時傳入的 `token_type_ids` 的詞彙表大小。 - initializer_range (
float
, 可選, 預設為 0.02) — 用於初始化所有權重矩陣的 truncated_normal_initializer 的標準差。 - layer_norm_eps (
float
, 可選, 預設為 1e-12) — 層歸一化層使用的 epsilon 值。 - relative_attention (
bool
, 可選, 預設為False
) — 是否使用相對位置編碼。 - max_relative_positions (
int
, 可選, 預設為 1) — 相對位置的範圍 `[-max_position_embeddings, max_position_embeddings]`。使用與 `max_position_embeddings` 相同的值。 - pad_token_id (
int
, 可選, 預設為 0) — 用於填充 input_ids 的值。 - position_biased_input (
bool
, 可選, 預設為True
) — 是否將絕對位置嵌入新增到內容嵌入中。 - pos_att_type (
list[str]
, 可選) — 相對位置注意力的型別,可以是["p2c", "c2p"]
的組合,例如["p2c"]
、["p2c", "c2p"]
。 - layer_norm_eps (
float
, 可選, 預設為 1e-12) — 層歸一化層使用的 epsilon 值。 - legacy (
bool
, 可選, 預設為True
) — 模型是否應使用傳統的 `LegacyDebertaOnlyMLMHead`,該頭部在掩碼填充任務中無法正常工作。
這是用於儲存 DebertaModel 或 TFDebertaModel 配置的配置類。它用於根據指定的引數例項化一個 DeBERTa 模型,定義模型架構。使用預設值例項化配置將產生與 DeBERTa microsoft/deberta-base 架構類似的配置。
配置物件繼承自 PretrainedConfig,可用於控制模型輸出。更多資訊請閱讀 PretrainedConfig 的文件。
示例
>>> from transformers import DebertaConfig, DebertaModel
>>> # Initializing a DeBERTa microsoft/deberta-base style configuration
>>> configuration = DebertaConfig()
>>> # Initializing a model (with random weights) from the microsoft/deberta-base style configuration
>>> model = DebertaModel(configuration)
>>> # Accessing the model configuration
>>> configuration = model.config
DebertaTokenizer
class transformers.DebertaTokenizer
< 來源 >( vocab_file merges_file errors = 'replace' bos_token = '[CLS]' eos_token = '[SEP]' sep_token = '[SEP]' cls_token = '[CLS]' unk_token = '[UNK]' pad_token = '[PAD]' mask_token = '[MASK]' add_prefix_space = False add_bos_token = False **kwargs )
引數
- vocab_file (
str
) — 詞彙表文件的路徑。 - merges_file (
str
) — 合併檔案的路徑。 - errors (
str
, 可選, 預設為"replace"
) — 將位元組解碼為 UTF-8 時遵循的正規化。有關更多資訊,請參閱 bytes.decode。 - bos_token (
str
, 可選, 預設為"[CLS]"
) — 序列開始的詞元。 - eos_token (
str
, 可選, 預設為"[SEP]"
) — 序列結束的詞元。 - sep_token (
str
, 可選, 預設為"[SEP]"
) — 分隔符標記,當從多個序列構建一個序列時使用,例如用於序列分類的兩個序列,或用於問答任務的文字和問題。它也用作使用特殊標記構建的序列的最後一個標記。 - cls_token (
str
, 可選, 預設為"[CLS]"
) — 分類符標記,用於序列分類(對整個序列進行分類,而不是對每個標記進行分類)。當使用特殊標記構建序列時,它是序列的第一個標記。 - unk_token (
str
, 可選, 預設為"[UNK]"
) — 未知標記。不在詞彙表中的標記無法轉換為 ID,將被設定為此標記。 - pad_token (
str
, 可選, 預設為"[PAD]"
) — 用於填充的標記,例如在批處理不同長度的序列時。 - mask_token (
str
, 可選, 預設為"[MASK]"
) — 用於掩碼值的標記。這是使用掩碼語言建模訓練此模型時使用的標記。這是模型將嘗試預測的標記。 - add_prefix_space (
bool
, 可選, 預設為False
) — 是否在輸入前新增一個初始空格。這允許將開頭的單詞像其他任何單詞一樣處理。(Deberta 分詞器透過前面的空格檢測單詞的開頭)。 - add_bos_token (
bool
, 可選, 預設為False
) — 是否在輸入前新增一個初始的 <|endoftext|>。這允許將開頭的單詞像其他任何單詞一樣處理。
構建一個 DeBERTa 分詞器。基於位元組級的位元組對編碼(Byte-Pair-Encoding)。
這個分詞器經過訓練,將空格視為詞元的一部分(有點像 sentencepiece),所以一個詞會
無論是否在句子開頭(無空格),編碼方式都會不同
>>> from transformers import DebertaTokenizer
>>> tokenizer = DebertaTokenizer.from_pretrained("microsoft/deberta-base")
>>> tokenizer("Hello world")["input_ids"]
[1, 31414, 232, 2]
>>> tokenizer(" Hello world")["input_ids"]
[1, 20920, 232, 2]
您可以透過在例項化此分詞器時或在對某些文字呼叫它時傳遞 add_prefix_space=True
來繞過此行為,但由於模型並非以這種方式進行預訓練,這可能會導致效能下降。
當與 is_split_into_words=True
一起使用時,此分詞器會在每個詞(甚至是第一個詞)之前新增一個空格。
該分詞器繼承自 PreTrainedTokenizer,其中包含了大部分主要方法。使用者應參考此超類以獲取有關這些方法的更多資訊。
build_inputs_with_special_tokens
< source >( token_ids_0: list token_ids_1: typing.Optional[list[int]] = None ) → List[int]
透過連線和新增特殊標記,從一個序列或一對序列為序列分類任務構建模型輸入。DeBERTa 序列具有以下格式:
- 單個序列:[CLS] X [SEP]
- 序列對:[CLS] A [SEP] B [SEP]
get_special_tokens_mask
< source >( token_ids_0: list token_ids_1: typing.Optional[list[int]] = None already_has_special_tokens: bool = False ) → List[int]
從未新增特殊令牌的令牌列表中檢索序列 ID。使用分詞器 prepare_for_model
或 encode_plus
方法新增特殊令牌時會呼叫此方法。
create_token_type_ids_from_sequences
< source >( token_ids_0: list token_ids_1: typing.Optional[list[int]] = None ) → list[int]
建立與傳入序列對應的標記型別 ID。什麼是標記型別 ID?
如果模型有特殊的構建方式,應在子類中重寫此方法。
DebertaTokenizerFast
class transformers.DebertaTokenizerFast
< source >( vocab_file = None merges_file = None tokenizer_file = None errors = 'replace' bos_token = '[CLS]' eos_token = '[SEP]' sep_token = '[SEP]' cls_token = '[CLS]' unk_token = '[UNK]' pad_token = '[PAD]' mask_token = '[MASK]' add_prefix_space = False **kwargs )
引數
- vocab_file (
str
, 可選) — 詞彙表文件的路徑。 - merges_file (
str
, 可選) — 合併檔案的路徑。 - tokenizer_file (
str
, 可選) — 要使用的分詞器檔案的路徑,而不是詞彙表文件。 - errors (
str
, 可選, 預設為"replace"
) — 解碼位元組為 UTF-8 時遵循的正規化。有關更多資訊,請參閱 bytes.decode。 - bos_token (
str
, 可選, 預設為"[CLS]"
) — 序列開始標記。 - eos_token (
str
, 可選, 預設為"[SEP]"
) — 序列結束標記。 - sep_token (
str
, 可選, 預設為"[SEP]"
) — 分隔符標記,當從多個序列構建一個序列時使用,例如用於序列分類的兩個序列,或用於問答任務的文字和問題。它也用作使用特殊標記構建的序列的最後一個標記。 - cls_token (
str
, 可選, 預設為"[CLS]"
) — 分類符標記,用於序列分類(對整個序列進行分類,而不是對每個標記進行分類)。當使用特殊標記構建序列時,它是序列的第一個標記。 - unk_token (
str
, 可選, 預設為"[UNK]"
) — 未知標記。不在詞彙表中的標記無法轉換為 ID,將被設定為此標記。 - pad_token (
str
, 可選, 預設為"[PAD]"
) — 用於填充的標記,例如在批處理不同長度的序列時。 - mask_token (
str
, 可選, 預設為"[MASK]"
) — 用於掩碼值的標記。這是使用掩碼語言建模訓練此模型時使用的標記。這是模型將嘗試預測的標記。 - add_prefix_space (
bool
, 可選, 預設為False
) — 是否在輸入前新增一個初始空格。這允許將開頭的單詞像其他任何單詞一樣處理。(Deberta 分詞器透過前面的空格檢測單詞的開頭)。
構建一個“快速”的 DeBERTa 分詞器(由 HuggingFace 的 *tokenizers* 庫支援)。基於位元組級的位元組對編碼(Byte-Pair-Encoding)。
這個分詞器經過訓練,將空格視為詞元的一部分(有點像 sentencepiece),所以一個詞會
無論是否在句子開頭(無空格),編碼方式都會不同
>>> from transformers import DebertaTokenizerFast
>>> tokenizer = DebertaTokenizerFast.from_pretrained("microsoft/deberta-base")
>>> tokenizer("Hello world")["input_ids"]
[1, 31414, 232, 2]
>>> tokenizer(" Hello world")["input_ids"]
[1, 20920, 232, 2]
您可以透過在例項化此分詞器時傳遞 add_prefix_space=True
來繞過此行為,但由於模型並非以此方式進行預訓練,這可能會導致效能下降。
當與 is_split_into_words=True
一起使用時,此分詞器需要以 add_prefix_space=True
進行例項化。
該分詞器繼承自 PreTrainedTokenizerFast,其中包含了大部分主要方法。使用者應參考此超類以獲取有關這些方法的更多資訊。
build_inputs_with_special_tokens
< source >( token_ids_0: list token_ids_1: typing.Optional[list[int]] = None ) → List[int]
透過連線和新增特殊標記,從一個序列或一對序列為序列分類任務構建模型輸入。DeBERTa 序列具有以下格式:
- 單個序列:[CLS] X [SEP]
- 序列對:[CLS] A [SEP] B [SEP]
create_token_type_ids_from_sequences
< source >( token_ids_0: list token_ids_1: typing.Optional[list[int]] = None ) → list[int]
建立與傳入序列對應的標記型別 ID。什麼是標記型別 ID?
如果模型有特殊的構建方式,應在子類中重寫此方法。
DebertaModel
class transformers.DebertaModel
< source >( config )
引數
- config (DebertaModel) — 包含模型所有引數的模型配置類。使用配置檔案進行初始化不會載入與模型相關的權重,只會載入配置。請檢視 from_pretrained() 方法來載入模型權重。
原始的 Deberta 模型,輸出原始的隱藏狀態,頂部沒有任何特定的頭。
該模型繼承自 PreTrainedModel。請檢視超類文件,瞭解該庫為所有模型實現的通用方法(例如下載或儲存、調整輸入嵌入大小、修剪頭部等)。
該模型也是一個 PyTorch torch.nn.Module 子類。可以像常規 PyTorch 模組一樣使用它,並參考 PyTorch 文件瞭解所有與通用用法和行為相關的事項。
forward
< source >( 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 inputs_embeds: typing.Optional[torch.Tensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.modeling_outputs.BaseModelOutput 或 tuple(torch.FloatTensor)
引數
- input_ids (
torch.Tensor
,形狀為(batch_size, sequence_length)
,可選) — 詞彙表中輸入序列標記的索引。預設情況下,填充將被忽略。可以使用 AutoTokenizer 獲取索引。有關詳細資訊,請參閱 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensor
,形狀為(batch_size, sequence_length)
,可選) — 用於避免對填充標記索引執行注意力計算的掩碼。掩碼值在[0, 1]
中選擇:- 1 表示標記未被掩碼,
- 0 表示標記被掩碼。
- token_type_ids (
torch.Tensor
,形狀為(batch_size, sequence_length)
,可選) — 用於指示輸入的第一和第二部分的段標記索引。索引在[0, 1]
中選擇:- 0 對應於*句子 A* 的標記,
- 1 對應於*句子 B* 的標記。
- position_ids (
torch.Tensor
,形狀為(batch_size, sequence_length)
,可選) — 位置嵌入中每個輸入序列標記的位置索引。在範圍[0, config.n_positions - 1]
中選擇。 - inputs_embeds (
torch.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 而不是一個普通的元組。
返回
transformers.modeling_outputs.BaseModelOutput 或 tuple(torch.FloatTensor)
一個 transformers.modeling_outputs.BaseModelOutput 或一個 torch.FloatTensor
的元組(如果傳遞 `return_dict=False` 或當 `config.return_dict=False` 時),包含各種元素,具體取決於配置(DebertaConfig)和輸入。
-
last_hidden_state (
torch.FloatTensor
, 形狀為(batch_size, sequence_length, hidden_size)
) — 模型最後一層輸出的隱藏狀態序列。 -
hidden_states (
tuple(torch.FloatTensor)
, 可選, 當傳遞 `output_hidden_states=True` 或當 `config.output_hidden_states=True` 時返回) —torch.FloatTensor
的元組(一個是嵌入層的輸出,如果模型有嵌入層,+ 每個層的輸出),形狀為 `(batch_size, sequence_length, hidden_size)`。模型在每個層輸出的隱藏狀態以及可選的初始嵌入輸出。
-
attentions (
tuple(torch.FloatTensor)
, 可選,當傳入 `output_attentions=True` 或 `config.output_attentions=True` 時返回) — `torch.FloatTensor` 的元組(每層一個),形狀為 `(batch_size, num_heads, sequence_length, sequence_length)`。注意力 softmax 後的注意力權重,用於計算自注意力頭中的加權平均值。
DebertaModel 的 forward 方法重寫了 `__call__` 特殊方法。
儘管前向傳播的流程需要在此函式中定義,但之後應呼叫 `Module` 例項而不是此函式,因為前者會處理前處理和後處理步驟,而後者則會靜默地忽略它們。
DebertaPreTrainedModel
class transformers.DebertaPreTrainedModel
< source >( config: PretrainedConfig *inputs **kwargs )
引數
- config (PretrainedConfig) — 包含模型所有引數的模型配置類。使用配置檔案進行初始化不會載入與模型相關的權重,只會載入配置。請檢視 from_pretrained() 方法來載入模型權重。
該模型繼承自 PreTrainedModel。請檢視超類文件,瞭解該庫為所有模型實現的通用方法(例如下載或儲存、調整輸入嵌入大小、修剪頭部等)。
該模型也是一個 PyTorch torch.nn.Module 子類。可以像常規 PyTorch 模組一樣使用它,並參考 PyTorch 文件瞭解所有與通用用法和行為相關的事項。
DebertaForMaskedLM
class transformers.DebertaForMaskedLM
< source >( config )
引數
- config (DebertaForMaskedLM) — 包含模型所有引數的模型配置類。使用配置檔案進行初始化不會載入與模型相關的權重,只會載入配置。請檢視 from_pretrained() 方法來載入模型權重。
帶有 `language modeling` 頭的 Deberta 模型。
該模型繼承自 PreTrainedModel。請檢視超類文件,瞭解該庫為所有模型實現的通用方法(例如下載或儲存、調整輸入嵌入大小、修剪頭部等)。
該模型也是一個 PyTorch torch.nn.Module 子類。可以像常規 PyTorch 模組一樣使用它,並參考 PyTorch 文件瞭解所有與通用用法和行為相關的事項。
forward
< source >( 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 inputs_embeds: typing.Optional[torch.Tensor] = None labels: typing.Optional[torch.Tensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.modeling_outputs.MaskedLMOutput 或 tuple(torch.FloatTensor)
引數
- input_ids (
torch.Tensor
,形狀為 `(batch_size, sequence_length)`,可選) — 詞彙表中輸入序列標記的索引。預設情況下,填充將被忽略。可以使用 AutoTokenizer 獲取索引。有關詳細資訊,請參閱 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensor
,形狀為 `(batch_size, sequence_length)`,可選) — 用於避免對填充標記索引執行注意力機制的掩碼。掩碼值選自 `[0, 1]`:- 1 表示**未被掩碼**的標記,
- 0 表示**被掩碼**的標記。
- token_type_ids (
torch.Tensor
,形狀為 `(batch_size, sequence_length)`,可選) — 段標記索引,用於指示輸入的第一部分和第二部分。索引選自 `[0, 1]`:- 0 對應於*句子 A*的標記,
- 1 對應於*句子 B*的標記。
- position_ids (
torch.Tensor
,形狀為 `(batch_size, sequence_length)`,可選) — 每個輸入序列標記在位置嵌入中的位置索引。選自 `[0, config.n_positions - 1]` 範圍。 - inputs_embeds (
torch.Tensor
,形狀為 `(batch_size, sequence_length, hidden_size)`,可選) — (可選)你可以選擇直接傳遞嵌入表示,而不是傳遞 `input_ids`。如果你希望比模型內部的嵌入查詢矩陣更能控制如何將 `input_ids` 索引轉換為相關向量,這會很有用。 - labels (
torch.LongTensor
,形狀為 `(batch_size, sequence_length)`,可選) — 用於計算掩碼語言建模損失的標籤。索引應在 `[-100, 0, ..., config.vocab_size]` 範圍內(參見 `input_ids` 文件字串)。索引設定為 `-100` 的標記將被忽略(掩碼),損失僅針對標籤在 `[0, ..., config.vocab_size]` 範圍內的標記進行計算。 - output_attentions (
bool
, 可選) — 是否返回所有注意力層的注意力張量。有關更多詳細資訊,請參閱返回張量下的 `attentions`。 - output_hidden_states (
bool
, 可選) — 是否返回所有層的隱藏狀態。有關更多詳細資訊,請參閱返回張量下的 `hidden_states`。 - return_dict (
bool
, 可選) — 是否返回一個 ModelOutput 而不是一個普通的元組。
返回
transformers.modeling_outputs.MaskedLMOutput 或 tuple(torch.FloatTensor)
一個 transformers.modeling_outputs.MaskedLMOutput 或一個 `torch.FloatTensor` 的元組(如果傳入 `return_dict=False` 或 `config.return_dict=False`),包含各種元素,具體取決於配置 (DebertaConfig) 和輸入。
-
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 後的注意力權重,用於計算自注意力頭中的加權平均值。
DebertaForMaskedLM 的 forward 方法重寫了 `__call__` 特殊方法。
儘管前向傳播的流程需要在此函式中定義,但之後應呼叫 `Module` 例項而不是此函式,因為前者會處理前處理和後處理步驟,而後者則會靜默地忽略它們。
示例
>>> from transformers import AutoTokenizer, DebertaForMaskedLM
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("microsoft/deberta-base")
>>> model = DebertaForMaskedLM.from_pretrained("microsoft/deberta-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)
...
DebertaForSequenceClassification
class transformers.DebertaForSequenceClassification
< source >( config )
引數
- config (DebertaForSequenceClassification) — 包含模型所有引數的模型配置類。使用配置檔案進行初始化不會載入與模型相關的權重,只會載入配置。請檢視 from_pretrained() 方法來載入模型權重。
DeBERTa 模型 transformer,其頂部帶有一個序列分類/迴歸頭(一個在池化輸出之上的線性層),例如用於 GLUE 任務。
該模型繼承自 PreTrainedModel。請檢視超類文件,瞭解該庫為所有模型實現的通用方法(例如下載或儲存、調整輸入嵌入大小、修剪頭部等)。
該模型也是一個 PyTorch torch.nn.Module 子類。可以像常規 PyTorch 模組一樣使用它,並參考 PyTorch 文件瞭解所有與通用用法和行為相關的事項。
forward
< source >( input_ids: typing.Optional[torch.Tensor] = None attention_mask: typing.Optional[torch.Tensor] = None token_type_ids: typing.Optional[torch.Tensor] = None position_ids: typing.Optional[torch.Tensor] = None inputs_embeds: typing.Optional[torch.Tensor] = None labels: typing.Optional[torch.Tensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.modeling_outputs.SequenceClassifierOutput 或 tuple(torch.FloatTensor)
引數
- input_ids (
torch.Tensor
,形狀為 `(batch_size, sequence_length)`,可選) — 詞彙表中輸入序列標記的索引。預設情況下,填充將被忽略。可以使用 AutoTokenizer 獲取索引。有關詳細資訊,請參閱 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensor
,形狀為 `(batch_size, sequence_length)`,可選) — 用於避免對填充標記索引執行注意力機制的掩碼。掩碼值選自 `[0, 1]`:- 1 表示**未被掩碼**的標記,
- 0 表示**被掩碼**的標記。
- token_type_ids (
torch.Tensor
,形狀為 `(batch_size, sequence_length)`,可選) — 段標記索引,用於指示輸入的第一部分和第二部分。索引選自 `[0, 1]`:- 0 對應於*句子 A*的標記,
- 1 對應於*句子 B*的標記。
- position_ids (
torch.Tensor
,形狀為 `(batch_size, sequence_length)`,可選) — 每個輸入序列標記在位置嵌入中的位置索引。選自 `[0, config.n_positions - 1]` 範圍。 - inputs_embeds (
torch.Tensor
,形狀為 `(batch_size, sequence_length, hidden_size)`,可選) — (可選)你可以選擇直接傳遞嵌入表示,而不是傳遞 `input_ids`。如果你希望比模型內部的嵌入查詢矩陣更能控制如何將 `input_ids` 索引轉換為相關向量,這會很有用。 - labels (
torch.LongTensor
,形狀為 `(batch_size,)`,可選) — 用於計算序列分類/迴歸損失的標籤。索引應在 `[0, ..., config.num_labels - 1]` 範圍內。如果 `config.num_labels == 1`,則計算迴歸損失(均方損失);如果 `config.num_labels > 1`,則計算分類損失(交叉熵)。 - output_attentions (
bool
, 可選) — 是否返回所有注意力層的注意力張量。有關更多詳細資訊,請參閱返回張量下的 `attentions`。 - output_hidden_states (
bool
, 可選) — 是否返回所有層的隱藏狀態。有關更多詳細資訊,請參閱返回張量下的 `hidden_states`。 - return_dict (
bool
, 可選) — 是否返回一個 ModelOutput 而不是一個普通的元組。
返回
transformers.modeling_outputs.SequenceClassifierOutput 或 tuple(torch.FloatTensor)
一個 transformers.modeling_outputs.SequenceClassifierOutput 或一個 `torch.FloatTensor` 的元組(如果傳入 `return_dict=False` 或 `config.return_dict=False`),包含各種元素,具體取決於配置 (DebertaConfig) 和輸入。
-
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 後的注意力權重,用於計算自注意力頭中的加權平均值。
DebertaForSequenceClassification 的 forward 方法重寫了 `__call__` 特殊方法。
儘管前向傳播的流程需要在此函式中定義,但之後應呼叫 `Module` 例項而不是此函式,因為前者會處理前處理和後處理步驟,而後者則會靜默地忽略它們。
單標籤分類示例
>>> import torch
>>> from transformers import AutoTokenizer, DebertaForSequenceClassification
>>> tokenizer = AutoTokenizer.from_pretrained("microsoft/deberta-base")
>>> model = DebertaForSequenceClassification.from_pretrained("microsoft/deberta-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 = DebertaForSequenceClassification.from_pretrained("microsoft/deberta-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, DebertaForSequenceClassification
>>> tokenizer = AutoTokenizer.from_pretrained("microsoft/deberta-base")
>>> model = DebertaForSequenceClassification.from_pretrained("microsoft/deberta-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 = DebertaForSequenceClassification.from_pretrained(
... "microsoft/deberta-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
DebertaForTokenClassification
class transformers.DebertaForTokenClassification
< source >( config )
引數
- config (DebertaForTokenClassification) — 包含模型所有引數的模型配置類。使用配置檔案進行初始化不會載入與模型相關的權重,只會載入配置。請檢視 from_pretrained() 方法來載入模型權重。
帶有標記分類頭的 Deberta transformer(一個在隱藏狀態輸出之上的線性層),例如用於命名實體識別 (NER) 任務。
該模型繼承自 PreTrainedModel。請檢視超類文件,瞭解該庫為所有模型實現的通用方法(例如下載或儲存、調整輸入嵌入大小、修剪頭部等)。
該模型也是一個 PyTorch torch.nn.Module 子類。可以像常規 PyTorch 模組一樣使用它,並參考 PyTorch 文件瞭解所有與通用用法和行為相關的事項。
forward
< source >( 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 inputs_embeds: typing.Optional[torch.Tensor] = None labels: typing.Optional[torch.Tensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.modeling_outputs.TokenClassifierOutput 或 tuple(torch.FloatTensor)
引數
- input_ids (
torch.Tensor
,形狀為 `(batch_size, sequence_length)`,可選) — 詞彙表中輸入序列標記的索引。預設情況下,填充將被忽略。可以使用 AutoTokenizer 獲取索引。有關詳細資訊,請參閱 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensor
,形狀為 `(batch_size, sequence_length)`,可選) — 用於避免對填充標記索引執行注意力機制的掩碼。掩碼值選自 `[0, 1]`:- 1 表示**未被掩碼**的標記,
- 0 表示**被掩碼**的標記。
- token_type_ids (
torch.Tensor
,形狀為 `(batch_size, sequence_length)`,可選) — 段標記索引,用於指示輸入的第一部分和第二部分。索引選自 `[0, 1]`:- 0 對應於*句子 A*的標記,
- 1 對應於*句子 B*的標記。
- position_ids (
torch.Tensor
,形狀為 `(batch_size, sequence_length)`,可選) — 每個輸入序列標記在位置嵌入中的位置索引。選自 `[0, config.n_positions - 1]` 範圍。 - inputs_embeds (
torch.Tensor
,形狀為 `(batch_size, sequence_length, hidden_size)`,可選) — (可選)你可以選擇直接傳遞嵌入表示,而不是傳遞 `input_ids`。如果你希望比模型內部的嵌入查詢矩陣更能控制如何將 `input_ids` 索引轉換為相關向量,這會很有用。 - labels (
torch.LongTensor
,形狀為 `(batch_size, sequence_length)`,可選) — 用於計算標記分類損失的標籤。索引應在 `[0, ..., config.num_labels - 1]` 範圍內。 - output_attentions (
bool
, 可選) — 是否返回所有注意力層的注意力張量。有關更多詳細資訊,請參閱返回張量下的 `attentions`。 - output_hidden_states (
bool
, 可選) — 是否返回所有層的隱藏狀態。有關更多詳細資訊,請參閱返回張量下的 `hidden_states`。 - return_dict (
bool
, 可選) — 是否返回一個 ModelOutput 而不是一個普通的元組。
返回
transformers.modeling_outputs.TokenClassifierOutput 或 tuple(torch.FloatTensor)
一個 transformers.modeling_outputs.TokenClassifierOutput 或一個 `torch.FloatTensor` 的元組(如果傳入 `return_dict=False` 或 `config.return_dict=False`),包含各種元素,具體取決於配置 (DebertaConfig) 和輸入。
-
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 後的注意力權重,用於計算自注意力頭中的加權平均值。
DebertaForTokenClassification 的 forward 方法重寫了 `__call__` 特殊方法。
儘管前向傳播的流程需要在此函式中定義,但之後應呼叫 `Module` 例項而不是此函式,因為前者會處理前處理和後處理步驟,而後者則會靜默地忽略它們。
示例
>>> from transformers import AutoTokenizer, DebertaForTokenClassification
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("microsoft/deberta-base")
>>> model = DebertaForTokenClassification.from_pretrained("microsoft/deberta-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)
...
DebertaForQuestionAnswering
class transformers.DebertaForQuestionAnswering
< source >( config )
引數
- config (DebertaForQuestionAnswering) — 包含模型所有引數的模型配置類。使用配置檔案進行初始化不會載入與模型相關的權重,只會載入配置。請檢視 from_pretrained() 方法來載入模型權重。
帶有片段分類頭的 Deberta transformer,用於抽取式問答任務,如 SQuAD(一個在隱藏狀態輸出之上的線性層,用於計算 `span start logits` 和 `span end logits`)。
該模型繼承自 PreTrainedModel。請檢視超類文件,瞭解該庫為所有模型實現的通用方法(例如下載或儲存、調整輸入嵌入大小、修剪頭部等)。
該模型也是一個 PyTorch torch.nn.Module 子類。可以像常規 PyTorch 模組一樣使用它,並參考 PyTorch 文件瞭解所有與通用用法和行為相關的事項。
forward
< source >( input_ids: typing.Optional[torch.Tensor] = None attention_mask: typing.Optional[torch.Tensor] = None token_type_ids: typing.Optional[torch.Tensor] = None position_ids: typing.Optional[torch.Tensor] = None inputs_embeds: typing.Optional[torch.Tensor] = None start_positions: typing.Optional[torch.Tensor] = None end_positions: typing.Optional[torch.Tensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.modeling_outputs.QuestionAnsweringModelOutput 或 tuple(torch.FloatTensor)
引數
- input_ids (
torch.Tensor
,形狀為 `(batch_size, sequence_length)`,可選) — 詞彙表中輸入序列標記的索引。預設情況下,填充將被忽略。可以使用 AutoTokenizer 獲取索引。有關詳細資訊,請參閱 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensor
,形狀為 `(batch_size, sequence_length)`,可選) — 用於避免對填充標記索引執行注意力機制的掩碼。掩碼值選自 `[0, 1]`:- 1 表示**未被掩碼**的標記,
- 0 表示**被掩碼**的標記。
- token_type_ids (
torch.Tensor
,形狀為(batch_size, sequence_length)
,可選) — 片段標記索引,用於指示輸入的第一部分和第二部分。索引在[0, 1]
中選擇:- 0 對應於 句子 A 的標記,
- 1 對應於 句子 B 的標記。
- position_ids (
torch.Tensor
,形狀為(batch_size, sequence_length)
,可選) — 位置嵌入中每個輸入序列標記的位置索引。在[0, config.n_positions - 1]
範圍內選擇。 - inputs_embeds (
torch.Tensor
,形狀為(batch_size, sequence_length, hidden_size)
,可選) — 可選地,你可以選擇直接傳遞嵌入表示,而不是傳遞input_ids
。如果你想比模型內部的嵌入查詢矩陣更好地控制如何將input_ids
索引轉換為相關聯的向量,這很有用。 - start_positions (
torch.Tensor
,形狀為(batch_size,)
,可選) — 標記範圍開始位置(索引)的標籤,用於計算標記分類損失。位置被限制在序列長度(sequence_length
)之內。序列之外的位置在計算損失時不予考慮。 - end_positions (
torch.Tensor
,形狀為(batch_size,)
,可選) — 標記範圍結束位置(索引)的標籤,用於計算標記分類損失。位置被限制在序列長度(sequence_length
)之內。序列之外的位置在計算損失時不予考慮。 - output_attentions (
bool
,可選) — 是否返回所有注意力層的注意力張量。有關更多詳細資訊,請參閱返回的張量下的attentions
。 - output_hidden_states (
bool
,可選) — 是否返回所有層的隱藏狀態。有關更多詳細資訊,請參閱返回的張量下的hidden_states
。 - return_dict (
bool
,可選) — 是否返回一個 ModelOutput 而不是一個普通的元組。
返回
transformers.modeling_outputs.QuestionAnsweringModelOutput 或 tuple(torch.FloatTensor)
一個 transformers.modeling_outputs.QuestionAnsweringModelOutput 或一個 torch.FloatTensor
的元組(如果傳遞了 return_dict=False
或當 config.return_dict=False
時),根據配置(DebertaConfig)和輸入包含各種元素。
-
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` 時返回) —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 後的注意力權重,用於計算自注意力頭中的加權平均值。
DebertaForQuestionAnswering 的前向方法,覆蓋了 __call__
特殊方法。
儘管前向傳播的流程需要在此函式中定義,但之後應呼叫 `Module` 例項而不是此函式,因為前者會處理前處理和後處理步驟,而後者則會靜默地忽略它們。
示例
>>> from transformers import AutoTokenizer, DebertaForQuestionAnswering
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("microsoft/deberta-base")
>>> model = DebertaForQuestionAnswering.from_pretrained("microsoft/deberta-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)
...
TFDebertaModel
class transformers.TFDebertaModel
< 來源 >( config: DebertaConfig *inputs **kwargs )
引數
- config (DebertaConfig) — 包含模型所有引數的模型配置類。使用配置檔案進行初始化不會載入與模型相關的權重,只會載入配置。請檢視 from_pretrained() 方法來載入模型權重。
基礎的 DeBERTa 模型 Transformer,輸出原始的隱藏狀態,沒有任何特定的頭部。DeBERTa 模型由 Pengcheng He、Xiaodong Liu、Jianfeng Gao、Weizhu Chen 在論文 DeBERTa: Decoding-enhanced BERT with Disentangled Attention 中提出。它建立在 BERT/RoBERTa 之上,有兩項改進,即解耦注意力和增強的掩碼解碼器。透過這兩項改進,它在大多數任務上以 80GB 的預訓練資料超越了 BERT/RoBERTa。
該模型也是一個 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 inputs_embeds: np.ndarray | tf.Tensor | None = None output_attentions: Optional[bool] = None output_hidden_states: Optional[bool] = None return_dict: Optional[bool] = None training: Optional[bool] = False ) → transformers.modeling_tf_outputs.TFBaseModelOutput 或 tuple(tf.Tensor)
引數
- input_ids (
np.ndarray
、tf.Tensor
、list[tf.Tensor]
、dict[str, tf.Tensor]
或dict[str, np.ndarray]
,每個樣本的形狀必須為(batch_size, sequence_length)
) — 詞彙表中輸入序列標記的索引。可以使用 AutoTokenizer 獲得索引。詳情請參閱 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
np.ndarray
或tf.Tensor
,形狀為(batch_size, sequence_length)
,可選) — 用於避免對填充標記索引執行注意力的掩碼。掩碼值在[0, 1]
中選擇:- 1 表示標記未被掩碼,
- 0 表示標記被掩碼。
- token_type_ids (
np.ndarray
或tf.Tensor
,形狀為(batch_size, sequence_length)
,可選) — 片段標記索引,用於指示輸入的第一部分和第二部分。索引在[0, 1]
中選擇:- 0 對應於 句子 A 的標記,
- 1 對應於 句子 B 的標記。
- position_ids (
np.ndarray
或tf.Tensor
,形狀為(batch_size, sequence_length)
,可選) — 位置嵌入中每個輸入序列標記的位置索引。在[0, config.max_position_embeddings - 1]
範圍內選擇。 - inputs_embeds (
np.ndarray
或tf.Tensor
,形狀為(batch_size, sequence_length, hidden_size)
,可選) — 可選地,你可以選擇直接傳遞嵌入表示,而不是傳遞input_ids
。如果你想比模型內部的嵌入查詢矩陣更好地控制如何將 input_ids 索引轉換為相關聯的向量,這很有用。 - output_attentions (
bool
,可選) — 是否返回所有注意力層的注意力張量。有關更多詳細資訊,請參閱返回的張量下的attentions
。 - output_hidden_states (
bool
,可選) — 是否返回所有層的隱藏狀態。有關更多詳細資訊,請參閱返回的張量下的hidden_states
。 - return_dict (
bool
,可選) — 是否返回一個 [`~utils.ModelOutput`] 而不是一個普通的元組。
返回
transformers.modeling_tf_outputs.TFBaseModelOutput 或 tuple(tf.Tensor)
一個 transformers.modeling_tf_outputs.TFBaseModelOutput 或一個 tf.Tensor
的元組(如果傳遞了 return_dict=False
或當 config.return_dict=False
時),根據配置(DebertaConfig)和輸入包含各種元素。
-
last_hidden_state (
tf.Tensor
of shape(batch_size, sequence_length, hidden_size)
) — 模型最後一層輸出的隱藏狀態序列。 -
hidden_states (
tuple(tf.FloatTensor)
,可選,當傳遞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 後的注意力權重,用於計算自注意力頭中的加權平均值。
TFDebertaModel 的前向方法,覆蓋了 __call__
特殊方法。
儘管前向傳播的流程需要在此函式中定義,但之後應呼叫 `Module` 例項而不是此函式,因為前者會處理前處理和後處理步驟,而後者則會靜默地忽略它們。
示例
>>> from transformers import AutoTokenizer, TFDebertaModel
>>> import tensorflow as tf
>>> tokenizer = AutoTokenizer.from_pretrained("kamalkraj/deberta-base")
>>> model = TFDebertaModel.from_pretrained("kamalkraj/deberta-base")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="tf")
>>> outputs = model(inputs)
>>> last_hidden_states = outputs.last_hidden_state
TFDebertaPreTrainedModel
一個用於處理權重初始化以及提供下載和載入預訓練模型的簡單介面的抽象類。
呼叫
< 來源 >( inputs training = None mask = None )
引數
- inputs — 輸入張量,或輸入張量的 dict/list/tuple。
- training — 布林值或布林標量張量,指示是以訓練模式還是推理模式執行
Network
。 - mask — 一個掩碼或掩碼列表。掩碼可以是一個布林張量或 None(無掩碼)。有關更多詳細資訊,請檢視此處的指南。
在新輸入上呼叫模型並以張量形式返回輸出。
在這種情況下,call()
只是將圖中所有的操作重新應用到新的輸入上(例如,從提供的輸入構建一個新的計算圖)。
注意:不應直接呼叫此方法。它僅用於在子類化 tf.keras.Model
時進行重寫。要在一個輸入上呼叫模型,請始終使用 __call__()
方法,即 model(inputs)
,它依賴於底層的 call()
方法。
TFDebertaForMaskedLM
class transformers.TFDebertaForMaskedLM
< 來源 >( config: DebertaConfig *inputs **kwargs )
引數
- config (DebertaConfig) — 包含模型所有引數的模型配置類。使用配置檔案進行初始化不會載入與模型相關的權重,只會載入配置。請檢視 from_pretrained() 方法來載入模型權重。
DeBERTa 模型,頂部帶有 語言建模
頭部。DeBERTa 模型由 Pengcheng He、Xiaodong Liu、Jianfeng Gao、Weizhu Chen 在論文 DeBERTa: Decoding-enhanced BERT with Disentangled Attention 中提出。它建立在 BERT/RoBERTa 之上,有兩項改進,即解耦注意力和增強的掩碼解碼器。透過這兩項改進,它在大多數任務上以 80GB 的預訓練資料超越了 BERT/RoBERTa。
該模型也是一個 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 inputs_embeds: np.ndarray | tf.Tensor | None = None output_attentions: Optional[bool] = None output_hidden_states: Optional[bool] = None return_dict: Optional[bool] = None labels: np.ndarray | tf.Tensor | None = None training: Optional[bool] = False ) → transformers.modeling_tf_outputs.TFMaskedLMOutput 或 tuple(tf.Tensor)
引數
- input_ids (
np.ndarray
、tf.Tensor
、list[tf.Tensor]
、dict[str, tf.Tensor]
或dict[str, np.ndarray]
,每個樣本的形狀必須為(batch_size, sequence_length)
) — 詞彙表中輸入序列標記的索引。可以使用 AutoTokenizer 獲得索引。詳情請參閱 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
np.ndarray
或tf.Tensor
,形狀為(batch_size, sequence_length)
,可選) — 用於避免對填充標記索引執行注意力的掩碼。掩碼值在[0, 1]
中選擇:- 1 表示標記未被掩碼,
- 0 表示標記被掩碼。
- token_type_ids (
np.ndarray
或tf.Tensor
,形狀為(batch_size, sequence_length)
,可選) — 片段標記索引,用於指示輸入的第一部分和第二部分。索引在[0, 1]
中選擇:- 0 對應於 句子 A 的標記,
- 1 對應於 句子 B 的標記。
- position_ids (
np.ndarray
或tf.Tensor
,形狀為(batch_size, sequence_length)
,可選) — 位置嵌入中每個輸入序列標記的位置索引。在[0, config.max_position_embeddings - 1]
範圍內選擇。 - inputs_embeds (
np.ndarray
或tf.Tensor
,形狀為(batch_size, sequence_length, hidden_size)
,可選) — 可選地,你可以選擇直接傳遞嵌入表示,而不是傳遞input_ids
。如果你想比模型內部的嵌入查詢矩陣更好地控制如何將 input_ids 索引轉換為相關聯的向量,這很有用。 - output_attentions (
bool
,可選) — 是否返回所有注意力層的注意力張量。有關更多詳細資訊,請參閱返回的張量下的attentions
。 - output_hidden_states (
bool
,可選) — 是否返回所有層的隱藏狀態。有關更多詳細資訊,請參閱返回的張量下的hidden_states
。 - return_dict (
bool
,可選) — 是否返回一個 [`~utils.ModelOutput`] 而不是一個普通的元組。 - labels (
tf.Tensor
或np.ndarray
,形狀為(batch_size, sequence_length)
,可選) — 用於計算掩碼語言建模損失的標籤。索引應在[-100, 0, ..., config.vocab_size]
範圍內(請參閱input_ids
文件字串)索引設定為-100
的標記將被忽略(掩碼),損失僅對標籤在[0, ..., config.vocab_size]
範圍內的標記進行計算
返回
transformers.modeling_tf_outputs.TFMaskedLMOutput 或 tuple(tf.Tensor)
一個 transformers.modeling_tf_outputs.TFMaskedLMOutput 或一個 tf.Tensor
的元組(如果傳遞了 return_dict=False
或當 config.return_dict=False
時),根據配置(DebertaConfig)和輸入包含各種元素。
-
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 後的注意力權重,用於計算自注意力頭中的加權平均值。
The TFDebertaForMaskedLM forward method, overrides the __call__
special method.
儘管前向傳播的流程需要在此函式中定義,但之後應呼叫 `Module` 例項而不是此函式,因為前者會處理前處理和後處理步驟,而後者則會靜默地忽略它們。
示例
>>> from transformers import AutoTokenizer, TFDebertaForMaskedLM
>>> import tensorflow as tf
>>> tokenizer = AutoTokenizer.from_pretrained("kamalkraj/deberta-base")
>>> model = TFDebertaForMaskedLM.from_pretrained("kamalkraj/deberta-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)
TFDebertaForSequenceClassification
class transformers.TFDebertaForSequenceClassification
< 來源 >( config: DebertaConfig *inputs **kwargs )
引數
- config (DebertaConfig) — 包含模型所有引數的模型配置類。使用配置檔案初始化不會載入與模型相關的權重,只會載入配置。請檢視 from_pretrained() 方法來載入模型權重。
DeBERTa 模型 transformer,其頂部帶有一個序列分類/迴歸頭(一個在池化輸出之上的線性層),例如用於 GLUE 任務。
DeBERTa 模型由 Pengcheng He、Xiaodong Liu、Jianfeng Gao 和 Weizhu Chen 在論文 DeBERTa: Decoding-enhanced BERT with Disentangled Attention 中提出。它基於 BERT/RoBERTa 構建,並進行了兩項改進:解耦注意力(disentangled attention)和增強型掩碼解碼器(enhanced mask decoder)。憑藉這兩項改進,它在使用 80GB 預訓練資料的情況下,在大多數任務上的表現優於 BERT/RoBERTa。
該模型也是一個 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 inputs_embeds: np.ndarray | tf.Tensor | None = None output_attentions: Optional[bool] = None output_hidden_states: Optional[bool] = None return_dict: Optional[bool] = None labels: np.ndarray | tf.Tensor | None = None training: Optional[bool] = False ) → transformers.modeling_tf_outputs.TFSequenceClassifierOutput 或 tuple(tf.Tensor)
引數
- input_ids (
np.ndarray
,tf.Tensor
,list[tf.Tensor]
、`dict[str, tf.Tensor]
或dict[str, np.ndarray]
,每個樣本的形狀必須為(batch_size, sequence_length)
) — 詞彙表中輸入序列標記的索引。索引可以使用 AutoTokenizer 獲得。更多細節請參閱 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
np.ndarray
或tf.Tensor
,形狀為(batch_size, sequence_length)
, 可選) — 用於避免對填充標記索引執行注意力的掩碼。掩碼值選自[0, 1]
:- 1 表示標記未被掩碼,
- 0 表示標記已被掩碼。
- token_type_ids (
np.ndarray
或tf.Tensor
,形狀為(batch_size, sequence_length)
, 可選) — 用於指示輸入的第一部分和第二部分的片段標記索引。索引選自[0, 1]
:- 0 對應於句子 A 的標記,
- 1 對應於句子 B 的標記。
- position_ids (
np.ndarray
或tf.Tensor
,形狀為(batch_size, sequence_length)
, 可選) — 位置嵌入中每個輸入序列標記的位置索引。選自範圍[0, config.max_position_embeddings - 1]
。 - inputs_embeds (
np.ndarray
或tf.Tensor
,形狀為(batch_size, sequence_length, hidden_size)
, 可選) — 可選地,你可以不傳遞input_ids
,而是直接傳遞嵌入表示。如果你想對如何將 input_ids 索引轉換為相關向量進行更多控制,而不是使用模型的內部嵌入查詢矩陣,這將非常有用。 - output_attentions (
bool
, 可選) — 是否返回所有注意力層的注意力張量。更多細節請參見返回張量下的attentions
。 - output_hidden_states (
bool
, 可選) — 是否返回所有層的隱藏狀態。更多細節請參見返回張量下的hidden_states
。 - return_dict (
bool
, 可選) — 是否返回一個 [`~utils.ModelOutput`] 而不是一個普通的元組。 - labels (
tf.Tensor
或np.ndarray
,形狀為(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
時),根據配置(DebertaConfig)和輸入,包含各種元素。
-
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 後的注意力權重,用於計算自注意力頭中的加權平均值。
TFDebertaForSequenceClassification 的前向方法會覆蓋 __call__
特殊方法。
儘管前向傳播的流程需要在此函式中定義,但之後應呼叫 `Module` 例項而不是此函式,因為前者會處理前處理和後處理步驟,而後者則會靜默地忽略它們。
示例
>>> from transformers import AutoTokenizer, TFDebertaForSequenceClassification
>>> import tensorflow as tf
>>> tokenizer = AutoTokenizer.from_pretrained("kamalkraj/deberta-base")
>>> model = TFDebertaForSequenceClassification.from_pretrained("kamalkraj/deberta-base")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="tf")
>>> logits = model(**inputs).logits
>>> predicted_class_id = int(tf.math.argmax(logits, axis=-1)[0])
>>> # To train a model on `num_labels` classes, you can pass `num_labels=num_labels` to `.from_pretrained(...)`
>>> num_labels = len(model.config.id2label)
>>> model = TFDebertaForSequenceClassification.from_pretrained("kamalkraj/deberta-base", num_labels=num_labels)
>>> labels = tf.constant(1)
>>> loss = model(**inputs, labels=labels).loss
TFDebertaForTokenClassification
class transformers.TFDebertaForTokenClassification
< 原始碼 >( config: DebertaConfig *inputs **kwargs )
引數
- config (DebertaConfig) — 包含模型所有引數的模型配置類。使用配置檔案初始化不會載入與模型相關的權重,只會載入配置。請檢視 from_pretrained() 方法來載入模型權重。
頂部帶有詞元分類頭的 DeBERTa 模型(在隱藏狀態輸出之上有一個線性層),例如用於命名實體識別(NER)任務。
DeBERTa 模型由 Pengcheng He、Xiaodong Liu、Jianfeng Gao 和 Weizhu Chen 在論文 DeBERTa: Decoding-enhanced BERT with Disentangled Attention 中提出。它基於 BERT/RoBERTa 構建,並進行了兩項改進:解耦注意力(disentangled attention)和增強型掩碼解碼器(enhanced mask decoder)。憑藉這兩項改進,它在使用 80GB 預訓練資料的情況下,在大多數任務上的表現優於 BERT/RoBERTa。
該模型也是一個 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 inputs_embeds: np.ndarray | tf.Tensor | None = None output_attentions: Optional[bool] = None output_hidden_states: Optional[bool] = None return_dict: Optional[bool] = None labels: np.ndarray | tf.Tensor | None = None training: Optional[bool] = False ) → transformers.modeling_tf_outputs.TFTokenClassifierOutput 或 tuple(tf.Tensor)
引數
- input_ids (
np.ndarray
,tf.Tensor
,list[tf.Tensor]
、`dict[str, tf.Tensor]
或dict[str, np.ndarray]
,每個樣本的形狀必須為(batch_size, sequence_length)
) — 詞彙表中輸入序列標記的索引。索引可以使用 AutoTokenizer 獲得。更多細節請參閱 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
np.ndarray
或tf.Tensor
,形狀為(batch_size, sequence_length)
, 可選) — 用於避免對填充標記索引執行注意力的掩碼。掩碼值選自[0, 1]
:- 1 表示標記未被掩碼,
- 0 表示標記已被掩碼。
- token_type_ids (
np.ndarray
或tf.Tensor
,形狀為(batch_size, sequence_length)
, 可選) — 用於指示輸入的第一部分和第二部分的片段標記索引。索引選自[0, 1]
:- 0 對應於句子 A 的標記,
- 1 對應於句子 B 的標記。
- position_ids (
np.ndarray
或tf.Tensor
,形狀為(batch_size, sequence_length)
, 可選) — 位置嵌入中每個輸入序列標記的位置索引。選自範圍[0, config.max_position_embeddings - 1]
。 - inputs_embeds (
np.ndarray
或tf.Tensor
,形狀為(batch_size, sequence_length, hidden_size)
, 可選) — 可選地,你可以不傳遞input_ids
,而是直接傳遞嵌入表示。如果你想對如何將 input_ids 索引轉換為相關向量進行更多控制,而不是使用模型的內部嵌入查詢矩陣,這將非常有用。 - output_attentions (
bool
, 可選) — 是否返回所有注意力層的注意力張量。更多細節請參見返回張量下的attentions
。 - output_hidden_states (
bool
, 可選) — 是否返回所有層的隱藏狀態。更多細節請參見返回張量下的hidden_states
。 - return_dict (
bool
, 可選) — 是否返回一個 [`~utils.ModelOutput`] 而不是一個普通的元組。 - labels (
tf.Tensor
或np.ndarray
,形狀為(batch_size, sequence_length)
, 可選) — 用於計算標記分類損失的標籤。索引應在[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
時),根據配置(DebertaConfig)和輸入,包含各種元素。
-
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 後的注意力權重,用於計算自注意力頭中的加權平均值。
TFDebertaForTokenClassification 的前向方法會覆蓋 __call__
特殊方法。
儘管前向傳播的流程需要在此函式中定義,但之後應呼叫 `Module` 例項而不是此函式,因為前者會處理前處理和後處理步驟,而後者則會靜默地忽略它們。
示例
>>> from transformers import AutoTokenizer, TFDebertaForTokenClassification
>>> import tensorflow as tf
>>> tokenizer = AutoTokenizer.from_pretrained("kamalkraj/deberta-base")
>>> model = TFDebertaForTokenClassification.from_pretrained("kamalkraj/deberta-base")
>>> 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()]
TFDebertaForQuestionAnswering
class transformers.TFDebertaForQuestionAnswering
< 原始碼 >( config: DebertaConfig *inputs **kwargs )
引數
- config (DebertaConfig) — 包含模型所有引數的模型配置類。使用配置檔案初始化不會載入與模型相關的權重,只會載入配置。請檢視 from_pretrained() 方法來載入模型權重。
頂部帶有片段分類頭的 DeBERTa 模型,用於像 SQuAD 這樣的抽取式問答任務(在隱藏狀態輸出之上有一系列線性層,用於計算片段開始 logits
和片段結束 logits
)。
DeBERTa 模型由 Pengcheng He、Xiaodong Liu、Jianfeng Gao 和 Weizhu Chen 在論文 DeBERTa: Decoding-enhanced BERT with Disentangled Attention 中提出。它基於 BERT/RoBERTa 構建,並進行了兩項改進:解耦注意力(disentangled attention)和增強型掩碼解碼器(enhanced mask decoder)。憑藉這兩項改進,它在使用 80GB 預訓練資料的情況下,在大多數任務上的表現優於 BERT/RoBERTa。
該模型也是一個 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 inputs_embeds: np.ndarray | tf.Tensor | None = None output_attentions: Optional[bool] = None output_hidden_states: Optional[bool] = None return_dict: Optional[bool] = None start_positions: np.ndarray | tf.Tensor | None = None end_positions: np.ndarray | tf.Tensor | None = None training: Optional[bool] = False ) → transformers.modeling_tf_outputs.TFQuestionAnsweringModelOutput 或 tuple(tf.Tensor)
引數
- input_ids (
np.ndarray
,tf.Tensor
,list[tf.Tensor]
、`dict[str, tf.Tensor]
或dict[str, np.ndarray]
,每個樣本的形狀必須為(batch_size, sequence_length)
) — 詞彙表中輸入序列標記的索引。索引可以使用 AutoTokenizer 獲得。更多細節請參閱 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
np.ndarray
或tf.Tensor
,形狀為(batch_size, sequence_length)
, 可選) — 用於避免對填充標記索引執行注意力的掩碼。掩碼值選自[0, 1]
:- 1 表示標記未被掩碼,
- 0 表示標記已被掩碼。
- token_type_ids (
np.ndarray
或tf.Tensor
,形狀為(batch_size, sequence_length)
, 可選) — 用於指示輸入的第一部分和第二部分的片段標記索引。索引選自[0, 1]
:- 0 對應於句子 A 的標記,
- 1 對應於句子 B 的標記。
- position_ids (
np.ndarray
或tf.Tensor
,形狀為(batch_size, sequence_length)
, 可選) — 位置嵌入中每個輸入序列標記的位置索引。選自範圍[0, config.max_position_embeddings - 1]
。 - inputs_embeds (
np.ndarray
或tf.Tensor
,形狀為(batch_size, sequence_length, hidden_size)
, 可選) — 可選地,你可以不傳遞input_ids
,而是直接傳遞嵌入表示。如果你想對如何將 input_ids 索引轉換為相關向量進行更多控制,而不是使用模型的內部嵌入查詢矩陣,這將非常有用。 - output_attentions (
bool
, 可選) — 是否返回所有注意力層的注意力張量。更多細節請參見返回張量下的attentions
。 - output_hidden_states (
bool
, 可選) — 是否返回所有層的隱藏狀態。更多細節請參見返回張量下的hidden_states
。 - return_dict (
bool
, 可選) — 是否返回一個 [`~utils.ModelOutput`] 而不是一個普通的元組。 - start_positions (
tf.Tensor
或np.ndarray
,形狀為(batch_size,)
, 可選) — 用於計算標記分類損失的標註片段起始位置(索引)的標籤。位置被限制在序列長度(sequence_length
)之內。超出序列的位置在計算損失時不會被考慮。 - end_positions (
tf.Tensor
或np.ndarray
,形狀為(batch_size,)
, 可選) — 用於計算標記分類損失的標註片段結束位置(索引)的標籤。位置被限制在序列長度(sequence_length
)之內。超出序列的位置在計算損失時不會被考慮。
返回
transformers.modeling_tf_outputs.TFQuestionAnsweringModelOutput 或 tuple(tf.Tensor)
一個 transformers.modeling_tf_outputs.TFQuestionAnsweringModelOutput 或一個 tf.Tensor
的元組(如果傳遞了 return_dict=False
或當 config.return_dict=False
時),根據配置(DebertaConfig)和輸入,包含各種元素。
-
loss (
tf.Tensor
,形狀為(batch_size, )
, 可選, 當提供了start_positions
和end_positions
時返回) — 總的片段提取損失是起始和結束位置交叉熵損失的和。 -
start_logits (形狀為
(batch_size, sequence_length)
的tf.Tensor
) — 跨度起始分數(SoftMax 之前)。 -
end_logits (形狀為
(batch_size, sequence_length)
的tf.Tensor
) — 跨度結束分數(SoftMax 之前)。 -
hidden_states (
tuple(tf.Tensor)
,可選,當傳遞output_hidden_states=True
或當config.output_hidden_states=True
時返回) —tf.Tensor
的元組(一個是嵌入層的輸出 + 一個是每個層的輸出),形狀為(batch_size, sequence_length, hidden_size)
。模型在每個層輸出的隱藏狀態加上初始嵌入輸出。
-
attentions (
tuple(tf.Tensor)
,可選,當傳遞output_attentions=True
或當config.output_attentions=True
時返回) —tf.Tensor
的元組(每個層一個),形狀為(batch_size, num_heads, sequence_length, sequence_length)
。注意力 softmax 後的注意力權重,用於計算自注意力頭中的加權平均值。
TFDebertaForQuestionAnswering 的前向方法會覆蓋 __call__
特殊方法。
儘管前向傳播的流程需要在此函式中定義,但之後應呼叫 `Module` 例項而不是此函式,因為前者會處理前處理和後處理步驟,而後者則會靜默地忽略它們。
示例
>>> from transformers import AutoTokenizer, TFDebertaForQuestionAnswering
>>> import tensorflow as tf
>>> tokenizer = AutoTokenizer.from_pretrained("kamalkraj/deberta-base")
>>> model = TFDebertaForQuestionAnswering.from_pretrained("kamalkraj/deberta-base")
>>> 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]