Hugging Face 的 LOGO

Transformers 文件

ELECTRA

Hugging Face's logo
加入 Hugging Face 社群

並獲得增強的文件體驗

開始使用

PyTorch TensorFlow Flax SDPA

ELECTRA

ELECTRA 修改了傳統掩碼語言模型（如 BERT）的預訓練目標。ELECTRA 不是簡單地掩蓋詞元並讓模型預測它們，而是訓練了兩個模型：一個生成器和一個判別器。生成器用合理的替代詞元替換一些詞元，而判別器（你實際使用的模型）則學習檢測哪些詞元是原始的，哪些是替換的。這種訓練方法非常高效，並且能夠擴充套件到更大的模型，同時使用的計算資源要少得多。

這種方法超級高效，因為 ELECTRA 從輸入的每一個詞元中學習，而不僅僅是被掩碼的詞元。這就是為什麼即使是小型的 ELECTRA 模型，也能在消耗更少計算資源的情況下，達到或超過更大模型的效能。

你可以在 ELECTRA 釋出頁面下找到所有原始的 ELECTRA 檢查點。

點選右側邊欄，檢視更多關於如何使用 ELECTRA 進行不同語言任務（如序列分類、詞元分類和問答）的示例。

下面的示例演示瞭如何使用 Pipeline 或 AutoModel 類進行文字分類。

流水線
自動模型
Transformers CLI
import torch
from transformers import pipeline

classifier = pipeline(
    task="text-classification",
    model="bhadresh-savani/electra-base-emotion",
    torch_dtype=torch.float16,
    device=0
)
classifier("This restaurant has amazing food!")

注意

  • ELECTRA 由兩個 transformer 模型組成：一個生成器（G）和一個判別器（D）。對於大多數下游任務，應使用判別器模型（名稱中以 *-discriminator 標識），而不是生成器。

  • ELECTRA 有三種尺寸：小型（14M 引數）、基礎型（110M 引數）和大型（335M 引數）。

  • 為了提高效率，ELECTRA 可以使用比隱藏層尺寸更小的嵌入尺寸。當配置中 embedding_size 小於 hidden_size 時，一個投影層會連線它們。

  • 當使用帶填充的批處理輸入時，請務必使用注意力掩碼，以防止模型關注填充詞元。

    # Example of properly handling padding with attention masks
inputs = tokenizer(["Short text", "This is a much longer text that needs padding"],
                padding=True,
                return_tensors="pt")
outputs = model(**inputs)  # automatically uses the attention_mask

  • 在下游任務中使用判別器時，可以將其載入到任何 ELECTRA 模型類中（例如 ElectraForSequenceClassification、ElectraForTokenClassification 等）。

ElectraConfig

class transformers.ElectraConfig

< >

( vocab_size = 30522 embedding_size = 128 hidden_size = 256 num_hidden_layers = 12 num_attention_heads = 4 intermediate_size = 1024 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 summary_type = 'first' summary_use_proj = True summary_activation = 'gelu' summary_last_dropout = 0.1 pad_token_id = 0 position_embedding_type = 'absolute' use_cache = True classifier_dropout = None **kwargs )

引數

  • vocab_size (int，可選，預設為 30522) — ELECTRA 模型的詞彙表大小。定義了在呼叫 ElectraModel 或 TFElectraModel 時，`inputs_ids` 可以表示的不同詞元的數量。
  • embedding_size (int，可選，預設為 128) — 編碼器層和池化層的維度。
  • hidden_size (int，可選，預設為 256) — 編碼器層和池化層的維度。
  • num_hidden_layers (int，可選，預設為 12) — Transformer 編碼器中的隱藏層數量。
  • num_attention_heads (int，可選，預設為 4) — Transformer 編碼器中每個注意力層的注意力頭數量。
  • intermediate_size (int，可選，預設為 1024) — 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) — 在呼叫 ElectraModel 或 TFElectraModel 時傳遞的 `token_type_ids` 的詞彙表大小。
  • initializer_range (float，可選，預設為 0.02) — 用於初始化所有權重矩陣的 truncated_normal_initializer 的標準差。
  • layer_norm_eps (float，可選，預設為 1e-12) — 層歸一化層使用的 epsilon 值。
  • summary_type (str，可選，預設為 "first") — 用於序列摘要的引數。用於序列分類和多項選擇模型。

    必須是以下選項之一：

    • "last": 取最後一個詞元的隱藏狀態（類似 XLNet）。
    • "first": 取第一個詞元的隱藏狀態（類似 BERT）。
    • "mean": 取所有詞元隱藏狀態的平均值。
    • "cls_index": 提供分類詞元位置的張量（類似 GPT/GPT-2）。
    • "attn": 目前未實現，使用多頭注意力。
  • summary_use_proj (bool，可選，預設為 True) — 用於序列摘要的引數。用於序列分類和多項選擇模型。

    是否在向量提取後新增投影層。

  • summary_activation (str，可選) — 用於序列摘要的引數。用於序列分類和多項選擇模型。

    傳遞 "gelu" 以對輸出應用 gelu 啟用函式，任何其他值將導致不應用啟用函式。

  • summary_last_dropout (float，可選，預設為 0.0) — 用於序列摘要的引數。用於序列分類和多項選擇模型。

    在投影和啟用之後使用的 dropout 比率。

  • 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.) 中的 *Method 4*。
  • use_cache (bool，可選，預設為 True) — 模型是否應返回最後一個鍵/值注意力（並非所有模型都使用）。僅當 `config.is_decoder=True` 時相關。
  • classifier_dropout (float，可選) — 分類頭的 dropout 比率。

這是用於儲存 ElectraModel 或 TFElectraModel 配置的配置類。它用於根據指定的引數例項化 ELECTRA 模型，定義模型架構。使用預設值例項化配置將產生與 ELECTRA google/electra-small-discriminator 架構類似的配置。

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

示例

>>> from transformers import ElectraConfig, ElectraModel

>>> # Initializing a ELECTRA electra-base-uncased style configuration
>>> configuration = ElectraConfig()

>>> # Initializing a model (with random weights) from the electra-base-uncased style configuration
>>> model = ElectraModel(configuration)

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

ElectraTokenizer

class transformers.ElectraTokenizer

< >

( vocab_file do_lower_case = True do_basic_tokenize = True never_split = None unk_token = '[UNK]' sep_token = '[SEP]' pad_token = '[PAD]' cls_token = '[CLS]' mask_token = '[MASK]' tokenize_chinese_chars = True strip_accents = None clean_up_tokenization_spaces = True **kwargs )

引數

  • vocab_file (str) — 包含詞彙表的檔案。
  • do_lower_case (bool, 可選, 預設為 True) — 是否在分詞時將輸入轉換為小寫。
  • do_basic_tokenize (bool, 可選, 預設為 True) — 是否在進行 WordPiece 分詞前進行基本分詞。
  • never_split (Iterable, 可選) — 一組在分詞過程中永遠不會被切分的詞元。僅當 do_basic_tokenize=True 時有效。
  • unk_token (str, 可選, 預設為 "[UNK]") — 未知詞元。不在詞彙表中的詞元無法轉換為 ID，將被設定為該詞元。
  • sep_token (str, 可選, 預設為 "[SEP]") — 分隔符詞元，用於從多個序列構建一個序列，例如用於序列分類的兩個序列，或用於問答任務的文字和問題。它也用作帶有特殊詞元的序列的最後一個詞元。
  • pad_token (str, 可選, 預設為 "[PAD]") — 用於填充的詞元，例如當批處理不同長度的序列時使用。
  • cls_token (str, 可選, 預設為 "[CLS]") — 分類器詞元，用於序列分類（對整個序列進行分類，而不是逐個詞元分類）。當使用特殊詞元構建序列時，它是序列的第一個詞元。
  • mask_token (str, 可選, 預設為 "[MASK]") — 用於掩蓋值的詞元。這是在使用掩碼語言建模訓練此模型時使用的詞元。這是模型將嘗試預測的詞元。
  • tokenize_chinese_chars (bool, 可選, 預設為 True) — 是否對中文字元進行分詞。

    對於日語，這可能應該停用（參見此 問題）。

  • strip_accents (bool, 可選) — 是否移除所有重音符號。如果未指定此選項，則將由 lowercase 的值決定（與原始 Electra 中一樣）。
  • clean_up_tokenization_spaces (bool, 可選, 預設為 True) — 是否在解碼後清理空格，清理操作包括移除可能的多餘空格等偽影。

構建一個 Electra 分詞器。基於 WordPiece。

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

build_inputs_with_special_tokens

< >

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

引數

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

返回

List[int]

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

透過拼接和新增特殊詞元，從單個序列或序列對構建用於序列分類任務的模型輸入。一個 Electra 序列的格式如下

  • 單個序列：[CLS] X [SEP]
  • 序列對：[CLS] A [SEP] B [SEP]

convert_tokens_to_string

< >

( tokens )

將標記序列（字串）轉換為單個字串。

get_special_tokens_mask

< >

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

引數

  • token_ids_0 (List[int]) — ID 列表。
  • token_ids_1 (List[int], 可選) — 用於序列對的可選的第二個 ID 列表。
  • already_has_special_tokens (bool, 可選, 預設為 False) — 詞元列表是否已經為模型格式化了特殊詞元。

返回

List[int]

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

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

ElectraTokenizerFast

class transformers.ElectraTokenizerFast

< >

( vocab_file = None tokenizer_file = None do_lower_case = True unk_token = '[UNK]' sep_token = '[SEP]' pad_token = '[PAD]' cls_token = '[CLS]' mask_token = '[MASK]' tokenize_chinese_chars = True strip_accents = None **kwargs )

引數

  • vocab_file (str) — 包含詞彙表的檔案。
  • do_lower_case (bool, 可選, 預設為 True) — 是否在分詞時將輸入轉換為小寫。
  • unk_token (str, 可選, 預設為 "[UNK]") — 未知詞元。不在詞彙表中的詞元無法轉換為 ID，將被設定為該詞元。
  • sep_token (str, 可選, 預設為 "[SEP]") — 分隔符詞元，用於從多個序列構建一個序列，例如用於序列分類的兩個序列，或用於問答任務的文字和問題。它也用作帶有特殊詞元的序列的最後一個詞元。
  • pad_token (str, 可選, 預設為 "[PAD]") — 用於填充的詞元，例如當批處理不同長度的序列時使用。
  • cls_token (str, 可選, 預設為 "[CLS]") — 分類器詞元，用於序列分類（對整個序列進行分類，而不是逐個詞元分類）。當使用特殊詞元構建序列時，它是序列的第一個詞元。
  • mask_token (str, 可選, 預設為 "[MASK]") — 用於掩蓋值的詞元。這是在使用掩碼語言建模訓練此模型時使用的詞元。這是模型將嘗試預測的詞元。
  • clean_text (bool, 可選, 預設為 True) — 是否在分詞前透過移除任何控制字元並將所有空白替換為標準空格來清理文字。
  • tokenize_chinese_chars (bool, 可選, 預設為 True) — 是否對中文字元進行分詞。對於日語，這可能應該停用（參見此問題）。
  • strip_accents (bool, 可選) — 是否移除所有重音符號。如果未指定此選項，則將由 lowercase 的值決定（與原始 ELECTRA 中一樣）。
  • wordpieces_prefix (str, 可選, 預設為 "##") — 子詞的字首。

構建一個“快速”的 ELECTRA 分詞器（由 HuggingFace 的 tokenizers 庫支援）。基於 WordPiece。

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

build_inputs_with_special_tokens

< >

( token_ids_0 token_ids_1 = None ) → List[int]

引數

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

返回

List[int]

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

透過拼接和新增特殊詞元，從單個序列或序列對構建用於序列分類任務的模型輸入。一個 ELECTRA 序列的格式如下

  • 單個序列：[CLS] X [SEP]
  • 序列對：[CLS] A [SEP] B [SEP]

Electra 特定輸出

class transformers.models.electra.modeling_electra.ElectraForPreTrainingOutput

< >

( loss: typing.Optional[torch.FloatTensor] = None logits: typing.Optional[torch.FloatTensor] = None hidden_states: typing.Optional[tuple[torch.FloatTensor]] = None attentions: typing.Optional[tuple[torch.FloatTensor]] = None )

引數

  • loss (*可選*, 當提供了 labels 時返回, torch.FloatTensor，形狀為 (1,)) — ELECTRA 目標的總損失。
  • logits (torch.FloatTensor，形狀為 (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 之後的注意力權重，用於計算自注意力頭中的加權平均值。

ElectraForPreTraining 的輸出型別。

class transformers.models.electra.modeling_tf_electra.TFElectraForPreTrainingOutput

< >

( logits: Optional[tf.Tensor] = None hidden_states: tuple[tf.Tensor] | None = None attentions: tuple[tf.Tensor] | None = None )

引數

  • loss (可選, 當提供了 labels 時返回, tf.Tensor，形狀為 (1,)) — ELECTRA 目標的總損失。
  • logits (tf.Tensor，形狀為 (batch_size, sequence_length)) — 頭的預測分數（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 之後的注意力權重，用於計算自注意力頭中的加權平均值。

TFElectraForPreTraining 的輸出型別。

Pytorch
隱藏 Pytorch 內容

ElectraModel

class transformers.ElectraModel

< >

（ config ）

引數

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

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

該模型繼承自 PreTrainedModel。請查閱超類文件以瞭解該庫為所有模型實現的通用方法（例如下載或儲存、調整輸入嵌入大小、修剪注意力頭等）。

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

forward

< >

（ input_ids: typing.Optional[torch.Tensor] = None attention_mask: typing.Optional[torch.Tensor] = None token_type_ids: typing.Optional[torch.Tensor] = None position_ids: typing.Optional[torch.Tensor] = None head_mask: typing.Optional[torch.Tensor] = None inputs_embeds: typing.Optional[torch.Tensor] = None encoder_hidden_states: typing.Optional[torch.Tensor] = None encoder_attention_mask: typing.Optional[torch.Tensor] = None past_key_values: typing.Optional[list[torch.FloatTensor]] = None use_cache: typing.Optional[bool] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ） → transformers.modeling_outputs.BaseModelOutputWithCrossAttentions 或 tuple(torch.FloatTensor)

引數

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

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

    什麼是輸入 ID？

  • attention_mask (torch.Tensor，形狀為 (batch_size, sequence_length)，可選) — 用於避免對填充標記索引執行注意力操作的掩碼。掩碼值在 [0, 1] 中選擇：

    • 1 表示標記未被遮蓋，
    • 0 表示標記已被遮蓋。

    什麼是注意力掩碼？

  • token_type_ids (torch.Tensor，形狀為 (batch_size, sequence_length)，可選) — 段標記索引，用於指示輸入的第一部分和第二部分。索引在 [0, 1] 中選擇：

    • 0 對應於 *句子 A* 的標記，
    • 1 對應於 *句子 B* 的標記。

    什麼是標記型別 ID？

  • position_ids (torch.Tensor，形狀為 (batch_size, sequence_length)，可選) — 每個輸入序列標記在位置嵌入中的位置索引。在 [0, config.n_positions - 1] 範圍內選擇。

    什麼是位置 ID？

  • head_mask (torch.Tensor，形狀為 (num_heads,) 或 (num_layers, num_heads)，可選) — 用於置零自注意力模組中選定頭的掩碼。掩碼值在 [0, 1] 中選擇：

    • 1 表示頭未被遮蓋，
    • 0 表示頭已被遮蓋。
  • inputs_embeds (torch.Tensor，形狀為 (batch_size, sequence_length, hidden_size)，可選) — 可選地，你可以不傳遞 input_ids，而是直接傳遞一個嵌入表示。這在你希望對如何將 input_ids 索引轉換為關聯向量進行更多控制時非常有用，而不是使用模型內部的嵌入查詢矩陣。
  • encoder_hidden_states (torch.Tensor，形狀為 (batch_size, sequence_length, hidden_size)，可選) — 編碼器最後一層輸出的隱藏狀態序列。如果模型配置為解碼器，則在交叉注意力中使用。
  • encoder_attention_mask (torch.Tensor，形狀為 (batch_size, sequence_length)，可選) — 用於避免對編碼器輸入的填充標記索引執行注意力操作的掩碼。如果模型配置為解碼器，則此掩碼用於交叉注意力。掩碼值在 [0, 1] 中選擇：

    • 1 表示標記未被遮蓋，
    • 0 表示標記已被遮蓋。
  • past_key_values (list[torch.FloatTensor]，可選) — 預先計算的隱藏狀態（自注意力和交叉注意力塊中的鍵和值），可用於加速順序解碼。這通常包括當 use_cache=True 或 config.use_cache=True 時，模型在解碼的前一階段返回的 past_key_values。

    允許兩種格式：

    • 一個 Cache 例項，請參閱我們的 kv 快取指南；
    • 長度為 config.n_layers 的 tuple(torch.FloatTensor) 元組，其中每個元組有 2 個形狀為 (batch_size, num_heads, sequence_length, embed_size_per_head) 的張量。這也稱為舊版快取格式。

    模型將輸出與輸入相同的快取格式。如果沒有傳遞 past_key_values，將返回舊版快取格式。

    如果使用 past_key_values，使用者可以選擇只輸入形狀為 (batch_size, 1) 的最後一個 input_ids（那些沒有提供其過去鍵值狀態給此模型的標記），而不是形狀為 (batch_size, sequence_length) 的所有 input_ids。

  • use_cache (bool，可選) — 如果設定為 True，將返回 past_key_values 鍵值狀態，可用於加速解碼（請參閱 past_key_values）。
  • output_attentions (bool，可選) — 是否返回所有注意力層的注意力張量。有關更多詳細資訊，請參閱返回張量下的 attentions。
  • output_hidden_states (bool，可選) — 是否返回所有層的隱藏狀態。有關更多詳細資訊，請參閱返回張量下的 hidden_states。
  • return_dict (bool，可選) — 是否返回一個 ModelOutput 而不是一個普通的元組。

返回

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

一個 transformers.modeling_outputs.BaseModelOutputWithCrossAttentions 或一個 torch.FloatTensor 的元組（如果傳遞了 return_dict=False 或 config.return_dict=False），根據配置 (ElectraConfig) 和輸入包含不同的元素。

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

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

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

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

用於預訓練的 Electra

class transformers.ElectraForPreTraining

< >

（ config ）

引數

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

帶有一個二元分類頭的 Electra 模型，用於在預訓練期間識別生成的標記。

建議將判別器的檢查點載入到該模型中。

該模型繼承自 PreTrainedModel。請查閱超類文件以瞭解該庫為所有模型實現的通用方法（例如下載或儲存、調整輸入嵌入大小、修剪注意力頭等）。

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

forward

< >

（ input_ids: typing.Optional[torch.Tensor] = None attention_mask: typing.Optional[torch.Tensor] = None token_type_ids: typing.Optional[torch.Tensor] = None position_ids: typing.Optional[torch.Tensor] = None head_mask: typing.Optional[torch.Tensor] = None inputs_embeds: typing.Optional[torch.Tensor] = None labels: typing.Optional[torch.Tensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ） → transformers.models.electra.modeling_electra.ElectraForPreTrainingOutput 或 tuple(torch.FloatTensor)

引數

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

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

    什麼是輸入 ID？

  • attention_mask (torch.Tensor，形狀為 (batch_size, sequence_length)，可選) — 用於避免對填充標記索引執行注意力操作的掩碼。掩碼值在 [0, 1] 中選擇：

    • 1 表示標記未被遮蓋，
    • 0 表示標記已被遮蓋。

    什麼是注意力掩碼？

  • token_type_ids (torch.Tensor，形狀為 (batch_size, sequence_length)，可選) — 段標記索引，用於指示輸入的第一部分和第二部分。索引在 [0, 1] 中選擇：

    • 0 對應於 *句子 A* 的標記，
    • 1 對應於 *句子 B* 的標記。

    什麼是標記型別 ID？

  • position_ids (torch.Tensor，形狀為 (batch_size, sequence_length)，可選) — 每個輸入序列標記在位置嵌入中的位置索引。在 [0, config.n_positions - 1] 範圍內選擇。

    什麼是位置 ID？

  • head_mask (torch.Tensor，形狀為 (num_heads,) 或 (num_layers, num_heads)，可選) — 用於置零自注意力模組中選定頭的掩碼。掩碼值在 [0, 1] 中選擇：

    • 1 表示頭未被遮蓋，
    • 0 表示頭已被遮蓋。
  • inputs_embeds (torch.Tensor，形狀為 (batch_size, sequence_length, hidden_size)，可選) — 可選地，你可以不傳遞 input_ids，而是直接傳遞一個嵌入表示。這在你希望對如何將 input_ids 索引轉換為關聯向量進行更多控制時非常有用，而不是使用模型內部的嵌入查詢矩陣。
  • labels (torch.LongTensor，形狀為 (batch_size, sequence_length)，可選) — 用於計算 ELECTRA 損失的標籤。輸入應為標記序列（參見 input_ids 文件）。索引應在 [0, 1] 中：

    • 0 表示該標記是原始標記，
    • 1 表示該標記被替換。
  • output_attentions (bool，可選) — 是否返回所有注意力層的注意力張量。有關更多詳細資訊，請參閱返回張量下的 attentions。
  • output_hidden_states (bool，可選) — 是否返回所有層的隱藏狀態。有關更多詳細資訊，請參閱返回張量下的 hidden_states。
  • return_dict (bool，可選) — 是否返回一個 ModelOutput 而不是一個普通的元組。

返回

transformers.models.electra.modeling_electra.ElectraForPreTrainingOutput 或 tuple(torch.FloatTensor)

一個 transformers.models.electra.modeling_electra.ElectraForPreTrainingOutput 或一個 torch.FloatTensor 的元組（如果傳遞了 return_dict=False 或 config.return_dict=False），根據配置 (ElectraConfig) 和輸入包含不同的元素。

  • loss (*可選*，當提供 labels 時返回，torch.FloatTensor，形狀為 (1,)) — ELECTRA 目標函式的總損失。

  • logits (torch.FloatTensor，形狀為 (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 後的注意力權重，用於計算自注意力頭中的加權平均值。

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

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

示例

>>> from transformers import ElectraForPreTraining, AutoTokenizer
>>> import torch

>>> discriminator = ElectraForPreTraining.from_pretrained("google/electra-base-discriminator")
>>> tokenizer = AutoTokenizer.from_pretrained("google/electra-base-discriminator")

>>> sentence = "The quick brown fox jumps over the lazy dog"
>>> fake_sentence = "The quick brown fox fake over the lazy dog"

>>> fake_tokens = tokenizer.tokenize(fake_sentence, add_special_tokens=True)
>>> fake_inputs = tokenizer.encode(fake_sentence, return_tensors="pt")
>>> discriminator_outputs = discriminator(fake_inputs)
>>> predictions = torch.round((torch.sign(discriminator_outputs[0]) + 1) / 2)

>>> fake_tokens
['[CLS]', 'the', 'quick', 'brown', 'fox', 'fake', 'over', 'the', 'lazy', 'dog', '[SEP]']

>>> predictions.squeeze().tolist()
[0.0, 0.0, 0.0, 0.0, 0.0, 1.0, 0.0, 0.0, 0.0, 0.0, 0.0]

用於因果語言建模的 Electra

class transformers.ElectraForCausalLM

< >

（ config ）

引數

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

帶有一個用於因果語言建模（CLM）微調的 `語言建模` 頭的 ELECTRA 模型。

該模型繼承自 PreTrainedModel。請查閱超類文件以瞭解該庫為所有模型實現的通用方法（例如下載或儲存、調整輸入嵌入大小、修剪注意力頭等）。

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

forward

< >

（ input_ids: typing.Optional[torch.Tensor] = None attention_mask: typing.Optional[torch.Tensor] = None token_type_ids: typing.Optional[torch.Tensor] = None position_ids: typing.Optional[torch.Tensor] = None head_mask: typing.Optional[torch.Tensor] = None inputs_embeds: typing.Optional[torch.Tensor] = None encoder_hidden_states: typing.Optional[torch.Tensor] = None encoder_attention_mask: typing.Optional[torch.Tensor] = None labels: typing.Optional[torch.Tensor] = None past_key_values: typing.Optional[list[torch.Tensor]] = None use_cache: typing.Optional[bool] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None **kwargs ） → transformers.modeling_outputs.CausalLMOutputWithCrossAttentions 或 tuple(torch.FloatTensor)

引數

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

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

    什麼是輸入 ID？

  • attention_mask (torch.Tensor，形狀為 (batch_size, sequence_length)，可選) — 用於避免對填充標記索引執行注意力操作的掩碼。掩碼值在 [0, 1] 中選擇：

    • 1 表示標記未被遮蓋，
    • 0 表示標記已被遮蓋。

    什麼是注意力掩碼？

  • token_type_ids (torch.Tensor，形狀為 (batch_size, sequence_length)，可選) — 段標記索引，用於指示輸入的第一部分和第二部分。索引在 [0, 1] 中選擇：

    • 0 對應於 *句子 A* 的標記，
    • 1 對應於 *句子 B* 的標記。

    什麼是標記型別 ID？

  • position_ids (torch.Tensor，形狀為 (batch_size, sequence_length)，可選) — 每個輸入序列標記在位置嵌入中的位置索引。在 [0, config.n_positions - 1] 範圍內選擇。

    什麼是位置 ID？

  • head_mask (torch.Tensor，形狀為 (num_heads,) 或 (num_layers, num_heads)，可選) — 用於置零自注意力模組中選定頭的掩碼。掩碼值在 [0, 1] 中選擇：

    • 1 表示頭未被遮蓋，
    • 0 表示頭已被遮蓋。
  • inputs_embeds (torch.Tensor，形狀為 (batch_size, sequence_length, hidden_size)，可選) — 可選地，你可以不傳遞 input_ids，而是直接傳遞一個嵌入表示。這在你希望對如何將 input_ids 索引轉換為關聯向量進行更多控制時非常有用，而不是使用模型內部的嵌入查詢矩陣。
  • encoder_hidden_states (torch.Tensor，形狀為 (batch_size, sequence_length, hidden_size)，可選) — 編碼器最後一層輸出的隱藏狀態序列。如果模型配置為解碼器，則在交叉注意力中使用。
  • encoder_attention_mask (torch.Tensor，形狀為 (batch_size, sequence_length)，可選) — 用於避免對編碼器輸入的填充標記索引執行注意力操作的掩碼。如果模型配置為解碼器，則此掩碼用於交叉注意力。掩碼值在 [0, 1] 中選擇：

    • 1 表示標記未被遮蓋，
    • 0 表示標記已被遮蓋。
  • labels (torch.LongTensor，形狀為 (batch_size, sequence_length)，可選) — 用於計算從左到右語言建模損失（下一個詞預測）的標籤。索引應在 [-100, 0, ..., config.vocab_size] 中（參見 input_ids 文件）。索引設定為 -100 的標記將被忽略（遮蓋），損失僅對標籤在 [0, ..., config.vocab_size] 中的標記計算。
  • past_key_values (list[torch.Tensor]，可選) — 預先計算的隱藏狀態（自注意力和交叉注意力塊中的鍵和值），可用於加速順序解碼。這通常包括當 use_cache=True 或 config.use_cache=True 時，模型在解碼的前一階段返回的 past_key_values。

    允許兩種格式：

    • 一個 Cache 例項，請參閱我們的 kv 快取指南；
    • 長度為 config.n_layers 的 tuple(torch.FloatTensor) 元組，其中每個元組有 2 個形狀為 (batch_size, num_heads, sequence_length, embed_size_per_head) 的張量。這也稱為舊版快取格式。

    模型將輸出與輸入相同的快取格式。如果沒有傳遞 past_key_values，將返回舊版快取格式。

    如果使用 past_key_values，使用者可以選擇只輸入形狀為 (batch_size, 1) 的最後一個 input_ids（那些沒有提供其過去鍵值狀態給此模型的標記），而不是形狀為 (batch_size, sequence_length) 的所有 input_ids。

  • use_cache (bool，可選) — 如果設定為 True，將返回 past_key_values 鍵值狀態，可用於加速解碼（請參閱 past_key_values）。
  • output_attentions (bool，可選) — 是否返回所有注意力層的注意力張量。有關更多詳細資訊，請參閱返回張量下的 attentions。
  • output_hidden_states (bool，可選) — 是否返回所有層的隱藏狀態。有關更多詳細資訊，請參閱返回張量下的 hidden_states。
  • return_dict (bool, 可選) — 是否返回一個 ModelOutput 而不是一個普通的元組。

返回

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

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

  • 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 輸入）加速順序解碼。

ElectraForCausalLM 的 forward 方法，重寫了 __call__ 特殊方法。

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

示例

>>> from transformers import AutoTokenizer, ElectraForCausalLM, ElectraConfig
>>> import torch

>>> tokenizer = AutoTokenizer.from_pretrained("google/electra-base-generator")
>>> config = ElectraConfig.from_pretrained("google/electra-base-generator")
>>> config.is_decoder = True
>>> model = ElectraForCausalLM.from_pretrained("google/electra-base-generator", config=config)

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

>>> prediction_logits = outputs.logits

ElectraForMaskedLM

class transformers.ElectraForMaskedLM

< >

（ config ）

引數

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

Electra 模型頂部帶有一個語言建模頭。

儘管判別器和生成器都可能被載入到這個模型中，但只有生成器是為掩碼語言建模任務進行訓練的。

該模型繼承自 PreTrainedModel。請查閱超類文件以瞭解該庫為所有模型實現的通用方法（例如下載或儲存、調整輸入嵌入大小、修剪注意力頭等）。

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

forward

< >

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

引數

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

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

    什麼是輸入 ID？

  • 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* 詞元。

    什麼是詞元型別 ID？

  • position_ids (形狀為 (batch_size, sequence_length) 的 torch.Tensor, 可選) — 位置嵌入中每個輸入序列詞元的位置索引。在 [0, config.n_positions - 1] 範圍內選擇。

    什麼是位置 ID？

  • 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 索引轉換為關聯向量，這會非常有用。
  • labels (形狀為 (batch_size, sequence_length) 的 torch.LongTensor, 可選) — 用於計算掩碼語言建模損失的標籤。索引應在 [-100, 0, ..., config.vocab_size] 中（參見 input_ids 文件字串）。索引設定為 -100 的詞元將被忽略（掩碼），損失僅針對標籤在 [0, ..., config.vocab_size] 中的詞元進行計算。
  • output_attentions (bool, 可選) — 是否返回所有注意力層的注意力張量。有關更多詳細資訊，請參閱返回張量下的 attentions。
  • output_hidden_states (bool, 可選) — 是否返回所有層的隱藏狀態。有關更多詳細資訊，請參閱返回張量下的 hidden_states。
  • return_dict (bool, 可選) — 是否返回一個 ModelOutput 而不是一個普通的元組。

返回

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

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

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

ElectraForMaskedLM 的 forward 方法，重寫了 __call__ 特殊方法。

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

示例

>>> from transformers import AutoTokenizer, ElectraForMaskedLM
>>> import torch

>>> tokenizer = AutoTokenizer.from_pretrained("google/electra-small-discriminator")
>>> model = ElectraForMaskedLM.from_pretrained("google/electra-small-discriminator")

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

ElectraForSequenceClassification

class transformers.ElectraForSequenceClassification

< >

（ config ）

引數

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

ELECTRA 模型 Transformer，頂部帶有一個序列分類/迴歸頭（在池化輸出之上有一個線性層），例如用於 GLUE 任務。

該模型繼承自 PreTrainedModel。請查閱超類文件以瞭解該庫為所有模型實現的通用方法（例如下載或儲存、調整輸入嵌入大小、修剪注意力頭等）。

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

forward

< >

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

引數

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

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

    什麼是輸入 ID？

  • 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* 詞元。

    什麼是詞元型別 ID？

  • position_ids (形狀為 (batch_size, sequence_length) 的 torch.Tensor, 可選) — 位置嵌入中每個輸入序列詞元的位置索引。在 [0, config.n_positions - 1] 範圍內選擇。

    什麼是位置 ID？

  • 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 索引轉換為關聯向量，這會非常有用。
  • labels (形狀為 (batch_size,) 的 torch.LongTensor, 可選) — 用於計算序列分類/迴歸損失的標籤。索引應在 [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 時），包含根據配置 (ElectraConfig) 和輸入而定的各種元素。

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

ElectraForSequenceClassification 的 forward 方法，重寫了 __call__ 特殊方法。

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

單標籤分類示例

>>> import torch
>>> from transformers import AutoTokenizer, ElectraForSequenceClassification

>>> tokenizer = AutoTokenizer.from_pretrained("google/electra-small-discriminator")
>>> model = ElectraForSequenceClassification.from_pretrained("google/electra-small-discriminator")

>>> 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 = ElectraForSequenceClassification.from_pretrained("google/electra-small-discriminator", num_labels=num_labels)

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

多標籤分類示例

>>> import torch
>>> from transformers import AutoTokenizer, ElectraForSequenceClassification

>>> tokenizer = AutoTokenizer.from_pretrained("google/electra-small-discriminator")
>>> model = ElectraForSequenceClassification.from_pretrained("google/electra-small-discriminator", 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 = ElectraForSequenceClassification.from_pretrained(
...     "google/electra-small-discriminator", 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

ElectraForMultipleChoice

class transformers.ElectraForMultipleChoice

< >

（ config ）

引數

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

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

該模型繼承自 PreTrainedModel。請查閱超類文件以瞭解該庫為所有模型實現的通用方法（例如下載或儲存、調整輸入嵌入大小、修剪注意力頭等）。

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

forward

< >

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

引數

  • input_ids (形狀為 (batch_size, num_choices, sequence_length) 的 torch.LongTensor) — 詞彙表中輸入序列詞元的索引。

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

    什麼是輸入 ID？

  • attention_mask (形狀為 (batch_size, sequence_length) 的 torch.Tensor, 可選) — 用於避免對填充詞元索引執行注意力操作的掩碼。掩碼值在 [0, 1] 中選擇：

    • 1 表示詞元未被掩碼,
    • 0 表示詞元被掩碼。

    什麼是注意力掩碼？

  • token_type_ids (形狀為 (batch_size, num_choices, sequence_length) 的 torch.LongTensor, 可選) — 用於指示輸入的第一和第二部分的段詞元索引。索引在 [0, 1] 中選擇：

    • 0 對應於 *句子 A* 詞元,
    • 1 對應於 *句子 B* 詞元。

    什麼是詞元型別 ID？

  • position_ids (形狀為 (batch_size, num_choices, sequence_length) 的 torch.LongTensor, 可選) — 位置嵌入中每個輸入序列詞元的位置索引。在 [0, config.max_position_embeddings - 1] 範圍內選擇。

    什麼是位置 ID？

  • head_mask (形狀為 (num_heads,) 或 (num_layers, num_heads) 的 torch.Tensor, 可選) — 用於置零自注意力模組中選定頭的掩碼。掩碼值在 [0, 1] 中選擇：

    • 1 表示頭未被掩碼,
    • 0 表示頭被掩碼。
  • inputs_embeds (形狀為 (batch_size, num_choices, sequence_length, hidden_size) 的 torch.FloatTensor, 可選) — 可選地，你可以選擇直接傳遞嵌入表示而不是 input_ids。如果你想比模型內部的嵌入查詢矩陣更好地控制如何將 input_ids 索引轉換為關聯向量，這會非常有用。
  • labels (形狀為 (batch_size,) 的 torch.LongTensor, 可選) — 用於計算多項選擇分類損失的標籤。索引應在 [0, ..., num_choices-1] 中，其中 num_choices 是輸入張量第二維的大小。（參見上面的 input_ids）
  • output_attentions (bool, 可選) — 是否返回所有注意力層的注意力張量。有關更多詳細資訊，請參閱返回張量下的 attentions。
  • output_hidden_states (bool, optional) — 是否返回所有層的隱藏狀態。有關更多詳細資訊，請參閱返回張量下的 hidden_states。
  • return_dict (bool, optional) — 是否返回一個 ModelOutput 而不是一個普通的元組。

返回

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

transformers.modeling_outputs.MultipleChoiceModelOutput 或 torch.FloatTensor 的元組（如果傳遞了 return_dict=False 或 config.return_dict=False），包含根據配置（ElectraConfig）和輸入而異的各種元素。

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

ElectraForMultipleChoice 的 forward 方法覆蓋了 __call__ 特殊方法。

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

示例

>>> from transformers import AutoTokenizer, ElectraForMultipleChoice
>>> import torch

>>> tokenizer = AutoTokenizer.from_pretrained("google/electra-small-discriminator")
>>> model = ElectraForMultipleChoice.from_pretrained("google/electra-small-discriminator")

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

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

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

ElectraForTokenClassification

class transformers.ElectraForTokenClassification

< >

（ config ）

引數

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

Electra 模型，其頂部帶有一個詞元分類頭。

判別器和生成器都可以載入到此模型中。

該模型繼承自 PreTrainedModel。請查閱超類文件以瞭解該庫為所有模型實現的通用方法（例如下載或儲存、調整輸入嵌入大小、修剪注意力頭等）。

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

forward

< >

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

引數

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

    可以使用 AutoTokenizer 獲得索引。詳情請參閱 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。

    什麼是 input ID？

  • attention_mask (torch.Tensor，形狀為 (batch_size, sequence_length)，可選) — 用於避免對填充詞元索引執行注意力操作的掩碼。掩碼值在 [0, 1] 中選擇：

    • 1 表示詞元未被掩碼，
    • 0 表示詞元被掩碼。

    什麼是注意力掩碼？

  • token_type_ids (torch.Tensor，形狀為 (batch_size, sequence_length)，可選) — 指示輸入的第一和第二部分的段詞元索引。索引在 [0, 1] 中選擇：

    • 0 對應一個 句子 A 的詞元，
    • 1 對應一個 句子 B 的詞元。

    什麼是詞元型別 ID？

  • position_ids (torch.Tensor，形狀為 (batch_size, sequence_length)，可選) — 每個輸入序列詞元在位置嵌入中的位置索引。在 [0, config.n_positions - 1] 範圍內選擇。

    什麼是位置 ID？

  • head_mask (torch.Tensor，形狀為 (num_heads,) 或 (num_layers, num_heads)，可選) — 用於置零自注意力模組中選定頭的掩碼。掩碼值在 [0, 1] 中選擇：

    • 1 表示頭未被掩碼，
    • 0 表示頭被掩碼。
  • inputs_embeds (torch.Tensor，形狀為 (batch_size, sequence_length, hidden_size)，可選) — 可選地，你可以選擇直接傳遞嵌入表示，而不是傳遞 input_ids。如果你想比模型內部的嵌入查詢矩陣更好地控制如何將 input_ids 索引轉換為關聯向量，這將非常有用。
  • labels (torch.LongTensor，形狀為 (batch_size, sequence_length)，可選) — 用於計算詞元分類損失的標籤。索引應在 [0, ..., config.num_labels - 1] 範圍內。
  • output_attentions (bool, optional) — 是否返回所有注意力層的注意力張量。有關更多詳細資訊，請參閱返回張量下的 attentions。
  • output_hidden_states (bool, optional) — 是否返回所有層的隱藏狀態。有關更多詳細資訊，請參閱返回張量下的 hidden_states。
  • return_dict (bool, optional) — 是否返回一個 ModelOutput 而不是一個普通的元組。

返回

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

transformers.modeling_outputs.TokenClassifierOutput 或 torch.FloatTensor 的元組（如果傳遞了 return_dict=False 或 config.return_dict=False），包含根據配置（ElectraConfig）和輸入而異的各種元素。

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

ElectraForTokenClassification 的 forward 方法覆蓋了 __call__ 特殊方法。

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

示例

>>> from transformers import AutoTokenizer, ElectraForTokenClassification
>>> import torch

>>> tokenizer = AutoTokenizer.from_pretrained("google/electra-small-discriminator")
>>> model = ElectraForTokenClassification.from_pretrained("google/electra-small-discriminator")

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

ElectraForQuestionAnswering

class transformers.ElectraForQuestionAnswering

< >

（ config ）

引數

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

Electra transformer，頂部帶有一個片段分類頭，用於像 SQuAD 這樣的抽取式問答任務（在隱藏狀態輸出之上有一個線性層，用於計算 `span start logits` 和 `span end logits`）。

該模型繼承自 PreTrainedModel。請查閱超類文件以瞭解該庫為所有模型實現的通用方法（例如下載或儲存、調整輸入嵌入大小、修剪注意力頭等）。

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

forward

< >

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

引數

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

    可以使用 AutoTokenizer 獲得索引。詳情請參閱 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。

    什麼是 input ID？

  • attention_mask (torch.Tensor，形狀為 (batch_size, sequence_length)，可選) — 用於避免對填充詞元索引執行注意力操作的掩碼。掩碼值在 [0, 1] 中選擇：

    • 1 表示詞元未被掩碼，
    • 0 表示詞元被掩碼。

    什麼是注意力掩碼？

  • token_type_ids (torch.Tensor，形狀為 (batch_size, sequence_length)，可選) — 指示輸入的第一和第二部分的段詞元索引。索引在 [0, 1] 中選擇：

    • 0 對應一個 句子 A 的詞元，
    • 1 對應一個 句子 B 的詞元。

    什麼是詞元型別 ID？

  • position_ids (torch.Tensor，形狀為 (batch_size, sequence_length)，可選) — 每個輸入序列詞元在位置嵌入中的位置索引。在 [0, config.n_positions - 1] 範圍內選擇。

    什麼是位置 ID？

  • head_mask (torch.Tensor，形狀為 (num_heads,) 或 (num_layers, num_heads)，可選) — 用於置零自注意力模組中選定頭的掩碼。掩碼值在 [0, 1] 中選擇：

    • 1 表示頭未被掩碼，
    • 0 表示頭被掩碼。
  • inputs_embeds (torch.Tensor，形狀為 (batch_size, sequence_length, hidden_size)，可選) — 可選地，你可以選擇直接傳遞嵌入表示，而不是傳遞 input_ids。如果你想比模型內部的嵌入查詢矩陣更好地控制如何將 input_ids 索引轉換為關聯向量，這將非常有用。
  • start_positions (torch.Tensor，形狀為 (batch_size,)，可選) — 用於計算詞元分類損失的標記片段開始位置（索引）的標籤。位置被限制在序列長度（sequence_length）範圍內。序列之外的位置不計入損失計算。
  • end_positions (torch.Tensor，形狀為 (batch_size,)，可選) — 用於計算詞元分類損失的標記片段結束位置（索引）的標籤。位置被限制在序列長度（sequence_length）範圍內。序列之外的位置不計入損失計算。
  • output_attentions (bool, optional) — 是否返回所有注意力層的注意力張量。有關更多詳細資訊，請參閱返回張量下的 attentions。
  • output_hidden_states (bool, optional) — 是否返回所有層的隱藏狀態。有關更多詳細資訊，請參閱返回張量下的 hidden_states。
  • return_dict (bool, optional) — 是否返回一個 ModelOutput 而不是一個普通的元組。

返回

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

transformers.modeling_outputs.QuestionAnsweringModelOutput 或 torch.FloatTensor 的元組（如果傳遞了 return_dict=False 或 config.return_dict=False），包含根據配置（ElectraConfig）和輸入而異的各種元素。

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

ElectraForQuestionAnswering 的 forward 方法覆蓋了 __call__ 特殊方法。

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

示例

>>> from transformers import AutoTokenizer, ElectraForQuestionAnswering
>>> import torch

>>> tokenizer = AutoTokenizer.from_pretrained("google/electra-small-discriminator")
>>> model = ElectraForQuestionAnswering.from_pretrained("google/electra-small-discriminator")

>>> question, text = "Who was Jim Henson?", "Jim Henson was a nice puppet"

>>> inputs = tokenizer(question, text, return_tensors="pt")
>>> with torch.no_grad():
...     outputs = model(**inputs)

>>> answer_start_index = outputs.start_logits.argmax()
>>> answer_end_index = outputs.end_logits.argmax()

>>> predict_answer_tokens = inputs.input_ids[0, answer_start_index : answer_end_index + 1]
>>> tokenizer.decode(predict_answer_tokens, skip_special_tokens=True)
...

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

>>> outputs = model(**inputs, start_positions=target_start_index, end_positions=target_end_index)
>>> loss = outputs.loss
>>> round(loss.item(), 2)
...
TensorFlow
隱藏 TensorFlow 內容

TFElectraModel

class transformers.TFElectraModel

< >

( config *inputs **kwargs )

引數

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

基礎的 Electra Model transformer，輸出原始的隱藏狀態，沒有任何特定的頭。與 BERT 模型相同，但如果隱藏大小和嵌入大小不同，則在嵌入層和編碼器之間使用一個額外的線性層。生成器和判別器的檢查點都可以載入到此模型中。

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

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

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

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

支援第二種格式的原因是 Keras 方法在向模型和層傳遞輸入時更喜歡這種格式。由於這種支援，當使用像 `model.fit()` 這樣的方法時，一切都應該“正常工作”——只需以 `model.fit()` 支援的任何格式傳遞你的輸入和標籤！然而，如果你想在 Keras 方法（如 `fit()` 和 `predict()`）之外使用第二種格式，例如在使用 Keras `Functional` API 建立自己的層或模型時，有三種可能性可以用來將所有輸入張量收集到第一個位置引數中

  • 只有一個 input_ids 的單個張量，沒有其他：model(input_ids)
  • 長度可變的列表，包含一個或多個輸入張量，按文件字串中給出的順序：model([input_ids, attention_mask]) 或 model([input_ids, attention_mask, token_type_ids])
  • 一個字典，其中包含一個或多個與文件字串中給出的輸入名稱關聯的輸入張量：model({"input_ids": input_ids, "token_type_ids": token_type_ids})

請注意，當使用子類化建立模型和層時，您無需擔心任何這些，因為您可以像呼叫任何其他 Python 函式一樣傳遞輸入！

呼叫

< >

( input_ids: TFModelInputType | None = None attention_mask: np.ndarray | tf.Tensor | None = None token_type_ids: np.ndarray | tf.Tensor | None = None position_ids: np.ndarray | tf.Tensor | None = None head_mask: np.ndarray | tf.Tensor | None = None inputs_embeds: np.ndarray | tf.Tensor | None = None encoder_hidden_states: np.ndarray | tf.Tensor | None = None encoder_attention_mask: np.ndarray | tf.Tensor | None = None past_key_values: Optional[tuple[tuple[Union[np.ndarray, tf.Tensor]]]] = None use_cache: Optional[bool] = None output_attentions: Optional[bool] = None output_hidden_states: Optional[bool] = None return_dict: Optional[bool] = None training: Optional[bool] = False ) → transformers.modeling_tf_outputs.TFBaseModelOutputWithPastAndCrossAttentions 或 tuple(tf.Tensor)

引數

  • input_ids (Numpy array 或 tf.Tensor，形狀為 (batch_size, sequence_length)) — 詞彙表中輸入序列詞元的索引。

    可以使用 AutoTokenizer 獲得索引。詳情請參閱 PreTrainedTokenizer.call() 和 PreTrainedTokenizer.encode()。

    什麼是 input ID？

  • attention_mask (Numpy array 或 tf.Tensor，形狀為 (batch_size, sequence_length)，可選) — 用於避免對填充詞元索引執行注意力操作的掩碼。掩碼值在 [0, 1] 中選擇：

    • 1 表示詞元未被掩碼，
    • 0 表示詞元被掩碼。

    什麼是注意力掩碼？

  • position_ids (Numpy array 或 tf.Tensor，形狀為 (batch_size, sequence_length)，可選) — 每個輸入序列詞元在位置嵌入中的位置索引。在 [0, config.max_position_embeddings - 1] 範圍內選擇。

    什麼是位置 ID？

  • head_mask (Numpy array 或 tf.Tensor，形狀為 (num_heads,) 或 (num_layers, num_heads)，可選) — 用於置零自注意力模組中選定頭的掩碼。掩碼值在 [0, 1] 中選擇：

    • 1 表示頭未被掩碼，
    • 0 表示頭被掩碼。
  • inputs_embeds (tf.Tensor，形狀為 (batch_size, sequence_length, hidden_size)，可選) — 可選地，你可以選擇直接傳遞嵌入表示，而不是傳遞 input_ids。如果你想比模型內部的嵌入查詢矩陣更好地控制如何將 input_ids 索引轉換為關聯向量，這將非常有用。
  • output_attentions (bool, optional) — 是否返回所有注意力層的注意力張量。有關更多詳細資訊，請參閱返回張量下的 attentions。此引數只能在 eager 模式下使用，在 graph 模式下將使用配置中的值。
  • output_hidden_states (bool, optional) — 是否返回所有層的隱藏狀態。有關更多詳細資訊，請參閱返回張量下的 hidden_states。此引數只能在 eager 模式下使用，在 graph 模式下將使用配置中的值。
  • return_dict (bool, 可選) — 是否返回一個 ModelOutput 而不是一個普通的元組。此引數可在即時模式（eager mode）下使用，在圖模式（graph mode）下，該值將始終設定為 True。
  • training (bool, 可選, 預設為 False) — 是否在訓練模式下使用模型（某些模組如 dropout 模組在訓練和評估模式下有不同的行為）。
  • encoder_hidden_states (tf.Tensor，形狀為 (batch_size, sequence_length, hidden_size), 可選) — 編碼器最後一層輸出的隱藏狀態序列。如果模型被配置為解碼器，則在交叉注意力（cross-attention）中使用。
  • encoder_attention_mask (tf.Tensor，形狀為 (batch_size, sequence_length), 可選) — 用於避免在編碼器輸入的填充標記索引上執行注意力的掩碼。如果模型被配置為解碼器，則在交叉注意力（cross-attention）中使用此掩碼。掩碼值選自 [0, 1]：

    • 1 表示標記未被遮蔽，
    • 0 表示標記已被遮蔽。
  • past_key_values (tuple[tuple[tf.Tensor]]，長度為 config.n_layers) — 包含預計算的注意力塊的鍵和值隱藏狀態。可用於加速解碼。如果使用 past_key_values，使用者可以選擇只輸入最後一個 decoder_input_ids（那些沒有提供其過去鍵值狀態給此模型的 decoder_input_ids），形狀為 (batch_size, 1)，而不是所有形狀為 (batch_size, sequence_length) 的 decoder_input_ids。
  • use_cache (bool, 可選, 預設為 True) — 如果設定為 True，則返回 past_key_values 鍵值狀態，可用於加速解碼（參見 past_key_values）。訓練時設定為 False，生成時設定為 True。

返回

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

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

  • last_hidden_state (tf.Tensor of shape (batch_size, sequence_length, hidden_size)) — 模型最後一層輸出的隱藏狀態序列。

    如果使用了 past_key_values，則只輸出形狀為 (batch_size, 1, hidden_size) 的序列的最後一個隱藏狀態。

  • past_key_values (list[tf.Tensor], 可選, 當傳遞了 use_cache=True 或 config.use_cache=True 時返回) — 長度為 config.n_layers 的 tf.Tensor 列表，每個張量的形狀為 (2, batch_size, num_heads, sequence_length, embed_size_per_head)。

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

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

  • cross_attentions (tuple(tf.Tensor), 可選, 當傳遞了 output_attentions=True 或 config.output_attentions=True 時返回) — tf.Tensor 的元組（每一層一個），形狀為 (batch_size, num_heads, sequence_length, sequence_length)。

    解碼器交叉注意力層的注意力權重，在注意力 softmax 之後，用於計算交叉注意力頭中的加權平均。

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

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

示例

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

>>> tokenizer = AutoTokenizer.from_pretrained("google/electra-small-discriminator")
>>> model = TFElectraModel.from_pretrained("google/electra-small-discriminator")

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

>>> last_hidden_states = outputs.last_hidden_state

TFElectraForPreTraining

class transformers.TFElectraForPreTraining

< >

( config **kwargs )

引數

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

帶有一個二元分類頭的 Electra 模型，用於在預訓練期間識別生成的標記。

儘管判別器和生成器都可能被載入到這個模型中，但只有判別器擁有用於此模型的正確分類頭。

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

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

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

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

支援第二種格式的原因是 Keras 方法在向模型和層傳遞輸入時更喜歡這種格式。由於這種支援，當使用像 `model.fit()` 這樣的方法時，一切都應該“正常工作”——只需以 `model.fit()` 支援的任何格式傳遞你的輸入和標籤！然而，如果你想在 Keras 方法（如 `fit()` 和 `predict()`）之外使用第二種格式，例如在使用 Keras `Functional` API 建立自己的層或模型時，有三種可能性可以用來將所有輸入張量收集到第一個位置引數中

  • 只有一個 input_ids 的單個張量，沒有其他：model(input_ids)
  • 長度可變的列表，包含一個或多個輸入張量，按文件字串中給出的順序：model([input_ids, attention_mask]) 或 model([input_ids, attention_mask, token_type_ids])
  • 一個字典，其中包含一個或多個與文件字串中給出的輸入名稱關聯的輸入張量：model({"input_ids": input_ids, "token_type_ids": token_type_ids})

請注意，當使用子類化建立模型和層時，您無需擔心任何這些，因為您可以像呼叫任何其他 Python 函式一樣傳遞輸入！

呼叫

< >

( input_ids: TFModelInputType | None = None attention_mask: np.ndarray | tf.Tensor | None = None token_type_ids: np.ndarray | tf.Tensor | None = None position_ids: np.ndarray | tf.Tensor | None = None head_mask: np.ndarray | tf.Tensor | None = None inputs_embeds: np.ndarray | tf.Tensor | None = None output_attentions: Optional[bool] = None output_hidden_states: Optional[bool] = None return_dict: Optional[bool] = None training: Optional[bool] = False ) → transformers.models.electra.modeling_tf_electra.TFElectraForPreTrainingOutput 或 tuple(tf.Tensor)

引數

  • input_ids (Numpy 陣列 或 tf.Tensor，形狀為 (batch_size, sequence_length)) — 詞彙表中輸入序列標記的索引。

    索引可以使用 AutoTokenizer 獲得。詳情請參閱 PreTrainedTokenizer.call() 和 PreTrainedTokenizer.encode()。

    什麼是輸入 ID？

  • attention_mask (Numpy 陣列 或 tf.Tensor，形狀為 (batch_size, sequence_length), 可選) — 用於避免在填充標記索引上執行注意力的掩碼。掩碼值選自 [0, 1]：

    • 1 表示標記未被遮蔽，
    • 0 表示標記已被遮蔽。

    什麼是注意力掩碼？

  • position_ids (Numpy 陣列 或 tf.Tensor，形狀為 (batch_size, sequence_length), 可選) — 每個輸入序列標記在位置嵌入中的位置索引。選值範圍為 [0, config.max_position_embeddings - 1]。

    什麼是位置 ID？

  • head_mask (Numpy 陣列 或 tf.Tensor，形狀為 (num_heads,) 或 (num_layers, num_heads), 可選) — 用於使自注意力模組中選定的頭無效的掩碼。掩碼值選自 [0, 1]：

    • 1 表示頭未被遮蔽，
    • 0 表示頭已被遮蔽。
  • inputs_embeds (tf.Tensor，形狀為 (batch_size, sequence_length, hidden_size), 可選) — 可選地，你可以選擇直接傳遞嵌入表示，而不是傳遞 input_ids。如果你想對如何將 input_ids 索引轉換為相關向量進行更多控制，而不是使用模型內部的嵌入查詢矩陣，這會很有用。
  • output_attentions (bool, 可選) — 是否返回所有注意力層的注意力張量。更多細節請參見返回張量下的 attentions。此引數只能在即時模式（eager mode）下使用，在圖模式（graph mode）下將使用配置中的值。
  • output_hidden_states (bool, 可選) — 是否返回所有層的隱藏狀態。更多細節請參見返回張量下的 hidden_states。此引數只能在即時模式（eager mode）下使用，在圖模式（graph mode）下將使用配置中的值。
  • return_dict (bool, 可選) — 是否返回一個 ModelOutput 而不是一個普通的元組。此引數可在即時模式（eager mode）下使用，在圖模式（graph mode）下，該值將始終設定為 True。
  • training (bool, 可選, 預設為 False) — 是否在訓練模式下使用模型（某些模組如 dropout 模組在訓練和評估模式下有不同的行為）。

返回

transformers.models.electra.modeling_tf_electra.TFElectraForPreTrainingOutput 或 tuple(tf.Tensor)

一個 transformers.models.electra.modeling_tf_electra.TFElectraForPreTrainingOutput 或一個 tf.Tensor 的元組（如果傳遞了 return_dict=False 或當 config.return_dict=False 時），根據配置（ElectraConfig）和輸入，包含不同的元素。

  • loss (可選, 當提供了 labels 時返回，tf.Tensor，形狀為 (1,)) — ELECTRA 目標函式的總損失。

  • logits (tf.Tensor，形狀為 (batch_size, sequence_length)) — 頭的預測分數（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 後的注意力權重，用於計算自注意力頭中的加權平均值。

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

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

示例

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

>>> tokenizer = AutoTokenizer.from_pretrained("google/electra-small-discriminator")
>>> model = TFElectraForPreTraining.from_pretrained("google/electra-small-discriminator")
>>> input_ids = tf.constant(tokenizer.encode("Hello, my dog is cute"))[None, :]  # Batch size 1
>>> outputs = model(input_ids)
>>> scores = outputs[0]

TFElectraForMaskedLM

class transformers.TFElectraForMaskedLM

< >

( config **kwargs )

引數

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

Electra 模型頂部帶有一個語言建模頭。

儘管判別器和生成器都可能被載入到這個模型中，但只有生成器是為掩碼語言建模任務進行訓練的。

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

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

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

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

支援第二種格式的原因是 Keras 方法在向模型和層傳遞輸入時更喜歡這種格式。由於這種支援，當使用像 `model.fit()` 這樣的方法時，一切都應該“正常工作”——只需以 `model.fit()` 支援的任何格式傳遞你的輸入和標籤！然而，如果你想在 Keras 方法（如 `fit()` 和 `predict()`）之外使用第二種格式，例如在使用 Keras `Functional` API 建立自己的層或模型時，有三種可能性可以用來將所有輸入張量收集到第一個位置引數中

  • 只有一個 input_ids 的單個張量，沒有其他：model(input_ids)
  • 長度可變的列表，包含一個或多個輸入張量，按文件字串中給出的順序：model([input_ids, attention_mask]) 或 model([input_ids, attention_mask, token_type_ids])
  • 一個字典，其中包含一個或多個與文件字串中給出的輸入名稱關聯的輸入張量：model({"input_ids": input_ids, "token_type_ids": token_type_ids})

請注意，當使用子類化建立模型和層時，您無需擔心任何這些，因為您可以像呼叫任何其他 Python 函式一樣傳遞輸入！

呼叫

< >

( input_ids: TFModelInputType | None = None attention_mask: np.ndarray | tf.Tensor | None = None token_type_ids: np.ndarray | tf.Tensor | None = None position_ids: np.ndarray | tf.Tensor | None = None head_mask: np.ndarray | tf.Tensor | None = None inputs_embeds: np.ndarray | tf.Tensor | None = None output_attentions: Optional[bool] = None output_hidden_states: Optional[bool] = None return_dict: Optional[bool] = None labels: np.ndarray | tf.Tensor | None = None training: Optional[bool] = False ) → transformers.modeling_tf_outputs.TFMaskedLMOutput 或 tuple(tf.Tensor)

引數

  • input_ids (Numpy 陣列 或 tf.Tensor，形狀為 (batch_size, sequence_length)) — 詞彙表中輸入序列標記的索引。

    索引可以使用 AutoTokenizer 獲得。詳情請參閱 PreTrainedTokenizer.call() 和 PreTrainedTokenizer.encode()。

    什麼是輸入 ID？

  • attention_mask (Numpy 陣列 或 tf.Tensor，形狀為 (batch_size, sequence_length), 可選) — 用於避免在填充標記索引上執行注意力的掩碼。掩碼值選自 [0, 1]：

    • 1 表示標記未被遮蔽，
    • 0 表示標記已被遮蔽。

    什麼是注意力掩碼？

  • position_ids (Numpy 陣列 或 tf.Tensor，形狀為 (batch_size, sequence_length), 可選) — 每個輸入序列標記在位置嵌入中的位置索引。選值範圍為 [0, config.max_position_embeddings - 1]。

    什麼是位置 ID？

  • head_mask (Numpy 陣列 或 tf.Tensor，形狀為 (num_heads,) 或 (num_layers, num_heads), 可選) — 用於使自注意力模組中選定的頭無效的掩碼。掩碼值選自 [0, 1]：

    • 1 表示頭未被遮蔽，
    • 0 表示頭已被遮蔽。
  • inputs_embeds (tf.Tensor，形狀為 (batch_size, sequence_length, hidden_size), 可選) — 可選地，你可以選擇直接傳遞嵌入表示，而不是傳遞 input_ids。如果你想對如何將 input_ids 索引轉換為相關向量進行更多控制，而不是使用模型內部的嵌入查詢矩陣，這會很有用。
  • output_attentions (bool, 可選) — 是否返回所有注意力層的注意力張量。更多細節請參見返回張量下的 attentions。此引數只能在即時模式（eager mode）下使用，在圖模式（graph mode）下將使用配置中的值。
  • output_hidden_states (bool, 可選) — 是否返回所有層的隱藏狀態。更多細節請參見返回張量下的 hidden_states。此引數只能在即時模式（eager mode）下使用，在圖模式（graph mode）下將使用配置中的值。
  • return_dict (bool, 可選) — 是否返回一個 ModelOutput 而不是一個普通的元組。此引數可在即時模式（eager mode）下使用，在圖模式（graph mode）下，該值將始終設定為 True。
  • training (bool, 可選, 預設為 False) — 是否在訓練模式下使用模型（某些模組如 dropout 模組在訓練和評估模式下有不同的行為）。
  • labels (tf.Tensor，形狀為 (batch_size, sequence_length), 可選) — 用於計算掩碼語言建模損失的標籤。索引應在 [-100, 0, ..., config.vocab_size] 範圍內（參見 input_ids 文件字串）。索引設定為 -100 的標記將被忽略（遮蔽），損失僅對標籤在 [0, ..., config.vocab_size] 範圍內的標記進行計算。

返回

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

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

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

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

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

示例

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

>>> tokenizer = AutoTokenizer.from_pretrained("google/electra-small-generator")
>>> model = TFElectraForMaskedLM.from_pretrained("google/electra-small-generator")

>>> inputs = tokenizer("The capital of France is [MASK].", return_tensors="tf")
>>> logits = model(**inputs).logits

>>> # retrieve index of [MASK]
>>> mask_token_index = tf.where((inputs.input_ids == tokenizer.mask_token_id)[0])
>>> selected_logits = tf.gather_nd(logits[0], indices=mask_token_index)

>>> predicted_token_id = tf.math.argmax(selected_logits, axis=-1)
>>> tokenizer.decode(predicted_token_id)
'paris'
>>> labels = tokenizer("The capital of France is Paris.", return_tensors="tf")["input_ids"]
>>> # mask labels of non-[MASK] tokens
>>> labels = tf.where(inputs.input_ids == tokenizer.mask_token_id, labels, -100)

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

TFElectraForSequenceClassification

class transformers.TFElectraForSequenceClassification

< >

( config *inputs **kwargs )

引數

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

ELECTRA 模型 Transformer，頂部帶有一個序列分類/迴歸頭（在池化輸出之上有一個線性層），例如用於 GLUE 任務。

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

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

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

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

支援第二種格式的原因是 Keras 方法在向模型和層傳遞輸入時更喜歡這種格式。由於這種支援，當使用像 `model.fit()` 這樣的方法時，一切都應該“正常工作”——只需以 `model.fit()` 支援的任何格式傳遞你的輸入和標籤！然而，如果你想在 Keras 方法（如 `fit()` 和 `predict()`）之外使用第二種格式，例如在使用 Keras `Functional` API 建立自己的層或模型時，有三種可能性可以用來將所有輸入張量收集到第一個位置引數中

  • 只有一個 input_ids 的單個張量，沒有其他：model(input_ids)
  • 長度可變的列表，包含一個或多個輸入張量，按文件字串中給出的順序：model([input_ids, attention_mask]) 或 model([input_ids, attention_mask, token_type_ids])
  • 一個字典，其中包含一個或多個與文件字串中給出的輸入名稱關聯的輸入張量：model({"input_ids": input_ids, "token_type_ids": token_type_ids})

請注意，當使用子類化建立模型和層時，您無需擔心任何這些，因為您可以像呼叫任何其他 Python 函式一樣傳遞輸入！

呼叫

< >

( input_ids: TFModelInputType | None = None attention_mask: np.ndarray | tf.Tensor | None = None token_type_ids: np.ndarray | tf.Tensor | None = None position_ids: np.ndarray | tf.Tensor | None = None head_mask: np.ndarray | tf.Tensor | None = None inputs_embeds: np.ndarray | tf.Tensor | None = None output_attentions: Optional[bool] = None output_hidden_states: Optional[bool] = None return_dict: Optional[bool] = None labels: np.ndarray | tf.Tensor | None = None training: Optional[bool] = False ) → transformers.modeling_tf_outputs.TFSequenceClassifierOutput 或 tuple(tf.Tensor)

引數

  • input_ids (Numpy 陣列 或 tf.Tensor，形狀為 (batch_size, sequence_length)) — 詞彙表中輸入序列標記的索引。

    索引可以使用 AutoTokenizer 獲得。詳情請參閱 PreTrainedTokenizer.call() 和 PreTrainedTokenizer.encode()。

    什麼是輸入 ID？

  • attention_mask (Numpy 陣列 或 tf.Tensor，形狀為 (batch_size, sequence_length), 可選) — 用於避免在填充標記索引上執行注意力的掩碼。掩碼值選自 [0, 1]：

    • 1 表示標記未被遮蔽，
    • 0 表示標記已被遮蔽。

    什麼是注意力掩碼？

  • position_ids (Numpy 陣列 或 tf.Tensor，形狀為 (batch_size, sequence_length), 可選) — 每個輸入序列標記在位置嵌入中的位置索引。選值範圍為 [0, config.max_position_embeddings - 1]。

    什麼是位置 ID？

  • head_mask (Numpy 陣列 或 tf.Tensor，形狀為 (num_heads,) 或 (num_layers, num_heads), 可選) — 用於使自注意力模組中選定的頭無效的掩碼。掩碼值選自 [0, 1]：

    • 1 表示頭未被遮蔽，
    • 0 表示頭已被遮蔽。
  • inputs_embeds (tf.Tensor，形狀為 (batch_size, sequence_length, hidden_size), 可選) — 可選地，你可以選擇直接傳遞嵌入表示，而不是傳遞 input_ids。如果你想對如何將 input_ids 索引轉換為相關向量進行更多控制，而不是使用模型內部的嵌入查詢矩陣，這會很有用。
  • output_attentions (bool, 可選) — 是否返回所有注意力層的注意力張量。更多細節請參見返回張量下的 attentions。此引數只能在即時模式（eager mode）下使用，在圖模式（graph mode）下將使用配置中的值。
  • output_hidden_states (bool, 可選) — 是否返回所有層的隱藏狀態。更多細節請參見返回張量下的 hidden_states。此引數只能在即時模式（eager mode）下使用，在圖模式（graph mode）下將使用配置中的值。
  • return_dict (bool, 可選) — 是否返回一個 ModelOutput 而不是一個普通的元組。此引數可在即時模式（eager mode）下使用，在圖模式（graph mode）下，該值將始終設定為 True。
  • training (bool, 可選, 預設為 False) — 是否在訓練模式下使用模型（某些模組如 dropout 模組在訓練和評估模式下有不同的行為）。
  • labels (tf.Tensor，形狀為 (batch_size,), 可選) — 用於計算序列分類/迴歸損失的標籤。索引應在 [0, ..., config.num_labels - 1] 範圍內。如果 config.num_labels == 1，則計算迴歸損失（均方損失），如果 config.num_labels > 1，則計算分類損失（交叉熵）。

返回

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

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

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

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

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

示例

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

>>> tokenizer = AutoTokenizer.from_pretrained("bhadresh-savani/electra-base-emotion")
>>> model = TFElectraForSequenceClassification.from_pretrained("bhadresh-savani/electra-base-emotion")

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

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

>>> predicted_class_id = int(tf.math.argmax(logits, axis=-1)[0])
>>> model.config.id2label[predicted_class_id]
'joy'
>>> # 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 = TFElectraForSequenceClassification.from_pretrained("bhadresh-savani/electra-base-emotion", num_labels=num_labels)

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

TFElectraForMultipleChoice

class transformers.TFElectraForMultipleChoice

< >

( config *inputs **kwargs )

引數

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

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

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

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

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

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

支援第二種格式的原因是 Keras 方法在向模型和層傳遞輸入時更喜歡這種格式。由於這種支援，當使用像 `model.fit()` 這樣的方法時，一切都應該“正常工作”——只需以 `model.fit()` 支援的任何格式傳遞你的輸入和標籤！然而，如果你想在 Keras 方法（如 `fit()` 和 `predict()`）之外使用第二種格式，例如在使用 Keras `Functional` API 建立自己的層或模型時，有三種可能性可以用來將所有輸入張量收集到第一個位置引數中

  • 只有一個 input_ids 的單個張量，沒有其他：model(input_ids)
  • 長度可變的列表，包含一個或多個輸入張量，按文件字串中給出的順序：model([input_ids, attention_mask]) 或 model([input_ids, attention_mask, token_type_ids])
  • 一個字典，其中包含一個或多個與文件字串中給出的輸入名稱關聯的輸入張量：model({"input_ids": input_ids, "token_type_ids": token_type_ids})

請注意，當使用子類化建立模型和層時，您無需擔心任何這些，因為您可以像呼叫任何其他 Python 函式一樣傳遞輸入！

呼叫

< >

( input_ids: TFModelInputType | None = None attention_mask: np.ndarray | tf.Tensor | None = None token_type_ids: np.ndarray | tf.Tensor | None = None position_ids: np.ndarray | tf.Tensor | None = None head_mask: np.ndarray | tf.Tensor | None = None inputs_embeds: np.ndarray | tf.Tensor | None = None output_attentions: Optional[bool] = None output_hidden_states: Optional[bool] = None return_dict: Optional[bool] = None labels: np.ndarray | tf.Tensor | None = None training: Optional[bool] = False ) → transformers.modeling_tf_outputs.TFMultipleChoiceModelOutput 或 tuple(tf.Tensor)

引數

  • input_ids (Numpy 陣列 或 tf.Tensor，形狀為 (batch_size, num_choices, sequence_length)) — 詞彙表中輸入序列標記的索引。

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

    什麼是輸入 ID？

  • attention_mask (Numpy 陣列 或 tf.Tensor，形狀為 (batch_size, num_choices, sequence_length)，可選) — 用於避免對填充標記索引執行注意力操作的掩碼。掩碼值選自 [0, 1]：

    • 1 表示標記未被掩碼，
    • 0 表示標記已被掩碼。

    什麼是注意力掩碼？

  • position_ids (Numpy 陣列 或 tf.Tensor，形狀為 (batch_size, num_choices, sequence_length)，可選) — 位置嵌入中每個輸入序列標記的位置索引。選值範圍為 [0, config.max_position_embeddings - 1]。

    什麼是位置 ID？

  • head_mask (Numpy 陣列 或 tf.Tensor，形狀為 (num_heads,) 或 (num_layers, num_heads)，可選) — 用於置零自注意力模組中選定頭的掩碼。掩碼值選自 [0, 1]：

    • 1 表示頭未被掩碼，
    • 0 表示頭已被掩碼。
  • inputs_embeds (tf.Tensor，形狀為 (batch_size, num_choices, sequence_length, hidden_size)，可選) — 可選地，你可以不傳遞 input_ids，而是直接傳遞嵌入表示。如果你希望比模型內部的嵌入查詢矩陣更能控制如何將 input_ids 索引轉換為關聯向量，這會非常有用。
  • output_attentions (bool，可選) — 是否返回所有注意力層的注意力張量。有關更多詳細資訊，請參閱返回張量下的 attentions。此引數只能在即時模式下使用，在圖模式下將使用配置中的值。
  • output_hidden_states (bool，可選) — 是否返回所有層的隱藏狀態。有關更多詳細資訊，請參閱返回張量下的 hidden_states。此引數只能在即時模式下使用，在圖模式下將使用配置中的值。
  • return_dict (bool，可選) — 是否返回一個 ModelOutput 而不是一個普通的元組。此引數可以在即時模式下使用，在圖模式下該值將始終設定為 True。
  • training (bool，可選，預設為 False) — 是否在訓練模式下使用模型（一些模組如 dropout 模組在訓練和評估之間有不同的行為）。
  • labels (tf.Tensor，形狀為 (batch_size,)，可選) — 用於計算多項選擇分類損失的標籤。索引應在 [0, ..., num_choices] 範圍內，其中 num_choices 是輸入張量第二維的大小。（參見上面的 input_ids）

返回

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

一個 transformers.modeling_tf_outputs.TFMultipleChoiceModelOutput 或一個 tf.Tensor 的元組（如果傳遞了 return_dict=False 或 config.return_dict=False），包含根據配置（ElectraConfig）和輸入的不同元素。

  • loss (tf.Tensor，形狀為 (batch_size, )，可選，當提供 labels 時返回) — 分類損失。

  • logits (tf.Tensor，形狀為 (batch_size, num_choices)) — num_choices 是輸入張量的第二維。（參見上面的 input_ids）。

    分類分數（SoftMax 之前）。

  • hidden_states (tuple(tf.Tensor), 可選, 當傳遞了 output_hidden_states=True 或 config.output_hidden_states=True 時返回) — tf.Tensor 的元組（一個是嵌入層的輸出，另一個是每一層的輸出），形狀為 (batch_size, sequence_length, hidden_size)。

    模型在每個層輸出的隱藏狀態加上初始嵌入輸出。

  • attentions (tuple(tf.Tensor), 可選, 當傳遞了 output_attentions=True 或 config.output_attentions=True 時返回) — tf.Tensor 的元組（每一層一個），形狀為 (batch_size, num_heads, sequence_length, sequence_length)。

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

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

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

示例

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

>>> tokenizer = AutoTokenizer.from_pretrained("google/electra-small-discriminator")
>>> model = TFElectraForMultipleChoice.from_pretrained("google/electra-small-discriminator")

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

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

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

TFElectraForTokenClassification

class transformers.TFElectraForTokenClassification

< >

( config **kwargs )

引數

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

Electra 模型，其頂部帶有一個詞元分類頭。

判別器和生成器都可以載入到此模型中。

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

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

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

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

支援第二種格式的原因是 Keras 方法在向模型和層傳遞輸入時更喜歡這種格式。由於這種支援，當使用像 `model.fit()` 這樣的方法時，一切都應該“正常工作”——只需以 `model.fit()` 支援的任何格式傳遞你的輸入和標籤！然而，如果你想在 Keras 方法（如 `fit()` 和 `predict()`）之外使用第二種格式，例如在使用 Keras `Functional` API 建立自己的層或模型時，有三種可能性可以用來將所有輸入張量收集到第一個位置引數中

  • 只有一個 input_ids 的單個張量，沒有其他：model(input_ids)
  • 長度可變的列表，包含一個或多個輸入張量，按文件字串中給出的順序：model([input_ids, attention_mask]) 或 model([input_ids, attention_mask, token_type_ids])
  • 一個字典，其中包含一個或多個與文件字串中給出的輸入名稱關聯的輸入張量：model({"input_ids": input_ids, "token_type_ids": token_type_ids})

請注意，當使用子類化建立模型和層時，您無需擔心任何這些，因為您可以像呼叫任何其他 Python 函式一樣傳遞輸入！

呼叫

< >

( input_ids: TFModelInputType | None = None attention_mask: np.ndarray | tf.Tensor | None = None token_type_ids: np.ndarray | tf.Tensor | None = None position_ids: np.ndarray | tf.Tensor | None = None head_mask: np.ndarray | tf.Tensor | None = None inputs_embeds: np.ndarray | tf.Tensor | None = None output_attentions: Optional[bool] = None output_hidden_states: Optional[bool] = None return_dict: Optional[bool] = None labels: np.ndarray | tf.Tensor | None = None training: Optional[bool] = False ) → transformers.modeling_tf_outputs.TFTokenClassifierOutput 或 tuple(tf.Tensor)

引數

  • input_ids (Numpy 陣列 或 tf.Tensor，形狀為 (batch_size, sequence_length)) — 詞彙表中輸入序列標記的索引。

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

    什麼是輸入 ID？

  • attention_mask (Numpy 陣列 或 tf.Tensor，形狀為 (batch_size, sequence_length)，可選) — 用於避免對填充標記索引執行注意力操作的掩碼。掩碼值選自 [0, 1]：

    • 1 表示標記未被掩碼，
    • 0 表示標記已被掩碼。

    什麼是注意力掩碼？

  • position_ids (Numpy 陣列 或 tf.Tensor，形狀為 (batch_size, sequence_length)，可選) — 位置嵌入中每個輸入序列標記的位置索引。選值範圍為 [0, config.max_position_embeddings - 1]。

    什麼是位置 ID？

  • head_mask (Numpy 陣列 或 tf.Tensor，形狀為 (num_heads,) 或 (num_layers, num_heads)，可選) — 用於置零自注意力模組中選定頭的掩碼。掩碼值選自 [0, 1]：

    • 1 表示頭未被掩碼，
    • 0 表示頭已被掩碼。
  • inputs_embeds (tf.Tensor，形狀為 (batch_size, sequence_length, hidden_size)，可選) — 可選地，你可以不傳遞 input_ids，而是直接傳遞嵌入表示。如果你希望比模型內部的嵌入查詢矩陣更能控制如何將 input_ids 索引轉換為關聯向量，這會非常有用。
  • output_attentions (bool，可選) — 是否返回所有注意力層的注意力張量。有關更多詳細資訊，請參閱返回張量下的 attentions。此引數只能在即時模式下使用，在圖模式下將使用配置中的值。
  • output_hidden_states (bool，可選) — 是否返回所有層的隱藏狀態。有關更多詳細資訊，請參閱返回張量下的 hidden_states。此引數只能在即時模式下使用，在圖模式下將使用配置中的值。
  • return_dict (bool，可選) — 是否返回一個 ModelOutput 而不是一個普通的元組。此引數可以在即時模式下使用，在圖模式下該值將始終設定為 True。
  • training (bool，可選，預設為 False) — 是否在訓練模式下使用模型（一些模組如 dropout 模組在訓練和評估之間有不同的行為）。
  • labels (tf.Tensor，形狀為 (batch_size, sequence_length)，可選) — 用於計算標記分類損失的標籤。索引應在 [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），包含根據配置（ElectraConfig）和輸入的不同元素。

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

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

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

示例

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

>>> tokenizer = AutoTokenizer.from_pretrained("bhadresh-savani/electra-base-discriminator-finetuned-conll03-english")
>>> model = TFElectraForTokenClassification.from_pretrained("bhadresh-savani/electra-base-discriminator-finetuned-conll03-english")

>>> inputs = tokenizer(
...     "HuggingFace is a company based in Paris and New York", add_special_tokens=False, return_tensors="tf"
... )

>>> logits = model(**inputs).logits
>>> predicted_token_class_ids = tf.math.argmax(logits, axis=-1)

>>> # Note that tokens are classified rather then input words which means that
>>> # there might be more predicted token classes than words.
>>> # Multiple token classes might account for the same word
>>> predicted_tokens_classes = [model.config.id2label[t] for t in predicted_token_class_ids[0].numpy().tolist()]
>>> predicted_tokens_classes
['B-LOC', 'B-ORG', 'O', 'O', 'O', 'O', 'O', 'B-LOC', 'O', 'B-LOC', 'I-LOC']
>>> labels = predicted_token_class_ids
>>> loss = tf.math.reduce_mean(model(**inputs, labels=labels).loss)
>>> round(float(loss), 2)
0.11

TFElectraForQuestionAnswering

class transformers.TFElectraForQuestionAnswering

< >

( config *inputs **kwargs )

引數

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

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

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

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

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

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

支援第二種格式的原因是 Keras 方法在向模型和層傳遞輸入時更喜歡這種格式。由於這種支援，當使用像 `model.fit()` 這樣的方法時，一切都應該“正常工作”——只需以 `model.fit()` 支援的任何格式傳遞你的輸入和標籤！然而，如果你想在 Keras 方法（如 `fit()` 和 `predict()`）之外使用第二種格式，例如在使用 Keras `Functional` API 建立自己的層或模型時，有三種可能性可以用來將所有輸入張量收集到第一個位置引數中

  • 只有一個 input_ids 的單個張量，沒有其他：model(input_ids)
  • 長度可變的列表，包含一個或多個輸入張量，按文件字串中給出的順序：model([input_ids, attention_mask]) 或 model([input_ids, attention_mask, token_type_ids])
  • 一個字典，其中包含一個或多個與文件字串中給出的輸入名稱關聯的輸入張量：model({"input_ids": input_ids, "token_type_ids": token_type_ids})

請注意，當使用子類化建立模型和層時，您無需擔心任何這些，因為您可以像呼叫任何其他 Python 函式一樣傳遞輸入！

呼叫

< >

( input_ids: TFModelInputType | None = None attention_mask: np.ndarray | tf.Tensor | None = None token_type_ids: np.ndarray | tf.Tensor | None = None position_ids: np.ndarray | tf.Tensor | None = None head_mask: np.ndarray | tf.Tensor | None = None inputs_embeds: np.ndarray | tf.Tensor | None = None output_attentions: Optional[bool] = None output_hidden_states: Optional[bool] = None return_dict: Optional[bool] = None start_positions: np.ndarray | tf.Tensor | None = None end_positions: np.ndarray | tf.Tensor | None = None training: Optional[bool] = False ) → transformers.modeling_tf_outputs.TFQuestionAnsweringModelOutput 或 tuple(tf.Tensor)

引數

  • input_ids (Numpy 陣列 或 tf.Tensor，形狀為 (batch_size, sequence_length)) — 詞彙表中輸入序列標記的索引。

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

    什麼是輸入 ID？

  • attention_mask (Numpy 陣列 或 tf.Tensor，形狀為 (batch_size, sequence_length)，可選) — 用於避免對填充標記索引執行注意力操作的掩碼。掩碼值選自 [0, 1]：

    • 1 表示標記未被掩碼，
    • 0 表示標記已被掩碼。

    什麼是注意力掩碼？

  • position_ids (Numpy 陣列 或 tf.Tensor，形狀為 (batch_size, sequence_length)，可選) — 位置嵌入中每個輸入序列標記的位置索引。選值範圍為 [0, config.max_position_embeddings - 1]。

    什麼是位置 ID？

  • head_mask (Numpy 陣列 或 tf.Tensor，形狀為 (num_heads,) 或 (num_layers, num_heads)，可選) — 用於置零自注意力模組中選定頭的掩碼。掩碼值選自 [0, 1]：

    • 1 表示頭未被掩碼，
    • 0 表示頭已被掩碼。
  • inputs_embeds (tf.Tensor，形狀為 (batch_size, sequence_length, hidden_size)，可選) — 可選地，你可以不傳遞 input_ids，而是直接傳遞嵌入表示。如果你希望比模型內部的嵌入查詢矩陣更能控制如何將 input_ids 索引轉換為關聯向量，這會非常有用。
  • output_attentions (bool，可選) — 是否返回所有注意力層的注意力張量。有關更多詳細資訊，請參閱返回張量下的 attentions。此引數只能在即時模式下使用，在圖模式下將使用配置中的值。
  • output_hidden_states (bool，可選) — 是否返回所有層的隱藏狀態。有關更多詳細資訊，請參閱返回張量下的 hidden_states。此引數只能在即時模式下使用，在圖模式下將使用配置中的值。
  • return_dict (bool，可選) — 是否返回一個 ModelOutput 而不是一個普通的元組。此引數可以在即時模式下使用，在圖模式下該值將始終設定為 True。
  • training (bool，可選，預設為 False) — 是否在訓練模式下使用模型（一些模組如 dropout 模組在訓練和評估之間有不同的行為）。
  • start_positions (tf.Tensor，形狀為 (batch_size,)，可選) — 用於計算標記分類損失的標籤化跨度開始位置（索引）的標籤。位置被限制在序列長度（sequence_length）內。序列之外的位置在計算損失時不予考慮。
  • end_positions (tf.Tensor，形狀為 (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），包含根據配置（ElectraConfig）和輸入的不同元素。

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

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

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

示例

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

>>> tokenizer = AutoTokenizer.from_pretrained("bhadresh-savani/electra-base-squad2")
>>> model = TFElectraForQuestionAnswering.from_pretrained("bhadresh-savani/electra-base-squad2")

>>> question, text = "Who was Jim Henson?", "Jim Henson was a nice puppet"

>>> inputs = tokenizer(question, text, return_tensors="tf")
>>> outputs = model(**inputs)

>>> answer_start_index = int(tf.math.argmax(outputs.start_logits, axis=-1)[0])
>>> answer_end_index = int(tf.math.argmax(outputs.end_logits, axis=-1)[0])

>>> predict_answer_tokens = inputs.input_ids[0, answer_start_index : answer_end_index + 1]
>>> tokenizer.decode(predict_answer_tokens)
'a nice puppet'
>>> # target is "nice puppet"
>>> target_start_index = tf.constant([11])
>>> target_end_index = tf.constant([12])

>>> outputs = model(**inputs, start_positions=target_start_index, end_positions=target_end_index)
>>> loss = tf.math.reduce_mean(outputs.loss)
>>> round(float(loss), 2)
2.64
JAX
隱藏 JAX 內容

FlaxElectraModel

class transformers.FlaxElectraModel

< >

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

引數

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

一個基礎的 Electra Transformer 模型，其頂部沒有任何特定的頭，只輸出原始的隱藏狀態（hidden-states）。

該模型繼承自 FlaxPreTrainedModel。請查閱超類的文件以瞭解該庫為所有模型實現的通用方法（例如下載、儲存以及從 PyTorch 模型轉換權重）。

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

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

__call__

< >

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

引數

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

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

    什麼是輸入 ID？

  • attention_mask (numpy.ndarray，形狀為 (batch_size, sequence_length), 可選) — 用於避免對填充標記索引執行注意力計算的掩碼。掩碼值在 [0, 1] 中選擇：

    • 1 表示標記未被遮蓋，
    • 0 表示標記已被遮蓋。

    什麼是注意力掩碼？

  • token_type_ids (numpy.ndarray，形狀為 (batch_size, sequence_length), 可選) — 用於指示輸入的第一部分和第二部分的分段標記索引。索引在 [0, 1] 中選擇：

    • 0 對應於 *A 句子* 的標記，
    • 1 對應於 *B 句子* 的標記。

    什麼是標記型別 ID？

  • position_ids (numpy.ndarray，形狀為 (batch_size, sequence_length), 可選) — 位置嵌入中每個輸入序列標記的位置索引。在範圍 [0, config.max_position_embeddings - 1] 內選擇。
  • head_mask (numpy.ndarray，形狀為 (batch_size, sequence_length), `可選) -- 用於遮蔽注意力模組中選定頭的掩碼。掩碼值在 `[0, 1]` 中選擇：

    • 1 表示頭未被遮蓋，
    • 0 表示頭已被遮蓋。
  • return_dict (bool, 可選) — 是否返回一個 ModelOutput 而不是一個普通的元組。

返回

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

一個 transformers.modeling_flax_outputs.FlaxBaseModelOutput 或一個 torch.FloatTensor 的元組（如果傳遞了 return_dict=False 或 config.return_dict=False），包含根據配置 (ElectraConfig) 和輸入的不同元素。

  • last_hidden_state (形狀為 (batch_size, sequence_length, hidden_size) 的 jnp.ndarray) — 模型最後一層輸出的隱藏狀態序列。

  • hidden_states (tuple(jnp.ndarray), 可選，當傳遞 output_hidden_states=True 或 config.output_hidden_states=True 時返回) — jnp.ndarray 的元組（一個用於嵌入層的輸出，另一個用於每一層的輸出），形狀為 (batch_size, sequence_length, hidden_size)。

    模型在每個層輸出的隱藏狀態加上初始嵌入輸出。

  • attentions (tuple(jnp.ndarray), 可選，當傳遞 output_attentions=True 或 config.output_attentions=True 時返回) — jnp.ndarray 的元組（每層一個），形狀為 (batch_size, num_heads, sequence_length, sequence_length)。

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

FlaxElectraPreTrainedModel 的前向傳播方法，它重寫了 `__call__` 特殊方法。

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

示例

>>> from transformers import AutoTokenizer, FlaxElectraModel

>>> tokenizer = AutoTokenizer.from_pretrained("google/electra-small-discriminator")
>>> model = FlaxElectraModel.from_pretrained("google/electra-small-discriminator")

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

>>> last_hidden_states = outputs.last_hidden_state

FlaxElectraForPreTraining

class transformers.FlaxElectraForPreTraining

< >

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

引數

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

帶有一個二元分類頭的 Electra 模型，用於在預訓練期間識別生成的標記。

建議將判別器的檢查點載入到該模型中。

該模型繼承自 FlaxPreTrainedModel。請查閱超類的文件以瞭解該庫為所有模型實現的通用方法（例如下載、儲存以及從 PyTorch 模型轉換權重）。

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

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

__call__

< >

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

引數

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

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

    什麼是輸入 ID？

  • attention_mask (numpy.ndarray，形狀為 (batch_size, sequence_length), 可選) — 用於避免對填充標記索引執行注意力計算的掩碼。掩碼值在 [0, 1] 中選擇：

    • 1 表示標記未被遮蓋，
    • 0 表示標記已被遮蓋。

    什麼是注意力掩碼？

  • token_type_ids (numpy.ndarray，形狀為 (batch_size, sequence_length), 可選) — 用於指示輸入的第一部分和第二部分的分段標記索引。索引在 [0, 1] 中選擇：

    • 0 對應於 *A 句子* 的標記，
    • 1 對應於 *B 句子* 的標記。

    什麼是標記型別 ID？

  • position_ids (numpy.ndarray，形狀為 (batch_size, sequence_length), 可選) — 位置嵌入中每個輸入序列標記的位置索引。在範圍 [0, config.max_position_embeddings - 1] 內選擇。
  • head_mask (numpy.ndarray，形狀為 (batch_size, sequence_length), `可選) -- 用於遮蔽注意力模組中選定頭的掩碼。掩碼值在 `[0, 1]` 中選擇：

    • 1 表示頭未被遮蓋，
    • 0 表示頭已被遮蓋。
  • return_dict (bool, 可選) — 是否返回一個 ModelOutput 而不是一個普通的元組。

返回

transformers.models.electra.modeling_flax_electra.FlaxElectraForPreTrainingOutput 或 tuple(torch.FloatTensor)

一個 transformers.models.electra.modeling_flax_electra.FlaxElectraForPreTrainingOutput 或一個 torch.FloatTensor 的元組（如果傳遞了 return_dict=False 或 config.return_dict=False），包含根據配置 (ElectraConfig) 和輸入的不同元素。

  • logits (形狀為 (batch_size, sequence_length, config.vocab_size) 的 jnp.ndarray) — 語言建模頭的預測分數（SoftMax 之前每個詞彙 token 的分數）。

  • hidden_states (tuple(jnp.ndarray), 可選，當傳遞 output_hidden_states=True 或 config.output_hidden_states=True 時返回) — jnp.ndarray 的元組（一個用於嵌入層的輸出，另一個用於每一層的輸出），形狀為 (batch_size, sequence_length, hidden_size)。

    模型在每個層輸出的隱藏狀態加上初始嵌入輸出。

  • attentions (tuple(jnp.ndarray), 可選，當傳遞 output_attentions=True 或 config.output_attentions=True 時返回) — jnp.ndarray 的元組（每層一個），形狀為 (batch_size, num_heads, sequence_length, sequence_length)。

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

FlaxElectraPreTrainedModel 的前向傳播方法，它重寫了 `__call__` 特殊方法。

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

示例

>>> from transformers import AutoTokenizer, FlaxElectraForPreTraining

>>> tokenizer = AutoTokenizer.from_pretrained("google/electra-small-discriminator")
>>> model = FlaxElectraForPreTraining.from_pretrained("google/electra-small-discriminator")

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

>>> prediction_logits = outputs.logits

FlaxElectraForCausalLM

class transformers.FlaxElectraForCausalLM

< >

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

引數

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

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

該模型繼承自 FlaxPreTrainedModel。請查閱超類的文件以瞭解該庫為所有模型實現的通用方法（例如下載、儲存以及從 PyTorch 模型轉換權重）。

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

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

__call__

< >

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

引數

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

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

    什麼是輸入 ID？

  • attention_mask (numpy.ndarray，形狀為 (batch_size, sequence_length), 可選) — 用於避免對填充標記索引執行注意力計算的掩碼。掩碼值在 [0, 1] 中選擇：

    • 1 表示標記未被遮蓋，
    • 0 表示標記已被遮蓋。

    什麼是注意力掩碼？

  • token_type_ids (numpy.ndarray，形狀為 (batch_size, sequence_length), 可選) — 用於指示輸入的第一部分和第二部分的分段標記索引。索引在 [0, 1] 中選擇：

    • 0 對應於 *A 句子* 的標記，
    • 1 對應於 *B 句子* 的標記。

    什麼是標記型別 ID？

  • position_ids (numpy.ndarray，形狀為 (batch_size, sequence_length), 可選) — 位置嵌入中每個輸入序列標記的位置索引。在範圍 [0, config.max_position_embeddings - 1] 內選擇。
  • head_mask (numpy.ndarray，形狀為 (batch_size, sequence_length), `可選) -- 用於遮蔽注意力模組中選定頭的掩碼。掩碼值在 `[0, 1]` 中選擇：

    • 1 表示頭未被遮蓋，
    • 0 表示頭已被遮蓋。
  • return_dict (bool, 可選) — 是否返回一個 ModelOutput 而不是一個普通的元組。

返回

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

一個 transformers.modeling_flax_outputs.FlaxCausalLMOutputWithCrossAttentions 或一個 torch.FloatTensor 的元組（如果傳遞了 return_dict=False 或 config.return_dict=False），包含根據配置 (ElectraConfig) 和輸入的不同元素。

  • logits (形狀為 (batch_size, sequence_length, config.vocab_size) 的 jnp.ndarray) — 語言建模頭的預測分數（SoftMax 之前每個詞彙 token 的分數）。

  • hidden_states (tuple(jnp.ndarray), 可選，當傳遞 output_hidden_states=True 或 config.output_hidden_states=True 時返回) — jnp.ndarray 的元組（一個用於嵌入層的輸出，另一個用於每一層的輸出），形狀為 (batch_size, sequence_length, hidden_size)。

    模型在每個層輸出的隱藏狀態加上初始嵌入輸出。

  • attentions (tuple(jnp.ndarray), 可選，當傳遞 output_attentions=True 或 config.output_attentions=True 時返回) — jnp.ndarray 的元組（每層一個），形狀為 (batch_size, num_heads, sequence_length, sequence_length)。

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

  • cross_attentions (tuple(jnp.ndarray), 可選，當傳遞 output_attentions=True 或 config.output_attentions=True 時返回) — jnp.ndarray 的元組（每層一個），形狀為 (batch_size, num_heads, sequence_length, sequence_length)。

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

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

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

FlaxElectraPreTrainedModel 的前向傳播方法，它重寫了 `__call__` 特殊方法。

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

示例

>>> from transformers import AutoTokenizer, FlaxElectraForCausalLM

>>> tokenizer = AutoTokenizer.from_pretrained("google/electra-small-discriminator")
>>> model = FlaxElectraForCausalLM.from_pretrained("google/electra-small-discriminator")

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

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

FlaxElectraForMaskedLM

class transformers.FlaxElectraForMaskedLM

< >

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

引數

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

帶有`語言建模`頭的 Electra 模型。

該模型繼承自 FlaxPreTrainedModel。請查閱超類的文件以瞭解該庫為所有模型實現的通用方法（例如下載、儲存以及從 PyTorch 模型轉換權重）。

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

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

__call__

< >

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

引數

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

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

    什麼是輸入 ID？

  • attention_mask (numpy.ndarray，形狀為 (batch_size, sequence_length), 可選) — 用於避免對填充標記索引執行注意力計算的掩碼。掩碼值在 [0, 1] 中選擇：

    • 1 表示標記未被遮蓋，
    • 0 表示標記已被遮蓋。

    什麼是注意力掩碼？

  • token_type_ids (numpy.ndarray，形狀為 (batch_size, sequence_length), 可選) — 用於指示輸入的第一部分和第二部分的分段標記索引。索引在 [0, 1] 中選擇：

    • 0 對應於 *A 句子* 的標記，
    • 1 對應於 *B 句子* 的標記。

    什麼是標記型別 ID？

  • position_ids (numpy.ndarray，形狀為 (batch_size, sequence_length), 可選) — 位置嵌入中每個輸入序列標記的位置索引。在範圍 [0, config.max_position_embeddings - 1] 內選擇。
  • head_mask (numpy.ndarray，形狀為 (batch_size, sequence_length), `可選) -- 用於遮蔽注意力模組中選定頭的掩碼。掩碼值在 `[0, 1]` 中選擇：

    • 1 表示頭未被遮蓋，
    • 0 表示頭已被遮蓋。
  • return_dict (bool, 可選) — 是否返回一個 ModelOutput 而不是一個普通的元組。

返回

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

一個 transformers.modeling_flax_outputs.FlaxMaskedLMOutput 或一個 torch.FloatTensor 的元組（如果傳遞了 return_dict=False 或 config.return_dict=False），包含根據配置 (ElectraConfig) 和輸入的不同元素。

  • logits (形狀為 (batch_size, sequence_length, config.vocab_size) 的 jnp.ndarray) — 語言建模頭的預測分數（SoftMax 之前每個詞彙 token 的分數）。

  • hidden_states (tuple(jnp.ndarray), 可選，當傳遞 output_hidden_states=True 或 config.output_hidden_states=True 時返回) — jnp.ndarray 的元組（一個用於嵌入層的輸出，另一個用於每一層的輸出），形狀為 (batch_size, sequence_length, hidden_size)。

    模型在每個層輸出的隱藏狀態加上初始嵌入輸出。

  • attentions (tuple(jnp.ndarray), 可選，當傳遞 output_attentions=True 或 config.output_attentions=True 時返回) — jnp.ndarray 的元組（每層一個），形狀為 (batch_size, num_heads, sequence_length, sequence_length)。

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

FlaxElectraPreTrainedModel 的前向傳播方法，它重寫了 `__call__` 特殊方法。

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

示例

>>> from transformers import AutoTokenizer, FlaxElectraForMaskedLM

>>> tokenizer = AutoTokenizer.from_pretrained("google/electra-small-discriminator")
>>> model = FlaxElectraForMaskedLM.from_pretrained("google/electra-small-discriminator")

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

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

FlaxElectraForSequenceClassification

class transformers.FlaxElectraForSequenceClassification

< >

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

引數

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

Electra Transformer 模型，其頂部帶有一個序列分類/迴歸頭（在池化輸出之上加一個線性層），例如用於 GLUE 任務。

該模型繼承自 FlaxPreTrainedModel。請查閱超類的文件以瞭解該庫為所有模型實現的通用方法（例如下載、儲存以及從 PyTorch 模型轉換權重）。

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

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

__call__

< >

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

引數

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

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

    什麼是輸入 ID？

  • attention_mask (numpy.ndarray，形狀為 (batch_size, sequence_length)，可選) — 用於避免在填充標記索引上執行注意力操作的掩碼。掩碼值選自 [0, 1]：

    • 1 表示標記未被掩碼，
    • 0 表示標記已被掩碼。

    什麼是注意力掩碼？

  • token_type_ids (numpy.ndarray，形狀為 (batch_size, sequence_length)，可選) — 分段標記索引，用於指示輸入的第一部分和第二部分。索引選自 [0, 1]：

    • 0 對應於句子 A 的標記，
    • 1 對應於句子 B 的標記。

    什麼是標記型別 ID？

  • position_ids (numpy.ndarray，形狀為 (batch_size, sequence_length)，可選) — 每個輸入序列標記在位置嵌入中的位置索引。選擇範圍為 [0, config.max_position_embeddings - 1]。
  • head_mask (numpy.ndarray，形狀為 (batch_size, sequence_length)，可選) -- 用於置零注意力模組中選定頭的掩碼。掩碼值選自 [0, 1]`：

    • 1 表示該頭未被掩碼，
    • 0 表示該頭已被掩碼。
  • return_dict (bool，可選) — 是否返回一個 ModelOutput 而不是一個普通的元組。

返回

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

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

  • logits (形狀為 (batch_size, config.num_labels) 的 jnp.ndarray) — 分類（如果 config.num_labels==1，則為迴歸）分數（SoftMax 之前）。

  • hidden_states (tuple(jnp.ndarray), 可選，當傳遞 output_hidden_states=True 或 config.output_hidden_states=True 時返回) — jnp.ndarray 的元組（一個用於嵌入層的輸出，另一個用於每一層的輸出），形狀為 (batch_size, sequence_length, hidden_size)。

    模型在每個層輸出的隱藏狀態加上初始嵌入輸出。

  • attentions (tuple(jnp.ndarray), 可選，當傳遞 output_attentions=True 或 config.output_attentions=True 時返回) — jnp.ndarray 的元組（每層一個），形狀為 (batch_size, num_heads, sequence_length, sequence_length)。

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

FlaxElectraPreTrainedModel 的前向傳播方法，它重寫了 `__call__` 特殊方法。

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

示例

>>> from transformers import AutoTokenizer, FlaxElectraForSequenceClassification

>>> tokenizer = AutoTokenizer.from_pretrained("google/electra-small-discriminator")
>>> model = FlaxElectraForSequenceClassification.from_pretrained("google/electra-small-discriminator")

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

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

FlaxElectraForMultipleChoice

class transformers.FlaxElectraForMultipleChoice

< >

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

引數

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

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

該模型繼承自 FlaxPreTrainedModel。請查閱超類的文件以瞭解該庫為所有模型實現的通用方法（例如下載、儲存以及從 PyTorch 模型轉換權重）。

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

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

__call__

< >

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

引數

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

    索引可以使用 AutoTokenizer 獲得。詳情請參閱 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。

    什麼是輸入 ID？

  • attention_mask (numpy.ndarray，形狀為 (batch_size, num_choices, sequence_length)，可選) — 用於避免在填充標記索引上執行注意力操作的掩碼。掩碼值選自 [0, 1]：

    • 1 表示標記未被掩碼，
    • 0 表示標記已被掩碼。

    什麼是注意力掩碼？

  • token_type_ids (numpy.ndarray，形狀為 (batch_size, num_choices, sequence_length)，可選) — 分段標記索引，用於指示輸入的第一部分和第二部分。索引選自 [0, 1]：

    • 0 對應於句子 A 的標記，
    • 1 對應於句子 B 的標記。

    什麼是標記型別 ID？

  • position_ids (numpy.ndarray，形狀為 (batch_size, num_choices, sequence_length)，可選) — 每個輸入序列標記在位置嵌入中的位置索引。選擇範圍為 [0, config.max_position_embeddings - 1]。
  • head_mask (numpy.ndarray，形狀為 (batch_size, num_choices, sequence_length)，可選) -- 用於置零注意力模組中選定頭的掩碼。掩碼值選自 [0, 1]`：

    • 1 表示該頭未被掩碼，
    • 0 表示該頭已被掩碼。
  • return_dict (bool，可選) — 是否返回一個 ModelOutput 而不是一個普通的元組。

返回

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

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

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

    分類分數（SoftMax 之前）。

  • hidden_states (tuple(jnp.ndarray), 可選，當傳遞 output_hidden_states=True 或 config.output_hidden_states=True 時返回) — jnp.ndarray 的元組（一個用於嵌入層的輸出，另一個用於每一層的輸出），形狀為 (batch_size, sequence_length, hidden_size)。

    模型在每個層輸出的隱藏狀態加上初始嵌入輸出。

  • attentions (tuple(jnp.ndarray), 可選，當傳遞 output_attentions=True 或 config.output_attentions=True 時返回) — jnp.ndarray 的元組（每層一個），形狀為 (batch_size, num_heads, sequence_length, sequence_length)。

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

FlaxElectraPreTrainedModel 的前向傳播方法，它重寫了 `__call__` 特殊方法。

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

示例

>>> from transformers import AutoTokenizer, FlaxElectraForMultipleChoice

>>> tokenizer = AutoTokenizer.from_pretrained("google/electra-small-discriminator")
>>> model = FlaxElectraForMultipleChoice.from_pretrained("google/electra-small-discriminator")

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

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

>>> logits = outputs.logits

FlaxElectraForTokenClassification

class transformers.FlaxElectraForTokenClassification

< >

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

引數

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

Electra 模型，其頂部帶有一個詞元分類頭。

判別器和生成器都可以載入到此模型中。

該模型繼承自 FlaxPreTrainedModel。請查閱超類的文件以瞭解該庫為所有模型實現的通用方法（例如下載、儲存以及從 PyTorch 模型轉換權重）。

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

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

__call__

< >

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

引數

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

    索引可以使用 AutoTokenizer 獲得。詳情請參閱 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。

    什麼是輸入 ID？

  • attention_mask (numpy.ndarray，形狀為 (batch_size, sequence_length)，可選) — 用於避免在填充標記索引上執行注意力操作的掩碼。掩碼值選自 [0, 1]：

    • 1 表示標記未被掩碼，
    • 0 表示標記已被掩碼。

    什麼是注意力掩碼？

  • token_type_ids (numpy.ndarray，形狀為 (batch_size, sequence_length)，可選) — 分段標記索引，用於指示輸入的第一部分和第二部分。索引選自 [0, 1]：

    • 0 對應於句子 A 的標記，
    • 1 對應於句子 B 的標記。

    什麼是標記型別 ID？

  • position_ids (numpy.ndarray，形狀為 (batch_size, sequence_length)，可選) — 每個輸入序列標記在位置嵌入中的位置索引。選擇範圍為 [0, config.max_position_embeddings - 1]。
  • head_mask (numpy.ndarray，形狀為 (batch_size, sequence_length)，可選) -- 用於置零注意力模組中選定頭的掩碼。掩碼值選自 [0, 1]`：

    • 1 表示該頭未被掩碼，
    • 0 表示該頭已被掩碼。
  • return_dict (bool，可選) — 是否返回一個 ModelOutput 而不是一個普通的元組。

返回

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

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

  • logits (jnp.ndarray，形狀為 (batch_size, sequence_length, config.num_labels)) — 分類得分（SoftMax 之前）。

  • hidden_states (tuple(jnp.ndarray), 可選，當傳遞 output_hidden_states=True 或 config.output_hidden_states=True 時返回) — jnp.ndarray 的元組（一個用於嵌入層的輸出，另一個用於每一層的輸出），形狀為 (batch_size, sequence_length, hidden_size)。

    模型在每個層輸出的隱藏狀態加上初始嵌入輸出。

  • attentions (tuple(jnp.ndarray), 可選，當傳遞 output_attentions=True 或 config.output_attentions=True 時返回) — jnp.ndarray 的元組（每層一個），形狀為 (batch_size, num_heads, sequence_length, sequence_length)。

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

FlaxElectraPreTrainedModel 的前向傳播方法，它重寫了 `__call__` 特殊方法。

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

示例

>>> from transformers import AutoTokenizer, FlaxElectraForTokenClassification

>>> tokenizer = AutoTokenizer.from_pretrained("google/electra-small-discriminator")
>>> model = FlaxElectraForTokenClassification.from_pretrained("google/electra-small-discriminator")

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

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

FlaxElectraForQuestionAnswering

class transformers.FlaxElectraForQuestionAnswering

< >

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

引數

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

帶有跨度分類頭的 ELECTRA 模型，用於像 SQuAD 這樣的抽取式問答任務（在隱藏狀態輸出之上新增線性層以計算 span start logits 和 span end logits）。

該模型繼承自 FlaxPreTrainedModel。請查閱超類的文件以瞭解該庫為所有模型實現的通用方法（例如下載、儲存以及從 PyTorch 模型轉換權重）。

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

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

__call__

< >

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

引數

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

    索引可以使用 AutoTokenizer 獲得。詳情請參閱 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。

    什麼是輸入 ID？

  • attention_mask (numpy.ndarray，形狀為 (batch_size, sequence_length)，可選) — 用於避免在填充標記索引上執行注意力操作的掩碼。掩碼值選自 [0, 1]：

    • 1 表示標記未被掩碼，
    • 0 表示標記已被掩碼。

    什麼是注意力掩碼？

  • token_type_ids (numpy.ndarray，形狀為 (batch_size, sequence_length)，可選) — 分段標記索引，用於指示輸入的第一部分和第二部分。索引選自 [0, 1]：

    • 0 對應於句子 A 的標記，
    • 1 對應於句子 B 的標記。

    什麼是標記型別 ID？

  • position_ids (numpy.ndarray，形狀為 (batch_size, sequence_length)，可選) — 每個輸入序列標記在位置嵌入中的位置索引。選擇範圍為 [0, config.max_position_embeddings - 1]。
  • head_mask (numpy.ndarray，形狀為 (batch_size, sequence_length)，可選) -- 用於置零注意力模組中選定頭的掩碼。掩碼值選自 [0, 1]`：

    • 1 表示該頭未被掩碼，
    • 0 表示該頭已被掩碼。
  • return_dict (bool，可選) — 是否返回一個 ModelOutput 而不是一個普通的元組。

返回

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

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

  • start_logits (jnp.ndarray，形狀為 (batch_size, sequence_length)) — 跨度開始得分（SoftMax 之前）。

  • end_logits (jnp.ndarray，形狀為 (batch_size, sequence_length)) — 跨度結束得分（SoftMax 之前）。

  • hidden_states (tuple(jnp.ndarray), 可選，當傳遞 output_hidden_states=True 或 config.output_hidden_states=True 時返回) — jnp.ndarray 的元組（一個用於嵌入層的輸出，另一個用於每一層的輸出），形狀為 (batch_size, sequence_length, hidden_size)。

    模型在每個層輸出的隱藏狀態加上初始嵌入輸出。

  • attentions (tuple(jnp.ndarray), 可選，當傳遞 output_attentions=True 或 config.output_attentions=True 時返回) — jnp.ndarray 的元組（每層一個），形狀為 (batch_size, num_heads, sequence_length, sequence_length)。

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

FlaxElectraPreTrainedModel 的前向傳播方法，它重寫了 `__call__` 特殊方法。

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

示例

>>> from transformers import AutoTokenizer, FlaxElectraForQuestionAnswering

>>> tokenizer = AutoTokenizer.from_pretrained("google/electra-small-discriminator")
>>> model = FlaxElectraForQuestionAnswering.from_pretrained("google/electra-small-discriminator")

>>> question, text = "Who was Jim Henson?", "Jim Henson was a nice puppet"
>>> inputs = tokenizer(question, text, return_tensors="jax")

>>> outputs = model(**inputs)
>>> start_scores = outputs.start_logits
>>> end_scores = outputs.end_logits
< > 在 GitHub 上更新

←DPR 編碼器-解碼器模型→
© . This site is unofficial and not affiliated with Hugging Face, Inc.