Transformers 文档

DPR

Hugging Face's logo
加入Hugging Face社区

并获得增强的文档体验

开始使用

DPR

Models Spaces

概述

密集段落检索 (DPR) 是一套用于最先进的开放域问答研究的工具和模型。它在 Vladimir Karpukhin、Barlas Oğuz、Sewon Min、Patrick Lewis、Ledell Wu、Sergey Edunov、Danqi Chen 和 Wen-tau Yih 的论文 用于开放域问答的密集段落检索 中被提出。

论文的摘要如下:

开放域问答依赖于高效的段落检索来选择候选上下文,其中传统的稀疏向量空间模型,如 TF-IDF 或 BM25,是事实上的方法。在这项工作中,我们展示了检索可以仅使用密集表示来实际实现,其中嵌入通过简单的双编码器框架从少量问题和段落中学习得到。当在各种开放域 QA 数据集上进行评估时,我们的密集检索器在 Top-20 段落检索准确率方面,主要优于强大的 Lucene-BM25 系统 9%-19% 的绝对值,并帮助我们的端到端 QA 系统在多个开放域 QA 基准测试中取得了新的最先进水平。

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

使用技巧

  • DPR 由三个模型组成:

    • 问题编码器:将问题编码为向量。
    • 上下文编码器:将上下文编码为向量。
    • 阅读器:从检索到的上下文中提取问题的答案,以及相关性得分(如果推断出的跨度确实回答了问题,则得分较高)。

DPRConfig

transformers.DPRConfig

< >

( vocab_size = 30522 hidden_size = 768 num_hidden_layers = 12 num_attention_heads = 12 intermediate_size = 3072 hidden_act = 'gelu' 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 pad_token_id = 0 position_embedding_type = 'absolute' projection_dim: int = 0 **kwargs )

参数

  • vocab_size (int, 可选, 默认为 30522) — DPR 模型的词汇量大小。定义了可以由传递给 BertModel 的 forward 方法的 inputs_ids 表示的不同标记。
  • hidden_size (int, 可选, 默认为 768) — 编码器层和池化层的维度。
  • num_hidden_layers (int, 可选, 默认为 12) — Transformer 编码器中的隐藏层数。

  • num_attention_heads (int可选,默认为 12) — Transformer 编码器中每个注意力层的注意力头数量。
  • intermediate_size (int可选,默认为 3072) — Transformer 编码器中“中间”(即前馈)层的维度。
  • hidden_act (strfunction可选,默认为 "gelu") — 编码器和池化器中的非线性激活函数(函数或字符串)。如果为字符串,则支持 "gelu""relu""silu""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) — 传入 BertModeltoken_type_ids 的词汇量大小。
  • initializer_range (float可选,默认为 0.02) — 初始化所有权重矩阵的 truncated_normal_initializer 的标准差。
  • layer_norm_eps (float可选,默认为 1e-12) — 层归一化层使用的 epsilon。
  • pad_token_id (int可选,默认为 0) — 填充 token id。
  • projection_dim (int可选,默认为 0) — 上下文编码器和问题编码器的投影维度。如果设置为零(默认值),则不进行投影。

DPRConfig 是用于存储DPRModel配置的配置类。

这是一个用于存储DPRContextEncoderDPRQuestionEncoderDPRReader配置的配置类。它用于根据指定的参数实例化DPR模型的组件,定义模型组件架构。使用默认值实例化配置将产生与DPRContextEncoder facebook/dpr-ctx_encoder-single-nq-base架构类似的配置。

此类是BertConfig的子类。请查看超类以获取所有kwargs的文档。

示例

>>> from transformers import DPRConfig, DPRContextEncoder

>>> # Initializing a DPR facebook/dpr-ctx_encoder-single-nq-base style configuration
>>> configuration = DPRConfig()

>>> # Initializing a model (with random weights) from the facebook/dpr-ctx_encoder-single-nq-base style configuration
>>> model = DPRContextEncoder(configuration)

>>> # Accessing the model configuration
>>> configuration = model.config

DPRContextEncoderTokenizer

transformers.DPRContextEncoderTokenizer

< >

( 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 clean_up_tokenization_spaces = True **kwargs )

构建DPRContextEncoder分词器。

DPRContextEncoderTokenizerBertTokenizer相同,并执行端到端分词:标点符号拆分和WordPiece。

有关用法示例和参数文档,请参阅超类BertTokenizer

DPRContextEncoderTokenizerFast

transformers.DPRContextEncoderTokenizerFast

< >

( 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 )

构建“快速”DPRContextEncoder分词器(由HuggingFace的tokenizers库支持)。

DPRContextEncoderTokenizerFastBertTokenizerFast相同,并执行端到端分词:标点符号拆分和WordPiece。

有关用法示例和参数文档,请参阅超类BertTokenizerFast

DPRQuestionEncoderTokenizer

transformers.DPRQuestionEncoderTokenizer

< >

( 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 clean_up_tokenization_spaces = True **kwargs )

构建 DPRQuestionEncoder 分词器。

DPRQuestionEncoderTokenizerBertTokenizer 相同,并执行端到端分词:标点符号分割和 WordPiece。

有关用法示例和参数文档,请参阅超类BertTokenizer

DPRQuestionEncoderTokenizerFast

transformers.DPRQuestionEncoderTokenizerFast

< >

( 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 )

构建一个“快速”DPRQuestionEncoder分词器(由HuggingFace的tokenizers库支持)。

DPRQuestionEncoderTokenizerFastBertTokenizerFast 相同,并执行端到端分词:标点符号分割和 WordPiece。

有关用法示例和参数文档,请参阅超类BertTokenizerFast

DPRReaderTokenizer

transformers.DPRReaderTokenizer

< >

( 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 clean_up_tokenization_spaces = True **kwargs ) Dict[str, List[List[int]]]

参数

  • questions (strList[str]) — 要编码的问题。您可以为多个段落指定一个问题。在这种情况下,问题将像 [questions] * n_passages 一样重复。否则,您必须指定与 titlestexts 中一样多的问题。
  • titles (strList[str]) — 要编码的段落标题。如果有多个段落,则可以是字符串或字符串列表。
  • texts (strList[str]) — 要编码的段落文本。如果有多个段落,则可以是字符串或字符串列表。
  • padding (bool, strPaddingStrategy, 可选,默认为 False) — 激活并控制填充。接受以下值:

    • True'longest':填充到批次中最长的序列(如果只提供单个序列,则不填充)。
    • 'max_length':填充到使用参数 max_length 指定的最大长度,或者如果未提供该参数,则填充到模型可接受的最大输入长度。
    • False'do_not_pad'(默认):不填充(即,可以输出具有不同长度序列的批次)。
  • truncation (bool, strTruncationStrategy, 可选,默认为 False) — 激活并控制截断。接受以下值:

    • True'longest_first':截断到使用参数 max_length 指定的最大长度,或者如果未提供该参数,则截断到模型可接受的最大输入长度。如果提供了一对序列(或一对序列的批次),则此操作将逐个标记进行截断,从最长序列中删除一个标记。
    • 'only_first':截断到使用参数 max_length 指定的最大长度,或者如果未提供该参数,则截断到模型可接受的最大输入长度。如果提供了一对序列(或一对序列的批次),则此操作将只截断第一对序列。
    • 'only_second':截断到使用参数 max_length 指定的最大长度,或者如果未提供该参数,则截断到模型可接受的最大输入长度。如果提供了一对序列(或一对序列的批次),则此操作将只截断第二对序列。
    • False'do_not_truncate'(默认):不截断(即,可以输出序列长度大于模型最大可接受输入大小的批次)。
  • max_length (int, 可选) — 通过截断/填充参数之一控制要使用的最大长度。

    如果未设置或设置为 None,则如果截断/填充参数之一需要最大长度,则此操作将使用预定义的模型最大长度。如果模型没有特定的最大输入长度(如 XLNet),则将停用截断/填充到最大长度。

  • return_tensors (strTensorType, 可选) — 如果设置,将返回张量而不是 Python 整数列表。可接受的值为:

    • 'tf':返回 TensorFlow tf.constant 对象。
    • 'pt':返回 PyTorch torch.Tensor 对象。
    • 'np':返回 NumPy np.ndarray 对象。
  • return_attention_mask (bool, 可选) — 是否返回注意力掩码。如果未设置,将根据特定标记器的默认值返回注意力掩码,由 return_outputs 属性定义。

    什么是注意力掩码?

返回

Dict[str, List[List[int]]]

具有以下键的字典

  • input_ids:要馈送到模型的标记 ID 列表。
  • attention_mask:指定模型应注意哪些标记的索引列表。

构建 DPRReader 分词器。

DPRReaderTokenizer 几乎与 BertTokenizer 相同,并运行端到端分词:标点符号分割和 WordPiece。不同之处在于它有三个输入字符串:问题、标题和文本,它们被组合起来馈送到 DPRReader 模型。

有关用法示例和参数文档,请参阅超类BertTokenizer

返回一个包含输入字符串的标记 ID 和其他信息的字典,以提供给 .decode_best_spans。它使用分词器和词汇表将问题和不同段落(标题和文本)的字符串转换为 ID(整数)序列。生成的 input_ids 是大小为 (n_passages, sequence_length) 的矩阵

格式为

[CLS] <question token ids> [SEP] <titles ids> [SEP] <texts ids>

DPRReaderTokenizerFast

transformers.DPRReaderTokenizerFast

< >

( 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 ) Dict[str, List[List[int]]]

参数

  • questions (strList[str]) — 要编码的问题。您可以为多个段落指定一个问题。在这种情况下,问题将像 [questions] * n_passages 一样重复。否则,您必须指定与 titlestexts 中一样多的问题。
  • titles (strList[str]) — 要编码的段落标题。如果有多个段落,则可以是字符串或字符串列表。
  • texts (strList[str]) — 要编码的段落文本。如果有多个段落,则可以是字符串或字符串列表。
  • padding (boolstrPaddingStrategy可选,默认为 False) — 激活并控制填充。接受以下值:

    • True'longest':填充到批次中最长的序列(如果仅提供单个序列,则不填充)。
    • 'max_length':填充到使用参数 max_length 指定的最大长度,或者如果未提供该参数,则填充到模型可接受的最大输入长度。
    • False'do_not_pad'(默认):不填充(即,可以输出具有不同长度序列的批次)。
  • truncation (boolstrTruncationStrategy可选,默认为 False) — 激活并控制截断。接受以下值:

    • True'longest_first':截断到使用参数 max_length 指定的最大长度,或者如果未提供该参数,则截断到模型可接受的最大输入长度。如果提供了一对序列(或一对序列的批次),这将逐个标记进行截断,从配对中最长的序列中删除一个标记。
    • 'only_first':截断到使用参数 max_length 指定的最大长度,或者如果未提供该参数,则截断到模型可接受的最大输入长度。如果提供了一对序列(或一对序列的批次),这将只截断配对的第一个序列。
    • 'only_second':截断到使用参数 max_length 指定的最大长度,或者如果未提供该参数,则截断到模型可接受的最大输入长度。如果提供了一对序列(或一对序列的批次),这将只截断配对的第二个序列。
    • False'do_not_truncate'(默认):不截断(即,可以输出序列长度大于模型最大可接受输入大小的批次)。
  • max_length (int可选) — 通过截断/填充参数之一控制要使用的最大长度。

    如果未设置或设置为 None,则如果截断/填充参数之一需要最大长度,则将使用预定义的模型最大长度。如果模型没有特定的最大输入长度(如 XLNet),则将停用截断/填充到最大长度。

  • return_tensors (strTensorType可选) — 如果设置,将返回张量而不是 python 整数列表。可接受的值为:

    • 'tf':返回 TensorFlow tf.constant 对象。
    • 'pt':返回 PyTorch torch.Tensor 对象。
    • 'np':返回 Numpy np.ndarray 对象。
  • return_attention_mask (bool可选) — 是否返回注意力掩码。如果未设置,将根据特定标记器的默认值返回注意力掩码,由 return_outputs 属性定义。

    什么是注意力掩码?

返回

Dict[str, List[List[int]]]

具有以下键的字典

  • input_ids:要馈送到模型的标记 ID 列表。
  • attention_mask:指定模型应注意哪些标记的索引列表。

构建一个“快速”DPRReader标记器(由 HuggingFace 的 tokenizers 库支持)。

DPRReaderTokenizerFast 几乎与 BertTokenizerFast 相同,并运行端到端标记化:标点符号分割和词片段。不同之处在于它有三个输入字符串:问题、标题和文本,它们被组合起来馈送到 DPRReader 模型。

有关用法示例和参数文档,请参阅超类BertTokenizerFast

返回一个包含输入字符串的标记 ID 和其他信息的字典,以提供给 .decode_best_spans。它使用标记器和词汇表将问题和不同段落(标题和文本)的字符串转换为 ID(整数)序列。生成的 input_ids 是一个大小为 (n_passages, sequence_length) 的矩阵,格式为

[CLS] <问题标记 ID> [SEP] <标题 ID> [SEP] <文本 ID>

DPR 特定输出

transformers.models.dpr.modeling_dpr.DPRContextEncoderOutput

< >

( pooler_output: FloatTensor hidden_states: Optional = None attentions: Optional = None )

参数

  • pooler_output (torch.FloatTensor 形状为 (batch_size, embeddings_size)) — DPR 编码器输出对应于上下文表示的 pooler_output。序列第一个标记(分类标记)的最后一层隐藏状态,并由线性层进一步处理。此输出用于将上下文嵌入到问题嵌入的最近邻查询中。
  • hidden_states (tuple(torch.FloatTensor), 可选,当传递 output_hidden_states=Trueconfig.output_hidden_states=True 时返回) — 形状为 (batch_size, sequence_length, hidden_size)torch.FloatTensor 元组(一个用于嵌入的输出,一个用于每一层的输出)。

    模型在每一层输出处的隐藏状态加上初始嵌入输出。

  • attentions (tuple(torch.FloatTensor), 可选,当传递 output_attentions=Trueconfig.output_attentions=True 时返回) — 形状为 (batch_size, num_heads, sequence_length, sequence_length)torch.FloatTensor 元组(每一层一个)。

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

用于 DPRQuestionEncoder 输出的类。

transformers.models.dpr.modeling_dpr.DPRQuestionEncoderOutput

< >

( pooler_output: FloatTensor hidden_states: Optional = None attentions: Optional = None )

参数

  • pooler_output (torch.FloatTensor 形状为 (batch_size, embeddings_size)) — DPR 编码器输出对应于问题表示的 pooler_output。序列第一个标记(分类标记)的最后一层隐藏状态,并由线性层进一步处理。此输出用于将问题嵌入到上下文嵌入的最近邻查询中。
  • hidden_states (tuple(torch.FloatTensor), 可选,当传递 output_hidden_states=Trueconfig.output_hidden_states=True 时返回) — 形状为 (batch_size, sequence_length, hidden_size)torch.FloatTensor 元组(一个用于嵌入的输出,一个用于每一层的输出)。

    模型在每一层输出处的隐藏状态加上初始嵌入输出。

  • attentions (tuple(torch.FloatTensor), 可选,当传递 output_attentions=Trueconfig.output_attentions=True 时返回) — 形状为 (batch_size, num_heads, sequence_length, sequence_length)torch.FloatTensor 元组(每一层一个)。

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

用于 DPRQuestionEncoder 输出的类。

transformers.DPRReaderOutput

< >

( start_logits: FloatTensor end_logits: FloatTensor = None relevance_logits: FloatTensor = None hidden_states: 可选 = None attentions: 可选 = None )

参数

  • start_logits (torch.FloatTensor 形状为 (n_passages, sequence_length)) — 每个段落的跨度起始索引的 logits。
  • end_logits (torch.FloatTensor 形状为 (n_passages, sequence_length)) — 每个段落的跨度结束索引的 logits。
  • relevance_logits (torch.FloatTensor 形状为 (n_passages, )) — DPRReader 的 QA 分类器的输出,对应于每个段落回答问题的得分,与所有其他段落相比。
  • hidden_states (tuple(torch.FloatTensor), 可选,当传递 output_hidden_states=Trueconfig.output_hidden_states=True 时返回) — 形状为 (batch_size, sequence_length, hidden_size)torch.FloatTensor 元组(一个用于嵌入的输出 + 一个用于每一层的输出)。

    模型在每一层输出处的隐藏状态以及初始嵌入输出。

  • attentions (tuple(torch.FloatTensor), 可选,当传递 output_attentions=Trueconfig.output_attentions=True 时返回) — 形状为 (batch_size, num_heads, sequence_length, sequence_length)torch.FloatTensor 元组(每一层一个)。

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

用于 DPRQuestionEncoder 输出的类。

Pytorch
隐藏 Pytorch 内容

DPRContextEncoder

transformers.DPRContextEncoder

< >

( config: DPRConfig )

参数

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

输出池化输出作为上下文表示的裸 DPRContextEncoder 变压器。

此模型继承自 PreTrainedModel。查看超类文档以了解库为其所有模型实现的通用方法(例如下载或保存、调整输入嵌入的大小、修剪 head 等)。

此模型也是 PyTorch torch.nn.Module 的子类。将其用作常规 PyTorch 模块,并参考 PyTorch 文档了解与一般用法和行为相关的所有事项。

正向传播

< >

( input_ids: 可选 = None attention_mask: 可选 = None token_type_ids: 可选 = None inputs_embeds: 可选 = None output_attentions: 可选 = None output_hidden_states: 可选

参数

  • input_ids (torch.LongTensor 形状为 (batch_size, sequence_length)) — 词汇表中输入序列标记的索引。为了匹配预训练,DPR 输入序列应按如下方式格式化:[CLS] 和 [SEP] 标记:

    (a) 对于序列对(例如标题+文本对):

返回

transformers.models.dpr.modeling_dpr.DPRContextEncoderOutputtuple(torch.FloatTensor)

一个 transformers.models.dpr.modeling_dpr.DPRContextEncoderOutput 或一个 torch.FloatTensor 元组(如果传递了 return_dict=Falseconfig.return_dict=False),包含取决于配置 (DPRConfig) 和输入的各种元素。

  • pooler_output (torch.FloatTensor 形状为 (batch_size, embeddings_size)) — DPR 编码器输出对应于上下文表示的 pooler_output。序列的第一个标记(分类标记)的最后一层隐藏状态,并由线性层进一步处理。此输出用于将上下文嵌入到与问题嵌入进行最近邻查询。

  • hidden_states (tuple(torch.FloatTensor), 可选, 当传递 output_hidden_states=Trueconfig.output_hidden_states=True 时返回) — torch.FloatTensor 元组(一个用于嵌入的输出 + 一个用于每一层的输出),形状为 (batch_size, sequence_length, hidden_size)

    模型在每一层输出处的隐藏状态加上初始嵌入输出。

  • attentions (tuple(torch.FloatTensor), 可选, 当传递 output_attentions=Trueconfig.output_attentions=True 时返回) — torch.FloatTensor 元组(每一层一个),形状为 (batch_size, num_heads, sequence_length, sequence_length)

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

DPRContextEncoder 正向方法覆盖了 __call__ 特殊方法。

尽管正向传递的步骤需要在此函数中定义,但之后应该调用 Module 实例而不是此函数,因为前者负责运行预处理和后处理步骤,而后者则默默地忽略它们。

示例

>>> from transformers import DPRContextEncoder, DPRContextEncoderTokenizer

>>> tokenizer = DPRContextEncoderTokenizer.from_pretrained("facebook/dpr-ctx_encoder-single-nq-base")
>>> model = DPRContextEncoder.from_pretrained("facebook/dpr-ctx_encoder-single-nq-base")
>>> input_ids = tokenizer("Hello, is my dog cute ?", return_tensors="pt")["input_ids"]
>>> embeddings = model(input_ids).pooler_output

DPRQuestionEncoder

transformers.DPRQuestionEncoder

< >

( config: DPRConfig )

参数

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

输出池化输出作为问题表示的基本 DPRQuestionEncoder 变压器。

此模型继承自 PreTrainedModel。查看超类文档以了解库为其所有模型实现的通用方法(例如下载或保存、调整输入嵌入的大小、修剪 head 等)。

此模型也是 PyTorch torch.nn.Module 的子类。将其用作常规 PyTorch 模块,并参考 PyTorch 文档了解与一般用法和行为相关的所有事项。

正向传播

< >

( input_ids: Optional = None attention_mask: Optional = None token_type_ids: Optional = None inputs_embeds: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) transformers.models.dpr.modeling_dpr.DPRQuestionEncoderOutputtuple(torch.FloatTensor)

参数

  • input_ids (torch.LongTensor 形状为 (batch_size, sequence_length)) — 词汇表中输入序列标记的索引。为了匹配预训练,DPR 输入序列应按如下方式格式化:[CLS] 和 [SEP] 标记:

    (a) 对于序列对(例如标题+文本对):

返回

transformers.models.dpr.modeling_dpr.DPRQuestionEncoderOutputtuple(torch.FloatTensor)

一个 transformers.models.dpr.modeling_dpr.DPRQuestionEncoderOutput 或一个 torch.FloatTensor 元组(如果传递了 return_dict=Falseconfig.return_dict=False),包含取决于配置 (DPRConfig) 和输入的各种元素。

  • pooler_output (torch.FloatTensor 形状为 (batch_size, embeddings_size)) — DPR 编码器输出对应于问题表示的 pooler_output。序列的第一个标记(分类标记)的最后一层隐藏状态,并由线性层进一步处理。此输出用于将问题嵌入到与上下文嵌入进行最近邻查询。

  • hidden_states (tuple(torch.FloatTensor), 可选, 当传递 output_hidden_states=Trueconfig.output_hidden_states=True 时返回) — torch.FloatTensor 元组(一个用于嵌入的输出 + 一个用于每一层的输出),形状为 (batch_size, sequence_length, hidden_size)

    模型在每一层输出处的隐藏状态加上初始嵌入输出。

  • attentions (tuple(torch.FloatTensor), 可选, 当传递 output_attentions=Trueconfig.output_attentions=True 时返回) — torch.FloatTensor 元组(每一层一个),形状为 (batch_size, num_heads, sequence_length, sequence_length)

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

DPRQuestionEncoder 正向方法覆盖了 __call__ 特殊方法。

尽管正向传递的步骤需要在此函数中定义,但之后应该调用 Module 实例而不是此函数,因为前者负责运行预处理和后处理步骤,而后者则默默地忽略它们。

示例

>>> from transformers import DPRQuestionEncoder, DPRQuestionEncoderTokenizer

>>> tokenizer = DPRQuestionEncoderTokenizer.from_pretrained("facebook/dpr-question_encoder-single-nq-base")
>>> model = DPRQuestionEncoder.from_pretrained("facebook/dpr-question_encoder-single-nq-base")
>>> input_ids = tokenizer("Hello, is my dog cute ?", return_tensors="pt")["input_ids"]
>>> embeddings = model(input_ids).pooler_output

DPRReader

transformers.DPRReader

< >

( config: DPRConfig )

参数

  • config (DPRConfig) — 模型配置类,包含模型的所有参数。使用配置文件进行初始化不会加载与模型关联的权重,仅加载配置。请查看 from_pretrained() 方法来加载模型权重。

输出跨度预测的裸 DPRReader 变换器。

此模型继承自 PreTrainedModel。查看超类文档以了解库为其所有模型实现的通用方法(例如下载或保存、调整输入嵌入的大小、修剪 head 等)。

此模型也是 PyTorch torch.nn.Module 的子类。将其用作常规 PyTorch 模块,并参考 PyTorch 文档了解与一般用法和行为相关的所有事项。

正向传播

< >

( input_ids: Optional = None attention_mask: Optional = None inputs_embeds: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) transformers.models.dpr.modeling_dpr.DPRReaderOutputtuple(torch.FloatTensor)

参数

  • input_ids (Tuple[torch.LongTensor] 形状为 (n_passages, sequence_length)) — 词汇表中输入序列标记的索引。它必须是一个序列三元组,其中包含 1) 问题和 2) 段落标题以及 3) 段落文本。为了匹配预训练,DPR 的 input_ids 序列应使用 [CLS] 和 [SEP] 以以下格式进行格式化:

    [CLS] <问题标记 ID> [SEP] <标题 ID> [SEP] <文本 ID>

    DPR 是一个具有绝对位置嵌入的模型,因此通常建议在右侧而不是左侧填充输入。

    可以使用 DPRReaderTokenizer 获取索引。有关更多详细信息,请查看此类文档。

    什么是输入 ID?

  • attention_mask (torch.FloatTensor 形状为 (n_passages, sequence_length)可选) — 用于避免对填充标记索引执行注意力的掩码。在 [0, 1] 中选择掩码值:

    • 1 表示未掩码的标记,
    • 0 表示掩码的标记。

    什么是注意力掩码?

  • inputs_embeds (torch.FloatTensor 形状为 (n_passages, sequence_length, hidden_size)可选) — 可选地,您可以选择直接传递嵌入表示,而不是传递 input_ids。如果您希望比模型的内部嵌入查找矩阵更精确地控制如何将 input_ids 索引转换为关联向量,这将非常有用。
  • output_attentions (bool可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息,请参阅返回张量下的 attentions
  • output_hidden_states (bool可选) — 是否返回所有层的隐藏状态。有关更多详细信息,请参阅返回张量下的 hidden_states
  • return_dict (bool可选) — 是否返回 ModelOutput 而不是普通元组。

返回

transformers.models.dpr.modeling_dpr.DPRReaderOutputtuple(torch.FloatTensor)

一个 transformers.models.dpr.modeling_dpr.DPRReaderOutputtorch.FloatTensor 的元组(如果传递了 return_dict=False 或当 config.return_dict=False 时),包含取决于配置 (DPRConfig) 和输入的各种元素。

  • start_logits (torch.FloatTensor 形状为 (n_passages, sequence_length)) — 每个篇章中跨度起始索引的 logits。

  • end_logits (torch.FloatTensor 形状为 (n_passages, sequence_length)) — 每个篇章中跨度结束索引的 logits。

  • relevance_logits (torch.FloatTensor 形状为 (n_passages, )) — DPRReader 的 QA 分类器的输出,对应于每个篇章回答问题的得分,与所有其他篇章相比。

  • hidden_states (tuple(torch.FloatTensor), 可选, 当传递 output_hidden_states=Trueconfig.output_hidden_states=True 时返回) — torch.FloatTensor 元组(一个用于嵌入的输出 + 一个用于每一层的输出),形状为 (batch_size, sequence_length, hidden_size)

    模型在每一层输出处的隐藏状态加上初始嵌入输出。

  • attentions (tuple(torch.FloatTensor), 可选, 当传递 output_attentions=Trueconfig.output_attentions=True 时返回) — torch.FloatTensor 元组(每一层一个),形状为 (batch_size, num_heads, sequence_length, sequence_length)

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

The DPRReader 正向方法覆盖了 __call__ 特殊方法。

尽管正向传递的步骤需要在此函数中定义,但之后应该调用 Module 实例而不是此函数,因为前者负责运行预处理和后处理步骤,而后者则默默地忽略它们。

示例

>>> from transformers import DPRReader, DPRReaderTokenizer

>>> tokenizer = DPRReaderTokenizer.from_pretrained("facebook/dpr-reader-single-nq-base")
>>> model = DPRReader.from_pretrained("facebook/dpr-reader-single-nq-base")
>>> encoded_inputs = tokenizer(
...     questions=["What is love ?"],
...     titles=["Haddaway"],
...     texts=["'What Is Love' is a song recorded by the artist Haddaway"],
...     return_tensors="pt",
... )
>>> outputs = model(**encoded_inputs)
>>> start_logits = outputs.start_logits
>>> end_logits = outputs.end_logits
>>> relevance_logits = outputs.relevance_logits
TensorFlow
隐藏 TensorFlow 内容

TFDPRContextEncoder

transformers.TFDPRContextEncoder

< >

( config: DPRConfig *args **kwargs )

参数

  • config (DPRConfig) — 模型配置类,包含模型的所有参数。使用配置文件初始化不会加载与模型关联的权重,仅加载配置。查看 from_pretrained() 方法来加载模型权重。

输出池化输出作为上下文表示的裸 DPRContextEncoder 变压器。

此模型继承自 TFPreTrainedModel。查看超类文档以了解库为其所有模型实现的通用方法(例如下载或保存、调整输入嵌入大小、剪枝 head 等)。

此模型也是 Tensorflow keras.Model 的子类。将其用作常规的 TF 2.0 Keras 模型,并参考 TF 2.0 文档了解与一般用法和行为相关的所有事项。

transformers 中的 TensorFlow 模型和层接受两种格式作为输入

  • 将所有输入作为关键字参数(如 PyTorch 模型),或
  • 将所有输入作为列表、元组或字典放在第一个位置参数中。

支持第二种格式的原因是 Keras 方法在将输入传递给模型和层时更喜欢这种格式。由于这种支持,当使用 model.fit() 等方法时,事情应该“正常工作” - 只需以 model.fit() 支持的任何格式传递输入和标签即可!但是,如果您想在 Keras 方法(如 fit()predict())之外使用第二种格式,例如在使用 Keras Functional API 创建自己的层或模型时,您可以使用三种可能性将所有输入张量收集到第一个位置参数中

  • 仅使用 input_ids 的单个张量,没有任何其他内容:model(input_ids)
  • 长度可变的列表,其中包含一个或多个输入张量,按照文档字符串中给出的顺序:model([input_ids, attention_mask])model([input_ids, attention_mask, token_type_ids])
  • 一个字典,其中一个或多个输入张量与文档字符串中给出的输入名称相关联:model({"input_ids": input_ids, "token_type_ids": token_type_ids})

请注意,当使用 子类化 创建模型和层时,您无需担心任何这些问题,因为您可以像传递给任何其他 Python 函数一样传递输入!

调用

< >

( input_ids: TFModelInputType | None = None attention_mask: tf.Tensor | None = None token_type_ids: tf.Tensor | None = None inputs_embeds: tf.Tensor | None = None output_attentions: bool | None = None output_hidden_states: bool | None = None return_dict: bool | None = None training: bool = False ) transformers.models.dpr.modeling_tf_dpr.TFDPRContextEncoderOutputtuple(tf.Tensor)

参数

  • input_ids (Numpy 数组tf.Tensor 形状为 (batch_size, sequence_length)) — 词汇表中输入序列标记的索引。为了匹配预训练,DPR 输入序列应以如下方式格式化 [CLS] 和 [SEP] 标记:

    (a) 对于序列对(例如,对于标题+文本对):

返回

transformers.models.dpr.modeling_tf_dpr.TFDPRContextEncoderOutputtuple(tf.Tensor)

一个 transformers.models.dpr.modeling_tf_dpr.TFDPRContextEncoderOutputtf.Tensor 的元组(如果传递了 return_dict=False 或当 config.return_dict=False 时),包含根据配置 (DPRConfig) 和输入而变化的各种元素。

  • pooler_output (tf.Tensor 形状为 (batch_size, embeddings_size)) — DPR 编码器输出 pooler_output,对应于上下文表示。序列第一个标记(分类标记)的最后一层隐藏状态,由线性层进一步处理。此输出用于将上下文嵌入到问题的嵌入中,以便进行最近邻查询。

  • hidden_states (tuple(tf.Tensor)可选,在传递 output_hidden_states=Trueconfig.output_hidden_states=True 时返回) — tf.Tensor 的元组(一个用于嵌入的输出 + 一个用于每一层的输出),形状为 (batch_size, sequence_length, hidden_size)

    模型在每一层输出处的隐藏状态加上初始嵌入输出。

  • attentions (tuple(tf.Tensor)可选,在传递 output_attentions=Trueconfig.output_attentions=True 时返回) — tf.Tensor 的元组(每一层一个),形状为 (batch_size, num_heads, sequence_length, sequence_length)

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

The TFDPRContextEncoder 正向方法覆盖了 __call__ 特殊方法。

尽管正向传递的步骤需要在此函数中定义,但之后应该调用 Module 实例而不是此函数,因为前者负责运行预处理和后处理步骤,而后者则默默地忽略它们。

示例

>>> from transformers import TFDPRContextEncoder, DPRContextEncoderTokenizer

>>> tokenizer = DPRContextEncoderTokenizer.from_pretrained("facebook/dpr-ctx_encoder-single-nq-base")
>>> model = TFDPRContextEncoder.from_pretrained("facebook/dpr-ctx_encoder-single-nq-base", from_pt=True)
>>> input_ids = tokenizer("Hello, is my dog cute ?", return_tensors="tf")["input_ids"]
>>> embeddings = model(input_ids).pooler_output

TFDPRQuestionEncoder

transformers.TFDPRQuestionEncoder

< >

( config: DPRConfig *args **kwargs )

参数

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

输出池化输出作为问题表示的基本 DPRQuestionEncoder 变压器。

此模型继承自 TFPreTrainedModel。查看超类文档以了解库为其所有模型实现的通用方法(例如下载或保存、调整输入嵌入大小、剪枝 head 等)。

此模型也是 Tensorflow keras.Model 的子类。将其用作常规的 TF 2.0 Keras 模型,并参考 TF 2.0 文档了解与一般用法和行为相关的所有事项。

transformers 中的 TensorFlow 模型和层接受两种格式作为输入

  • 将所有输入作为关键字参数(如 PyTorch 模型),或
  • 将所有输入作为列表、元组或字典放在第一个位置参数中。

支持第二种格式的原因是 Keras 方法在将输入传递给模型和层时更喜欢这种格式。由于这种支持,当使用 model.fit() 等方法时,事情应该“正常工作” - 只需以 model.fit() 支持的任何格式传递输入和标签即可!但是,如果您想在 Keras 方法(如 fit()predict())之外使用第二种格式,例如在使用 Keras Functional API 创建自己的层或模型时,您可以使用三种可能性将所有输入张量收集到第一个位置参数中

  • 仅使用 input_ids 的单个张量,没有任何其他内容:model(input_ids)
  • 长度可变的列表,其中包含一个或多个输入张量,按照文档字符串中给出的顺序:model([input_ids, attention_mask])model([input_ids, attention_mask, token_type_ids])
  • 一个字典,其中一个或多个输入张量与文档字符串中给出的输入名称相关联:model({"input_ids": input_ids, "token_type_ids": token_type_ids})

请注意,当使用 子类化 创建模型和层时,您无需担心任何这些问题,因为您可以像传递给任何其他 Python 函数一样传递输入!

调用

< >

( input_ids: TFModelInputType | None = None attention_mask: tf.Tensor | None = None token_type_ids: tf.Tensor | None = None inputs_embeds: tf.Tensor | None = None output_attentions: bool | None = None output_hidden_states: bool | None = None return_dict: bool | None = None training: bool = False ) transformers.models.dpr.modeling_tf_dpr.TFDPRQuestionEncoderOutputtuple(tf.Tensor)

参数

  • input_ids (Numpy 数组tf.Tensor 形状为 (batch_size, sequence_length)) — 词汇表中输入序列标记的索引。为了匹配预训练,DPR 输入序列应格式化为带有 [CLS] 和 [SEP] 标记,如下所示:

    (a) 对于序列对(例如,对于标题+文本对):

返回

transformers.models.dpr.modeling_tf_dpr.TFDPRQuestionEncoderOutputtuple(tf.Tensor)

一个 transformers.models.dpr.modeling_tf_dpr.TFDPRQuestionEncoderOutput 或一个 tf.Tensor 的元组(如果传递了 return_dict=False 或当 config.return_dict=False 时),包含根据配置 (DPRConfig) 和输入而变化的各种元素。

  • pooler_output (tf.Tensor 形状为 (batch_size, embeddings_size)) — DPR 编码器输出 pooler_output,它对应于问题表示。序列的第一个标记(分类标记)的最后一层隐藏状态,通过线性层进一步处理。此输出用于将问题嵌入到与上下文嵌入的最近邻查询中。

  • hidden_states (tuple(tf.Tensor)可选,在传递 output_hidden_states=Trueconfig.output_hidden_states=True 时返回) — tf.Tensor 的元组(一个用于嵌入的输出 + 一个用于每一层的输出),形状为 (batch_size, sequence_length, hidden_size)

    模型在每一层输出处的隐藏状态加上初始嵌入输出。

  • attentions (tuple(tf.Tensor)可选,在传递 output_attentions=Trueconfig.output_attentions=True 时返回) — tf.Tensor 的元组(每一层一个),形状为 (batch_size, num_heads, sequence_length, sequence_length)

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

TFDPRQuestionEncoder 的前向方法覆盖了 __call__ 特殊方法。

尽管正向传递的步骤需要在此函数中定义,但之后应该调用 Module 实例而不是此函数,因为前者负责运行预处理和后处理步骤,而后者则默默地忽略它们。

示例

>>> from transformers import TFDPRQuestionEncoder, DPRQuestionEncoderTokenizer

>>> tokenizer = DPRQuestionEncoderTokenizer.from_pretrained("facebook/dpr-question_encoder-single-nq-base")
>>> model = TFDPRQuestionEncoder.from_pretrained("facebook/dpr-question_encoder-single-nq-base", from_pt=True)
>>> input_ids = tokenizer("Hello, is my dog cute ?", return_tensors="tf")["input_ids"]
>>> embeddings = model(input_ids).pooler_output

TFDPRReader

transformers.TFDPRReader

< >

( config: DPRConfig *args **kwargs )

参数

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

输出跨度预测的裸 DPRReader 变换器。

此模型继承自 TFPreTrainedModel。查看超类文档以了解库为其所有模型实现的通用方法(例如下载或保存、调整输入嵌入大小、剪枝 head 等)。

此模型也是 Tensorflow keras.Model 的子类。将其用作常规的 TF 2.0 Keras 模型,并参考 TF 2.0 文档了解与一般用法和行为相关的所有事项。

transformers 中的 TensorFlow 模型和层接受两种格式作为输入

  • 将所有输入作为关键字参数(如 PyTorch 模型),或
  • 将所有输入作为列表、元组或字典放在第一个位置参数中。

支持第二种格式的原因是 Keras 方法在将输入传递给模型和层时更喜欢这种格式。由于这种支持,当使用 model.fit() 等方法时,事情应该“正常工作” - 只需以 model.fit() 支持的任何格式传递输入和标签即可!但是,如果您想在 Keras 方法(如 fit()predict())之外使用第二种格式,例如在使用 Keras Functional API 创建自己的层或模型时,您可以使用三种可能性将所有输入张量收集到第一个位置参数中

  • 仅使用 input_ids 的单个张量,没有任何其他内容:model(input_ids)
  • 长度可变的列表,其中包含一个或多个输入张量,按照文档字符串中给出的顺序:model([input_ids, attention_mask])model([input_ids, attention_mask, token_type_ids])
  • 一个字典,其中一个或多个输入张量与文档字符串中给出的输入名称相关联:model({"input_ids": input_ids, "token_type_ids": token_type_ids})

请注意,当使用 子类化 创建模型和层时,您无需担心任何这些问题,因为您可以像传递给任何其他 Python 函数一样传递输入!

调用

< >

( input_ids: TFModelInputType | None = None attention_mask: tf.Tensor | None = None inputs_embeds: tf.Tensor | None = None output_attentions: bool | None = None output_hidden_states: bool | None = None return_dict: bool | None = None training: bool = False ) transformers.models.dpr.modeling_tf_dpr.TFDPRReaderOutputtuple(tf.Tensor)

参数

  • input_ids (NumPy 数组tf.Tensor 形状为 (n_passages, sequence_length)) — 词汇表中输入序列标记的索引。它必须是一个包含以下三个部分的三元组序列:1)问题,2)段落标题和 3)段落文本。为了匹配预训练,DPR 的 input_ids 序列应以 [CLS] 和 [SEP] 格式化,格式如下:

    [CLS] <问题标记 ID> [SEP] <标题 ID> [SEP] <文本 ID>

    DPR 是一个使用绝对位置嵌入的模型,因此通常建议在右侧而不是左侧填充输入。

    可以使用 DPRReaderTokenizer 获取索引。有关更多详细信息,请参阅此类文档。

  • attention_mask (NumPy 数组tf.Tensor 形状为 (n_passages, sequence_length)可选) — 用于避免对填充标记索引执行注意力的掩码。掩码值选择在 [0, 1] 中:

    • 1 表示未掩码的标记,
    • 0 表示已掩码的标记。

    什么是注意力掩码?

  • inputs_embeds (NumPy 数组tf.Tensor 形状为 (n_passages, sequence_length, hidden_size)可选) — 可选地,您可以选择直接传递嵌入表示,而不是传递 input_ids。如果您希望比模型的内部嵌入查找矩阵更精细地控制如何将 input_ids 索引转换为关联向量,这将非常有用。
  • output_hidden_states (bool可选) — 是否返回所有层的隐藏状态。有关更多详细信息,请参阅返回张量下的 hidden_states。此参数只能在急切模式下使用,在图形模式下将使用配置中的值。
  • return_dict (bool可选) — 是否返回 ModelOutput 而不是普通元组。此参数可在急切模式下使用,在图形模式下,该值将始终设置为 True。
  • training (bool可选,默认为 False) — 是否以训练模式使用模型(某些模块,如 dropout 模块,在训练和评估之间具有不同的行为)。

返回

transformers.models.dpr.modeling_tf_dpr.TFDPRReaderOutputtuple(tf.Tensor)

一个 transformers.models.dpr.modeling_tf_dpr.TFDPRReaderOutput 或一个 tf.Tensor 的元组(如果传递了 return_dict=Falseconfig.return_dict=False 时),包含根据配置 (DPRConfig) 和输入而变化的各种元素。

  • start_logits (tf.Tensor 形状为 (n_passages, sequence_length)) — 每个段落跨度的起始索引的 logits。

  • end_logits (tf.Tensor 形状为 (n_passages, sequence_length)) — 每个段落跨度的结束索引的 logits。

  • relevance_logits (tf.Tensor 形状为 (n_passages, )) — DPRReader 的 QA 分类器的输出,对应于每个段落回答问题的得分,与所有其他段落相比。

  • hidden_states (tuple(tf.Tensor)可选,在传递 output_hidden_states=Trueconfig.output_hidden_states=True 时返回) — tf.Tensor 的元组(一个用于嵌入的输出 + 一个用于每一层的输出),形状为 (batch_size, sequence_length, hidden_size)

    模型在每一层输出处的隐藏状态加上初始嵌入输出。

  • attentions (tuple(torch.FloatTensor), 可选, 当传递 output_attentions=Trueconfig.output_attentions=True 时返回) — torch.FloatTensor 元组(每一层一个),形状为 (batch_size, num_heads, sequence_length, sequence_length)

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

The TFDPRReader 前向方法,覆盖了 __call__ 特殊方法。

尽管正向传递的步骤需要在此函数中定义,但之后应该调用 Module 实例而不是此函数,因为前者负责运行预处理和后处理步骤,而后者则默默地忽略它们。

示例

>>> from transformers import TFDPRReader, DPRReaderTokenizer

>>> tokenizer = DPRReaderTokenizer.from_pretrained("facebook/dpr-reader-single-nq-base")
>>> model = TFDPRReader.from_pretrained("facebook/dpr-reader-single-nq-base", from_pt=True)
>>> encoded_inputs = tokenizer(
...     questions=["What is love ?"],
...     titles=["Haddaway"],
...     texts=["'What Is Love' is a song recorded by the artist Haddaway"],
...     return_tensors="tf",
... )
>>> outputs = model(encoded_inputs)
>>> start_logits = outputs.start_logits
>>> end_logits = outputs.end_logits
>>> relevance_logits = outputs.relevance_logits
< > 在 GitHub 上更新