Transformers 文档

ProphetNet

Hugging Face's logo
加入 Hugging Face 社区

并获得增强型文档体验

开始使用

ProphetNet

Models Spaces

概述

ProphetNet 模型是在 ProphetNet: Predicting Future N-gram for Sequence-to-Sequence Pre-training 中提出的,由 Yu Yan、Weizhen Qi、Yeyun Gong、Dayiheng Liu、Nan Duan、Jiusheng Chen、Ruofei Zhang、Ming Zhou 于 2020 年 1 月 13 日发表。

ProphetNet 是一种编码器-解码器模型,可以预测“n 元语法”语言建模的 n 个未来标记,而不仅仅是下一个标记。

论文中的摘要如下

在本文中,我们提出了一种新的序列到序列预训练模型,称为 ProphetNet,它引入了名为未来 n 元语法预测的新型自监督目标以及提出的 n 流自注意力机制。与传统序列到序列模型中的一步预测优化不同,ProphetNet 通过 n 步预测进行优化,在每个时间步基于之前的上下文标记同时预测接下来的 n 个标记。未来 n 元语法预测明确地鼓励模型规划未来的标记并防止过度拟合强烈的局部相关性。我们分别使用基本规模数据集(16GB)和大型规模数据集(160GB)对 ProphetNet 进行预训练。然后,我们对 CNN/DailyMail、Gigaword 和 SQuAD 1.1 基准进行了实验,用于抽象摘要和问题生成任务。实验结果表明,与使用相同规模预训练语料库的模型相比,ProphetNet 在所有这些数据集上都取得了新的最先进的结果。

作者的代码可以在这里找到 这里

使用技巧

  • ProphetNet 是一种具有绝对位置嵌入的模型,因此通常建议在右侧而不是左侧填充输入。
  • 模型架构基于原始 Transformer,但用主自注意力机制和自注意力机制和 n 流(预测)自注意力机制替换了解码器中的“标准”自注意力机制。

资源

ProphetNetConfig

class transformers.ProphetNetConfig

< >

( activation_dropout: 可选 = 0.1 activation_function: 联合 = 'gelu' vocab_size: 可选 = 30522 hidden_size: 可选 = 1024 encoder_ffn_dim: 可选 = 4096 num_encoder_layers: 可选 = 12 num_encoder_attention_heads: 可选 = 16 decoder_ffn_dim: 可选 = 4096 num_decoder_layers: 可选 = 12 num_decoder_attention_heads: 可选 = 16 attention_dropout: 可选 = 0.1 dropout: 可选 = 0.1 max_position_embeddings: 可选 = 512 init_std: 可选 = 0.02 is_encoder_decoder: 可选 = True add_cross_attention: 可选 = True decoder_start_token_id: 可选 = 0 ngram: 可选 = 2 num_buckets: 可选 = 32 relative_max_distance: 可选 = 128 disable_ngram_loss: 可选 = False eps: 可选 = 0.0 use_cache: 可选 = True pad_token_id: 可选 = 0 bos_token_id: 可选 = 1 eos_token_id: 可选 = 2 **kwargs )

参数

  • activation_dropout (float, 可选, 默认为 0.1) — 全连接层中激活值的 dropout 比例。
  • activation_function (strfunction, 可选, 默认为 "gelu") — 编码器和池化层中的非线性激活函数(函数或字符串)。如果为字符串,则支持 "gelu""relu""silu""gelu_new"
  • vocab_size (int, 可选, 默认为 30522) — ProphetNET 模型的词汇量大小。定义了调用 ProphetNetModel 时传递的 inputs_ids 可以表示的不同标记的数量。
  • hidden_size (int, 可选, 默认为 1024) — 层和池化层的维度。
  • encoder_ffn_dim (int, 可选, 默认为 4096) — 解码器中“中间”(通常称为前馈)层的维度。
  • num_encoder_layers (int, 可选, 默认为 12) — 编码器层数。
  • num_encoder_attention_heads (int, 可选, 默认为 16) — Transformer 编码器中每个注意力层的注意力头数。
  • decoder_ffn_dim (int, 可选, 默认为 4096) — 解码器中 intermediate(通常称为前馈)层的维度。
  • num_decoder_layers (int, 可选, 默认为 12) — 解码器层的数量。
  • num_decoder_attention_heads (int, 可选, 默认为 16) — Transformer 解码器中每个注意力层的注意力头的数量。
  • attention_dropout (float, 可选, 默认为 0.1) — 注意力概率的 dropout 率。
  • dropout (float, 可选, 默认为 0.1) — 嵌入、编码器和池化器中所有全连接层的 dropout 概率。
  • max_position_embeddings (int, 可选, 默认为 512) — 该模型可能用到的最大序列长度。通常将其设置为一个较大的值,以防万一 (例如,512 或 1024 或 2048)。
  • init_std (float, 可选, 默认为 0.02) — 初始化所有权重矩阵的截断正态分布初始化器的标准差。
  • add_cross_attention (bool, 可选, 默认为 True) — 是否应将交叉注意力层添加到模型中。
  • is_encoder_decoder (bool, 可选, 默认为 True) — 这是否是一个编码器/解码器模型。
  • pad_token_id (int, 可选, 默认为 1) — 填充 token id。
  • bos_token_id (int, 可选, 默认为 0) — 流的开始 token id。
  • ngram (int, 可选, 默认为 2) — 要预测的未来标记数量。设置为 1 等同于传统的语言模型,预测下一个第一个标记。
  • num_buckets (int, 可选, 默认为 32) — 每个注意力层使用的桶的数量。这是用于相对位置计算。更多细节请参考 [T5 论文](参见 https://arxiv.org/abs/1910.10683)。
  • relative_max_distance (int, 可选, 默认为 128) — 大于此数字的相对距离将被放入最后一个相同的桶中。这是用于相对位置计算。更多细节请参考 [T5 论文](参见 https://arxiv.org/abs/1910.10683)。
  • disable_ngram_loss (bool, 可选, 默认为 False) — 是否只训练预测下一个第一个标记。
  • eps (float, 可选, 默认为 0.0) — 控制损失计算中标签平滑的 epsilon 参数值。如果设置为 0,则不执行标签平滑。
  • use_cache (bool, 可选, 默认为 True) — 模型是否应该返回最后的键值注意力(并非所有模型都使用)。

这是一个用于存储 ProphetNetModel 配置的配置类。它用于根据指定的参数实例化一个 ProphetNet 模型,定义模型架构。使用默认值实例化配置将生成与 ProphetNet microsoft/prophetnet-large-uncased 架构类似的配置。

配置对象继承自 PretrainedConfig,可用于控制模型输出。有关更多信息,请阅读 PretrainedConfig 的文档。

ProphetNetTokenizer

class transformers.ProphetNetTokenizer

< >

( vocab_file: str do_lower_case: Optional = True do_basic_tokenize: Optional = True never_split: Optional = None unk_token: Optional = '[UNK]' sep_token: Optional = '[SEP]' x_sep_token: Optional = '[X_SEP]' pad_token: Optional = '[PAD]' mask_token: Optional = '[MASK]' tokenize_chinese_chars: Optional = True strip_accents: Optional = 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, optional, defaults to "[SEP]") — 分隔符标记,在从多个序列构建序列时使用,例如两个用于序列分类的序列,或者一个文本和一个用于问答的提问。它也被用作使用特殊标记构建的序列的最后一个标记。
  • x_sep_token (str, optional, defaults to "[X_SEP]") — 特殊的第二个分隔符标记,可以由 ProphetNetForConditionalGeneration 生成。它用于在摘要中分隔类似于项目符号的句子,例如
  • pad_token (str, optional, defaults to "[PAD]") — 用于填充的标记,例如在批处理不同长度的序列时。
  • mask_token (str, optional, defaults to "[MASK]") — 用于屏蔽值的标记。这是在使用屏蔽语言建模训练此模型时使用的标记。这是模型将尝试预测的标记。
  • tokenize_chinese_chars (bool, optional, defaults to True) — 是否分词中文字符。

    对于日语,这可能应该被禁用(参见此 问题)。

  • strip_accents (bool, optional) — 是否去除所有音调符号。如果未指定此选项,则将由lowercase的值确定(与原始 BERT 一致)。

构建 ProphetNetTokenizer。基于 WordPiece。

此标记器继承自 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], optional) — 用于序列对的可选第二个 ID 列表。

返回

List[int]

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

通过连接和添加特殊标记,从用于序列分类任务的序列或序列对构建模型输入。BERT 序列具有以下格式

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

convert_tokens_to_string

< >

( tokens: str )

将一系列标记(字符串)转换为单个字符串。

create_token_type_ids_from_sequences

< >

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

参数

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

返回

List[int]

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

从传递的两个序列中创建一个掩码,用于在序列对分类任务中使用。ProphetNet

序列对掩码具有以下格式

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_1None,则此方法仅返回掩码的第一部分 (0s)。

get_special_tokens_mask

< >

( token_ids_0: List token_ids_1

参数

  • 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 方法添加特殊令牌时,会调用此方法。

ProphetNet 特定的输出

class transformers.models.prophetnet.modeling_prophetnet.ProphetNetSeq2SeqLMOutput

< >

( loss: Optional = None logits: FloatTensor = None logits_ngram: Optional = None past_key_values: Optional = None decoder_hidden_states: Optional = None decoder_ngram_hidden_states: Optional = None decoder_attentions: Optional = None decoder_ngram_attentions: Optional = None cross_attentions: Optional = None encoder_last_hidden_state: Optional = None encoder_hidden_states: Optional = None encoder_attentions: Optional = None )

参数

  • loss (torch.FloatTensor of shape (1,), optional, returned when labels is provided) — 语言建模损失。
  • logits (torch.FloatTensor of shape (batch_size, decoder_sequence_length, config.vocab_size)) — 主流语言建模头的预测分数(SoftMax 之前的每个词汇表令牌的分数)。
  • logits_ngram (torch.FloatTensor of shape (batch_size, ngram * decoder_sequence_length, config.vocab_size)) — 预测流语言建模头的预测分数(SoftMax 之前的每个词汇表令牌的分数)。
  • past_key_values (List[torch.FloatTensor], optional, returned when use_cache=True is passed or when config.use_cache=True) — 长度为 config.n_layerstorch.FloatTensor 列表,每个张量的形状为 (2, batch_size, num_attn_heads, decoder_sequence_length, embed_size_per_head))。

    包含预先计算的解码器隐藏状态(注意力块中的键和值),可

  • decoder_hidden_states (tuple(torch.FloatTensor), optional, returned when output_hidden_states=True is passed or when config.output_hidden_states=True) — 形状为(batch_size, decoder_sequence_length, hidden_size)torch.FloatTensor 元组(一个用于嵌入的输出 + 一个用于每一层的输出)。

    解码器主流程中每一层的输出隐藏状态以及初始嵌入输出。

  • decoder_ngram_hidden_states (tuple(torch.FloatTensor), optional, returned when output_hidden_states=True is passed or when config.output_hidden_states=True) — 形状为(batch_size, ngram * decoder_sequence_length, hidden_size)torch.FloatTensor 元组(一个用于嵌入的输出 + 一个用于每一层的输出)。

    解码器预测流程中每一层的输出隐藏状态以及初始嵌入输出。

  • decoder_attentions (tuple(torch.FloatTensor), optional, returned when output_attentions=True is passed or when config.output_attentions=True) — 形状为(batch_size, num_attn_heads, decoder_sequence_length, decoder_sequence_length)torch.FloatTensor 元组(每一层一个)。

    解码器的注意力权重,经过注意力 softmax 后,用于计算自注意力头的加权平均值。

  • decoder_ngram_attentions (tuple(torch.FloatTensor), optional, returned when output_attentions=True is passed or when config.output_attentions=True) — 形状为(batch_size, num_attn_heads, decoder_sequence_length, decoder_sequence_length)torch.FloatTensor 元组(每一层一个)。

    解码器预测流程的注意力权重,经过注意力 softmax 后,用于计算自注意力头的加权平均值。

  • cross_attentions (tuple(torch.FloatTensor), optional, returned when output_attentions=True is passed or when config.output_attentions=True) — 形状为(batch_size, num_attn_heads, encoder_sequence_length, decoder_sequence_length)torch.FloatTensor 元组(每一层一个)。

    解码器交叉注意力层的注意力权重,经过注意力 softmax 后,用于计算

  • encoder_last_hidden_state (形状为(batch_size, encoder_sequence_length, hidden_size)torch.FloatTensor, optional) — 模型编码器最后一层的输出隐藏状态序列。
  • encoder_hidden_states (tuple(torch.FloatTensor), optional, returned when output_hidden_states=True is passed or when config.output_hidden_states=True) — 形状为(batch_size, encoder_sequence_length, hidden_size)torch.FloatTensor 元组(一个用于嵌入的输出 + 一个用于每一层的输出)。

    编码器中每一层的输出隐藏状态以及初始嵌入输出。

  • encoder_attentions (tuple(torch.FloatTensor), optional, returned when output_attentions=True is passed or when config.output_attentions=True) — 形状为(batch_size, num_attn_heads, encoder_sequence_length, encoder_sequence_length)torch.FloatTensor 元组(每一层一个)。编码器的注意力权重,经过注意力 softmax 后,用于计算自注意力头的加权平均值。

序列到序列语言模型输出的基类。

class transformers.models.prophetnet.modeling_prophetnet.ProphetNetSeq2SeqModelOutput

< >

( last_hidden_state: FloatTensor last_hidden_state_ngram: Optional = None past_key_values: Optional = None decoder_hidden_states: Optional = None decoder_ngram_hidden_states: Optional = None decoder_attentions: Optional = None decoder_ngram_attentions: Optional = None cross_attentions: Optional = None encoder_last_hidden_state: Optional = None encoder_hidden_states: Optional = None encoder_attentions: Optional = None )

参数

  • last_hidden_state (torch.FloatTensor 形状为 (batch_size, decoder_sequence_length, hidden_size)) — 模型解码器最后一层输出的 主流隐藏状态序列。

    如果使用 past_key_values,则仅输出形状为 (batch_size, 1, hidden_size) 的序列的最后一个隐藏状态。

  • last_hidden_state_ngram (torch.FloatTensor 形状为 (batch_size,ngram * decoder_sequence_length, config.vocab_size), 可选) — 模型解码器最后一层输出的预测流隐藏状态序列。
  • past_key_values (List[torch.FloatTensor], 可选,当传递 use_cache=Trueconfig.use_cache=True 时返回) — 长度为 config.n_layerstorch.FloatTensor 列表,每个张量的形状为 (2, batch_size, num_attn_heads, decoder_sequence_length, embed_size_per_head))。

    包含解码器中预先计算的隐藏状态(注意力块中的键和值),可以用于(参见 past_key_values 输入)加速顺序解码。

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

    解码器的主流在每一层输出的隐藏状态加上初始嵌入输出。

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

    解码器的预测流在每一层输出的隐藏状态加上初始嵌入输出。

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

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

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

    解码器的预测流的注意力权重,在注意力 softmax 之后,用于计算加权平均值

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

    解码器的交叉注意力层的注意力权重,在注意力 softmax 之后,用于计算加权平均值

  • encoder_last_hidden_state (torch.FloatTensor 形状为 (batch_size, encoder_sequence_length, hidden_size), 可选) — 模型编码器最后一层输出的隐藏状态序列。
  • encoder_hidden_states (tuple(torch.FloatTensor), 可选,当传递 output_hidden_states=Trueconfig.output_hidden_states=True 时返回) — 形状为 (batch_size, encoder_sequence_length, hidden_size)torch.FloatTensor 元组(一个用于嵌入输出,一个用于每一层的输出)。

    编码器在每一层输出的隐藏状态加上初始嵌入输出。

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

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

模型编码器输出的基类,还包含:预先计算的隐藏状态,可以加速顺序解码。

class transformers.models.prophetnet.modeling_prophetnet.ProphetNetDecoderModelOutput

< >

( last_hidden_state: FloatTensor last_hidden_state_ngram: Optional = None past_key_values: Optional = None hidden_states: Optional = None hidden_states_ngram: Optional = None attentions: Optional = None ngram_attentions: Optional = None cross_attentions: Optional = None )

参数

  • last_hidden_state (torch.FloatTensor 形状为 (batch_size, decoder_sequence_length, hidden_size)) — 模型解码器最后一层输出的主流隐藏状态序列。

    如果使用 past_key_values,则仅输出形状为 (batch_size, 1, hidden_size) 的序列的最后一个隐藏状态。

  • last_hidden_state_ngram (torch.FloatTensor 形状为 (batch_size, ngram * decoder_sequence_length, config.vocab_size)) — 模型解码器最后一层输出的预测流隐藏状态序列。
  • past_key_values (List[torch.FloatTensor], 可选,当传递 use_cache=Trueconfig.use_cache=True 时返回) — 长度为 config.n_layerstorch.FloatTensor 列表,每个张量形状为 (2, batch_size, num_attn_heads, decoder_sequence_length, embed_size_per_head)).

    包含解码器预先计算的隐藏状态(注意力块中的键和值),可以用来(见 past_key_values 输入)加速顺序解码。

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

    解码器主流在每一层输出的隐藏状态加上初始嵌入输出。

  • ngram_hidden_states (tuple(torch.FloatTensor), 可选,当 output_hidden_states=True 传入或 config.output_hidden_states=True 时返回) — 形状为 (batch_size, ngram * decoder_sequence_length, hidden_size)torch.FloatTensor 元组(一个用于嵌入的输出,一个用于每一层的输出)。

    解码器预测流在每一层输出的隐藏状态,加上初始嵌入输出。

  • attentions (tuple(torch.FloatTensor), 可选,当 output_attentions=True 传入或 config.output_attentions=True 时返回) — 形状为 (batch_size, num_attn_heads, decoder_sequence_length, decoder_sequence_length)torch.FloatTensor 元组(每一层一个)。

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

  • ngram_attentions (tuple(torch.FloatTensor), 可选,当 output_attentions=True 传入或 config.output_attentions=True 时返回) — 形状为 (batch_size, num_attn_heads, decoder_sequence_length, decoder_sequence_length)torch.FloatTensor 元组(每一层一个)。

    解码器预测流在注意力softmax之后的注意力权重,用于计算加权平均值。

  • cross_attentions (tuple(torch.FloatTensor), 可选,当 output_attentions=True 传入或 config.output_attentions=True 时返回) — 形状为 (batch_size, num_attn_heads, encoder_sequence_length, decoder_sequence_length)torch.FloatTensor 元组(每一层一个)。

    解码器交叉注意力层的注意力权重,在注意力softmax之后,用于计算加权平均值。

模型输出的基类,也可以包含过去的键/值(以加快顺序解码)。

class transformers.models.prophetnet.modeling_prophetnet.ProphetNetDecoderLMOutput

< >

( loss: Optional = None logits: FloatTensor = None logits_ngram: Optional = None past_key_values: Optional = None hidden_states: Optional = None hidden_states_ngram: Optional = None attentions: Optional = None ngram_attentions: Optional = None cross_attentions: Optional = None )

参数

  • loss (形状为 (1,)torch.FloatTensor可选,当 labels 被提供时返回) — 语言建模损失。
  • logits (形状为 (batch_size, decoder_sequence_length, config.vocab_size)torch.FloatTensor) — 主流语言建模头的预测分数(SoftMax之前的每个词汇表令牌的分数)。
  • logits_ngram (形状为 (batch_size, ngram * decoder_sequence_length, config.vocab_size)torch.FloatTensor) — 预测流语言建模头的预测分数(SoftMax之前的每个词汇表令牌的分数)。
  • past_key_values (List[torch.FloatTensor], optional, 返回当 use_cache=True 传递或当 config.use_cache=True 时) — 长度为 config.n_layerstorch.FloatTensor 列表,每个张量形状为 (2, batch_size, num_attn_heads, decoder_sequence_length, embed_size_per_head)).

    包含解码器预先计算的隐藏状态(注意力块中的键和值),可以用于(参见 past_key_values 输入)加速顺序解码。

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

    解码器主干流在每一层输出的隐藏状态,加上初始嵌入输出。

  • ngram_hidden_states (tuple(torch.FloatTensor), optional, 返回当 output_hidden_states=True 传递或当 config.output_hidden_states=True 时) — torch.FloatTensor 元组(一个用于嵌入的输出 + 一个用于每一层的输出)形状为 (batch_size, ngram * decoder_sequence_length, hidden_size).

    解码器预测流在每一层输出的隐藏状态,加上初始嵌入输出。

  • attentions (tuple(torch.FloatTensor), optional, 返回当 output_attentions=True 传递或当 config.output_attentions=True 时) — torch.FloatTensor 元组(每一层一个)形状为 (batch_size, num_attn_heads, decoder_sequence_length, decoder_sequence_length).

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

  • ngram_attentions (tuple(torch.FloatTensor), optional, 返回当 output_attentions=True 传递或当 config.output_attentions=True 时) — torch.FloatTensor 元组(每一层一个)形状为 (batch_size, num_attn_heads, decoder_sequence_length, decoder_sequence_length).

    解码器预测流的注意力权重,在注意力 softmax 之后,用于计算加权平均值。

  • cross_attentions (tuple(torch.FloatTensor), optional, 返回当 output_attentions=True 传递或当 config.output_attentions=True 时) — torch.FloatTensor 元组(每一层一个)形状为 (batch_size, num_attn_heads, encoder_sequence_length, decoder_sequence_length).

    解码器交叉注意力层的注意力权重,在注意力 softmax 之后,用于计算加权平均值。

模型输出的基类,也可以包含过去的键/值(以加快顺序解码)。

ProphetNetModel

class transformers.ProphetNetModel

< >

( config: ProphetNetConfig )

参数

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

ProphetNet 模型基础,输出原始隐藏状态,没有任何特定的头部。此模型继承自 PreTrainedModel。查看超类文档以获取库为其所有模型实现的通用方法(例如下载或保存、调整输入嵌入的大小、修剪头等)。

ProphetNet 原始代码可以在 这里找到。检查点是从原始 Fairseq 检查点转换而来。有关检查点转换的更多信息,请查看文件 convert_prophetnet_original_pytorch_checkpoint_to_pytorch.py

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

forward

< >

( input_ids: Optional = None attention_mask: Optional = None decoder_input_ids: Optional = None decoder_attention_mask: Optional = None head_mask: Optional = None decoder_head_mask: Optional = None cross_attn_head_mask: Optional = None encoder_outputs: Optional = None past_key_values: Optional = None inputs_embeds: Optional = None decoder_inputs_embeds: Optional = None use_cache: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) transformers.models.prophetnet.modeling_prophetnet.ProphetNetSeq2SeqModelOutputtuple(torch.FloatTensor)

参数

  • input_ids (torch.LongTensor 形状为 (batch_size, sequence_length)) — 词汇表中输入序列标记的索引。如果您提供填充,默认情况下将忽略填充。

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

    什么是输入 ID?

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

    • 1 表示未屏蔽的标记,
    • 0 表示屏蔽的标记。

    什么是注意力掩码?

  • decoder_input_ids (torch.LongTensor 形状为 (batch_size, target_sequence_length)可选) — 词汇表中解码器输入序列标记的索引。

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

    什么是解码器输入 ID?

    ProphetNet 使用 eos_token_id 作为 decoder_input_ids 生成中的起始标记。如果使用 past_key_values,可选地只需要输入最后一个 decoder_input_ids(参见 past_key_values)。

  • decoder_attention_mask (torch.BoolTensor 形状为 (batch_size, target_sequence_length)可选) — 默认行为:生成一个忽略 decoder_input_ids 中填充标记的张量。因果掩码也会默认使用。
  • head_mask (torch.Tensor 形状为 (encoder_layers, encoder_attention_heads)可选) — 掩码,用于使编码器中注意力模块的选定头部无效。在 [0, 1] 中选择掩码值:

    • 1 表示未屏蔽的头部,
    • 0 表示屏蔽的头部。
  • decoder_head_mask (torch.Tensor 形状为 (decoder_layers, decoder_attention_heads)可选) — 掩码,用于使解码器中注意力模块的选定头部无效。在 [0, 1] 中选择掩码值:

    • 1 表示未屏蔽的头部,
    • 0 表示屏蔽的头部。
  • cross_attn_head_mask (torch.Tensor 形状为 (decoder_layers, decoder_attention_heads), 可选) — 用于使交叉注意力模块的选定头部失效的掩码。掩码值在 [0, 1] 中选择:

    • 1 表示头部未被掩码
    • 0 表示头部被掩码
  • encoder_outputs (tuple(tuple(torch.FloatTensor), 可选) — 元组包含 (last_hidden_state, 可选: hidden_states, 可选: attentions) last_hidden_state 形状为 (batch_size, sequence_length, hidden_size), 可选) 是编码器最后一层输出的隐藏状态序列。用于解码器的交叉注意力。
  • past_key_values (tuple(tuple(torch.FloatTensor)) 长度为 config.n_layers, 每个元组包含 4 个形状为 (batch_size, num_heads, sequence_length - 1, embed_size_per_head) 的张量) — 包含预先计算的注意力块的键和值隐藏状态。可用于加快解码速度。

    如果使用 past_key_values,用户可以选择性地仅输入形状为 (batch_size, 1) 的最后一个 decoder_input_ids(其过去键值状态未提供给此模型)而不是形状为 (batch_size, sequence_length) 的所有 decoder_input_ids

  • use_cache (bool, 可选) — 如果设置为 True,则返回 past_key_values 键值状态,可用于加快解码速度(参见 past_key_values)。
  • output_attentions (bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息,请参见返回张量中的 attentions
  • output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息,请参见返回张量中的 hidden_states
  • return_dict (bool, 可选) — 是否返回一个 ModelOutput 而不是一个普通元组。

返回

transformers.models.prophetnet.modeling_prophetnet.ProphetNetSeq2SeqModelOutputtuple(torch.FloatTensor)

一个 transformers.models.prophetnet.modeling_prophetnet.ProphetNetSeq2SeqModelOutputtorch.FloatTensor 的元组(如果传递了 return_dict=False 或当 config.return_dict=False 时),包括取决于配置 (ProphenetConfig) 和输入的各种元素。

  • last_hidden_state (torch.FloatTensor 形状为 (batch_size, decoder_sequence_length, hidden_size)) — 模型解码器最后一层的输出处的序列主干隐藏状态。

    如果使用 past_key_values,则仅输出形状为 (batch_size, 1, hidden_size) 的序列的最后一个隐藏状态。

  • last_hidden_state_ngram (torch.FloatTensor 形状为 (batch_size,ngram * decoder_sequence_length, config.vocab_size), 可选) — 模型解码器最后一层的输出处的序列预测流隐藏状态。

  • past_key_values (List[torch.FloatTensor], 可选, 当传递 use_cache=True 或当 config.use_cache=True 时返回) — torch.FloatTensor 的列表,长度为 config.n_layers,每个张量形状为 (2, batch_size, num_attn_heads, decoder_sequence_length, embed_size_per_head)).

    包含预先计算的解码器隐藏状态(注意力块中的键和值),可用于(参见 past_key_values 输入)加速顺序解码。

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

    解码器主干在每一层输出处的隐藏状态加上初始嵌入输出。

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

    解码器预测流在每一层输出处的隐藏状态加上初始嵌入输出。

  • decoder_attentions (tuple(torch.FloatTensor), 可选, 当传递 output_attentions=True 或当 config.output_attentions=True 时返回) — torch.FloatTensor 的元组(每一层一个),形状为 (batch_size, num_attn_heads, decoder_sequence_length, decoder_sequence_length)

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

  • decoder_ngram_attentions (tuple(torch.FloatTensor), 可选, 当传递 output_attentions=True 或当 config.output_attentions=True 时返回) — torch.FloatTensor 的元组(每一层一个),形状为 (batch_size, num_attn_heads, decoder_sequence_length, decoder_sequence_length)

    解码器预测流的注意力权重,在注意力 softmax 之后,用于计算

  • cross_attentions (tuple(torch.FloatTensor), 可选, 当传递 output_attentions=True 或当 config.output_attentions=True 时返回) — torch.FloatTensor 的元组(每一层一个),形状为 (batch_size, num_attn_heads, encoder_sequence_length, decoder_sequence_length)

    解码器交叉注意力层的注意力权重,在注意力 softmax 之后,用于计算

  • encoder_last_hidden_state (torch.FloatTensor 形状为 (batch_size, encoder_sequence_length, hidden_size), 可选) — 模型编码器最后一层的输出处的隐藏状态序列。

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

    编码器在每一层输出处的隐藏状态加上初始嵌入输出。

  • encoder_attentions (tuple(torch.FloatTensor), 可选, 当传入 output_attentions=Trueconfig.output_attentions=True 时返回) — 形状为 (batch_size, num_attn_heads, encoder_sequence_length, encoder_sequence_length)torch.FloatTensor 元组(每个层一个)。

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

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

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

示例

>>> from transformers import AutoTokenizer, ProphetNetModel

>>> tokenizer = AutoTokenizer.from_pretrained("microsoft/prophetnet-large-uncased")
>>> model = ProphetNetModel.from_pretrained("microsoft/prophetnet-large-uncased")

>>> input_ids = tokenizer(
...     "Studies have been shown that owning a dog is good for you", return_tensors="pt"
... ).input_ids  # Batch size 1
>>> decoder_input_ids = tokenizer("Studies show that", return_tensors="pt").input_ids  # Batch size 1
>>> outputs = model(input_ids=input_ids, decoder_input_ids=decoder_input_ids)

>>> last_hidden_states = outputs.last_hidden_state  # main stream hidden states
>>> last_hidden_states_ngram = outputs.last_hidden_state_ngram  # predict hidden states

ProphetNetEncoder

class transformers.ProphetNetEncoder

< >

( config: ProphetNetConfig word_embeddings: Embedding = None )

参数

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

ProphetNetModel 的独立编码器部分。 此模型继承自 PreTrainedModel。 检查超类文档以了解库为所有模型实现的通用方法(例如下载或保存、调整输入嵌入的大小、修剪头等)。

ProphetNet 原始代码可以在 这里找到。检查点是从原始 Fairseq 检查点转换而来。有关检查点转换的更多信息,请查看文件 convert_prophetnet_original_pytorch_checkpoint_to_pytorch.py

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

word_embeddings (形状为 (config.vocab_size, config.hidden_size)torch.nn.Embeddings, 可选): 词嵌入参数。 这可以用于用预定义的词嵌入而不是随机初始化的词嵌入来初始化 ProphetNetEncoder

forward

< >

( input_ids: Optional = None attention_mask: Optional = None head_mask: Optional = None inputs_embeds: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) transformers.modeling_outputs.BaseModelOutputtuple(torch.FloatTensor)

参数

  • input_ids (形状为 (batch_size, sequence_length)torch.LongTensor) — 词汇表中输入序列标记的索引。 如果您提供填充,默认情况下会忽略填充。

    可以使用 AutoTokenizer 获取索引。 查看 PreTrainedTokenizer.encode()PreTrainedTokenizer.call() 获取详细信息。

    什么是输入 ID?

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

    • 1 表示标记未被掩码
    • 0 表示标记被掩码

    什么是注意力掩码?

  • head_mask (形状为 (encoder_layers, encoder_attention_heads)torch.Tensor, 可选) — 掩码以使编码器中注意力模块的选定头无效。 在 [0, 1] 中选择掩码值:

    • 1 表示头未被掩码
    • 0 表示头被掩码
  • output_attentions (bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息,请参阅返回张量中的 attentions
  • output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息,请参阅返回张量中的 hidden_states
  • return_dict (bool, 可选) — 是否返回一个 ModelOutput 而不是一个简单的元组。

返回

transformers.modeling_outputs.BaseModelOutputtuple(torch.FloatTensor)

一个 transformers.modeling_outputs.BaseModelOutputtorch.FloatTensor 的元组(如果传递了 return_dict=Falseconfig.return_dict=False),包含取决于配置 (ProphenetConfig) 和输入的不同元素。

  • last_hidden_state (torch.FloatTensor 形状为 (batch_size, sequence_length, hidden_size)) — 模型最后一层的输出处的隐藏状态序列。

  • 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 ProphetNetEncoder forward 方法,覆盖了 __call__ 特殊方法。

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

示例

>>> from transformers import AutoTokenizer, ProphetNetEncoder
>>> import torch

>>> tokenizer = AutoTokenizer.from_pretrained("microsoft/prophetnet-large-uncased")
>>> model = ProphetNetEncoder.from_pretrained("patrickvonplaten/prophetnet-large-uncased-standalone")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")
>>> outputs = model(**inputs)

>>> last_hidden_states = outputs.last_hidden_state

ProphetNetDecoder

class transformers.ProphetNetDecoder

< >

( config: ProphetNetConfig word_embeddings: Optional = None )

参数

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

ProphetNetModel 的独立解码器部分。该模型继承自 PreTrainedModel。查看超类文档以了解库为其所有模型实现的通用方法(例如下载或保存、调整输入嵌入的大小、剪枝头等)。

ProphetNet 原始代码可以在 这里找到。检查点是从原始 Fairseq 检查点转换而来。有关检查点转换的更多信息,请查看文件 convert_prophetnet_original_pytorch_checkpoint_to_pytorch.py

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

word_embeddings (形状为 (config.vocab_size, config.hidden_size)torch.nn.Embeddings, 可选): 词嵌入参数。 这可以用于用预定义的词嵌入而不是随机初始化的词嵌入来初始化 ProphetNetEncoder

forward

< >

( input_ids: Optional = None attention_mask: Optional = None encoder_hidden_states: Optional = None encoder_attention_mask: Optional = None head_mask: Optional = None cross_attn_head_mask: Optional = None past_key_values: Optional = None inputs_embeds: Optional = None use_cache: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) transformers.models.prophetnet.modeling_prophetnet.ProphetNetDecoderModelOutputtuple(torch.FloatTensor)

参数

  • input_ids (torch.LongTensor 形状为 (batch_size, sequence_length)) — 词汇表中输入序列标记的索引。如果您提供填充,默认情况下将忽略填充。

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

    什么是输入 ID?

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

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

    什么是注意力掩码?

  • head_mask (torch.Tensor 形状为 (encoder_layers, encoder_attention_heads), 可选) — 掩码,用于使编码器中注意力模块的选定头部无效。掩码值选择在 [0, 1] 中:

    • 1 表示头部未被掩码
    • 0 表示头部被掩码
  • output_attentions (bool, 可选) — 是否返回所有注意力层的注意力张量。有关详细信息,请参阅返回张量中的 attentions
  • output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。有关详细信息,请参阅返回张量中的 hidden_states
  • return_dict (bool, 可选) — 是否返回 ModelOutput 而不是普通元组。
  • encoder_hidden_states (torch.FloatTensor 形状为 (batch_size, sequence_length, hidden_size), 可选) — 编码器最后一层输出的隐藏状态序列。如果模型配置为解码器,则在交叉注意力中使用。
  • encoder_attention_mask (torch.FloatTensor 形状为 (batch_size, sequence_length), 可选) — 掩码,用于避免对编码器输入的填充标记索引执行注意力。如果模型配置为解码器,则在交叉注意力中使用。掩码值选择在 [0, 1] 中:
  • cross_attn_head_mask (torch.Tensor 形状为 (decoder_layers, decoder_attention_heads), 可选) — 掩码,用于使交叉注意力模块的选定头部无效。掩码值选择在 [0, 1] 中:

    • 1 表示头部未被掩码
    • 0 表示头部被掩码
  • past_key_values (tuple(tuple(torch.FloatTensor)) 长度为 config.n_layers,每个元组包含 4 个形状为 (batch_size, num_heads, sequence_length - 1, embed_size_per_head) 的张量) — 包含预先计算的注意力块的关键值隐藏状态。可用于加速解码。

    如果使用 past_key_values,用户可以选择仅输入最后一个 decoder_input_ids(那些没有提供其过去关键值状态的 id)形状为 (batch_size, 1),而不是所有 decoder_input_ids 形状为 (batch_size, sequence_length)

  • use_cache (bool, 可选) — 如果设置为 True,将返回 past_key_values 键值状态,可用于加速解码(参见 past_key_values)。

    • 1 用于未屏蔽的 token,
    • 0 用于屏蔽的 token。

返回

transformers.models.prophetnet.modeling_prophetnet.ProphetNetDecoderModelOutputtuple(torch.FloatTensor)

一个 transformers.models.prophetnet.modeling_prophetnet.ProphetNetDecoderModelOutput 或者一个 torch.FloatTensor 元组(如果传递 return_dict=Falseconfig.return_dict=False),包含各种元素,具体取决于配置 (ProphenetConfig) 和输入。

  • last_hidden_state (torch.FloatTensor 形状为 (batch_size, decoder_sequence_length, hidden_size)) — 模型解码器最后一层的输出处的序列主干隐藏状态。

    如果使用 past_key_values,则仅输出形状为 (batch_size, 1, hidden_size) 的序列的最后一个隐藏状态。

  • last_hidden_state_ngram (torch.FloatTensor 形状为 (batch_size, ngram * decoder_sequence_length, config.vocab_size)) — 模型解码器最后一层的预测流隐藏状态序列。

  • past_key_values (List[torch.FloatTensor], 可选, 当传递 use_cache=True 或当 config.use_cache=True 时返回) — torch.FloatTensor 的列表,长度为 config.n_layers,每个张量形状为 (2, batch_size, num_attn_heads, decoder_sequence_length, embed_size_per_head)).

    包含预先计算的解码器隐藏状态(注意力块中的键和值),可用于(参见 past_key_values 输入)加速顺序解码。

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

    解码器主干在每一层输出处的隐藏状态加上初始嵌入输出。

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

    解码器预测流在每一层输出处的隐藏状态加上初始嵌入输出。

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

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

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

    解码器预测流的注意力权重,在注意力 softmax 之后,用于计算

  • cross_attentions (tuple(torch.FloatTensor), 可选, 当传递 output_attentions=True 或当 config.output_attentions=True 时返回) — torch.FloatTensor 的元组(每一层一个),形状为 (batch_size, num_attn_heads, encoder_sequence_length, decoder_sequence_length)

    解码器交叉注意力层的注意力权重,在注意力 softmax 之后,用于计算

The ProphetNetDecoder 正向方法,覆盖 __call__ 特殊方法。

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

示例

>>> from transformers import AutoTokenizer, ProphetNetDecoder
>>> import torch

>>> tokenizer = AutoTokenizer.from_pretrained("microsoft/prophetnet-large-uncased")
>>> model = ProphetNetDecoder.from_pretrained("microsoft/prophetnet-large-uncased", add_cross_attention=False)
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")
>>> outputs = model(**inputs)

>>> last_hidden_states = outputs.last_hidden_state

ProphetNetForConditionalGeneration

class transformers.ProphetNetForConditionalGeneration

< >

( config: ProphetNetConfig )

参数

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

带有语言模型头的 ProphetNet 模型。可用于序列生成任务。此模型继承自 PreTrainedModel。查看超类文档,了解库为所有模型实现的通用方法(例如下载或保存、调整输入嵌入大小、修剪 head 等)。

ProphetNet 原始代码可以在 这里找到。检查点是从原始 Fairseq 检查点转换而来。有关检查点转换的更多信息,请查看文件 convert_prophetnet_original_pytorch_checkpoint_to_pytorch.py

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

forward

< >

( input_ids: Optional = None attention_mask: Optional = None decoder_input_ids: Optional = None decoder_attention_mask: Optional = None head_mask: Optional = None decoder_head_mask: Optional = None cross_attn_head_mask: Optional = None encoder_outputs: Optional = None past_key_values: Optional = None inputs_embeds: Optional = None decoder_inputs_embeds: Optional = None labels: Optional = None use_cache: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) transformers.models.prophetnet.modeling_prophetnet.ProphetNetSeq2SeqLMOutput or tuple(torch.FloatTensor)

参数

  • input_ids (torch.LongTensor 形状为 (batch_size, sequence_length)) — 词汇表中输入序列标记的索引。默认情况下,如果您提供填充,填充将被忽略。

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

    什么是输入 ID?

  • attention_mask (torch.Tensor 形状为 (batch_size, sequence_length), 可选) — 掩码以避免在填充标记索引上执行注意力。在 [0, 1] 中选择掩码值:

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

    什么是注意力掩码?

  • decoder_input_ids (torch.LongTensor 形状为 (batch_size, target_sequence_length), 可选) — 词汇表中解码器输入序列标记的索引。

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

    什么是解码器输入 ID?

    ProphetNet 使用 eos_token_id 作为 decoder_input_ids 生成的起始标记。如果使用 past_key_values,则可以选择仅输入最后一个 decoder_input_ids(请参阅 past_key_values)。

  • decoder_attention_mask (torch.BoolTensor 形状为 (batch_size, target_sequence_length), 可选) — 默认行为:生成一个忽略 decoder_input_ids 中的填充标记的张量。因果掩码也会默认使用。
  • head_mask (torch.Tensor 形状为 (encoder_layers, encoder_attention_heads), 可选) — 掩码以使编码器中注意力模块的选定头部无效。在 [0, 1] 中选择掩码值:

    • 1 表示头部 未掩码
    • 0 表示头部 掩码
  • decoder_head_mask (torch.Tensor 形状为 (decoder_layers, decoder_attention_heads), 可选) — 掩码以使解码器中注意力模块的选定头部无效。在 [0, 1] 中选择掩码值:

    • 1 表示头部 未掩码
    • 0 表示头部 掩码
  • cross_attn_head_mask (torch.Tensor 形状为 (decoder_layers, decoder_attention_heads), 可选) — 掩码以使交叉注意力模块的选定头部无效。在 [0, 1] 中选择掩码值:

    • 1 表示头部 未掩码
    • 0 表示头部 掩码
  • encoder_outputs (tuple(tuple(torch.FloatTensor), optional) — 元组包含 (last_hidden_state, 可选: hidden_states, 可选: attentions) last_hidden_state 的形状为 (batch_size, sequence_length, hidden_size), 可选) 是编码器最后一层输出的隐藏状态序列。用于解码器的交叉注意力。
  • past_key_values (tuple(tuple(torch.FloatTensor)) 长度为 config.n_layers,每个元组包含 4 个形状为 (batch_size, num_heads, sequence_length - 1, embed_size_per_head) 的张量) — 包含注意力块的预计算键和值隐藏状态。可用于加快解码速度。

    如果使用 past_key_values,用户可以选择只输入最后的 decoder_input_ids(没有提供其过去键值状态的那些)形状为 (batch_size, 1),而不是所有 decoder_input_ids 的形状为 (batch_size, sequence_length)

  • use_cache (bool, 可选) — 如果设置为 True,则会返回 past_key_values 键值状态,可用于加快解码速度(参见 past_key_values)。
  • output_attentions (bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息,请参见返回张量中的 attentions
  • output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息,请参见返回张量中的 hidden_states
  • return_dict (bool, 可选) — 是否返回 ModelOutput 而不是普通元组。
  • labels (torch.LongTensor 形状为 (batch_size,), 可选) — 用于计算序列分类/回归损失的标签。索引应在 [-100, 0, ..., config.vocab_size - 1] 中。所有设置为 -100 的标签都将被忽略(屏蔽),损失仅针对 [0, ..., config.vocab_size] 中的标签计算。

返回

transformers.models.prophetnet.modeling_prophetnet.ProphetNetSeq2SeqLMOutputtuple(torch.FloatTensor)

一个 transformers.models.prophetnet.modeling_prophetnet.ProphetNetSeq2SeqLMOutput 或一个 torch.FloatTensor 元组(如果传递了 return_dict=Falseconfig.return_dict=False 时),包含根据配置(ProphenetConfig)和输入的不同元素。

  • loss (torch.FloatTensor 形状为 (1,), 可选, 当提供 labels 时返回) — 语言建模损失。

  • logits (torch.FloatTensor 形状为 (batch_size, decoder_sequence_length, config.vocab_size)) — 主流语言建模头的预测分数(SoftMax 之前每个词汇表标记的分数)。

  • logits_ngram (torch.FloatTensor 形状为 (batch_size, ngram * decoder_sequence_length, config.vocab_size)) — 预测流语言建模头的预测分数(SoftMax 之前每个词汇表标记的分数)。

  • past_key_values (List[torch.FloatTensor], 可选, 当传递 use_cache=True 或当 config.use_cache=True 时返回) — torch.FloatTensor 的列表,长度为 config.n_layers,每个张量形状为 (2, batch_size, num_attn_heads, decoder_sequence_length, embed_size_per_head)).

    包含预先计算的解码器隐藏状态(注意力块中的键和值),可用于(参见 past_key_values 输入)加速顺序解码。

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

    解码器主干在每一层输出处的隐藏状态加上初始嵌入输出。

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

    解码器预测流在每一层输出处的隐藏状态加上初始嵌入输出。

  • decoder_attentions (tuple(torch.FloatTensor), 可选, 当传递 output_attentions=True 或当 config.output_attentions=True 时返回) — torch.FloatTensor 的元组(每一层一个),形状为 (batch_size, num_attn_heads, decoder_sequence_length, decoder_sequence_length)

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

  • decoder_ngram_attentions (tuple(torch.FloatTensor), 可选, 当传递 output_attentions=True 或当 config.output_attentions=True 时返回) — torch.FloatTensor 的元组(每一层一个),形状为 (batch_size, num_attn_heads, decoder_sequence_length, decoder_sequence_length)

    解码器预测流的注意力权重,在注意力 softmax 之后,用于计算自注意力头中的加权平均值。

  • cross_attentions (tuple(torch.FloatTensor), 可选, 当传递 output_attentions=True 或当 config.output_attentions=True 时返回) — torch.FloatTensor 的元组(每一层一个),形状为 (batch_size, num_attn_heads, encoder_sequence_length, decoder_sequence_length)

    解码器交叉注意力层的注意力权重,在注意力 softmax 之后,用于计算

  • encoder_last_hidden_state (torch.FloatTensor 形状为 (batch_size, encoder_sequence_length, hidden_size), 可选) — 模型编码器最后一层的输出处的隐藏状态序列。

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

    编码器在每一层输出处的隐藏状态加上初始嵌入输出。

  • encoder_attentions (tuple(torch.FloatTensor), 可选, 当传递 output_attentions=Trueconfig.output_attentions=True 时返回) — torch.FloatTensor 元组(每个层一个),形状为 (batch_size, num_attn_heads, encoder_sequence_length, encoder_sequence_length)。编码器的注意力权重,在注意力 softmax 之后,用于计算自注意力头中的加权平均值。

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

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

示例

>>> from transformers import AutoTokenizer, ProphetNetForConditionalGeneration

>>> tokenizer = AutoTokenizer.from_pretrained("microsoft/prophetnet-large-uncased")
>>> model = ProphetNetForConditionalGeneration.from_pretrained("microsoft/prophetnet-large-uncased")

>>> input_ids = tokenizer(
...     "Studies have been shown that owning a dog is good for you", return_tensors="pt"
... ).input_ids  # Batch size 1
>>> decoder_input_ids = tokenizer("Studies show that", return_tensors="pt").input_ids  # Batch size 1
>>> outputs = model(input_ids=input_ids, decoder_input_ids=decoder_input_ids)

>>> logits_next_token = outputs.logits  # logits to predict next token as usual
>>> logits_ngram_next_tokens = outputs.logits_ngram  # logits to predict 2nd, 3rd, ... next tokens

ProphetNetForCausalLM

class transformers.ProphetNetForCausalLM

< >

( config: ProphetNetConfig )

参数

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

ProphetNetModel 的独立解码器部分,顶部带有一个 lm 头。该模型可用于因果语言建模。该模型继承自 PreTrainedModel。查看超类文档以了解库为所有模型实现的通用方法(例如下载或保存、调整输入嵌入的大小、修剪头等)。

ProphetNet 原始代码可以在 这里找到。检查点是从原始 Fairseq 检查点转换而来。有关检查点转换的更多信息,请查看文件 convert_prophetnet_original_pytorch_checkpoint_to_pytorch.py

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

forward

< >

( input_ids: Optional = None attention_mask: Optional = None encoder_hidden_states: Optional = None encoder_attention_mask: Optional = None head_mask: Optional = None cross_attn_head_mask: Optional = None past_key_values: Optional = None inputs_embeds: Optional = None labels: Optional = None use_cache: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) transformers.models.prophetnet.modeling_prophetnet.ProphetNetDecoderLMOutputtuple(torch.FloatTensor)

参数

  • input_ids (torch.LongTensor 形状为 (batch_size, sequence_length)) — 输入序列标记在词汇表中的索引。如果您提供填充,默认情况下会忽略填充。

    可以使用 AutoTokenizer 获取索引。查看 PreTrainedTokenizer.encode()PreTrainedTokenizer.call() 获取详细信息。

    什么是输入 ID?

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

    • 1 表示标记未被掩盖
    • 0 表示标记被掩盖

    什么是注意力掩码?

  • head_mask (torch.Tensor 形状为 (encoder_layers, encoder_attention_heads), 可选) — 掩码以使编码器中注意力模块的选定头无效。掩码值选择在 [0, 1] 中:

    • 1 表示头未被掩盖
    • 0 表示头被掩盖
  • output_attentions (bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息,请参阅返回张量中的attentions
  • output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息,请参阅返回张量中的 hidden_states
  • return_dict (bool, 可选) — 是否返回 ModelOutput 而不是普通元组。
  • encoder_hidden_states (torch.FloatTensor 形状为 (batch_size, sequence_length, hidden_size), 可选) — 编码器最后一层输出的隐藏状态序列。如果模型配置为解码器,则在交叉注意中使用。
  • encoder_attention_mask (torch.FloatTensor 形状为 (batch_size, sequence_length), 可选) — 用于避免对编码器输入的填充标记索引执行注意的掩码。如果模型配置为解码器,则此掩码用于交叉注意。掩码值选择为 [0, 1]:
  • cross_attn_head_mask (torch.Tensor 形状为 (decoder_layers, decoder_attention_heads), 可选) — 用于使交叉注意模块的选定头无效的掩码。掩码值选择为 [0, 1]:

    • 1 表示头未被掩码
    • 0 表示头被掩码
  • past_key_values (tuple(tuple(torch.FloatTensor)) 长度为 config.n_layers,每个元组包含 4 个形状为 (batch_size, num_heads, sequence_length - 1, embed_size_per_head) 的张量) — 包含注意力块的预计算键和值隐藏状态。可用于加速解码。

    如果使用 past_key_values,用户可以选择仅输入最后一个 decoder_input_ids(没有为此模型提供过去键值状态的那些),形状为 (batch_size, 1),而不是所有形状为 (batch_size, sequence_length)decoder_input_ids

  • use_cache (bool, 可选) — 如果设置为 True,则会返回 past_key_values 键值状态,可用于加速解码(见 past_key_values)。

    • 1 表示未被掩码的标记,
    • 0 表示被掩码的标记。
  • labels (torch.LongTensor 形状为 (batch_size, sequence_length), 可选) — 用于计算从左到右的语言建模损失(下一个词预测)的标签。索引应在 [-100, 0, ..., config.vocab_size] 中(见 input_ids 文档字符串)索引设置为 -100 的标记将被忽略(掩码),损失仅针对标签为 [0, ..., config.vocab_size] 的标记计算。

返回

transformers.models.prophetnet.modeling_prophetnet.ProphetNetDecoderLMOutputtuple(torch.FloatTensor)

一个 transformers.models.prophetnet.modeling_prophetnet.ProphetNetDecoderLMOutputtorch.FloatTensor 的元组(如果传递 return_dict=False 或当 config.return_dict=False 时),包括根据配置(ProphenetConfig)和输入而变化的各种元素。

  • loss (torch.FloatTensor 形状为 (1,), 可选, 当提供 labels 时返回) — 语言建模损失。

  • logits (torch.FloatTensor 形状为 (batch_size, decoder_sequence_length, config.vocab_size)) — 主流语言建模头的预测分数(SoftMax 之前每个词汇表标记的分数)。

  • logits_ngram (torch.FloatTensor 形状为 (batch_size, ngram * decoder_sequence_length, config.vocab_size)) — 预测流语言建模头的预测分数(SoftMax 之前每个词汇表标记的分数)。

  • past_key_values (List[torch.FloatTensor], 可选, 当传递 use_cache=True 或当 config.use_cache=True 时返回) — torch.FloatTensor 的列表,长度为 config.n_layers,每个张量形状为 (2, batch_size, num_attn_heads, decoder_sequence_length, embed_size_per_head)).

    包含预先计算的解码器隐藏状态(注意力块中的键和值),可用于(参见 past_key_values 输入)加速顺序解码。

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

    解码器主干在每一层输出处的隐藏状态加上初始嵌入输出。

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

    解码器预测流在每一层输出处的隐藏状态加上初始嵌入输出。

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

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

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

    解码器预测流的注意力权重,在注意力 softmax 之后,用于计算

  • cross_attentions (tuple(torch.FloatTensor), 可选, 当传递 output_attentions=True 或当 config.output_attentions=True 时返回) — torch.FloatTensor 的元组(每一层一个),形状为 (batch_size, num_attn_heads, encoder_sequence_length, decoder_sequence_length)

    解码器交叉注意力层的注意力权重,在注意力 softmax 之后,用于计算

ProphetNetForCausalLM 正向方法覆盖 __call__ 特殊方法。

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

示例

>>> from transformers import AutoTokenizer, ProphetNetForCausalLM
>>> import torch

>>> tokenizer = AutoTokenizer.from_pretrained("microsoft/prophetnet-large-uncased")
>>> model = ProphetNetForCausalLM.from_pretrained("microsoft/prophetnet-large-uncased")
>>> assert model.config.is_decoder, f"{model.__class__} has to be configured as a decoder."
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")
>>> outputs = model(**inputs)

>>> logits = outputs.logits

>>> # Model can also be used with EncoderDecoder framework
>>> from transformers import BertTokenizer, EncoderDecoderModel, AutoTokenizer
>>> import torch

>>> tokenizer_enc = BertTokenizer.from_pretrained("google-bert/bert-large-uncased")
>>> tokenizer_dec = AutoTokenizer.from_pretrained("microsoft/prophetnet-large-uncased")
>>> model = EncoderDecoderModel.from_encoder_decoder_pretrained(
...     "google-bert/bert-large-uncased", "microsoft/prophetnet-large-uncased"
... )

>>> ARTICLE = (
...     "the us state department said wednesday it had received no "
...     "formal word from bolivia that it was expelling the us ambassador there "
...     "but said the charges made against him are `` baseless ."
... )
>>> input_ids = tokenizer_enc(ARTICLE, return_tensors="pt").input_ids
>>> labels = tokenizer_dec(
...     "us rejects charges against its ambassador in bolivia", return_tensors="pt"
... ).input_ids
>>> outputs = model(input_ids=input_ids, decoder_input_ids=labels[:, :-1], labels=labels[:, 1:])

>>> loss = outputs.loss
< > 在 GitHub 上更新