Hugging Face 的 LOGO

Transformers 文件

ErnieM

Hugging Face's logo
加入 Hugging Face 社群

並獲得增強的文件體驗

開始使用

ErnieM

PyTorch

此模型僅處於維護模式，我們不接受任何更改其程式碼的新 PR。如果您在執行此模型時遇到任何問題，請重新安裝支援此模型的最後一個版本：v4.40.2。您可以透過執行以下命令來執行此操作：pip install -U transformers==4.40.2。

概述

ErnieM 模型由 Xuan Ouyang、Shuohuan Wang、Chao Pang、Yu Sun、Hao Tian、Hua Wu、Haifeng Wang 在論文 ERNIE-M: Enhanced Multilingual Representation by Aligning Cross-lingual Semantics with Monolingual Corpora 中提出。

論文摘要如下：

最近的研究表明，預訓練的跨語言模型在下游跨語言任務中取得了令人印象深刻的效能。這種改進得益於學習大量的單語和並行語料庫。儘管人們普遍承認並行語料庫對於提高模型效能至關重要，但現有方法通常受限於並行語料庫的大小，特別是對於低資源語言。在本文中，我們提出了 ERNIE-M，一種新的訓練方法，鼓勵模型將多種語言的表示與單語語料庫對齊，以克服並行語料庫大小對模型效能的限制。我們的關鍵見解是將反向翻譯整合到預訓練過程中。我們在單語語料庫上生成偽並行句子對，以實現不同語言之間語義對齊的學習，從而增強跨語言模型的語義建模。實驗結果表明，ERNIE-M 優於現有的跨語言模型，並在各種跨語言下游任務中取得了新的最先進成果。 此模型由 Susnato Dhar 貢獻。原始程式碼可以在這裡找到。

使用技巧

  • Ernie-M 是一個類似 BERT 的模型，因此它是一個堆疊的 Transformer 編碼器。
  • 作者沒有使用 MaskedLM 進行預訓練（像 BERT 那樣），而是使用了兩種新技術：`Cross-attention Masked Language Modeling` 和 `Back-translation Masked Language Modeling`。目前，這兩種語言模型頭目標尚未在此處實現。
  • 它是一個多語言模型。
  • 在預訓練過程中未使用下一句預測。

資源

ErnieMConfig

class transformers.ErnieMConfig

< >

( vocab_size: int = 250002 hidden_size: int = 768 num_hidden_layers: int = 12 num_attention_heads: int = 12 intermediate_size: int = 3072 hidden_act: str = 'gelu' hidden_dropout_prob: float = 0.1 attention_probs_dropout_prob: float = 0.1 max_position_embeddings: int = 514 initializer_range: float = 0.02 pad_token_id: int = 1 layer_norm_eps: float = 1e-05 classifier_dropout = None act_dropout = 0.0 **kwargs )

引數

  • vocab_size (int, 可選, 預設為 250002) — ErnieMModel 中 inputs_ids 的詞彙表大小。同時也是詞嵌入矩陣的詞彙表大小。定義了在呼叫 ErnieMModel 時傳遞的 inputs_ids 可以表示的不同詞元的數量。
  • hidden_size (int, 可選, 預設為 768) — 嵌入層、編碼器層和池化層的維度。
  • num_hidden_layers (int, 可選, 預設為 12) — Transformer 編碼器中的隱藏層數量。
  • num_attention_heads (int, 可選, 預設為 12) — Transformer 編碼器中每個注意力層的注意力頭數量。
  • intermediate_size (int, 可選, 預設為 3072) — 編碼器中前饋（ff）層的維度。輸入到前饋層的張量首先從 hidden_size 投影到 intermediate_size，然後投影回 hidden_size。通常 intermediate_size 大於 hidden_size。
  • hidden_act (str, 可選, 預設為 "gelu") — 前饋層中的非線性啟用函式。支援 "gelu"、"relu" 以及任何其他 torch 支援的啟用函式。
  • hidden_dropout_prob (float, 可選, 預設為 0.1) — 嵌入層和編碼器中所有全連線層的丟棄機率。
  • attention_probs_dropout_prob (float, 可選, 預設為 0.1) — 在所有編碼器層的 `MultiHeadAttention` 中使用的丟棄機率，用於丟棄一些注意力目標。
  • max_position_embeddings (int, 可選, 預設為 514) — 位置編碼維度的最大值，決定了輸入序列支援的最大長度。
  • initializer_range (float, 可選, 預設為 0.02) — 用於初始化所有權重矩陣的正態分佈初始化器的標準差。詞元詞彙表中填充詞元的索引。
  • pad_token_id (int, 可選, 預設為 1) — 填充詞元 ID。
  • layer_norm_eps (float, 可選, 預設為 1e-05) — 層歸一化層使用的 epsilon 值。
  • classifier_dropout (float, 可選) — 分類頭的丟棄率。
  • act_dropout (float, 可選, 預設為 0.0) — 此丟棄機率在 `ErnieMEncoderLayer` 的啟用函式之後使用。

這是用於儲存 ErnieMModel 配置的配置類。它用於根據指定的引數例項化一個 Ernie-M 模型，定義模型架構。使用預設值例項化配置將產生與 `Ernie-M` susnato/ernie-m-base_pytorch 架構相似的配置。

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

normal_initializer 將權重矩陣初始化為正態分佈。有關如何在 `ErnieMModel` 中初始化權重，請參閱 `ErnieMPretrainedModel._init_weights()`。

ErnieMTokenizer

class transformers.ErnieMTokenizer

< >

( sentencepiece_model_ckpt vocab_file = None do_lower_case = False encoding = 'utf8' unk_token = '[UNK]' sep_token = '[SEP]' pad_token = '[PAD]' cls_token = '[CLS]' mask_token = '[MASK]' sp_model_kwargs: typing.Optional[dict[str, typing.Any]] = None **kwargs )

引數

  • sentencepiece_model_file (str) — sentencepiece 模型的路徑。
  • vocab_file (str, 可選) — 詞彙表文件的路徑。
  • do_lower_case (str, 可選, 預設為 `True`) — 是否在分詞時將輸入轉換為小寫。
  • unk_token (str, 可選, 預設為 "[UNK]") — 表示 `未知（詞彙表外）` 詞元的特殊詞元。未知詞元被設定為 `unk_token` 以便轉換為 ID。
  • sep_token (str, 可選, 預設為 "[SEP]") — 在同一輸入中分隔兩個不同句子的特殊詞元。
  • pad_token (str, 可選, 預設為 "[PAD]") — 用於將詞元陣列填充到相同大小以進行批處理的特殊詞元。
  • cls_token (str, 可選, 預設為 "[CLS]") — 用於序列分類的特殊詞元。在使用特殊詞元構建序列時，它是序列的最後一個詞元。
  • mask_token (str, 可選, 預設為 "[MASK]") — 表示被掩碼的詞元的特殊詞元。這是在掩碼語言建模任務中使用的詞元，模型會嘗試預測原始未掩碼的詞元。

構建一個 Ernie-M 分詞器。它使用 `sentencepiece` 工具將單詞切分為子詞。

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]

帶有相應特殊標記的 input_id 列表。

透過連線和新增特殊標記，為序列分類任務從一個序列或一對序列構建模型輸入。ErnieM 序列具有以下格式：

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

get_special_tokens_mask

< >

（ token_ids_0 token_ids_1 = None already_has_special_tokens = False ） → list[int]

引數

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

返回

list[int]

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

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

create_token_type_ids_from_sequences

< >

（ token_ids_0: list token_ids_1: typing.Optional[list[int]] = None ） → list[int]

引數

  • token_ids_0 (list[int]) — 第一個分詞後的序列。
  • token_ids_1 (list[int], 可選) — 第二個分詞後的序列。

返回

list[int]

標記型別 ID。

建立與傳入序列相對應的標記型別 ID。 什麼是標記型別 ID？ 如果模型有特殊的構建方式，應在子類中覆蓋此方法。

save_vocabulary

< >

（ save_directory: str filename_prefix: typing.Optional[str] = None ）

ErnieMModel

class transformers.ErnieMModel

< >

（ config add_pooling_layer = True ）

引數

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

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

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

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

forward

< >

（ input_ids: typing.Optional[<built-in method tensor of type object at 0x7f00efef6f40>] = None position_ids: typing.Optional[<built-in method tensor of type object at 0x7f00efef6f40>] = None attention_mask: typing.Optional[<built-in method tensor of type object at 0x7f00efef6f40>] = None head_mask: typing.Optional[<built-in method tensor of type object at 0x7f00efef6f40>] = None inputs_embeds: typing.Optional[<built-in method tensor of type object at 0x7f00efef6f40>] = None past_key_values: typing.Optional[tuple[tuple[torch._VariableFunctionsClass.tensor]]] = None use_cache: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None output_attentions: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ） → transformers.modeling_outputs.BaseModelOutputWithPastAndCrossAttentions 或 tuple(torch.FloatTensor)

引數

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

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

    什麼是輸入 ID？

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

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

    什麼是注意力掩碼？

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

    什麼是位置 ID？

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

    • 1 表示頭部未被遮蓋，
    • 0 表示頭部被遮蓋。
  • inputs_embeds (torch.FloatTensor，形狀為 (batch_size, sequence_length, hidden_size), 可選) — 或者，你可以選擇直接傳遞嵌入表示而不是 `input_ids`。如果你想比模型內部的嵌入查詢矩陣更能控制如何將 *input_ids* 索引轉換為關聯向量，這將非常有用。
  • output_attentions (bool, 可選) — 是否返回所有注意力層的注意力張量。有關更多詳細資訊，請參閱返回張量下的 `attentions`。
  • output_hidden_states (bool, 可選) — 是否返回所有層的隱藏狀態。有關更多詳細資訊，請參閱返回張量下的 `hidden_states`。
  • return_dict (bool, 可選) — 是否返回一個 ModelOutput 而不是一個普通的元組。

返回

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

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

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

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

  • past_key_values (Cache, 可選，在傳遞 use_cache=True 或 config.use_cache=True 時返回) — 這是一個 Cache 例項。有關更多詳細資訊，請參閱我們的 kv 快取指南。

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

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

ErnieMModel 的 forward 方法，覆蓋了 `__call__` 特殊方法。

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

示例

>>> from transformers import AutoTokenizer, ErnieMModel
>>> import torch

>>> tokenizer = AutoTokenizer.from_pretrained("susnato/ernie-m-base_pytorch")
>>> model = ErnieMModel.from_pretrained("susnato/ernie-m-base_pytorch")

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

>>> last_hidden_states = outputs.last_hidden_state

ErnieMForSequenceClassification

class transformers.ErnieMForSequenceClassification

< >

（ config ）

引數

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

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

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

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

forward

< >

（ input_ids: typing.Optional[torch.Tensor] = None attention_mask: 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 past_key_values: typing.Optional[list[torch.Tensor]] = None use_cache: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None output_attentions: typing.Optional[bool] = None return_dict: typing.Optional[bool] = True labels: typing.Optional[torch.Tensor] = None ） → transformers.modeling_outputs.SequenceClassifierOutput 或 tuple(torch.FloatTensor)

引數

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

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

    什麼是輸入 ID？

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

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

    什麼是注意力掩碼？

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

    什麼是位置 ID？

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

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

返回

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

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

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

ErnieMForSequenceClassification 的 forward 方法，覆蓋了 `__call__` 特殊方法。

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

單標籤分類示例

>>> import torch
>>> from transformers import AutoTokenizer, ErnieMForSequenceClassification

>>> tokenizer = AutoTokenizer.from_pretrained("susnato/ernie-m-base_pytorch")
>>> model = ErnieMForSequenceClassification.from_pretrained("susnato/ernie-m-base_pytorch")

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

>>> with torch.no_grad():
...     logits = model(**inputs).logits

>>> predicted_class_id = logits.argmax().item()

>>> # 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 = ErnieMForSequenceClassification.from_pretrained("susnato/ernie-m-base_pytorch", num_labels=num_labels)

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

多標籤分類示例

>>> import torch
>>> from transformers import AutoTokenizer, ErnieMForSequenceClassification

>>> tokenizer = AutoTokenizer.from_pretrained("susnato/ernie-m-base_pytorch")
>>> model = ErnieMForSequenceClassification.from_pretrained("susnato/ernie-m-base_pytorch", 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 = ErnieMForSequenceClassification.from_pretrained(
...     "susnato/ernie-m-base_pytorch", 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

ErnieMForMultipleChoice

class transformers.ErnieMForMultipleChoice

< >

（ config ）

引數

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

ErnieM 模型，頂部帶有多項選擇分類頭（在池化輸出之上是一個線性層和一個 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 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] = True ） → transformers.modeling_outputs.MultipleChoiceModelOutput 或 tuple(torch.FloatTensor)

引數

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

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

    什麼是輸入 ID？

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

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

    什麼是注意力掩碼？

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

    什麼是位置 ID？

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

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

返回

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

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

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

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

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

示例

>>> from transformers import AutoTokenizer, ErnieMForMultipleChoice
>>> import torch

>>> tokenizer = AutoTokenizer.from_pretrained("susnato/ernie-m-base_pytorch")
>>> model = ErnieMForMultipleChoice.from_pretrained("susnato/ernie-m-base_pytorch")

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

ErnieMForTokenClassification

class transformers.ErnieMForTokenClassification

< >

（ config ）

引數

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

ErnieM 模型，頂部帶有一個 token 分類頭（即在隱藏狀態輸出之上加一個線性層），例如用於命名實體識別（NER）任務。

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

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

forward

< >

( input_ids: typing.Optional[torch.Tensor] = None attention_mask: 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 past_key_values: typing.Optional[list[torch.Tensor]] = None output_hidden_states: typing.Optional[bool] = None output_attentions: typing.Optional[bool] = None return_dict: typing.Optional[bool] = True labels: typing.Optional[torch.Tensor] = None ) → transformers.modeling_outputs.TokenClassifierOutput 或 tuple(torch.FloatTensor)

引數

  • input_ids (torch.LongTensor of shape (batch_size, sequence_length)) — 詞彙表中輸入序列 token 的索引。

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

    什麼是輸入 ID？

  • attention_mask (torch.FloatTensor of shape (batch_size, sequence_length), optional) — 用於避免對填充 token 索引執行注意力的掩碼。掩碼值在 [0, 1] 中選擇：

    • 1 表示 token 未被遮蔽，
    • 0 表示 token 被遮蔽。

    什麼是注意力掩碼？

  • position_ids (torch.LongTensor of shape (batch_size, sequence_length), optional) — 每個輸入序列 token 在位置嵌入中的位置索引。在 [0, config.max_position_embeddings - 1] 範圍內選擇。

    什麼是位置 ID？

  • head_mask (torch.FloatTensor of shape (num_heads,) or (num_layers, num_heads), optional) — 用於置零自注意力模組中選定頭的掩碼。掩碼值在 [0, 1] 中選擇：

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

返回

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

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

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

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

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

示例

>>> from transformers import AutoTokenizer, ErnieMForTokenClassification
>>> import torch

>>> tokenizer = AutoTokenizer.from_pretrained("susnato/ernie-m-base_pytorch")
>>> model = ErnieMForTokenClassification.from_pretrained("susnato/ernie-m-base_pytorch")

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

>>> labels = predicted_token_class_ids
>>> loss = model(**inputs, labels=labels).loss

ErnieMForQuestionAnswering

class transformers.ErnieMForQuestionAnswering

< >

（ config ）

引數

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

ErnieM 模型，頂部帶有一個 span 分類頭，用於抽取式問答任務，如 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 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] = True ) → transformers.modeling_outputs.QuestionAnsweringModelOutput 或 tuple(torch.FloatTensor)

引數

  • input_ids (torch.LongTensor of shape (batch_size, sequence_length)) — 詞彙表中輸入序列 token 的索引。

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

    什麼是輸入 ID？

  • attention_mask (torch.FloatTensor of shape (batch_size, sequence_length), optional) — 用於避免對填充 token 索引執行注意力的掩碼。掩碼值在 [0, 1] 中選擇：

    • 1 表示 token 未被遮蔽，
    • 0 表示 token 被遮蔽。

    什麼是注意力掩碼？

  • position_ids (torch.LongTensor of shape (batch_size, sequence_length), optional) — 每個輸入序列 token 在位置嵌入中的位置索引。在 [0, config.max_position_embeddings - 1] 範圍內選擇。

    什麼是位置 ID？

  • head_mask (torch.FloatTensor of shape (num_heads,) or (num_layers, num_heads), optional) — 用於置零自注意力模組中選定頭的掩碼。掩碼值在 [0, 1] 中選擇：

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

返回

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

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

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

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

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

示例

>>> from transformers import AutoTokenizer, ErnieMForQuestionAnswering
>>> import torch

>>> tokenizer = AutoTokenizer.from_pretrained("susnato/ernie-m-base_pytorch")
>>> model = ErnieMForQuestionAnswering.from_pretrained("susnato/ernie-m-base_pytorch")

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

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

ErnieMForInformationExtraction

class transformers.ErnieMForInformationExtraction

< >

（ config ）

引數

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

ErnieMForInformationExtraction 是一個 Ernie-M 模型，在隱藏狀態輸出之上帶有兩個線性層，用於計算 `start_prob` 和 `end_prob`，專為通用資訊抽取而設計。

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

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

forward

< >

( input_ids: typing.Optional[torch.Tensor] = None attention_mask: 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] = True )

引數

  • input_ids (torch.LongTensor of shape (batch_size, num_choices, sequence_length)) — 詞彙表中輸入序列 token 的索引。

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

    什麼是輸入 ID？

  • attention_mask (torch.FloatTensor of shape (batch_size, num_choices, sequence_length), optional) — 用於避免對填充 token 索引執行注意力的掩碼。掩碼值在 [0, 1] 中選擇：

    • 1 表示 token 未被遮蔽，
    • 0 表示 token 被遮蔽。

    什麼是注意力掩碼？

  • position_ids (torch.LongTensor of shape (batch_size, num_choices, sequence_length), optional) — 每個輸入序列 token 在位置嵌入中的位置索引。在 [0, config.max_position_embeddings - 1] 範圍內選擇。

    什麼是位置 ID？

  • head_mask (torch.FloatTensor of shape (num_heads,) or (num_layers, num_heads), optional) — 用於置零自注意力模組中選定頭的掩碼。掩碼值在 [0, 1] 中選擇：

    • 1 表示頭 未被遮蔽，
    • 0 表示頭 被遮蔽。
  • inputs_embeds (torch.FloatTensor of shape (batch_size, num_choices, sequence_length, hidden_size), optional) — 可選地，你可以選擇直接傳遞嵌入表示，而不是傳遞 `input_ids`。如果你想比模型內部的嵌入查詢矩陣更多地控制如何將 *input_ids* 索引轉換為關聯向量，這會很有用。
  • output_attentions (bool, optional) — 是否返回所有注意力層的注意力張量。有關更多詳細資訊，請參閱返回張量下的 attentions。
  • output_hidden_states (bool, optional) — 是否返回所有層的隱藏狀態。有關更多詳細資訊，請參閱返回張量下的 hidden_states。
  • return_dict (bool, optional) — 是返回一個 ModelOutput 而不是一個普通的元組。
  • start_positions (torch.LongTensor，形狀為 (batch_size, sequence_length)，可選) — 用於計算 start_positions 損失的位置（索引）標籤。在計算損失時，不考慮序列之外的位置。
  • end_positions (torch.LongTensor，形狀為 (batch_size,)，可選) — 用於計算 end_positions 損失的位置（索引）標籤。在計算損失時，不考慮序列之外的位置。

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

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

< > 在 GitHub 上更新

←ERNIE ESM→
© . This site is unofficial and not affiliated with Hugging Face, Inc.