Transformers 文档

REALM

Transformers

加入 Hugging Face 社区

并获取增强的文档体验

在模型、数据集和 Spaces 上协作

通过加速推理获得更快的示例

切换文档主题

开始使用

REALM

此模型仅处于维护模式，我们不接受任何更改其代码的新 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 中提出。它是一种检索增强语言模型，首先从文本知识语料库中检索文档，然后利用检索到的文档来处理问答任务。

该论文的摘要如下：

语言模型预训练已被证明可以捕获惊人的世界知识量，这对于诸如问答等 NLP 任务至关重要。然而，这些知识隐式地存储在神经网络的参数中，需要越来越大的网络来覆盖更多的 facts（事实/知识点）。为了以更模块化和可解释的方式捕获知识，我们使用潜在知识检索器增强语言模型预训练，这允许模型在预训练、微调和推理期间检索和关注来自大型语料库（例如维基百科）的文档。我们首次展示了如何以无监督的方式预训练这种知识检索器，使用 masked language modeling（掩码语言建模）作为学习信号，并通过考虑数百万文档的检索步骤进行反向传播。我们通过在具有挑战性的 Open-domain Question Answering (Open-QA)（开放域问答）任务上进行微调，证明了 Retrieval-Augmented Language Model pre-training (REALM)（检索增强语言模型预训练 (REALM)）的有效性。我们在三个流行的 Open-QA 基准上与显式和隐式知识存储的最先进模型进行了比较，发现我们以显着优势（绝对准确率提高 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, optional, 默认为 30522) — REALM 模型的词汇表大小。定义了在调用 RealmEmbedder, RealmScorer, RealmKnowledgeAugEncoder, 或 RealmReader 时传递的 inputs_ids 可以表示的不同 token（词元）的数量。
hidden_size (int, optional, 默认为 768) — encoder（编码器）层和 pooler（池化）层的维度。
retriever_proj_size (int, optional, 默认为 128) — 检索器（embedder）投影的维度。
num_hidden_layers (int, optional, 默认为 12) — Transformer encoder（Transformer 编码器）中的隐藏层数。
num_attention_heads (int, optional, 默认为 12) — Transformer encoder（Transformer 编码器）中每个 attention（注意力）层的注意力头数。
num_candidates (int, optional, 默认为 8) — 输入到 RealmScorer 或 RealmKnowledgeAugEncoder 的候选数量。
intermediate_size (int, optional, 默认为 3072) — Transformer encoder（Transformer 编码器）中“intermediate”（即，feed-forward（前馈））层的维度。
hidden_act (str 或 function, optional, 默认为 "gelu_new") — encoder（编码器）和 pooler（池化器）中的非线性激活函数（函数或字符串）。如果是字符串，则支持 “gelu”、“relu”、“selu” 和 “gelu_new”。
hidden_dropout_prob (float, optional, 默认为 0.1) — embeddings（嵌入层）、encoder（编码器）和 pooler（池化器）中所有 fully connected layers（全连接层）的 dropout 概率。
attention_probs_dropout_prob (float, optional, 默认为 0.1) — attention（注意力）概率的 dropout 比率。
max_position_embeddings (int, optional, 默认为 512) — 此模型可能使用的最大序列长度。通常将其设置为较大的值以防万一（例如，512 或 1024 或 2048）。
type_vocab_size (int, optional, 默认为 2) — 在调用 RealmEmbedder, RealmScorer, RealmKnowledgeAugEncoder, 或 RealmReader 时传递的 token_type_ids 的词汇表大小。
initializer_range (float, optional, 默认为 0.02) — 用于初始化所有权重矩阵的 truncated_normal_initializer 的标准差。
layer_norm_eps (float, optional, 默认为 1e-12) — 层归一化层使用的 epsilon 值。
span_hidden_size (int, optional, 默认为 256) — reader（阅读器）的 span（跨度）的维度。
max_span_width (int, optional, 默认为 10) — reader（阅读器）的最大 span（跨度）宽度。
reader_layer_norm_eps (float, optional, 默认为 1e-3) — reader（阅读器）的层归一化层使用的 epsilon 值。
reader_beam_size (int, optional, 默认为 5) — reader（阅读器）的 beam（束搜索）大小。
reader_seq_len (int, optional, 默认为 288+32) — reader（阅读器）的最大序列长度。
num_block_records (int, optional, 默认为 13353718) — block（块）记录数。
searcher_beam_size (int, optional, 默认为 5000) — searcher（搜索器）的 beam（束搜索）大小。注意：当启用 eval（评估）模式时，searcher_beam_size 将与 reader_beam_size 相同。

这是用于存储以下配置的配置类：

它用于根据指定的参数实例化 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, optional, defaults to True) — 是否在分词时将输入文本转换为小写。
do_basic_tokenize (bool, optional, defaults to True) — 是否在 WordPiece 分词之前进行基础分词。
never_split (Iterable, optional) — 在分词期间永远不会被分割的 token 集合。仅当 do_basic_tokenize=True 时有效
unk_token (str, optional, defaults to "[UNK]") — 未知 token。词汇表中不存在的 token 无法转换为 ID，并将设置为此 token。
sep_token (str, optional, defaults to "[SEP]") — 分隔符 token，用于从多个序列构建序列时，例如用于序列分类的两个序列或用于问答的文本和问题。它也用作使用特殊 token 构建的序列的最后一个 token。
pad_token (str, optional, defaults to "[PAD]") — 用于填充的 token，例如在批量处理不同长度的序列时。
cls_token (str, optional, defaults to "[CLS]") — 分类器 token，用于进行序列分类（对整个序列而不是每个 token 进行分类）。当使用特殊 token 构建时，它是序列的第一个 token。
mask_token (str, optional, defaults to "[MASK]") — 用于遮蔽值的 token。这是使用掩码语言建模训练此模型时使用的 token。这是模型将尝试预测的 token。
tokenize_chinese_chars (bool, optional, defaults to True) — 是否对中文字符进行分词。

对于日语，可能应该停用此功能 (参见此 issue)。
strip_accents (bool, optional) — 是否去除所有重音符号。如果未指定此选项，则将由 lowercase 的值确定（与原始 BERT 中一样）。

构建 REALM 分词器。

RealmTokenizer 与 BertTokenizer 完全相同，并运行端到端分词：标点符号分割和 wordpiece。

此分词器继承自 PreTrainedTokenizer，其中包含大多数主要方法。用户应参考此超类以获取有关这些方法的更多信息。

build_inputs_with_special_tokens

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

参数

token_ids_0 (List[int]) — 将在其中添加特殊 token 的 ID 列表。
token_ids_1 (List[int], optional) — 序列对的可选的第二个 ID 列表。

返回值

List[int]

带有适当特殊 token 的 input IDs 列表。

通过连接并添加特殊 token，从序列或序列对构建模型输入，用于序列分类任务。 REALM 序列具有以下格式

单个序列: [CLS] X [SEP]
序列对: [CLS] A [SEP] B [SEP]

get_special_tokens_mask

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

参数

token_ids_0 (List[int]) — ID 列表。
token_ids_1 (List[int], optional) — 序列对的可选的第二个 ID 列表。
already_has_special_tokens (bool, optional, defaults to False) — token 列表是否已使用模型的特殊 token 格式化。

返回值

List[int]

一个整数列表，范围为 [0, 1]：1 表示特殊 token，0 表示序列 token。

从没有添加特殊 token 的 token 列表中检索序列 ID。当使用分词器的 prepare_for_model 方法添加特殊 token 时，将调用此方法。

create_token_type_ids_from_sequences

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

参数

token_ids_0 (List[int]) — ID 列表。
token_ids_1 (List[int], optional) — 序列对的可选的第二个 ID 列表。

返回值

List[int]

根据给定的序列，返回 token 类型 ID 列表。

从传递的两个序列创建一个掩码，用于序列对分类任务。 REALM 序列

对掩码具有以下格式

0 0 0 0 0 0 0 0 0 0 0 1 1 1 1 1 1 1 1 1
| first sequence    | second sequence |

如果 token_ids_1 为 None，则此方法仅返回掩码的第一部分 (0s)。

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]], optional) — 要编码的序列批次。每个序列必须为此格式：(batch_size, num_candidates, text)。
**kwargs — call 方法的关键字参数。

返回值

编码后的文本或文本对。

编码一批文本或文本对。此方法类似于常规 call 方法，但具有以下差异

处理额外的 num_candidate 轴。(batch_size, num_candidates, text)
始终将序列填充到 max_length。
必须指定 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, optional, defaults to True) — 是否在标记化时将输入转换为小写。
unk_token (str, optional, defaults to "[UNK]") — 未知标记。词汇表中不存在的标记无法转换为 ID，而是设置为此标记。
sep_token (str, optional, defaults to "[SEP]") — 分隔符标记，用于从多个序列构建序列时，例如用于序列分类的两个序列，或用于问答的文本和问题。它也用作使用特殊标记构建的序列的最后一个标记。
pad_token (str, optional, defaults to "[PAD]") — 用于填充的标记，例如在对不同长度的序列进行批处理时。
cls_token (str, optional, defaults to "[CLS]") — 分类器标记，用于执行序列分类（对整个序列而不是每个标记进行分类）。当使用特殊标记构建时，它是序列的第一个标记。
mask_token (str, optional, defaults to "[MASK]") — 用于屏蔽值的标记。这是使用掩码语言建模训练此模型时使用的标记。这是模型将尝试预测的标记。
clean_text (bool, optional, defaults to True) — 是否在标记化之前清理文本，方法是删除任何控制字符并将所有空格替换为经典空格。
tokenize_chinese_chars (bool, optional, defaults to True) — 是否标记化中文字符。对于日语，这可能应该被停用（请参阅此问题）。
strip_accents (bool, optional) — 是否去除所有重音符号。如果未指定此选项，则将由 lowercase 的值确定（与原始 BERT 中一样）。
wordpieces_prefix (str, optional, defaults to "##") — 子词的前缀。

构建一个“快速” 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]], optional) — 要编码的序列批次。每个序列必须为此格式：(batch_size, num_candidates, text)。
**kwargs — call 方法的关键字参数。

返回值

编码后的文本或文本对。

编码一批文本或文本对。此方法类似于常规 call 方法，但具有以下差异

处理额外的 num_candidate 轴。(batch_size, num_candidates, text)
始终将序列填充到 max_length。
必须指定 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 的嵌入器，输出用于计算相关性得分的 projected score。此模型是 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 or tuple(torch.FloatTensor)

参数

input_ids (torch.LongTensor，形状为 (batch_size, sequence_length)) — 词汇表中输入序列标记的索引。

可以使用 AutoTokenizer 获取索引。请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call() 以了解详细信息。

什么是输入 IDs？
attention_mask (torch.FloatTensor，形状为 (batch_size, sequence_length)，可选) — 用于避免对 padding 标记索引执行 attention 的掩码。掩码值在 [0, 1] 中选择：
- 1 表示未掩盖的标记，
- 0 表示已掩盖的标记。
什么是 attention 掩码？
token_type_ids (torch.LongTensor，形状为 (batch_size, sequence_length)，可选) — 段落标记索引，用于指示输入的第一个和第二个部分。索引在 [0, 1] 中选择：
- 0 对应于 句子 A 标记，
- 1 对应于 句子 B 标记。
什么是 token type IDs？
position_ids (torch.LongTensor，形状为 (batch_size, sequence_length)，可选) — 每个输入序列标记在位置嵌入中的位置索引。在范围 [0, config.max_position_embeddings - 1] 中选择。

什么是 position IDs？
head_mask (torch.FloatTensor，形状为 (num_heads,) 或 (num_layers, num_heads)，可选) — 用于 nullify self-attention 模块中选定 head 的掩码。掩码值在 [0, 1] 中选择：
- 1 表示 head 未被掩盖，
- 0 表示 head 已被掩盖。
inputs_embeds (torch.FloatTensor，形状为 (batch_size, sequence_length, hidden_size)，可选) — 可选地，您可以选择直接传递嵌入表示，而不是传递 input_ids。如果您希望比模型的内部嵌入查找矩阵更精细地控制如何将 input_ids 索引转换为关联的向量，这将非常有用。
output_attentions (bool，可选) — 是否返回所有 attention 层的 attention tensors。有关更多详细信息，请参阅返回的 tensors 下的 attentions。
output_hidden_states (bool，可选) — 是否返回所有层的 hidden states。有关更多详细信息，请参阅返回的 tensors 下的 hidden_states。
return_dict (bool，可选) — 是否返回 ModelOutput 而不是纯 tuple。

返回值

transformers.models.deprecated.realm.modeling_realm.RealmEmbedderOutput or tuple(torch.FloatTensor)

transformers.models.deprecated.realm.modeling_realm.RealmEmbedderOutput 或 torch.FloatTensor 的 tuple（如果传递了 return_dict=False 或当 config.return_dict=False 时），其中包含各种元素，具体取决于配置 (RealmConfig) 和输入。

projected_score (torch.FloatTensor，形状为 (batch_size, config.retriever_proj_size)) — Projected score。
hidden_states (tuple(torch.FloatTensor)，可选，当传递 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — torch.FloatTensor 的 tuple（embeddings 的输出一个，每层输出一个），形状为 (batch_size, sequence_length, hidden_size)。

模型在每一层输出端的 hidden-states 加上初始嵌入输出。
attentions (tuple(torch.FloatTensor)，可选，当传递 output_attentions=True 或当 config.output_attentions=True 时返回) — torch.FloatTensor 的 tuple（每层一个），形状为 (batch_size, num_heads, sequence_length, sequence_length)。

attention softmax 之后的 attention 权重，用于计算 self-attention heads 中的加权平均值。

RealmEmbedder 的 forward 方法，重写了 __call__ 特殊方法。

尽管 forward pass 的配方需要在该函数内定义，但应该在之后调用 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 or tuple(torch.FloatTensor)

参数

input_ids (torch.LongTensor，形状为 (batch_size, sequence_length)) — 词汇表中输入序列标记的索引。

可以使用 AutoTokenizer 获取索引。请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call() 以了解详细信息。

什么是输入 IDs？
attention_mask (torch.FloatTensor，形状为 (batch_size, sequence_length)，可选) — 用于避免对 padding 标记索引执行 attention 的掩码。掩码值在 [0, 1] 中选择：
- 1 表示未掩盖的标记，
- 0 表示已掩盖的标记。
什么是 attention 掩码？
token_type_ids (torch.LongTensor，形状为 (batch_size, sequence_length)，可选) — 段落标记索引，用于指示输入的第一个和第二个部分。索引在 [0, 1] 中选择：
- 0 对应于 句子 A 标记，
- 1 对应于 句子 B 标记。
什么是 token type IDs？
position_ids (torch.LongTensor，形状为 (batch_size, sequence_length)，可选) — 每个输入序列标记在位置嵌入中的位置索引。在范围 [0, config.max_position_embeddings - 1] 中选择。

什么是 position IDs？
head_mask (torch.FloatTensor，形状为 (num_heads,) 或 (num_layers, num_heads)，可选) — 用于 nullify self-attention 模块中选定 head 的掩码。掩码值在 [0, 1] 中选择：
- 1 表示 head 未被掩盖，
- 0 表示 head 已被掩盖。
inputs_embeds (torch.FloatTensor，形状为 (batch_size, 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 而不是普通元组。
candidate_input_ids (torch.LongTensor of shape (batch_size, num_candidates, sequence_length)) — 词汇表中候选输入序列标记的索引。

索引可以使用 AutoTokenizer 获得。详见 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.__call__() 以获取更多详细信息。

什么是输入 IDs？
candidate_attention_mask (torch.FloatTensor of shape (batch_size, num_candidates, sequence_length), optional) — 用于避免对填充标记索引执行注意力的掩码。掩码值在 [0, 1] 中选择：
- 1 表示未被掩码的标记，
- 0 表示被掩码的标记。
什么是注意力掩码？
candidate_token_type_ids (torch.LongTensor of shape (batch_size, num_candidates, sequence_length), optional) — 分段标记索引，用于指示输入的第一个和第二个部分。索引在 [0, 1] 中选择：
- 0 对应于句子 A 标记，
- 1 对应于句子 B 标记。
什么是标记类型 IDs？
candidate_inputs_embeds (torch.FloatTensor of shape (batch_size * num_candidates, sequence_length, hidden_size), optional) — 可选地，您可以选择直接传递嵌入表示，而不是传递 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 of shape (batch_size, config.num_candidates)) — 文档候选的相关性得分（softmax 之前）。
query_score (torch.FloatTensor of shape (batch_size, config.retriever_proj_size)) — 从查询嵌入器派生的查询得分。
candidate_score (torch.FloatTensor of shape (batch_size, config.num_candidates, config.retriever_proj_size)) — 从嵌入器派生的候选得分。

RealmScorer 的 forward 方法，覆盖了 __call__ 特殊方法。

尽管 forward pass 的配方需要在该函数内定义，但应该在之后调用 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 of shape (batch_size, num_candidates, sequence_length)) — 词汇表中输入序列标记的索引。

索引可以使用 AutoTokenizer 获得。详见 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.__call__() 以获取更多详细信息。

什么是输入 IDs？
attention_mask (torch.FloatTensor of shape (batch_size, num_candidates, sequence_length), optional) — 用于避免对填充标记索引执行注意力的掩码。掩码值在 [0, 1] 中选择：
- 1 表示未被掩码的标记，
- 0 表示被掩码的标记。
什么是注意力掩码？
token_type_ids (torch.LongTensor of shape (batch_size, num_candidates, sequence_length), optional) — 分段标记索引，用于指示输入的第一个和第二个部分。索引在 [0, 1] 中选择：
- 0 对应于句子 A 标记，
- 1 对应于句子 B 标记。
什么是标记类型 IDs？
position_ids (torch.LongTensor of shape (batch_size, num_candidates, sequence_length), optional) — 位置嵌入中每个输入序列标记的位置索引。在范围 [0, config.max_position_embeddings - 1] 中选择。

什么是位置 IDs？
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_candidates, 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 而不是普通元组。
relevance_score (torch.FloatTensor of shape (batch_size, num_candidates), optional) — 从 RealmScorer 派生的相关性得分，如果您想计算掩码语言建模损失，则必须指定。
labels (torch.LongTensor of shape (batch_size, sequence_length), optional) — 用于计算掩码语言建模损失的标签。索引应在 [-100, 0, ..., config.vocab_size] 中（请参阅 input_ids 文档字符串）。索引设置为 -100 的标记将被忽略（掩码），损失仅针对标签在 [0, ..., config.vocab_size] 中的标记计算。
mlm_mask (torch.LongTensor of shape (batch_size, sequence_length), optional) — 用于避免在某些位置计算联合损失的掩码。如果未指定，则不会掩码损失。掩码值在 [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 (torch.FloatTensor of shape (1,), optional, returned when labels is provided) — 掩码语言建模 (MLM) 损失。
logits (torch.FloatTensor of shape (batch_size, sequence_length, config.vocab_size)) — 语言建模头的预测分数（SoftMax 之前每个词汇表标记的分数）。
hidden_states (tuple(torch.FloatTensor), optional, returned when output_hidden_states=True is passed or when 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 的 tuple（每层一个），形状为 (batch_size, num_heads, sequence_length, sequence_length)。

attention softmax 之后的 attention 权重，用于计算 self-attention heads 中的加权平均值。

RealmKnowledgeAugEncoder 的 forward 方法，覆盖了 __call__ 特殊方法。

尽管 forward pass 的配方需要在该函数内定义，但应该在之后调用 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 (形状为 (reader_beam_size, sequence_length) 的 torch.LongTensor) — 词汇表中输入序列 tokens 的索引。

可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。

什么是 input IDs？
attention_mask (形状为 (reader_beam_size, sequence_length) 的 torch.FloatTensor, 可选) — 用于避免在 padding token 索引上执行 attention 的掩码。Mask 值在 [0, 1] 中选择：
- 1 表示 tokens 未被掩盖，
- 0 表示 tokens 已被掩盖。
什么是 attention masks？
token_type_ids (形状为 (reader_beam_size, sequence_length) 的 torch.LongTensor, 可选) — Segment token 索引，用于指示输入的第一部分和第二部分。索引在 [0, 1] 中选择：
- 0 对应于 sentence A token，
- 1 对应于 sentence B token。
什么是 token type IDs？
position_ids (形状为 (reader_beam_size, sequence_length) 的 torch.LongTensor, 可选) — 位置嵌入中每个输入序列 tokens 的位置索引。在范围 [0, config.max_position_embeddings - 1] 中选择。

什么是 position IDs？
head_mask (形状为 (num_heads,) 或 (num_layers, num_heads) 的 torch.FloatTensor, 可选) — 用于置空 self-attention 模块的选定 head 的掩码。 Mask 值在 [0, 1] 中选择：
- 1 表示 head 未被掩盖，
- 0 表示 head 已被掩盖。
inputs_embeds (形状为 (reader_beam_size, sequence_length, hidden_size) 的 torch.FloatTensor, 可选) — （可选）您可以选择直接传递嵌入表示，而不是传递 input_ids。如果您希望比模型的内部嵌入查找矩阵更精细地控制如何将 *input_ids* 索引转换为关联的向量，这将非常有用。
output_attentions (bool, 可选) — 是否返回所有 attention 层的 attentions tensors。有关更多详细信息，请参见返回 tensors 下的 attentions。
output_hidden_states (bool, 可选) — 是否返回所有层的 hidden states。有关更多详细信息，请参见返回 tensors 下的 hidden_states。
return_dict (bool, 可选) — 是否返回 ModelOutput 而不是普通 tuple。
relevance_score (形状为 (searcher_beam_size,) 的 torch.FloatTensor, 可选) — 相关性得分，如果您想计算 logits 和 marginal log loss，则必须指定此项。
block_mask (形状为 (searcher_beam_size, sequence_length) 的 torch.BoolTensor, 可选) — evidence block 的掩码，如果您想计算 logits 和 marginal log loss，则必须指定此项。
start_positions (形状为 (searcher_beam_size,) 的 torch.LongTensor, 可选) — 用于计算 token 分类损失的带标签 span 的起始位置（索引）的标签。位置被限制为序列的长度 (sequence_length)。序列之外的位置不计入损失计算。
end_positions (形状为 (searcher_beam_size,) 的 torch.LongTensor, 可选) — 用于计算 token 分类损失的带标签 span 的结束位置（索引）的标签。位置被限制为序列的长度 (sequence_length)。序列之外的位置不计入损失计算。
has_answers (形状为 (searcher_beam_size,) 的 torch.BoolTensor, 可选) — evidence block 是否有答案。

返回值

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

一个 transformers.models.deprecated.realm.modeling_realm.RealmReaderOutput 或一个 torch.FloatTensor 的 tuple（如果传递了 return_dict=False 或当 config.return_dict=False 时），包含各种元素，具体取决于配置 (RealmConfig) 和输入。

loss (形状为 (1,) 的 torch.FloatTensor, 可选, 当提供 start_positions, end_positions, has_answers 时返回) — 总损失。
retriever_loss (形状为 (1,) 的 torch.FloatTensor, 可选, 当提供 start_positions, end_positions, has_answers 时返回) — 检索器损失。
reader_loss (形状为 (1,) 的 torch.FloatTensor, 可选, 当提供 start_positions, end_positions, has_answers 时返回) — 读取器损失。
retriever_correct (形状为 (config.searcher_beam_size,) 的 torch.BoolTensor, 可选) — evidence block 是否包含答案。
reader_correct (形状为 (config.reader_beam_size, num_candidates) 的 torch.BoolTensor, 可选) — span 候选是否包含答案。
block_idx (形状为 () 的 torch.LongTensor) — 检索到的 evidence block 的索引，其中预测的答案最有可能位于其中。
candidate (形状为 () 的 torch.LongTensor) — 检索到的 span 候选项的索引，其中预测的答案最有可能位于其中。
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 的 tuple（embeddings 的输出一个，每层输出一个），形状为 (batch_size, sequence_length, hidden_size)。

模型在每一层输出端的 hidden-states 加上初始嵌入输出。
attentions (tuple(torch.FloatTensor)，可选，当传递 output_attentions=True 或当 config.output_attentions=True 时返回) — torch.FloatTensor 的 tuple（每层一个），形状为 (batch_size, num_heads, sequence_length, sequence_length)。

attention softmax 之后的 attention 权重，用于计算 self-attention heads 中的加权平均值。

RealmReader forward 方法，覆盖了 __call__ 特殊方法。

尽管 forward pass 的配方需要在该函数内定义，但应该在之后调用 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 (形状为 (1, sequence_length) 的 torch.LongTensor) — 词汇表中输入序列 tokens 的索引。

可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。

什么是 input IDs？
attention_mask (torch.FloatTensor, 形状为 (1, sequence_length), 可选) — 用于避免在 padding 标记索引上执行 attention 的掩码。掩码值在 [0, 1] 中选择：
- 1 表示未被掩码的标记，
- 0 表示被掩码的标记。
什么是 attention masks？
token_type_ids (torch.LongTensor, 形状为 (1, sequence_length), 可选) — 分段标记索引，用于指示输入的第一部分和第二部分。索引在 [0, 1] 中选择：
- 0 对应于 sentence A 标记，
- 1 对应于 sentence B 标记（按设计不应在此模型中使用）。
什么是 token type IDs？
answer_ids (list, 形状为 (num_answers, answer_length), 可选) — 用于计算边际对数似然损失的答案 ids 列表。索引应在 [-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) — Reader 输出。
predicted_answer_ids (torch.LongTensor, 形状为 (answer_sequence_length)) — 预测的答案 ids。

RealmForOpenQA forward 方法，覆盖了 __call__ 特殊方法。

尽管 forward pass 的配方需要在该函数内定义，但应该在之后调用 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→