Transformers

( vocab_size = 30522 hidden_size = 768 retriever_proj_size = 128 num_hidden_layers = 12 num_attention_heads = 12 num_candidates = 8 intermediate_size = 3072 hidden_act = 'gelu_new' hidden_dropout_prob = 0.1 attention_probs_dropout_prob = 0.1 max_position_embeddings = 512 type_vocab_size = 2 initializer_range = 0.02 layer_norm_eps = 1e-12 span_hidden_size = 256 max_span_width = 10 reader_layer_norm_eps = 0.001 reader_beam_size = 5 reader_seq_len = 320 num_block_records = 13353718 searcher_beam_size = 5000 pad_token_id = 1 bos_token_id = 0 eos_token_id = 2 **kwargs )

参数

vocab_size (int, 可选, 默认为30522) — REALM模型的词汇量。定义了在调用RealmEmbedder、RealmScorer、RealmKnowledgeAugEncoder或RealmReader时，inputs_ids可以表示的不同token的数量。
hidden_size (int, 可选, 默认为768) — 编码层和池化层的维度。
retriever_proj_size (int, 可选, 默认为128) — 检索器（嵌入器）投影的维度。
num_hidden_layers (int, 可选, 默认为12) — Transformer编码器中隐藏层的数量。
num_attention_heads (int, 可选, 默认为12) — Transformer编码器中每个注意力层中的注意力头数量。
num_candidates (int, 可选, 默认为8) — 输入到RealmScorer或RealmKnowledgeAugEncoder的候选者数量。
intermediate_size (int, 可选, 默认为3072) — Transformer编码器中“中间层”（即前馈层）的维度。
hidden_act (str or function, 可选，默认为 "gelu_new") — 编码器和解码器中的非线性激活函数（函数或字符串）。如果为字符串，支持 "gelu"、"relu"、"selu" 和 "gelu_new"。
hidden_dropout_prob (float, 可选，默认为 0.1) — 嵌入、编码器和解码器中所有全连接层的dropout概率。
attention_probs_dropout_prob (float, 可选，默认为 0.1) — 关注概率的dropout率。
max_position_embeddings (int, 可选, 默认为 512) — 此模型可能使用的最大序列长度。通常设置为较大的数值以备不时之需（例如，512 或 1024 或 2048）。
type_vocab_size (int, 可选, 默认为 2) — 在调用 RealmEmbedder、RealmScorer、RealmKnowledgeAugEncoder 或 RealmReader 时传入的 token_type_ids 的词汇表大小。
initializer_range (float, 可选, 默认为 0.02) — 用于初始化所有权重矩阵的截断正态初始化器的标准差。
reader_beam_size （int，可选，默认为 5）—— 读取器束大小。
reader_seq_len （int，可选，默认为 288+32）—— 读取器最大序列长度。
num_block_records （int，可选，默认为 13353718）—— 块记录数。
searcher_beam_size （int，可选，默认为 5000）—— 搜索器束大小。注意，当启用评估模式时，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

类 transformers.RealmTokenizer

参数

do_basic_tokenize （bool，可选，默认为 True） — 是否在WordPiece前执行基本分词。
never_split （Iterable，可选） — 在分词过程中永远不会被分割的标记集合。仅在 do_basic_tokenize=True 时有效
unk_token （str，可选，默认为 "[UNK]"） — 未知标记。不在词汇表中的标记无法转换为ID，将被设定为此标记。
sep_token (str, 可选, 默认为 "[SEP]") — 分割标记，当从多个序列构建序列（例如，用于序列分类的两个序列，或者用于问答的文本和问题）时使用。它也是由特殊标记构建的序列的最后标记。
pad_token (str, 可选, 默认为 "[PAD]") — 填充标记，用于填充不同长度的序列。
cls_token (str, 可选, 默认为 "[CLS]") — 用于序列分类（整个序列的分类而不是逐个标记分类）的分类标记。当与特殊标记一起构建序列时，它是序列的第一个标记。
mask_token (str, 可选，默认为 "[MASK]") — 用于屏蔽值的标记。这是在用屏蔽语言模型训练此模型时使用的标记。这是模型将尝试预测的标记。
tokenize_chinese_chars (bool, 可选，默认为 True) — 是否分词中文字符。
这对于日语可能需要禁用（见此问题）。
strip_accents (bool, 可选) — 是否去除所有重音符号。如果没有指定此选项，则将根据 lowercase（如原始 BERT 中的）值来决定。

构建 REALM 分词器。

RealmTokenizer 与 BertTokenizer 相同，并运行端到端分词：标点分隔和词元分割。

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

build_inputs_with_special_tokens

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

参数

token_ids_0 (List[int]) — 特殊标记将被添加到的ID列表。
token_ids_1 (List[int], 可选) — 对于序列对的第二个可选ID列表。

返回结果

List[int]

包含适当特殊标记的输入ID列表。

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

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

get_special_tokens_mask

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

参数

token_ids_0 (列表[int]) — ID列表。
token_ids_1 (列表[int]，可选) — 序列对的 IDs 的可选第二个列表。
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 ) → List[int]

参数

token_ids_0 (列表[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: Optional = None )

batch_encode_candidates

（ text **kwargs ） → BatchEncoding

参数

text （List[List[str]]）— 要编制的序列批次。每个序列必须采用以下格式：（批次大小，候选数量，文本）。
text_pair （List[List[str]]，可选）— 要编码的序列批次。每个序列必须遵循以下格式：（批次大小，候选数量，文本）。**kwargs — call 方法的关键字参数。

返回结果

BatchEncoding

编码后的文本或文本对。

将一批文本或文本对进行编码。此方法与常规 call 方法类似，但有以下差异：

处理额外的 num_candidate 轴（批次大小，候选数量，文本）。
始终将序列填充到 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

参数

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, 可选) — 是否移除所有重音（ accents）。如果没有指定此选项，则将根据 lowercase（如原始 BERT）的值决定。
wordpieces_prefix (str, 可选, 默认为 "##") — 子词的前缀。

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

RealmTokenizerFast 与 BertTokenizerFast 相同，并运行端到端分词：标点分割和 wordpiece。

此分词器继承自 PreTrainedTokenizerFast，它包含了大部分主要方法。用户应参考这个超类以了解更多关于这些方法的信息。

batch_encode_candidates

（ text **kwargs ） → BatchEncoding

参数

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

返回结果

BatchEncoding

编码后的文本或文本对。

将一批文本或文本对进行编码。此方法与常规 call 方法类似，但有以下差异：

处理额外的 num_candidate 轴（批次大小，候选数量，文本）。
始终将序列填充到 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 )

检查检索到的块是否有答案。

RealmEmbedder

类 transformers.RealmEmbedder

< 源 >

( config )

参数

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

REALM嵌入器输出投影分数，该分数将用于计算相关性得分。这是一个PyTorchtorch.nn.Module子类。将其用作常规PyTorch模块，并参考PyTorch文档了解所有与通用使用和行为相关的内容。

forward

( input_ids: 可选 = None attention_mask: 可选 = None token_type_ids: 可选 = None position_ids: 可选 = None head_mask: 可选 = None inputs_embeds: 可选 = None output_attentions: 可选 = None output_hidden_states: 可选 = None return_dict: 可选 = None ) → transformers.models.deprecated.realm.modeling_realm.RealmEmbedderOutput 或 tuple(torch.FloatTensor)

参数

input_ids （torch.LongTensor 形状为 (batch_size, sequence_length)） — 输入序列令牌在词汇表中的索引。

可以通过使用 AutoTokenizer 获取索引。详情请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。

什么是输入 ID?
attention_mask （torch.FloatTensor 形状为 (batch_size, sequence_length)，可选） — 避免在填充令牌索引上执行注意力的掩码。掩码值选择在 [0, 1] 内：
- 1 表示 未掩码 令牌，
- 0 表示掩码令牌。
什么是注意掩码？
token_type_ids (torch.LongTensor of shape (batch_size, sequence_length), optional) — 指示输入前后两部分的 Section tokens 的索引。索引选择在 [0, 1]:
- 0 对应于 句子 A 标记,
- 1 对应于 句子 B 标记。
什么是 token type IDs?
position_ids (torch.LongTensor of shape (batch_size, sequence_length), optional) — 每个输入序列标记在位置嵌入中的位置索引。选择在范围 [0, config.max_position_embeddings - 1]。

什么是 position IDs?
head_mask (torch.FloatTensor of shape (num_heads,) or (num_layers, num_heads), optional) — 用于屏蔽 Self-attention 模块选择的头部。屏蔽值在 [0, 1] 之间：
- 1 表示头部 未屏蔽,
- 0 表示头部 已屏蔽.
inputs_embeds （torch.FloatTensor 形状为(batch_size, sequence_length, hidden_size)，可选） — 您可以选择直接传递嵌入表示，而不是通过input_ids传递。如果您想要比模型内部嵌入查找矩阵有更多控制输入索引转换为相关向量的方式，这个功能很有用。
output_attentions （bool，可选） — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的attentions。
output_hidden_states （bool，可选） — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的hidden_states。
return_dict (bool, 可选) — 是否返回ModelOutput对象而不是一个普通的元组。

返回结果

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

一个transformers.models.deprecated.realm.modeling_realm.RealmEmbedderOutput或者一个由torch.FloatTensor组成的元组（如果传递了return_dict=False或者当config.return_dict=False）根据配置 (RealmConfig) 和输入包含各种元素。

projected_score (torch.FloatTensor 形状为 (batch_size, config.retriever_proj_size)) — 投影分数。
hidden_states (tuple(torch.FloatTensor)，可选，当传递output_hidden_states=True时返回或者当config.output_hidden_states=True) — 元组，包含torch.FloatTensor (一个用于嵌入层的输出，一个用于每层的输出)，形状为 (batch_size, sequence_length, hidden_size)。

模型在各层输出后的隐藏状态，加上初始嵌入输出。
attentions (tuple(torch.FloatTensor)，可选，当传递output_attentions=True时返回或者当config.output_attentions=True) — 元组，包含torch.FloatTensor (每一层都有一个)，形状为 (batch_size, num_heads, sequence_length, sequence_length)。

在注意力softmax之后的注意力权重，用于在自注意力头部计算加权平均值。

RealmEmbedder前向方法，重写了__call__特殊方法。

尽管前向传递的配方需要在函数内部定义，但应该调用Module实例而不是这个，因为前者负责运行前处理和后处理步骤，而后者则默默忽略它们。

示例

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

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

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

>>> projected_score = outputs.projected_score

RealmScorer

class transformers.RealmScorer

参数

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

forward

< 源 >

( input_ids: 可选 = None attention_mask: 可选 = None token_type_ids: 可选 = None position_ids: 可选 = None candidate_input_ids: 可选 = None candidate_attention_mask: 可选 = None candidate_token_type_ids: 可选 = None candidate_inputs_embeds: 可选 = None head_mask: 可选 = None inputs_embeds: 可选 = None output_attentions: 可选 = None output_hidden_states: 可选 = None return_dict: 可选 = None ) → transformers.models.deprecated.realm.modeling_realm.RealmScorerOutput 或 tuple(torch.FloatTensor)

参数

input_ids （torch.LongTensor 形状为 (batch_size, sequence_length)） — 词汇表中的输入序列令牌的索引。

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

输入ID是什么？
attention_mask （torch.FloatTensor 形状为 (batch_size, sequence_length)，可选项） — 避免对填充令牌索引进行注意力操作的掩码。掩码值在[0, 1]之间选择：
- 1 表示 未掩码 的令牌，
- 0 表示掩码的令牌。
注意力掩码是什么？
token_type_ids （torch.LongTensor 形状为 (batch_size, sequence_length)，可选项） — 用于指示输入的第一个和第二个部分的段令牌索引。索引在[0, 1]之间选择：
- 0 对应于 句子 A 令牌，
- 1 对应于 句子 B 令牌。
令牌类型ID是什么？
position_ids （形状为 (batch_size, sequence_length) 的 torch.LongTensor，可选）—— 每个输入序列令牌在位置嵌入中的位置索引。在选择范围中选定 [0, config.max_position_embeddings - 1]。

什么是位置 ID？
head_mask （形状为 (num_heads,) 或 (num_layers, num_heads) 的 torch.FloatTensor，可选）—— 用于取消选择自注意力模块中选定头部的掩码。掩码值选择在 [0, 1] 范围内：
- 1 表示头部 未屏蔽，
- 0 表示头部 已屏蔽。
inputs_embeds （形状为 (batch_size, sequence_length, hidden_size) 的 torch.FloatTensor，可选）—— 可选地，您可以直接传递嵌入表示，而不是传递 input_ids。如果您想比模型内部嵌入查找矩阵有更多控制权，将 input_ids 索引转换为相关向量，这很有用。
output_attentions (bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的 attentions。
output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的 hidden_states。
return_dict (bool, 可选) — 是否返回一个 ModelOutput 而不是一个普通元组。
candidate_input_ids (torch.LongTensor 形状为 (batch_size, num_candidates, sequence_length)) — 词汇表中的候选输入序列标记的索引。

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

什么是输入ID？
candidate_attention_mask (torch.FloatTensor 形状为 (batch_size, num_candidates, sequence_length)，可选) — 避免在填充标记索引上执行注意力的掩码。掩码值选自 [0, 1]：
- 1 对应于未掩码的标记，
- 0 对应于掩码的标记。
什么是注意力掩码？
candidate_token_type_ids (torch.LongTensor 形状为 (batch_size, num_candidates, sequence_length)，可选) — 分段标记索引，用于指示输入的第一部分和第二部分。索引选自 [0, 1]：
- 0 对应于 句子 A 标记，
- 1 对应于 句子 B 标记。
什么是标记类型ID？
candidate_inputs_embeds (torch.FloatTensor 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)) — 从嵌入器派生出的候选得分。

The RealmScorer 前向方法，重写了 __call__ 特殊方法。

尽管前向传递的配方需要在函数内部定义，但应该调用Module实例而不是这个，因为前者负责运行前处理和后处理步骤，而后者则默默忽略它们。

示例

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

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

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

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

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

RealmKnowledgeAugEncoder

类 transformers.RealmKnowledgeAugEncoder

( config )

参数

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

REALM的知识增强编码器，输出掩码语言模型的对数几率和边缘对数似然损失。这是一个PyTorch torch.nn.Module的子类。可以将它用作常规的PyTorch模块，并参考PyTorch文档了解与通用地使用和行为相关的一切。

forward

( 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 of shape (batch_size, num_candidates, sequence_length)) — 词汇中输入序列标记的索引。

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

什么是输入ID？
attention_mask (torch.FloatTensor 形状为 (batch_size, num_candidates, sequence_length)，可选) — 避免在填充 token 索引上进行注意力操作的遮罩。遮罩值在 [0, 1] 范围内选定：
- 1 对于 未被遮罩 的 token，
- 0 对于 被遮罩 的 token。
什么是注意力遮罩？
token_type_ids (torch.LongTensor 形状为 (batch_size, num_candidates, sequence_length)，可选) — 段 token 索引，用于指示输入的第一和第二部分。索引选择范围在 [0, 1] 内：
- 0 对应于 句子 A token，
- 1 对应于 句子 B token。
什么是 token 类型 ID？
position_ids (torch.LongTensor 形状为 (batch_size, num_candidates, sequence_length)，可选) — 各个输入序列 token 在位置嵌入中的位置索引。选择范围在 [0, config.max_position_embeddings - 1] 内。

什么是位置 ID？
output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。有关更详细的信息，请参阅返回张量下的 hidden_states。
return_dict (bool, 可选) — 是否返回 ModelOutput 而不是普通元组。
relevance_score (torch.FloatTensor 形状为 (batch_size, num_candidates), 可选) — 来自 RealmScorer 的相关性分数，如果你想要计算掩码语言模型损失，则必须指定。
labels (torch.LongTensor of shape (batch_size, sequence_length), 可选) — 用于计算掩码语言模型损失的标签。索引应在 [-100, 0, ..., config.vocab_size] 范围内（参见 input_ids 文档字符串）。索引设置为 -100 的标记将被忽略（掩码），只有标签在 [0, ..., config.vocab_size] 范围内的标记的损失才会被计算
mlm_mask (torch.LongTensor of shape (batch_size, sequence_length), 可选) — 用以避免在特定位置计算联合损失的掩码。如果未指定，则不会进行掩码。掩码值选择在 [0, 1]：
- 1 对未掩码的标记
- 0 对掩码的标记

返回结果

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

由 transformers.modeling_outputs.MaskedLMOutput 或元组 torch.FloatTensor（如果传递 return_dict=False 或当 config.return_dict=False）组成，包含各种元素，具体取决于配置（RealmConfig）和输入。

loss (torch.FloatTensor of shape (1,), 可选，当提供 labels 时返回) — 掩码语言模型（MLM）损失。
logits (torch.FloatTensor of shape (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 的 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.logits

RealmReader

类 transformers.RealmReader

( 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 relevance_score: Optional = None block_mask: Optional = None start_positions: Optional = None end_positions: Optional = None has_answers: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → transformers.models.deprecated.realm.modeling_realm.RealmReaderOutput or tuple(torch.FloatTensor)

参数

input_ids (torch.LongTensor of shape (reader_beam_size, sequence_length)) — 输入序列词汇中的标记索引。

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

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

位置ID是什么？
head_mask （形状为 (num_heads,) 或 (num_layers, num_heads) 的 torch.FloatTensor，可选）— 禁用自注意力模块中选定头部的掩码。掩码值在 [0, 1] 之间：
- 1 表示头部 未掩码，
- 0 表示头部掩码。
inputs_embeds （形状为 (reader_beam_size, sequence_length, hidden_size) 的 torch.FloatTensor，可选）— 可选地，您可以直接传递嵌入表示，而无需传递 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,), 可选) — 相关度得分，在您想要计算对数似然和边缘对数损失时必须指定。
block_mask (torch.BoolTensor，形状为(searcher_beam_size, sequence_length)，为可选参数) — 证据块掩码，如果要计算logits和边际对数损失，则必须指定。
start_positions (torch.LongTensor，形状为(searcher_beam_size,)，为可选参数) — 标记片段开始位置（索引）的标签，用于计算token分类损失。位置被钳制为序列长度（sequence_length）。序列之外的端点不会被用于损失计算。
end_positions (torch.LongTensor，形状为(searcher_beam_size,)，为可选参数) — 标记片段结束位置（索引）的标签，用于计算token分类损失。位置被钳制为序列长度（sequence_length）。序列之外的端点不会被用于损失计算。
has_answers (torch.BoolTensor of shape (searcher_beam_size,), optional) — 指示证据块是否包含答案。

返回结果

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

A transformers.models.deprecated.realm.modeling_realm.RealmReaderOutput 或一个 torch.FloatTensor 的元组（如果传递了 return_dict=False 或当 config.return_dict=False），它包含根据配置（RealmConfig）和输入的各种元素。

loss (torch.FloatTensor of shape (1,), optional, returned when start_positions, end_positions, has_answers are provided) — 总损失。
retriever_loss (torch.FloatTensor of shape (1,), optional, returned when start_positions, end_positions, has_answers are provided) — 检索器损失。
reader_loss (torch.FloatTensor of shape (1,), optional, returned when start_positions, end_positions, has_answers are provided) — 读者损失。
retriever_correct (torch.BoolTensor of shape (config.searcher_beam_size,), optional) — 是否有证据块包含答案。
reader_correct (torch.BoolTensor of shape (config.reader_beam_size, num_candidates), optional) — 是否有跨度候选者包含答案。
block_idx (torch.LongTensor of shape ()) — 预测答案最有可能的检索证据块的索引。
candidate (torch.LongTensor of shape ()) — 预测答案最有可能的检索跨度候选者的索引。
start_pos (torch.IntTensor of shape ()) — 在 RealmReader 的输入中预测答案的起始位置。
end_pos (torch.IntTensor of shape ()) — 在 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

( config retriever = None )

参数

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

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

block_embedding_to

( 设备 )

参数

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

将 self.block_emb 发送到一个特定的设备。

forward