Hugging Face 的 LOGO

Transformers 文件

REALM

Hugging Face's logo
加入 Hugging Face 社群

並獲得增強的文件體驗

開始使用

REALM

PyTorch

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

概述

REALM 模型由 Kelvin Guu、Kenton Lee、Zora Tung、Panupong Pasupat 和 Ming-Wei Chang 在論文 REALM: Retrieval-Augmented Language Model Pre-Training 中提出。它是一個檢索增強的語言模型，首先從文字知識庫中檢索文件，然後利用檢索到的文件來處理問答任務。

論文摘要如下：

語言模型預訓練已被證明能捕獲大量世界知識，這對於像問答這樣的自然語言處理任務至關重要。然而，這些知識隱式地儲存在神經網路的引數中，需要越來越大的網路來覆蓋更多的知識點。為了以更模組化和可解釋的方式捕獲知識，我們透過一個潛在知識檢索器來增強語言模型預訓練，該檢索器允許模型從大型語料庫（如維基百科）中檢索並關注文件，並在預訓練、微調和推理過程中使用這些文件。我們首次展示瞭如何以無監督的方式預訓練這種知識檢索器，使用掩碼語言建模作為學習訊號，並透過一個考慮了數百萬文件的檢索步驟進行反向傳播。我們透過在具有挑戰性的開放域問答（Open-QA）任務上進行微調，展示了檢索增強語言模型預訓練（REALM）的有效性。我們在三個流行的開放域問答基準上，將 REALM 與顯式和隱式知識儲存的最新模型進行了比較，發現它在所有先前的模型上都有顯著的效能提升（絕對準確率提高 4-16%），同時還提供了可解釋性和模組化等定性優勢。

該模型由 qqaatw 貢獻。原始程式碼可以在此處找到。

RealmConfig

class transformers.RealmConfig

< >

( vocab_size = 30522 hidden_size = 768 retriever_proj_size = 128 num_hidden_layers = 12 num_attention_heads = 12 num_candidates = 8 intermediate_size = 3072 hidden_act = 'gelu_new' 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 span_hidden_size = 256 max_span_width = 10 reader_layer_norm_eps = 0.001 reader_beam_size = 5 reader_seq_len = 320 num_block_records = 13353718 searcher_beam_size = 5000 pad_token_id = 1 bos_token_id = 0 eos_token_id = 2 **kwargs )

引數

  • vocab_size (int, 可選, 預設為 30522) — REALM 模型的詞彙表大小。定義了在呼叫 RealmEmbedder、RealmScorer、RealmKnowledgeAugEncoder 或 RealmReader 時，可以由 `inputs_ids` 表示的不同標記的數量。
  • hidden_size (int, 可選, 預設為 768) — 編碼器層和池化層的維度。
  • retriever_proj_size (int, 可選, 預設為 128) — 檢索器（嵌入器）投影的維度。
  • num_hidden_layers (int, 可選, 預設為 12) — Transformer 編碼器中的隱藏層數量。
  • num_attention_heads (int, 可選, 預設為 12) — Transformer 編碼器中每個注意力層的注意力頭數量。
  • num_candidates (int, 可選, 預設為 8) — 輸入到 RealmScorer 或 RealmKnowledgeAugEncoder 的候選者數量。
  • intermediate_size (int, 可選, 預設為 3072) — Transformer 編碼器中“中間”（即前饋）層的維度。
  • hidden_act (str 或 function, 可選, 預設為 "gelu_new") — 編碼器和池化器中的非線性啟用函式（函式或字串）。如果為字串，支援 "gelu"、"relu"、"selu" 和 "gelu_new"。
  • hidden_dropout_prob (float, 可選, 預設為 0.1) — 嵌入、編碼器和池化器中所有全連線層的丟棄機率。
  • attention_probs_dropout_prob (float, 可選, 預設為 0.1) — 注意力機率的丟棄率。
  • max_position_embeddings (int, 可選, 預設為 512) — 此模型可能使用的最大序列長度。通常將其設定為一個較大的值以防萬一（例如 512、1024 或 2048）。
  • type_vocab_size (int, 可選, 預設為 2) — 呼叫 RealmEmbedder、RealmScorer、RealmKnowledgeAugEncoder 或 RealmReader 時傳遞的 `token_type_ids` 的詞彙表大小。
  • initializer_range (float, 可選, 預設為 0.02) — 用於初始化所有權重矩陣的 truncated_normal_initializer 的標準差。
  • layer_norm_eps (float, 可選, 預設為 1e-12) — 層歸一化層使用的 epsilon 值。
  • span_hidden_size (int, 可選, 預設為 256) — 讀取器（reader）跨度（span）的維度。
  • max_span_width (int, 可選, 預設為 10) — 讀取器（reader）的最大跨度（span）寬度。
  • reader_layer_norm_eps (float, 可選, 預設為 1e-3) — 讀取器（reader）層歸一化層使用的 epsilon 值。
  • reader_beam_size (int, 可選, 預設為 5) — 讀取器（reader）的束搜尋大小。
  • reader_seq_len (int, 可選, 預設為 288+32) — 讀取器（reader）的最大序列長度。
  • num_block_records (int, 可選, 預設為 13353718) — 塊記錄的數量。
  • searcher_beam_size (int, 可選, 預設為 5000) — 搜尋器（searcher）的束搜尋大小。請注意，當啟用評估模式時，searcher_beam_size 將與 reader_beam_size 相同。

這是用於儲存以下模型配置的配置類：

  1. RealmEmbedder
  2. RealmScorer
  3. RealmKnowledgeAugEncoder
  4. RealmRetriever
  5. RealmReader
  6. RealmForOpenQA

它用於根據指定的引數例項化 REALM 模型，定義模型架構。使用預設值例項化配置將產生與 REALM google/realm-cc-news-pretrained-embedder 架構類似的配置。

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

示例

>>> from transformers import RealmConfig, RealmEmbedder

>>> # Initializing a REALM realm-cc-news-pretrained-* style configuration
>>> configuration = RealmConfig()

>>> # Initializing a model (with random weights) from the google/realm-cc-news-pretrained-embedder style configuration
>>> model = RealmEmbedder(configuration)

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

RealmTokenizer

class transformers.RealmTokenizer

< >

( 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 **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 的值決定（與原始 BERT 中一樣）。

構建一個 REALM 分詞器。

RealmTokenizer 與 BertTokenizer 相同，並執行端到端的分詞：標點符號切分和 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列表。

透過連線和新增特殊詞元，從一個序列或一對序列構建模型輸入，用於序列分類任務。一個 REALM 序列具有以下格式

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

get_special_tokens_mask

< >

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

引數

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

返回

List[int]

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

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

create_token_type_ids_from_sequences

< >

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

引數

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

返回

list[int]

標記型別 ID。

建立與傳入序列對應的標記型別 ID。什麼是標記型別 ID？

如果模型有特殊的構建方式，應在子類中重寫此方法。

save_vocabulary

< >

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

batch_encode_candidates

< >

( text **kwargs ) → BatchEncoding

引數

  • text (List[List[str]]) — 待編碼的序列批次。每個序列必須採用以下格式：(batch_size, num_candidates, text)。
  • text_pair (List[List[str]], 可選) — 待編碼的序列批次。每個序列必須採用以下格式：(batch_size, num_candidates, text)。
  • **kwargs — call 方法的關鍵字引數。

返回

BatchEncoding

編碼後的文字或文字對。

對一批文字或文字對進行編碼。此方法與常規 call 方法類似，但有以下區別

  1. 處理額外的 num_candidate 軸。(batch_size, num_candidates, text)
  2. 始終將序列填充到 max_length。
  3. 必須指定 max_length，以便將候選包堆疊成一個批次。
  • 單個序列：[CLS] X [SEP]
  • 序列對：[CLS] A [SEP] B [SEP]

示例

>>> from transformers import RealmTokenizer

>>> # batch_size = 2, num_candidates = 2
>>> text = [["Hello world!", "Nice to meet you!"], ["The cute cat.", "The adorable dog."]]

>>> tokenizer = RealmTokenizer.from_pretrained("google/realm-cc-news-pretrained-encoder")
>>> tokenized_text = tokenizer.batch_encode_candidates(text, max_length=10, return_tensors="pt")

RealmTokenizerFast

class transformers.RealmTokenizerFast

< >

( 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 的值決定（與原始 BERT 中一樣）。
  • wordpieces_prefix (str, 可選, 預設為 "##") — 子詞的字首。

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

RealmTokenizerFast 與 BertTokenizerFast 相同，並執行端到端的分詞：標點符號切分和 WordPiece。

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

batch_encode_candidates

< >

( text **kwargs ) → BatchEncoding

引數

  • text (List[List[str]]) — 待編碼的序列批次。每個序列必須採用以下格式：(batch_size, num_candidates, text)。
  • text_pair (List[List[str]], 可選) — 待編碼的序列批次。每個序列必須採用以下格式：(batch_size, num_candidates, text)。
  • **kwargs — call 方法的關鍵字引數。

返回

BatchEncoding

編碼後的文字或文字對。

對一批文字或文字對進行編碼。此方法與常規 call 方法類似，但有以下區別

  1. 處理額外的 num_candidate 軸。(batch_size, num_candidates, text)
  2. 始終將序列填充到 max_length。
  3. 必須指定 max_length，以便將候選包堆疊成一個批次。
  • 單個序列：[CLS] X [SEP]
  • 序列對：[CLS] A [SEP] B [SEP]

示例

>>> from transformers import RealmTokenizerFast

>>> # batch_size = 2, num_candidates = 2
>>> text = [["Hello world!", "Nice to meet you!"], ["The cute cat.", "The adorable dog."]]

>>> tokenizer = RealmTokenizerFast.from_pretrained("google/realm-cc-news-pretrained-encoder")
>>> tokenized_text = tokenizer.batch_encode_candidates(text, max_length=10, return_tensors="pt")

RealmRetriever

class transformers.RealmRetriever

< >

( block_records tokenizer )

引數

  • block_records (np.ndarray) — 一個包含證據文字的 numpy 陣列。
  • tokenizer (RealmTokenizer) — 用於編碼檢索到的文字的分詞器。

REALM 的檢索器，輸出檢索到的證據塊、該塊是否包含答案以及答案位置。”

block_has_answer

< >

( concat_inputs answer_ids )

檢查 retrieved_blocks 是否包含答案。

RealmEmbedder

class transformers.RealmEmbedder

< >

( config )

引數

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

REALM 的嵌入器（embedder），輸出用於計算相關性分數的投影分數。該模型是 PyTorch torch.nn.Module 的子類。可將其用作常規的 PyTorch 模組，有關所有常規用法和行為，請參閱 PyTorch 文件。

forward

< >

( input_ids: typing.Optional[torch.LongTensor] = None attention_mask: typing.Optional[torch.FloatTensor] = None token_type_ids: typing.Optional[torch.LongTensor] = None position_ids: typing.Optional[torch.LongTensor] = None head_mask: typing.Optional[torch.FloatTensor] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.models.deprecated.realm.modeling_realm.RealmEmbedderOutput 或 tuple(torch.FloatTensor)

引數

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

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

    什麼是輸入 ID？

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

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

    什麼是注意力掩碼？

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

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

    什麼是標記型別 ID？

  • 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.models.deprecated.realm.modeling_realm.RealmEmbedderOutput 或 tuple(torch.FloatTensor)

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

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

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

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

示例

>>> from transformers import AutoTokenizer, RealmEmbedder
>>> import torch

>>> tokenizer = AutoTokenizer.from_pretrained("google/realm-cc-news-pretrained-embedder")
>>> model = RealmEmbedder.from_pretrained("google/realm-cc-news-pretrained-embedder")

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

>>> projected_score = outputs.projected_score

RealmScorer

class transformers.RealmScorer

< >

( config query_embedder = None )

引數

  • config (RealmConfig) — 包含模型所有引數的模型配置類。使用配置檔案初始化不會載入與模型相關的權重，只會載入配置。請檢視 from_pretrained() 方法來載入模型權重。
  • query_embedder (RealmEmbedder) — 用於輸入序列的嵌入器。如果未指定，將使用與候選序列相同的嵌入器。

REALM 的評分器（scorer），輸出表示候選文件分數的相關性分數（在 softmax 之前）。該模型是 PyTorch torch.nn.Module 的子類。可將其用作常規的 PyTorch 模組，有關所有常規用法和行為，請參閱 PyTorch 文件。

forward

< >

( input_ids: typing.Optional[torch.LongTensor] = None attention_mask: typing.Optional[torch.FloatTensor] = None token_type_ids: typing.Optional[torch.LongTensor] = None position_ids: typing.Optional[torch.LongTensor] = None candidate_input_ids: typing.Optional[torch.LongTensor] = None candidate_attention_mask: typing.Optional[torch.FloatTensor] = None candidate_token_type_ids: typing.Optional[torch.LongTensor] = None candidate_inputs_embeds: typing.Optional[torch.FloatTensor] = None head_mask: typing.Optional[torch.FloatTensor] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.models.deprecated.realm.modeling_realm.RealmScorerOutput 或 tuple(torch.FloatTensor)

引數

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

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

    什麼是輸入 ID？

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

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

    什麼是注意力掩碼？

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

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

    什麼是標記型別 ID？

  • 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 而不是一個普通的元組。
  • candidate_input_ids (torch.LongTensor，形狀為 (batch_size, num_candidates, sequence_length)) — 詞彙表中候選輸入序列標記的索引。

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

    什麼是輸入 ID？

  • candidate_attention_mask (torch.FloatTensor，形狀為 (batch_size, num_candidates, sequence_length)，可選) — 用於避免對填充標記索引執行注意力計算的掩碼。掩碼值選自 [0, 1]：

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

    什麼是注意力掩碼？

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

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

    什麼是標記型別 ID？

  • candidate_inputs_embeds (torch.FloatTensor，形狀為 (batch_size * num_candidates, sequence_length, hidden_size)，可選) — 或者，你可以選擇直接傳遞嵌入表示，而不是傳遞 `candidate_input_ids`。如果你希望比模型內部的嵌入查詢矩陣對如何將 *candidate_input_ids* 索引轉換為關聯向量有更多控制，這會非常有用。

返回

transformers.models.deprecated.realm.modeling_realm.RealmScorerOutput 或 tuple(torch.FloatTensor)

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

  • relevance_score (torch.FloatTensor，形狀為 (batch_size, config.num_candidates)) — 候選文件的相關性分數（在 softmax 之前）。
  • query_score (torch.FloatTensor，形狀為 (batch_size, config.retriever_proj_size)) — 從查詢嵌入器派生的查詢分數。
  • candidate_score (torch.FloatTensor，形狀為 (batch_size, config.num_candidates, config.retriever_proj_size)) — 從嵌入器派生的候選分數。

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

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

示例

>>> import torch
>>> from transformers import AutoTokenizer, RealmScorer

>>> tokenizer = AutoTokenizer.from_pretrained("google/realm-cc-news-pretrained-scorer")
>>> model = RealmScorer.from_pretrained("google/realm-cc-news-pretrained-scorer", num_candidates=2)

>>> # batch_size = 2, num_candidates = 2
>>> input_texts = ["How are you?", "What is the item in the picture?"]
>>> candidates_texts = [["Hello world!", "Nice to meet you!"], ["A cute cat.", "An adorable dog."]]

>>> inputs = tokenizer(input_texts, return_tensors="pt")
>>> candidates_inputs = tokenizer.batch_encode_candidates(candidates_texts, max_length=10, return_tensors="pt")

>>> outputs = model(
...     **inputs,
...     candidate_input_ids=candidates_inputs.input_ids,
...     candidate_attention_mask=candidates_inputs.attention_mask,
...     candidate_token_type_ids=candidates_inputs.token_type_ids,
... )
>>> relevance_score = outputs.relevance_score

RealmKnowledgeAugEncoder

class transformers.RealmKnowledgeAugEncoder

< >

( config )

引數

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

REALM 的知識增強編碼器，輸出掩碼語言模型 logits 和邊際對數似然損失。該模型是 PyTorch torch.nn.Module 的子類。可將其用作常規的 PyTorch 模組，有關所有常規用法和行為，請參閱 PyTorch 文件。

forward

< >

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

引數

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

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

    什麼是輸入 ID？

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

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

    什麼是注意力掩碼？

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

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

    什麼是標記型別 ID？

  • position_ids (torch.LongTensor，形狀為 (batch_size, num_candidates, 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_candidates, sequence_length, hidden_size)，可選) — 或者，你可以選擇直接傳遞嵌入表示，而不是傳遞 `input_ids`。如果你希望比模型內部的嵌入查詢矩陣對如何將 *input_ids* 索引轉換為關聯向量有更多控制，這會非常有用。
  • output_attentions (bool，可選) — 是否返回所有注意力層的注意力張量。有關更多詳細資訊，請參閱返回張量下的 `attentions`。
  • output_hidden_states (bool，可選) — 是否返回所有層的隱藏狀態。有關更多詳細資訊，請參閱返回張量下的 `hidden_states`。
  • return_dict (bool，可選) — 是返回一個 ModelOutput 而不是一個普通的元組。
  • relevance_score (torch.FloatTensor，形狀為 (batch_size, num_candidates)，可選) — 從 RealmScorer 派生的相關性分數，如果要計算掩碼語言模型損失，必須指定此項。
  • labels (torch.LongTensor，形狀為 (batch_size, sequence_length)，可選) — 用於計算掩碼語言模型損失的標籤。索引應在 [-100, 0, ..., config.vocab_size] 範圍內（參見 `input_ids` 文件字串）。索引設定為 `-100` 的標記將被忽略（掩碼），損失僅針對標籤在 [0, ..., config.vocab_size] 範圍內的標記計算。
  • mlm_mask (torch.LongTensor，形狀為 (batch_size, sequence_length)，可選) — 用於避免在某些位置計算聯合損失的掩碼。如果未指定，損失將不會被掩碼。掩碼值選自 [0, 1]：

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

返回

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

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

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

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

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

示例

>>> import torch
>>> from transformers import AutoTokenizer, RealmKnowledgeAugEncoder

>>> tokenizer = AutoTokenizer.from_pretrained("google/realm-cc-news-pretrained-encoder")
>>> model = RealmKnowledgeAugEncoder.from_pretrained(
...     "google/realm-cc-news-pretrained-encoder", num_candidates=2
... )

>>> # batch_size = 2, num_candidates = 2
>>> text = [["Hello world!", "Nice to meet you!"], ["The cute cat.", "The adorable dog."]]

>>> inputs = tokenizer.batch_encode_candidates(text, max_length=10, return_tensors="pt")
>>> outputs = model(**inputs)
>>> logits = outputs.logits

RealmReader

class transformers.RealmReader

< >

( config )

引數

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

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

forward

< >

( input_ids: typing.Optional[torch.LongTensor] = None attention_mask: typing.Optional[torch.FloatTensor] = None token_type_ids: typing.Optional[torch.LongTensor] = None position_ids: typing.Optional[torch.LongTensor] = None head_mask: typing.Optional[torch.FloatTensor] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None relevance_score: typing.Optional[torch.FloatTensor] = None block_mask: typing.Optional[torch.BoolTensor] = None start_positions: typing.Optional[torch.LongTensor] = None end_positions: typing.Optional[torch.LongTensor] = None has_answers: typing.Optional[torch.BoolTensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.models.deprecated.realm.modeling_realm.RealmReaderOutput 或 tuple(torch.FloatTensor)

引數

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

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

    什麼是輸入 ID？

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

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

    什麼是注意力掩碼？

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

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

    什麼是標記型別 ID？

  • position_ids (torch.LongTensor，形狀為 (reader_beam_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，形狀為 (reader_beam_size, sequence_length, hidden_size)，可選) — 可選地，你可以直接傳遞嵌入表示，而不是傳遞 input_ids。如果你想比模型的內部嵌入查詢矩陣更多地控制如何將 input_ids 索引轉換為相關向量，這將非常有用。
  • output_attentions (bool，可選) — 是否返回所有注意力層的注意力張量。有關更多詳細資訊，請參閱返回的張量下的 attentions。
  • output_hidden_states (bool，可選) — 是否返回所有層的隱藏狀態。有關更多詳細資訊，請參閱返回的張量下的 hidden_states。
  • return_dict (bool，可選) — 是否返回 ModelOutput 而不是普通的元組。
  • relevance_score (torch.FloatTensor，形狀為 (searcher_beam_size,)，可選) — 相關性得分，如果想計算 logits 和邊際對數損失，則必須指定。
  • block_mask (torch.BoolTensor，形狀為 (searcher_beam_size, sequence_length)，可選) — 證據塊的掩碼，如果想計算 logits 和邊際對數損失，則必須指定。
  • start_positions (torch.LongTensor，形狀為 (searcher_beam_size,)，可選) — 用於計算標記分類損失的標記區間的開始位置（索引）標籤。位置會被限制在序列長度（sequence_length）內。超出序列的位置在計算損失時不會被考慮。
  • end_positions (torch.LongTensor，形狀為 (searcher_beam_size,)，可選) — 用於計算標記分類損失的標記區間的結束位置（索引）標籤。位置會被限制在序列長度（sequence_length）內。超出序列的位置在計算損失時不會被考慮。
  • has_answers (torch.BoolTensor，形狀為 (searcher_beam_size,)，可選) — 證據塊是否包含答案。

返回

transformers.models.deprecated.realm.modeling_realm.RealmReaderOutput 或 tuple(torch.FloatTensor)

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

  • loss (torch.FloatTensor，形狀為 (1,)，可選，當提供 start_positions, end_positions, has_answers 時返回) — 總損失。

  • retriever_loss (torch.FloatTensor，形狀為 (1,)，可選，當提供 start_positions, end_positions, has_answers 時返回) — 檢索器損失。

  • reader_loss (torch.FloatTensor，形狀為 (1,)，可選，當提供 start_positions, end_positions, has_answers 時返回) — 閱讀器損失。

  • retriever_correct (torch.BoolTensor，形狀為 (config.searcher_beam_size,)，可選) — 證據塊是否包含答案。

  • reader_correct (torch.BoolTensor，形狀為 (config.reader_beam_size, num_candidates)，可選) — 候選答案區間是否包含答案。

  • block_idx (torch.LongTensor，形狀為 ()) — 預測答案最可能所在的檢索到的證據塊的索引。

  • candidate (torch.LongTensor，形狀為 ()) — 預測答案最可能所在的檢索到的候選答案區間的索引。

  • start_pos (torch.IntTensor，形狀為 ()) — RealmReader 輸入中預測答案的起始位置。

  • end_pos (torch.IntTensor，形狀為 ()) — RealmReader 輸入中預測答案的結束位置。

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

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

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

RealmForOpenQA

class transformers.RealmForOpenQA

< >

( config retriever = None )

引數

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

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

block_embedding_to

< >

( device )

引數

  • device (str 或 torch.device) — self.block_emb 將被髮送到的裝置。

將 self.block_emb 傳送到指定裝置。

forward

< >

( input_ids: typing.Optional[torch.LongTensor] attention_mask: typing.Optional[torch.FloatTensor] = None token_type_ids: typing.Optional[torch.LongTensor] = None answer_ids: typing.Optional[torch.LongTensor] = None return_dict: typing.Optional[bool] = None ) → transformers.models.deprecated.realm.modeling_realm.RealmForOpenQAOutput 或 tuple(torch.FloatTensor)

引數

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

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

    什麼是輸入 ID？

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

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

    什麼是注意力掩碼？

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

    • 0 對應於 句子 A 的標記，
    • 1 對應於 句子 B 的標記（設計上不應在此模型中使用）。

    什麼是標記型別 ID？

  • answer_ids (list，形狀為 (num_answers, answer_length)，可選) — 用於計算邊際對數似然損失的答案 ID。索引應在 [-1, 0, ..., config.vocab_size] 範圍內（請參閱 input_ids 文件字串）。索引設定為 -1 的標記將被忽略（遮蓋），損失僅對標籤在 [0, ..., config.vocab_size] 範圍內的標記進行計算。
  • return_dict (bool，可選) — 是否返回 ModelOutput 而不是普通的元組。

返回

transformers.models.deprecated.realm.modeling_realm.RealmForOpenQAOutput 或 tuple(torch.FloatTensor)

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

  • reader_output (dict) — 閱讀器輸出。
  • predicted_answer_ids (torch.LongTensor，形狀為 (answer_sequence_length)) — 預測的答案 ID。

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

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

示例

>>> import torch
>>> from transformers import RealmForOpenQA, RealmRetriever, AutoTokenizer

>>> retriever = RealmRetriever.from_pretrained("google/realm-orqa-nq-openqa")
>>> tokenizer = AutoTokenizer.from_pretrained("google/realm-orqa-nq-openqa")
>>> model = RealmForOpenQA.from_pretrained("google/realm-orqa-nq-openqa", retriever=retriever)

>>> question = "Who is the pioneer in modern computer science?"
>>> question_ids = tokenizer([question], return_tensors="pt")
>>> answer_ids = tokenizer(
...     ["alan mathison turing"],
...     add_special_tokens=False,
...     return_token_type_ids=False,
...     return_attention_mask=False,
... ).input_ids

>>> reader_output, predicted_answer_ids = model(**question_ids, answer_ids=answer_ids, return_dict=False)
>>> predicted_answer = tokenizer.decode(predicted_answer_ids)
>>> loss = reader_output.loss
< > 在 GitHub 上更新

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