Transformers 4.37 中文文档（五十四）（1）-阿里云开发者社区

原文：huggingface.co/docs/transformers

REALM

原始文本：huggingface.co/docs/transformers/v4.37.2/en/model_doc/realm

概述

REALM 模型是由 Kelvin Guu、Kenton Lee、Zora Tung、Panupong Pasupat 和 Ming-Wei Chang 在REALM: Retrieval-Augmented Language Model Pre-Training中提出的。这是一个检索增强语言模型，首先从文本知识语料库中检索文档，然后利用检索到的文档来处理问答任务。

该论文的摘要如下：

语言模型预训练已被证明可以捕获大量世界知识，对于诸如问答等 NLP 任务至关重要。然而，这些知识隐式存储在神经网络的参数中，需要越来越大的网络来涵盖更多事实。为了以更模块化和可解释的方式捕获知识，我们通过潜在知识检索器增强了语言模型预训练，使模型能够从大型语料库（如维基百科）中检索和关注文档，这些文档在预训练、微调和推理过程中使用。我们首次展示了如何以无监督方式预训练这样一个知识检索器，使用掩码语言建模作为学习信号，并通过考虑数百万文档的检索步骤进行反向传播。我们通过在具有挑战性的开放域问答（Open-QA）任务上微调来展示检索增强语言模型预训练（REALM）的有效性。我们在三个流行的开放域问答基准上与最先进的显式和隐式知识存储模型进行比较，发现我们在绝对准确率上表现优异（4-16%），同时还提供了诸如可解释性和模块化等质量优势。

该模型由qqaatw贡献。原始代码可在此处找到。

RealmConfig

`class transformers.RealmConfig`

< source >

( 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 时可以表示的不同标记数量。
hidden_size (int, optional, 默认为 768) — 编码器层和池化器层的维度。
retriever_proj_size (int, optional, 默认为 128) — 检索器（嵌入器）投影的维度。
num_hidden_layers (int, optional, 默认为 12) — Transformer 编码器中的隐藏层数量。
num_attention_heads (int, optional, 默认为 12) — Transformer 编码器中每个注意力层的注意力头数。
num_candidates (int, optional, 默认为 8) — 输入到 RealmScorer 或 RealmKnowledgeAugEncoder 的候选项数量。
intermediate_size (int, optional, 默认为 3072) — Transformer 编码器中“中间”（即前馈）层的维度。
hidden_act (str或function, optional, 默认为"gelu_new") — 编码器和池化器中的非线性激活函数（函数或字符串）。如果是字符串，支持"gelu"、"relu"、"selu"和"gelu_new"。
hidden_dropout_prob (float, optional, 默认为 0.1) — 嵌入层、编码器和池化器中所有全连接层的丢失概率。
attention_probs_dropout_prob (float, optional, defaults to 0.1) — 注意力概率的丢弃比率。
max_position_embeddings (int, optional, defaults to 512) — 此模型可能使用的最大序列长度。通常将其设置为较大的值以防万一（例如，512 或 1024 或 2048）。
type_vocab_size (int, optional, defaults to 2) — 在调用 RealmEmbedder、RealmScorer、RealmKnowledgeAugEncoder 或 RealmReader 时传递的token_type_ids的词汇表大小。
initializer_range (float, optional, defaults to 0.02) — 用于初始化所有权重矩阵的截断正态初始化器的标准差。
layer_norm_eps (float, optional, defaults to 1e-12) — 层归一化层使用的 epsilon。
span_hidden_size (int, optional, defaults to 256) — 读者跨度的维度。
max_span_width (int, optional, defaults to 10) — 读者的最大跨度宽度。
reader_layer_norm_eps (float, optional, defaults to 1e-3) — 读者的层归一化层使用的 epsilon。
reader_beam_size (int, optional, defaults to 5) — 读者的波束大小。
reader_seq_len (int, optional, defaults to 288+32) — 读者的最大序列长度。
num_block_records (int, optional, defaults to 13353718) — 区块记录的数量。
searcher_beam_size (int, optional, defaults to 5000) — 搜索器的波束大小。请注意，当启用评估模式时，searcher_beam_size将与reader_beam_size相同。

这是用于存储配置的配置类

RealmEmbedder
RealmScorer
RealmKnowledgeAugEncoder
RealmRetriever
RealmReader
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`

< 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 to True) — 在标记化时是否将输入转换为小写。
do_basic_tokenize (bool, optional, defaults to True) — 在 WordPiece 之前是否进行基本标记化。
never_split (Iterable, optional) — 在标记化过程中永远不会拆分的标记集合。仅在do_basic_tokenize=True时有效
unk_token (str, optional, defaults to "[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 相同，并进行端到端的分词：标点符号拆分和词片段。

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

`build_inputs_with_special_tokens`

源代码

( token_ids_0: List token_ids_1: Optional = None ) → export const metadata = 'undefined';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: Optional = None already_has_special_tokens: bool = False ) → export const metadata = 'undefined';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: Optional = None ) → export const metadata = 'undefined';List[int]

参数

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

List[int]

根据给定序列的标记类型 ID 列表。

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

pair mask 的格式如下：

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: Optional = None )

`batch_encode_candidates`

<来源>

( text **kwargs ) → export const metadata = 'undefined';BatchEncoding

参数

text (List[List[str]]) — 要编码的序列批次。每个序列必须以此格式呈现：（批次大小，候选项数，文本）。
text_pair (List[List[str]]，可选） — 要编码的序列批次。每个序列必须以此格式呈现：（批次大小，候选项数，文本）。**kwargs — call方法的关键字参数。

BatchEncoding

编码的文本或文本对。

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

处理额外的候选项轴。（批次大小，候选项数，文本）
始终将序列填充到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，可选，默认为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 ) → export const metadata = 'undefined';BatchEncoding

参数

text (List[List[str]]) — 要编码的序列批次。每个序列必须采用以下格式：(batch_size, num_candidates, text)。
text_pair (List[List[str]], 可选) — 要编码的序列批次。每个序列必须采用以下格式：(batch_size, num_candidates, text)。**kwargs — call方法的关键字参数。

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`

<来源>

( 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 的嵌入器输出投影分数，将用于计算相关性分数。该模型是 PyTorch 的torch.nn.Module子类。将其用作常规的 PyTorch 模块，并参考 PyTorch 文档以获取有关一般用法和行为的所有相关信息。

`forward`

<来源>

( 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 ) → export const metadata = 'undefined';transformers.models.realm.modeling_realm.RealmEmbedderOutput or 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，
对于被masked的标记为 0。

注意力掩码是什么？
token_type_ids (torch.LongTensor，形状为(batch_size, sequence_length)，optional) — 段标记索引，指示输入的第一部分和第二部分。索引在[0, 1]中选择：

0 对应于句子 A标记，
1 对应于句子 B标记。

什么是标记类型 ID？
position_ids (torch.LongTensor，形状为(batch_size, sequence_length)，optional) — 每个输入序列标记在位置嵌入中的位置索引。在范围[0, config.max_position_embeddings - 1]中选择。
什么是位置 ID？
head_mask (torch.FloatTensor，形状为(num_heads,)或(num_layers, num_heads)，optional) — 用于使自注意力模块的选定头部失效的掩码。在[0, 1]中选择的掩码值：

1 表示头部未被masked，
0 表示头部被masked。

inputs_embeds (torch.FloatTensor，形状为(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 而不是一个普通元组。

transformers.models.realm.modeling_realm.RealmEmbedderOutput或tuple(torch.FloatTensor)

一个transformers.models.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), optional, 当传递output_hidden_states=True或config.output_hidden_states=True时返回) — 形状为(batch_size, sequence_length, hidden_size)的torch.FloatTensor元组（一个用于嵌入的输出 + 一个用于每个层的输出）。
模型在每个层的输出以及初始嵌入输出的隐藏状态。
attentions (tuple(torch.FloatTensor), optional, 当传递output_attentions=True或config.output_attentions=True时返回) — 形状为(batch_size, num_heads, sequence_length, sequence_length)的torch.FloatTensor元组（每个层一个）。
在自注意力头中用于计算加权平均值的注意力 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

Transformers 4.37 中文文档（五十四）（2）https://developer.aliyun.com/article/1565373

Transformers 4.37 中文文档（五十四）（1）

REALM

概述

RealmConfig

`class transformers.RealmConfig`

RealmTokenizer

`class transformers.RealmTokenizer`

`build_inputs_with_special_tokens`

`get_special_tokens_mask`

`create_token_type_ids_from_sequences`

`save_vocabulary`

`batch_encode_candidates`

RealmTokenizerFast

`class transformers.RealmTokenizerFast`

`batch_encode_candidates`

RealmRetriever

`class transformers.RealmRetriever`

`block_has_answer`

RealmEmbedder

`class transformers.RealmEmbedder`

`forward`

热门文章

最新文章

相关电子书

热门

活动广场

任务中心

开发者评测

高校计划

乘风者计划

训练营

阿里云MVP

话题

直播

下载

镜像站

技术资料

插件

Transformers 4.37 中文文档（五十四）（1）

REALM

概述

RealmConfig

class transformers.RealmConfig

RealmTokenizer

class transformers.RealmTokenizer

build_inputs_with_special_tokens

get_special_tokens_mask

create_token_type_ids_from_sequences

save_vocabulary

batch_encode_candidates

RealmTokenizerFast

class transformers.RealmTokenizerFast

batch_encode_candidates

RealmRetriever

class transformers.RealmRetriever

block_has_answer

RealmEmbedder

class transformers.RealmEmbedder

forward

热门文章

最新文章

相关电子书

`class transformers.RealmConfig`

`class transformers.RealmTokenizer`

`build_inputs_with_special_tokens`

`get_special_tokens_mask`

`create_token_type_ids_from_sequences`

`save_vocabulary`

`batch_encode_candidates`

`class transformers.RealmTokenizerFast`

`batch_encode_candidates`

`class transformers.RealmRetriever`

`block_has_answer`

`class transformers.RealmEmbedder`

`forward`