Transformers 文档

领域

Transformers

领域

该模型目前处于维护模式，我们不接受任何更改其代码的新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）的有效性。我们在三个流行的Open-QA基准测试中与显式和隐式知识存储的最先进模型进行了比较，发现我们在所有先前方法的基础上显著提高了性能（绝对准确率提高了4-16%），同时还提供了可解释性和模块化等定性优势。

该模型由qqaatw贡献。原始代码可以在这里找到。

RealmConfig

类 transformers.RealmConfig

( 词汇大小 = 30522 隐藏大小 = 768 检索器投影大小 = 128 隐藏层数 = 12 注意力头数 = 12 候选数 = 8 中间大小 = 3072 隐藏激活函数 = 'gelu_new' 隐藏层丢弃概率 = 0.1 注意力概率丢弃概率 = 0.1 最大位置嵌入 = 512 类型词汇大小 = 2 初始化范围 = 0.02 层归一化epsilon = 1e-12 跨度隐藏大小 = 256 最大跨度宽度 = 10 阅读器层归一化epsilon = 0.001 阅读器束大小 = 5 阅读器序列长度 = 320 块记录数 = 13353718 搜索器束大小 = 5000 填充标记ID = 1 开始标记ID = 0 结束标记ID = 2 **kwargs )

参数

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

类 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, 可选) — 在分词过程中永远不会被分割的标记集合。仅在 do_basic_tokenize=True
unk_token (str, optional, defaults to "[UNK]") — 未知标记。不在词汇表中的标记无法转换为ID，而是设置为该标记。
sep_token (str, 可选, 默认为 "[SEP]") — 分隔符标记，用于从多个序列构建一个序列时，例如用于序列分类的两个序列或用于问答的文本和问题。它也用作使用特殊标记构建的序列的最后一个标记。
pad_token (str, optional, defaults to "[PAD]") — 用于填充的标记，例如在批处理不同长度的序列时使用。
cls_token (str, 可选, 默认为 "[CLS]") — 用于序列分类的分类器标记（对整个序列进行分类而不是对每个标记进行分类）。当使用特殊标记构建时，它是序列的第一个标记。
mask_token (str, optional, defaults to "[MASK]") — 用于屏蔽值的标记。这是在训练此模型时使用的标记，用于屏蔽语言建模。这是模型将尝试预测的标记。
tokenize_chinese_chars (bool, optional, defaults to True) — Whether or not to tokenize Chinese characters.
这可能应该为日语停用（参见此 issue）。
strip_accents (bool, optional) — 是否去除所有重音符号。如果未指定此选项，则将由lowercase的值决定（如原始BERT中所示）。

构建一个REALM分词器。

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

此分词器继承自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]) — 特殊令牌将被添加到的ID列表。
token_ids_1 (List[int], optional) — 可选的第二个序列对的ID列表。

返回

List[int]

带有适当特殊标记的输入ID列表。

通过连接和添加特殊标记，从序列或序列对构建序列分类任务的模型输入。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) — 是否已经为模型格式化了包含特殊标记的标记列表。

返回

List[int]

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

从没有添加特殊标记的标记列表中检索序列ID。当使用标记器的prepare_for_model方法添加特殊标记时，会调用此方法。

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 type IDs列表。

从传递给序列对分类任务的两个序列中创建一个掩码。一个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）。

保存词汇表

( 保存目录: str 文件名前缀: typing.Optional[str] = None )

batch_encode_candidates

( text **kwargs ) → BatchEncoding

参数

文本 (List[List[str]]) — 要编码的序列批次。每个序列必须采用此格式：(batch_size, num_candidates, text)。
text_pair (List[List[str]], 可选) — 要编码的序列批次。每个序列必须采用以下格式：(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

类 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, optional, defaults to "[UNK]") — 未知标记。不在词汇表中的标记无法转换为ID，而是设置为该标记。
sep_token (str, optional, defaults to "[SEP]") — 分隔符标记，用于从多个序列构建序列时，例如用于序列分类的两个序列或用于问答的文本和问题。它也用作使用特殊标记构建的序列的最后一个标记。
pad_token (str, optional, defaults to "[PAD]") — 用于填充的标记，例如在批处理不同长度的序列时使用。
cls_token (str, 可选, 默认为 "[CLS]") — 用于序列分类的分类器标记（对整个序列进行分类，而不是对每个标记进行分类）。当使用特殊标记构建时，它是序列的第一个标记。
mask_token (str, 可选, 默认为 "[MASK]") — 用于屏蔽值的标记。这是在训练此模型时用于屏蔽语言建模的标记。这是模型将尝试预测的标记。
clean_text (bool, optional, defaults to True) — 是否在分词前通过移除任何控制字符并用经典空格替换所有空格来清理文本。
tokenize_chinese_chars (bool, 可选, 默认为 True) — 是否对中文字符进行分词。对于日语，可能需要停用此功能（参见此问题）。
strip_accents (bool, 可选) — 是否去除所有重音符号。如果未指定此选项，则将由lowercase的值决定（如原始BERT中所示）。
wordpieces_prefix (str, optional, defaults to "##") — 子词的前缀。

构建一个“快速”的REALM分词器（由HuggingFace的tokenizers库支持）。基于WordPiece。

RealmTokenizerFast 与 BertTokenizerFast 相同，并运行端到端的分词：标点符号分割和词片。

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

batch_encode_candidates

( text **kwargs ) → BatchEncoding

参数

文本 (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

类 transformers.RealmRetriever

( block_records tokenizer )

参数

block_records (np.ndarray) — 一个包含证据文本的numpy数组。
tokenizer (RealmTokenizer) — 用于编码检索文本的分词器。

REALM的检索器输出检索到的证据块以及该块是否有答案以及答案的位置。

block_has_answer

( concat_inputs answer_ids )

检查retrieved_blocks是否有答案。

RealmEmbedder

类 transformers.RealmEmbedder

( config )

参数

config (RealmConfig) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载与模型相关的权重，只会加载配置。查看 from_pretrained() 方法以加载模型权重。

REALM的嵌入器输出投影分数，该分数将用于计算相关性分数。此模型是PyTorch torch.nn.Module的子类。将其作为常规的PyTorch模块使用，并参考PyTorch文档以了解与一般使用和行为相关的所有事项。

前进

( 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 of shape (batch_size, sequence_length)) — Indices of input sequence tokens in the vocabulary.
可以使用AutoTokenizer获取索引。详情请参见PreTrainedTokenizer.encode()和 PreTrainedTokenizer.call()。

什么是输入ID？
attention_mask (torch.FloatTensor of shape (batch_size, sequence_length), optional) — Mask to avoid performing attention on padding token indices. Mask values selected in [0, 1]:
- 1 for tokens that are not masked,
- 0 for tokens that are masked.
什么是注意力掩码？
token_type_ids (torch.LongTensor of shape (batch_size, sequence_length), optional) — Segment token indices to indicate first and second portions of the inputs. Indices are selected in [0, 1]:
- 0 corresponds to a sentence A token,
- 1 corresponds to a sentence B token.
什么是token type IDs?
position_ids (torch.LongTensor of shape (batch_size, sequence_length), optional) — Indices of positions of each input sequence tokens in the position embeddings. Selected in the range [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 of shape (batch_size, sequence_length, hidden_size), optional) — 可选地，您可以选择直接传递嵌入表示，而不是传递input_ids。如果您希望对如何将input_ids索引转换为相关向量有更多控制，而不是使用模型的内部嵌入查找矩阵，这将非常有用。
output_attentions (bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参见返回张量中的attentions。
output_hidden_states (bool, optional) — 是否返回所有层的隐藏状态。有关更多详细信息，请参见返回张量下的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 的 forward 方法，重写了 __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

类 transformers.RealmScorer

( config query_embedder = 无 )

参数

config (RealmConfig) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载与模型相关的权重，只会加载配置。查看 from_pretrained() 方法以加载模型权重。
query_embedder (RealmEmbedder) — 输入序列的嵌入器。如果未指定，将使用与候选序列相同的嵌入器。

REALM的评分器输出表示候选文档相关性分数的分数（在softmax之前）。该模型是PyTorch torch.nn.Module的子类。将其作为常规的PyTorch模块使用，并参考PyTorch文档以了解与一般使用和行为相关的所有事项。

前进

( 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 of shape (batch_size, sequence_length)) — Indices of input sequence tokens in the vocabulary.
可以使用AutoTokenizer获取索引。详情请参见PreTrainedTokenizer.encode()和 PreTrainedTokenizer.call()。

什么是输入ID？
attention_mask (torch.FloatTensor of shape (batch_size, sequence_length), optional) — Mask to avoid performing attention on padding token indices. Mask values selected in [0, 1]:
- 1 for tokens that are not masked,
- 0 for tokens that are masked.
什么是注意力掩码？
token_type_ids (torch.LongTensor of shape (batch_size, sequence_length), optional) — Segment token indices to indicate first and second portions of the inputs. Indices are selected in [0, 1]:
- 0 corresponds to a sentence A token,
- 1 corresponds to a sentence B token.
什么是token type IDs?
position_ids (torch.LongTensor of shape (batch_size, sequence_length), optional) — Indices of positions of each input sequence tokens in the position embeddings. Selected in the range [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 of shape (batch_size, sequence_length, hidden_size), optional) — 可选地，您可以选择直接传递嵌入表示，而不是传递input_ids。如果您希望对如何将input_ids索引转换为相关向量有更多控制权，而不是使用模型的内部嵌入查找矩阵，这将非常有用。
output_attentions (bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参见返回张量下的attentions。
output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参见返回张量下的hidden_states。
return_dict (bool, optional) — 是否返回一个ModelOutput而不是一个普通的元组。
candidate_input_ids (torch.LongTensor of shape (batch_size, num_candidates, sequence_length)) — Indices of candidate input sequence tokens in the vocabulary.
可以使用AutoTokenizer获取索引。详情请参见PreTrainedTokenizer.encode()和 PreTrainedTokenizer.call()。

什么是输入ID？
candidate_attention_mask (torch.FloatTensor of shape (batch_size, num_candidates, sequence_length), optional) — Mask to avoid performing attention on padding token indices. Mask values selected in [0, 1]:
- 1 for tokens that are not masked,
- 0 for tokens that are masked.
什么是注意力掩码？
candidate_token_type_ids (torch.LongTensor of shape (batch_size, num_candidates, sequence_length), optional) — Segment token indices to indicate first and second portions of the inputs. Indices are selected in [0, 1]:
- 0 corresponds to a sentence A token,
- 1 corresponds to a sentence B token.
什么是token type 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 形状为 (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 的 forward 方法，重写了 __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

类 transformers.RealmKnowledgeAugEncoder

( config )

参数

config (RealmConfig) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载与模型相关的权重，只会加载配置。查看 from_pretrained() 方法以加载模型权重。

REALM的知识增强编码器输出掩码语言模型的logits和边际对数似然损失。该模型是PyTorch torch.nn.Module的子类。将其作为常规的PyTorch模块使用，并参考PyTorch文档以获取与一般使用和行为相关的所有信息。

前进

( 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)) — Indices of input sequence tokens in the vocabulary.
可以使用AutoTokenizer获取索引。详情请参见PreTrainedTokenizer.encode()和 PreTrainedTokenizer.call()。

什么是输入ID？
attention_mask (torch.FloatTensor of shape (batch_size, num_candidates, sequence_length), optional) — Mask to avoid performing attention on padding token indices. Mask values selected in [0, 1]:
- 1 for tokens that are not masked,
- 0 for tokens that are masked.
什么是注意力掩码？
token_type_ids (torch.LongTensor of shape (batch_size, num_candidates, sequence_length), optional) — Segment token indices to indicate first and second portions of the inputs. Indices are selected in [0, 1]:
- 0 corresponds to a sentence A token,
- 1 corresponds to a sentence B token.
什么是token type IDs?
position_ids (torch.LongTensor of shape (batch_size, num_candidates, sequence_length), optional) — Indices of positions of each input sequence tokens in the position embeddings. Selected in the range [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 of shape (batch_size, num_candidates, sequence_length, hidden_size), optional) — 可选地，您可以选择直接传递嵌入表示，而不是传递input_ids。如果您希望对如何将input_ids索引转换为相关向量有更多控制，而不是使用模型的内部嵌入查找矩阵，这将非常有用。
output_attentions (bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参见返回张量中的attentions。
output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参见返回张量下的hidden_states。
return_dict (bool, 可选) — 是否返回一个 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 形状为 (1,)，可选，当提供 labels 时返回) — 掩码语言建模（MLM）损失。
logits (torch.FloatTensor 形状为 (batch_size, sequence_length, config.vocab_size)) — 语言建模头的预测分数（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

类 transformers.RealmReader

( config )

参数

config (RealmConfig) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载与模型相关的权重，只会加载配置。查看 from_pretrained() 方法以加载模型权重。

REALM的读者。该模型是一个PyTorch torch.nn.Module 子类。将其作为常规的PyTorch模块使用，并参考PyTorch文档以获取与一般使用和行为相关的所有信息。

前进

( 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 of shape (reader_beam_size, sequence_length)) — Indices of input sequence tokens in the vocabulary.
可以使用AutoTokenizer获取索引。详情请参见PreTrainedTokenizer.encode()和 PreTrainedTokenizer.call()。

什么是输入ID？
attention_mask (torch.FloatTensor of shape (reader_beam_size, sequence_length), optional) — Mask to avoid performing attention on padding token indices. Mask values selected in [0, 1]:
- 1 for tokens that are not masked,
- 0 for tokens that are masked.
什么是注意力掩码？
token_type_ids (torch.LongTensor of shape (reader_beam_size, sequence_length), optional) — Segment token indices to indicate first and second portions of the inputs. Indices are selected in [0, 1]:
- 0 corresponds to a sentence A token,
- 1 corresponds to a sentence B token.
什么是token type IDs?
position_ids (torch.LongTensor of shape (reader_beam_size, sequence_length), optional) — Indices of positions of each input sequence tokens in the position embeddings. Selected in the range [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 of shape (searcher_beam_size,), optional) — 相关性分数，如果您想计算logits和边际对数损失，则必须指定此分数。
block_mask (torch.BoolTensor of shape (searcher_beam_size, sequence_length), optional) — 证据块的掩码，如果您想计算logits和边际对数损失，则必须指定此掩码。
start_positions (torch.LongTensor of shape (searcher_beam_size,), optional) — 用于计算标记分类损失的标记跨度起始位置（索引）的标签。位置被限制在序列长度内（sequence_length）。序列之外的位置不会被考虑用于计算损失。
end_positions (torch.LongTensor of shape (searcher_beam_size,), optional) — 用于计算标记分类损失的标记跨度结束位置（索引）的标签。位置被限制在序列长度内（sequence_length）。序列之外的位置不会被考虑用于计算损失。
has_answers (torch.BoolTensor of shape (searcher_beam_size,), optional) — 证据块是否有答案。

返回

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

类 transformers.RealmForOpenQA

( config retriever = 无 )

参数

config (RealmConfig) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载与模型相关的权重，只会加载配置。查看 from_pretrained() 方法以加载模型权重。

RealmForOpenQA 用于端到端的开放领域问答。该模型是一个 PyTorch torch.nn.Module 的子类。将其作为常规的 PyTorch 模块使用，并参考 PyTorch 文档以获取与一般使用和行为相关的所有信息。

block_embedding_to

( 设备 )

参数

设备 (str 或 torch.device) — self.block_emb 将被发送到的设备。

发送 self.block_emb 到特定设备。

前进

( 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 of shape (1, sequence_length)) — Indices of input sequence tokens in the vocabulary.
可以使用AutoTokenizer获取索引。详情请参见PreTrainedTokenizer.encode()和 PreTrainedTokenizer.call()。

什么是输入ID？
attention_mask (torch.FloatTensor of shape (1, sequence_length), optional) — Mask to avoid performing attention on padding token indices. Mask values selected in [0, 1]:
- 1 for tokens that are not masked,
- 0 for tokens that are masked.
什么是注意力掩码？
token_type_ids (torch.LongTensor of shape (1, sequence_length), optional) — Segment token indices to indicate first and second portions of the inputs. Indices are selected in [0, 1]:
- 0 corresponds to a sentence A token,
- 1 corresponds to a sentence B token (should not be used in this model by design).
什么是token type IDs?
answer_ids (list of shape (num_answers, answer_length), optional) — 用于计算边际对数似然损失的答案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

< > Update on GitHub

←RAG RecurrentGemma→