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 任务至关重要。然而，这些知识是隐式地存储在神经网络的参数中的，需要越来越大的网络来覆盖更多的知识。为了以更模块化和可解释的方式捕获知识，我们使用潜在知识检索器增强了语言模型预训练，该检索器允许模型在预训练、微调和推理期间检索和关注来自大型语料库（如 Wikipedia）的文档。我们首次展示了如何以无监督的方式预训练这样的知识检索器，使用掩码语言建模作为学习信号，并通过考虑数百万文档的检索步骤进行反向传播。我们通过在具有挑战性的开放域问答（Open-QA）任务上进行微调，证明了检索增强语言模型预训练（REALM）的有效性。我们将显式和隐式知识存储的最新模型在三个流行的 Open-QA 基准上进行了比较，发现我们优于所有以前的方法，具有显着优势（绝对准确率提高 4-16%），同时还提供了诸如可解释性和模块化等定性优势。
RealmConfig
类 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, defaults to 30522) — REALM 模型的词汇表大小。 定义了在调用 RealmEmbedder, RealmScorer, RealmKnowledgeAugEncoder, 或 RealmReader 时，可以通过inputs_ids传递的不同 token 的数量。 - hidden_size (
int, optional, defaults to 768) — 编码器层和 pooler 层的维度。 - retriever_proj_size (
int, optional, defaults to 128) — 检索器（embedder）投影的维度。 - num_hidden_layers (
int, optional, defaults to 12) — Transformer 编码器中隐藏层的数量。 - num_attention_heads (
int, optional, defaults to 12) — Transformer 编码器中每个 attention 层的 attention head 数量。 - num_candidates (
int, optional, defaults to 8) — 输入到 RealmScorer 或 RealmKnowledgeAugEncoder 的候选数量。 - intermediate_size (
int, optional, defaults to 3072) — Transformer 编码器中 “intermediate”（即，前馈）层的维度。 - hidden_act (
strorfunction, optional, defaults to"gelu_new") — 编码器和 pooler 中的非线性激活函数（函数或字符串）。 如果是字符串，则支持"gelu","relu","selu"和"gelu_new"。 - hidden_dropout_prob (
float, optional, defaults to 0.1) — embeddings、编码器和 pooler 中所有全连接层的 dropout 概率。 - attention_probs_dropout_prob (
float, optional, defaults to 0.1) — attention 概率的 dropout 比率。 - max_position_embeddings (
int, optional, defaults to 512) — 此模型可能使用的最大序列长度。 通常将其设置为较大的值以防万一（例如，512 或 1024 或 2048）。 - type_vocab_size (
int, optional, defaults to 2) —token_type_ids的词汇表大小，在调用 RealmEmbedder, RealmScorer, RealmKnowledgeAugEncoder, 或 RealmReader 时传递。 - initializer_range (
float, optional, defaults to 0.02) — 用于初始化所有权重矩阵的 truncated_normal_initializer 的标准差。 - layer_norm_eps (
float, optional, defaults to 1e-12) — layer normalization 层使用的 epsilon 值。 - span_hidden_size (
int, optional, defaults to 256) — reader 的 span 的维度。 - max_span_width (
int, optional, defaults to 10) — reader 的最大 span 宽度。 - reader_layer_norm_eps (
float, optional, defaults to 1e-3) — reader 的 layer normalization 层使用的 epsilon 值。 - reader_beam_size (
int, optional, defaults to 5) — reader 的 beam size。 - reader_seq_len (
int, optional, defaults to 288+32) — reader 的最大序列长度。 - num_block_records (
int, optional, defaults to 13353718) — block 记录的数量。 - searcher_beam_size (
int, optional, defaults to 5000) — searcher 的 beam size。 请注意，当启用 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.configRealmTokenizer
class transformers.RealmTokenizer
< source >( 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 toTrue) — 是否在 tokenization 过程中将输入转换为小写。 - do_basic_tokenize (
bool, optional, defaults toTrue) — 是否在 WordPiece 之前进行 basic tokenization。 - never_split (
Iterable, optional) — 在 tokenization 期间永远不会被拆分的 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]") — 用于 padding 的 token，例如在 batch 处理不同长度的序列时。 - cls_token (
str, optional, defaults to"[CLS]") — classifier token，用于进行序列分类（对整个序列进行分类而不是按 token 分类）。 当使用特殊 token 构建时，它是序列的第一个 token。 - mask_token (
str, optional, defaults to"[MASK]") — 用于遮盖值的标记。 这是使用掩码语言建模训练此模型时使用的标记。 这是模型将尝试预测的标记。 - tokenize_chinese_chars (
bool, optional, defaults toTrue) — 是否对中文Token进行分词。对于日语，这可能应该被禁用 (参阅此 issue)。
- strip_accents (
bool, optional) — 是否移除所有重音符号。 如果未指定此选项，则将由lowercase的值确定（与原始 BERT 中一样）。
构建 REALM 分词器。
RealmTokenizer 与 BertTokenizer 完全相同，并运行端到端的分词：标点符号分割和 wordpiece。
此分词器继承自 PreTrainedTokenizer，其中包含大多数主要方法。 用户应参考此超类以获取有关这些方法的更多信息。
build_inputs_with_special_tokens
< source >( token_ids_0: List token_ids_1: Optional = None ) → List[int]
参数
- token_ids_0 (
List[int]) — 将在其中添加特殊 token 的 ID 列表。 - token_ids_1 (
List[int], optional) — 序列对的可选的第二个 ID 列表。
返回值
List[int]
带有适当特殊 token 的 输入 ID 列表。
通过连接和添加特殊 token，从序列或序列对构建模型输入，以用于序列分类任务。 REALM 序列具有以下格式
- 单个序列:
[CLS] X [SEP] - 序列对:
[CLS] A [SEP] B [SEP]
get_special_tokens_mask
< source >( token_ids_0: List token_ids_1: Optional = None already_has_special_tokens: bool = False ) → List[int]
从没有添加特殊 token 的 token 列表中检索序列 ID。 当使用分词器的 prepare_for_model 方法添加特殊 token 时，将调用此方法。
create_token_type_ids_from_sequences
< source >( token_ids_0: List token_ids_1: Optional = None ) → List[int]
从传递的两个序列创建一个掩码，用于序列对分类任务。 REALM 序列
如果 token_ids_1 为 None，则此方法仅返回掩码的第一部分 (0)。
batch_encode_candidates
< source >( text **kwargs ) → BatchEncoding
编码一批文本或文本对。 此方法类似于常规 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
< source >( 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 toTrue) — 是否在分词时将输入转换为小写。 - 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。 - 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
< source >( text **kwargs ) → BatchEncoding
编码一批文本或文本对。 此方法类似于常规 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
< source >( block_records tokenizer )
参数
- block_records (
np.ndarray) — 一个包含证据文本的 numpy 数组。 - tokenizer (RealmTokenizer) — 用于编码检索到的文本的分词器。
REALM 的检索器，输出检索到的证据块以及该块是否包含答案以及答案位置。”
检查 retrieved_blocks 是否有答案。
RealmEmbedder
class transformers.RealmEmbedder
< source >( config )
参数
- config (RealmConfig) — 带有模型所有参数的模型配置类。 使用配置文件初始化不会加载与模型关联的权重，仅加载配置。 查看 from_pretrained() 方法以加载模型权重。
REALM 的嵌入器，输出投影分数，该分数将用于计算相关性分数。 此模型是 PyTorch torch.nn.Module 子类。 将其用作常规 PyTorch 模块，并参考 PyTorch 文档以获取与常规用法和行为相关的所有事项。
forward
< source >( input_ids: Optional = None attention_mask: Optional = None token_type_ids: Optional = None position_ids: Optional = None head_mask: Optional = None inputs_embeds: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → transformers.models.deprecated.realm.modeling_realm.RealmEmbedderOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor，形状为(batch_size, sequence_length)) — 词汇表中输入序列标记的索引。索引可以使用 AutoTokenizer 获得。 有关详细信息，请参见 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- 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 令牌。
- position_ids (
torch.LongTensor，形状为(batch_size, sequence_length), 可选) — 位置嵌入中每个输入序列令牌的位置索引。 在范围[0, config.max_position_embeddings - 1]中选择。 - 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_scoreRealmScorer
class transformers.RealmScorer
< source >( config query_embedder = None )
参数
- config (RealmConfig) — 带有模型所有参数的模型配置类。使用配置文件初始化不会加载与模型关联的权重，仅加载配置。查看 from_pretrained() 方法来加载模型权重。
- query_embedder (RealmEmbedder) — 用于输入序列的嵌入器。如果未指定，它将使用与候选序列相同的嵌入器。
REALM 的评分器，输出代表文档候选的得分（softmax 之前）的相关性得分。此模型是 PyTorch torch.nn.Module 子类。像常规 PyTorch 模块一样使用它，并参考 PyTorch 文档了解所有与通用用法和行为相关的内容。
forward
< source >( input_ids: Optional = None attention_mask: Optional = None token_type_ids: Optional = None position_ids: Optional = None candidate_input_ids: Optional = None candidate_attention_mask: Optional = None candidate_token_type_ids: Optional = None candidate_inputs_embeds: Optional = None head_mask: Optional = None inputs_embeds: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → transformers.models.deprecated.realm.modeling_realm.RealmScorerOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor，形状为(batch_size, sequence_length)) — 词汇表中输入序列标记的索引。索引可以使用 AutoTokenizer 获得。 有关详细信息，请参见 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.FloatTensor，形状为(batch_size, sequence_length), 可选) — 掩码，用于避免在 padding 标记索引上执行注意力机制。掩码值在[0, 1]中选择：- 1 表示标记未被掩盖，
- 0 表示标记被掩盖。
- token_type_ids (
torch.LongTensor，形状为(batch_size, sequence_length), 可选) — 分段标记索引，用于指示输入的第一部分和第二部分。索引在[0, 1]中选择：- 0 对应于 句子 A 标记，
- 1 对应于 句子 B 标记。
- position_ids (
torch.LongTensor，形状为(batch_size, sequence_length), 可选) — 每个输入序列标记在位置嵌入中的位置索引。在范围[0, config.max_position_embeddings - 1]中选择。 - 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()。
- candidate_attention_mask (
torch.FloatTensor，形状为(batch_size, num_candidates, sequence_length), 可选) — 掩码，用于避免在 padding 标记索引上执行注意力机制。掩码值在[0, 1]中选择：- 1 表示标记未被掩盖，
- 0 表示标记被掩盖。
- candidate_token_type_ids (
torch.LongTensor，形状为(batch_size, num_candidates, sequence_length), 可选) — 分段标记索引，用于指示输入的第一部分和第二部分。索引在[0, 1]中选择：- 0 对应于 句子 A 标记，
- 1 对应于 句子 B 标记。
- 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_scoreRealmKnowledgeAugEncoder
class transformers.RealmKnowledgeAugEncoder
< source >( config )
参数
- config (RealmConfig) — 带有模型所有参数的模型配置类。使用配置文件初始化不会加载与模型相关的权重，仅加载配置。请查看 from_pretrained() 方法来加载模型权重。
REALM 的知识增强编码器，输出 masked language model logits 和 marginal log-likelihood loss。此模型是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参阅 PyTorch 文档以了解与一般用法和行为相关的所有事项。
forward
< source >( input_ids: 可选 = None attention_mask: 可选 = None token_type_ids: 可选 = None position_ids: 可选 = None head_mask: 可选 = None inputs_embeds: 可选 = None relevance_score: 可选 = None labels: 可选 = None mlm_mask: 可选 = None output_attentions: 可选 = None output_hidden_states: 可选 = None return_dict: 可选 = None ) → transformers.modeling_outputs.MaskedLMOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor，形状为(batch_size, num_candidates, sequence_length)) — 词汇表中输入序列 tokens 的索引。索引可以使用 AutoTokenizer 获得。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.FloatTensor，形状为(batch_size, num_candidates, sequence_length)，可选) — 用于避免对 padding token 索引执行 attention 的 Mask。Mask 值在[0, 1]中选择：- 1 表示 未被 mask 的 tokens，
- 0 表示 被 mask 的 tokens。
- token_type_ids (
torch.LongTensor，形状为(batch_size, num_candidates, sequence_length)，可选) — Segment token 索引，用于指示输入的第一个和第二个部分。索引在[0, 1]中选择：- 0 对应于 sentence A token，
- 1 对应于 sentence B token。
- position_ids (
torch.LongTensor，形状为(batch_size, num_candidates, sequence_length)，可选) — 每个输入序列 tokens 在 position embeddings 中的位置索引。在范围[0, config.max_position_embeddings - 1]中选择。 - head_mask (
torch.FloatTensor，形状为(num_heads,)或(num_layers, num_heads)，可选) — 用于 nullify self-attention 模块中选定 heads 的 Mask。Mask 值在[0, 1]中选择：- 1 表示 head 未被 mask，
- 0 表示 head 被 mask。
- inputs_embeds (
torch.FloatTensor，形状为(batch_size, num_candidates, sequence_length, hidden_size)，可选) — 可选地，您可以选择直接传递嵌入表示，而不是传递input_ids。如果您想比模型的内部 embedding lookup matrix 更精确地控制如何将 input_ids 索引转换为关联向量，这将非常有用。 - output_attentions (
bool，可选) — 是否返回所有 attention layers 的 attentions tensors。有关更多详细信息，请参阅返回 tensors 下的attentions。 - output_hidden_states (
bool，可选) — 是否返回所有 layers 的 hidden states。有关更多详细信息，请参阅返回 tensors 下的hidden_states。 - return_dict (
bool，可选) — 是否返回 ModelOutput 而不是 plain tuple。 - relevance_score (
torch.FloatTensor，形状为(batch_size, num_candidates)，可选) — 从 RealmScorer 导出的相关性得分，如果您想计算 masked language modeling loss，则必须指定。 - labels (
torch.LongTensor，形状为(batch_size, sequence_length)，可选) — 用于计算 masked language modeling loss 的 labels。索引应在[-100, 0, ..., config.vocab_size]中（请参阅input_idsdocstring）。索引设置为-100的 tokens 将被忽略（masked），loss 仅针对 labels 在[0, ..., config.vocab_size]中的 tokens 计算。 - mlm_mask (
torch.LongTensor，形状为(batch_size, sequence_length)，可选) — 用于避免在某些位置计算联合 loss 的 Mask。如果未指定，则 loss 将不会被 mask。Mask 值在[0, 1]中选择：- 1 表示 未被 mask 的 tokens，
- 0 表示 被 mask 的 tokens。
返回值
transformers.modeling_outputs.MaskedLMOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.MaskedLMOutput 或一个 torch.FloatTensor 的 tuple （如果传递了 return_dict=False 或当 config.return_dict=False 时），其中包含各种元素，具体取决于配置 (RealmConfig) 和输入。
-
loss (
torch.FloatTensor，形状为(1,)，可选，当提供labels时返回) — Masked language modeling (MLM) loss。 -
logits (
torch.FloatTensor，形状为(batch_size, sequence_length, config.vocab_size)) — 语言建模头的预测分数（SoftMax 之前每个词汇表 token 的分数）。 -
hidden_states (
tuple(torch.FloatTensor)，可选，当传递output_hidden_states=True或当config.output_hidden_states=True时返回) —torch.FloatTensor的 Tuple（如果模型具有 embedding layer，则 embeddings 的输出为一个，+ 每个 layer 的输出为一个），形状为(batch_size, sequence_length, hidden_size)。模型在每个 layer 输出的 Hidden-states，加上可选的初始 embedding 输出。
-
attentions (
tuple(torch.FloatTensor), 可选, 当传递output_attentions=True或当config.output_attentions=True时返回) —torch.FloatTensor的元组（每层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 之后的注意力权重，用于计算自注意力头中的加权平均值。
RealmKnowledgeAugEncoder forward 方法，覆盖了 __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.logitsRealmReader
class transformers.RealmReader
< source >( config )
参数
- config (RealmConfig) — 带有模型所有参数的模型配置类。使用配置文件初始化不会加载与模型相关的权重，仅加载配置。请查看 from_pretrained() 方法来加载模型权重。
REALM 的 reader。此模型是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参阅 PyTorch 文档以了解与一般用法和行为相关的所有事项。
forward
< source >( input_ids: 可选 = None attention_mask: 可选 = None token_type_ids: 可选 = None position_ids: 可选 = None head_mask: 可选 = None inputs_embeds: 可选 = None relevance_score: 可选 = None block_mask: 可选 = None start_positions: 可选 = None end_positions: 可选 = None has_answers: 可选 = None output_attentions: 可选 = None output_hidden_states: 可选 = None return_dict: 可选 = None ) → transformers.models.deprecated.realm.modeling_realm.RealmReaderOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor，形状为(reader_beam_size, sequence_length)) — 词汇表中输入序列 tokens 的索引。索引可以使用 AutoTokenizer 获得。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.FloatTensor，形状为(reader_beam_size, sequence_length)，可选) — 用于避免在 padding 标记索引上执行 attention 的掩码。掩码值在[0, 1]中选择：- 1 表示标记未被掩盖，
- 0 表示标记被掩盖。
- token_type_ids (
torch.LongTensor，形状为(reader_beam_size, sequence_length)，可选) — 分段标记索引，用于指示输入的第一个和第二个部分。索引在[0, 1]中选择：- 0 对应于 句子 A 标记，
- 1 对应于 句子 B 标记。
- position_ids (
torch.LongTensor，形状为(reader_beam_size, sequence_length)，可选) — 位置嵌入中每个输入序列标记的位置索引。在范围[0, config.max_position_embeddings - 1]中选择。 - head_mask (
torch.FloatTensor，形状为(num_heads,)或(num_layers, num_heads)，可选) — 用于使 self-attention 模块的选定 head 失效的掩码。掩码值在[0, 1]中选择：- 1 表示 head 未被掩盖，
- 0 表示 head 被掩盖。
- inputs_embeds (
torch.FloatTensor，形状为(reader_beam_size, sequence_length, hidden_size)，可选) — （可选）您可以选择直接传递嵌入表示，而不是传递input_ids。如果您希望比模型的内部嵌入查找矩阵更精细地控制如何将 *input_ids* 索引转换为关联的向量，这将非常有用。 - output_attentions (
bool，可选) — 是否返回所有 attention 层的 attention 张量。 有关更多详细信息，请参见返回张量下的attentions。 - output_hidden_states (
bool，可选) — 是否返回所有层的 hidden states。 有关更多详细信息，请参见返回张量下的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 前向方法，覆盖了 __call__ 特殊方法。
虽然前向传播的配方需要在该函数内定义，但应该调用 Module 实例，而不是直接调用此函数，因为前者会处理预处理和后处理步骤，而后者会静默地忽略它们。
RealmForOpenQA
class transformers.RealmForOpenQA
< source >( config retriever = None )
参数
- config (RealmConfig) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型关联的权重，仅加载配置。查看 from_pretrained() 方法以加载模型权重。
RealmForOpenQA 用于端到端开放域问答。此模型是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参阅 PyTorch 文档以了解所有与常规用法和行为相关的事项。
将 self.block_emb 发送到特定设备。
forward
< source >( input_ids: Optional attention_mask: Optional = None token_type_ids: Optional = None answer_ids: Optional = None return_dict: Optional = None ) → transformers.models.deprecated.realm.modeling_realm.RealmForOpenQAOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor，形状为(1, sequence_length)) — 词汇表中输入序列标记的索引。索引可以使用 AutoTokenizer 获得。 有关详细信息，请参见 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.FloatTensor，形状为(1, sequence_length)，可选) — 用于避免在 padding 标记索引上执行 attention 的掩码。掩码值在[0, 1]中选择：- 1 表示标记未被掩盖，
- 0 表示标记被掩盖。
- token_type_ids (
torch.LongTensor，形状为(1, sequence_length)，可选) — 分段标记索引，用于指示输入的第一个和第二个部分。索引在[0, 1]中选择：- 0 对应于 句子 A 标记，
- 1 对应于 句子 B 标记（设计上不应在此模型中使用）。
- answer_ids (形状为
(num_answers, answer_length)的list，可选) — 用于计算边际对数似然损失的答案 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 前向方法，覆盖了 __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