ProphetNet
概述
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 个 token 以进行 “ngram” 语言建模，而不仅仅是下一个 token。
该论文的摘要如下：
在本文中，我们提出了一种新的序列到序列预训练模型，名为 ProphetNet，它引入了一种新颖的自监督目标，名为未来 n-gram 预测和提出的 n 流自注意力机制。与传统序列到序列模型中的一步提前预测的优化不同，ProphetNet 通过 n 步提前预测进行优化，该预测在每个时间步基于先前的上下文 token 同时预测接下来的 n 个 token。未来 n-gram 预测显式地鼓励模型规划未来的 token，并防止在强局部相关性上过度拟合。我们分别使用基本规模数据集 (16GB) 和大规模数据集 (160GB) 预训练 ProphetNet。然后，我们在 CNN/DailyMail、Gigaword 和 SQuAD 1.1 基准上进行了抽象摘要和问题生成任务的实验。实验结果表明，与使用相同规模预训练语料库的模型相比，ProphetNet 在所有这些数据集上都取得了新的最先进的结果。
作者的代码可以在此处找到。
使用技巧
- ProphetNet 是一个具有绝对位置嵌入的模型，因此通常建议在右侧而不是左侧填充输入。
- 该模型架构基于原始 Transformer，但将解码器中的 “标准” 自注意力机制替换为主自注意力机制和自 n 流（预测）自注意力机制。
资源
ProphetNetConfig
class transformers.ProphetNetConfig
< source >( activation_dropout: Optional = 0.1 activation_function: Union = 'gelu' vocab_size: Optional = 30522 hidden_size: Optional = 1024 encoder_ffn_dim: Optional = 4096 num_encoder_layers: Optional = 12 num_encoder_attention_heads: Optional = 16 decoder_ffn_dim: Optional = 4096 num_decoder_layers: Optional = 12 num_decoder_attention_heads: Optional = 16 attention_dropout: Optional = 0.1 dropout: Optional = 0.1 max_position_embeddings: Optional = 512 init_std: Optional = 0.02 is_encoder_decoder: Optional = True add_cross_attention: Optional = True decoder_start_token_id: Optional = 0 ngram: Optional = 2 num_buckets: Optional = 32 relative_max_distance: Optional = 128 disable_ngram_loss: Optional = False eps: Optional = 0.0 use_cache: Optional = True pad_token_id: Optional = 0 bos_token_id: Optional = 1 eos_token_id: Optional = 2 **kwargs )
参数
- activation_dropout (
float, 可选, 默认为 0.1) — 全连接层内部激活函数的 dropout 比率。 - activation_function (
str或function, 可选, 默认为"gelu") — 编码器和 pooler 中的非线性激活函数（函数或字符串）。如果为字符串，则支持"gelu","relu","silu"和"gelu_new"。 - vocab_size (
int, 可选, 默认为 30522) — ProphetNET 模型的词汇表大小。定义了调用 ProphetNetModel 时传递的inputs_ids可以表示的不同 token 的数量。 - hidden_size (
int, 可选, 默认为 1024) — 层和 pooler 层的维度。 - 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) — 嵌入层、编码器和 pooler 中所有全连接层的 dropout 概率。 - max_position_embeddings (
int, 可选, 默认为 512) — 此模型可能使用的最大序列长度。通常将其设置为较大的值以防万一（例如，512 或 1024 或 2048）。 - init_std (
float, 可选, 默认为 0.02) — 用于初始化所有权重矩阵的 truncated_normal_initializer 的标准差。 - add_cross_attention (
bool, 可选, 默认为True) — 是否应将交叉注意力层添加到模型中。 - is_encoder_decoder (
bool, 可选, 默认为True) — 这是否是编码器/解码器模型。 - pad_token_id (
int, 可选, 默认为 1) — Padding token id。 - bos_token_id (
int, 可选, 默认为 0) — 流开始 token id。 - eos_token_id (
int, 可选, 默认为 2) — 流结束 token id。 - ngram (
int, 可选, 默认为 2) — 要预测的未来 token 数量。设置为 1 时，与传统的语言模型相同，仅预测下一个第一个 token。 - num_buckets (
int, 可选, 默认为 32) — 每个注意力层要使用的 bucket 数量。这用于相对位置计算。有关更多详细信息，请参见 [T5 论文](see https://arxiv.org/abs/1910.10683)。 - relative_max_distance (
int, 可选, 默认为 128) — 大于此数字的相对距离将放入最后一个相同的 bucket 中。这用于相对位置计算。有关更多详细信息，请参见 [T5 论文](see https://arxiv.org/abs/1910.10683)。 - disable_ngram_loss (
bool, 可选, 默认为False) — 是否仅训练预测下一个第一个 token。 - eps (
float, 可选, 默认为 0.0) — 控制损失计算中标签平滑的epsilon参数值。如果设置为 0，则不执行标签平滑。 - use_cache (
bool, 可选, 默认为True) — 模型是否应返回上次的 key/values 注意力（并非所有模型都使用）。
这是用于存储 ProphetNetModel 配置的配置类。它用于根据指定的参数实例化 ProphetNet 模型，定义模型架构。使用默认值实例化配置将产生与 ProphetNet microsoft/prophetnet-large-uncased 架构类似的配置。
配置对象继承自 PretrainedConfig，可用于控制模型输出。阅读 PretrainedConfig 的文档以获取更多信息。
ProphetNetTokenizer
class transformers.ProphetNetTokenizer
< source >( 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 clean_up_tokenization_spaces: bool = True **kwargs )
参数
- vocab_file (
str) — 包含词汇表的文件。 - do_lower_case (
bool, 可选, 默认为True) — 是否在分词时将输入转换为小写。 - do_basic_tokenize (
bool, 可选, 默认为True) — 是否在 WordPiece 分词之前进行基础分词。 - never_split (
Iterable, 可选) — 在分词期间永远不会被分割的 token 集合。仅当do_basic_tokenize=True时有效 - unk_token (
str, 可选, 默认为"[UNK]") — 未知 token。词汇表中不存在的 token 无法转换为 ID，并被设置为此 token。 - sep_token (
str, 可选, 默认为"[SEP]") — 分隔符 token，用于从多个序列构建序列时，例如序列分类的两个序列或问答的文本和问题。它也用作使用特殊 token 构建的序列的最后一个 token。 - x_sep_token (
str, 可选, 默认为"[X_SEP]") — 特殊的第二分隔符 token，可以由 ProphetNetForConditionalGeneration 生成。它用于分隔摘要中的项目符号式句子，例如。 - pad_token (
str, 可选, 默认为"[PAD]") — 用于填充的 token，例如在批量处理不同长度的序列时。 - mask_token (
str, 可选, 默认为"[MASK]") — 用于掩码值的 token。这是使用掩码语言建模训练此模型时使用的 token。这是模型将尝试预测的 token。 - tokenize_chinese_chars (
bool, 可选, 默认为True) — 是否对中文字符进行分词。对于日文，这可能应该停用（参见此issue）。
- strip_accents (
bool, 可选) — 是否去除所有重音符号。如果未指定此选项，则将由lowercase的值确定（与原始 BERT 中一样）。 - clean_up_tokenization_spaces (
bool, 可选, 默认为True) — 是否在解码后清理空格，清理包括删除潜在的伪像，如多余的空格。
构建 ProphetNetTokenizer。基于 WordPiece。
此分词器继承自 PreTrainedTokenizer，其中包含大多数主要方法。用户应参考此超类以获取有关这些方法的更多信息。
build_inputs_with_special_tokens
< source >( token_ids_0: List token_ids_1: Optional = None ) → List[int]
通过连接并添加特殊 token，从序列或序列对构建模型输入，用于序列分类任务。 BERT 序列具有以下格式
- 单个序列:
[CLS] X [SEP] - 序列对:
[CLS] A [SEP] B [SEP]
将 token 序列（字符串）转换为单个字符串。
create_token_type_ids_from_sequences
< source >( token_ids_0: List token_ids_1: Optional = None ) → List[int]
创建一个由传递的两个序列生成的掩码，用于序列对分类任务。 ProphetNet
如果 token_ids_1 为 None，则此方法仅返回掩码的第一部分（0）。
get_special_tokens_mask
< source >( token_ids_0: List token_ids_1: Optional = None already_has_special_tokens: Optional = False ) → List[int]
从没有添加特殊 token 的 token 列表中检索序列 ID。当使用分词器的 prepare_for_model 方法添加特殊 token 时，将调用此方法。
ProphetNet 特定输出
class transformers.models.prophetnet.modeling_prophetnet.ProphetNetSeq2SeqLMOutput
< source >( 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，形状为(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时返回) — 长度为config.n_layers的torch.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=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=True或config.output_attentions=True时返回) —torch.FloatTensor的元组（每层一个），形状为(batch_size, num_attn_heads, encoder_sequence_length, encoder_sequence_length)。 编码器的注意力权重，在注意力 softmax 之后，用于计算自注意力头中的加权平均值。
序列到序列语言模型输出的基类。
class transformers.models.prophetnet.modeling_prophetnet.ProphetNetSeq2SeqModelOutput
< source >( 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=True或config.use_cache=True时返回) — 长度为config.n_layers的torch.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=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.FloatTensorof shape(batch_size, encoder_sequence_length, hidden_size), optional) — 模型编码器最后一层的输出的隐藏状态序列。 - encoder_hidden_states (
tuple(torch.FloatTensor), optional, returned whenoutput_hidden_states=Trueis passed or whenconfig.output_hidden_states=True) —torch.FloatTensor元组（每个元素对应一层输出，包括嵌入层输出），形状为(batch_size, encoder_sequence_length, hidden_size)。编码器每一层的输出的隐藏状态，外加初始嵌入输出。
- encoder_attentions (
tuple(torch.FloatTensor), optional, returned whenoutput_attentions=Trueis passed or whenconfig.output_attentions=True) —torch.FloatTensor元组（每个元素对应一层），形状为(batch_size, num_attn_heads, encoder_sequence_length, encoder_sequence_length)。编码器的注意力权重，在 attention softmax 之后，用于计算自注意力头中的加权平均值。
模型编码器输出的基类，也包含：可以加速顺序解码的预计算隐藏状态。
class transformers.models.prophetnet.modeling_prophetnet.ProphetNetDecoderModelOutput
< source >( 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.FloatTensorof shape(batch_size, decoder_sequence_length, hidden_size)) — 模型解码器最后一层的输出的主流隐藏状态序列。如果使用
past_key_values，则仅输出形状为(batch_size, 1, hidden_size)的序列的最后一个隐藏状态。 - last_hidden_state_ngram (
torch.FloatTensorof shape(batch_size, ngram * decoder_sequence_length, config.vocab_size)) — 模型解码器最后一层的输出的预测流隐藏状态序列。 - past_key_values (
List[torch.FloatTensor], optional, returned whenuse_cache=Trueis passed or whenconfig.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), optional, returned whenoutput_hidden_states=Trueis passed or whenconfig.output_hidden_states=True) —torch.FloatTensor元组（每个元素对应一层输出，包括嵌入层输出），形状为(batch_size, decoder_sequence_length, hidden_size)。解码器主流的每一层的输出的隐藏状态，外加初始嵌入输出。
- ngram_hidden_states (
tuple(torch.FloatTensor), optional, returned whenoutput_hidden_states=Trueis passed or whenconfig.output_hidden_states=True) —torch.FloatTensor元组（每个元素对应一层输出，包括嵌入层输出），形状为(batch_size, ngram * decoder_sequence_length, hidden_size)。解码器预测流的每一层的输出的隐藏状态，外加初始嵌入输出。
- attentions (
tuple(torch.FloatTensor), optional, returned whenoutput_attentions=Trueis passed or whenconfig.output_attentions=True) —torch.FloatTensor元组（每个元素对应一层），形状为(batch_size, num_attn_heads, decoder_sequence_length, decoder_sequence_length)。解码器的注意力权重，在 attention softmax 之后，用于计算自注意力头中的加权平均值。
- ngram_attentions (
tuple(torch.FloatTensor), optional, returned whenoutput_attentions=Trueis passed or whenconfig.output_attentions=True) —torch.FloatTensor元组（每个元素对应一层），形状为(batch_size, num_attn_heads, decoder_sequence_length, decoder_sequence_length)。解码器预测流的注意力权重，在 attention softmax 之后，用于计算自注意力头中的加权平均值。
- cross_attentions (
tuple(torch.FloatTensor), optional, returned whenoutput_attentions=Trueis passed or whenconfig.output_attentions=True) —torch.FloatTensor元组（每个元素对应一层），形状为(batch_size, num_attn_heads, encoder_sequence_length, decoder_sequence_length)。解码器的交叉注意力层的注意力权重，在 attention softmax 之后，用于计算加权平均值。
模型输出的基类，可能还包含过去的键/值（以加速顺序解码）。
class transformers.models.prophetnet.modeling_prophetnet.ProphetNetDecoderLMOutput
< source >( 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 (
torch.FloatTensorof shape(1,), optional, returned whenlabelsis provided) — 语言建模损失。 - logits (
torch.FloatTensorof shape(batch_size, decoder_sequence_length, config.vocab_size)) — 主流语言建模头的预测得分（SoftMax 之前的每个词汇标记的得分）。 - logits_ngram (
torch.FloatTensorof shape(batch_size, ngram * decoder_sequence_length, config.vocab_size)) — 预测流语言建模头的预测得分（SoftMax 之前的每个词汇标记的得分）。 - past_key_values (
List[torch.FloatTensor], optional, returned whenuse_cache=Trueis passed or whenconfig.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), optional, returned whenoutput_hidden_states=Trueis passed or whenconfig.output_hidden_states=True) —torch.FloatTensor元组（每个元素对应一层输出，包括嵌入层输出），形状为(batch_size, decoder_sequence_length, hidden_size)。解码器主流的每一层的输出的隐藏状态，外加初始嵌入输出。
- ngram_hidden_states (
tuple(torch.FloatTensor), optional, returned whenoutput_hidden_states=Trueis passed or whenconfig.output_hidden_states=True) —torch.FloatTensor元组（每个元素对应一层输出，包括嵌入层输出），形状为(batch_size, ngram * decoder_sequence_length, hidden_size)。解码器预测流的每一层的输出的隐藏状态，外加初始嵌入输出。
- attentions (
tuple(torch.FloatTensor), optional, returned whenoutput_attentions=Trueis passed or whenconfig.output_attentions=True) —torch.FloatTensor元组（每个元素对应一层），形状为(batch_size, num_attn_heads, decoder_sequence_length, decoder_sequence_length)。解码器的注意力权重，在 attention 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 之后，用于计算加权平均值
模型输出的基类，可能还包含过去的键/值（以加速顺序解码）。
ProphetNetModel
class transformers.ProphetNetModel
< source >( config: ProphetNetConfig )
参数
- config (ProphetNetConfig) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载与模型相关的权重，仅加载配置。查看 from_pretrained() 方法以加载模型权重。
裸 ProphetNet 模型输出原始隐藏状态，顶部没有任何特定的 head。此模型继承自 PreTrainedModel。查看超类文档以获取库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、剪枝 head 等）。
原始 ProphetNet 代码可以在 这里 找到。检查点是从原始 Fairseq 检查点转换而来的。有关检查点转换的更多信息，请查看文件 convert_prophetnet_original_pytorch_checkpoint_to_pytorch.py。
此模型是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参阅 PyTorch 文档以了解与通用用法和行为相关的所有事项。
forward
< source >( 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.ProphetNetSeq2SeqModelOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor，形状为(batch_size, sequence_length)) — 词汇表中输入序列标记的索引。默认情况下，如果您提供填充，则会忽略填充。索引可以使用 AutoTokenizer 获得。 有关详细信息，请参见 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensor，形状为(batch_size, sequence_length)，可选) — 用于避免在 padding 标记索引上执行注意力的掩码。掩码值在[0, 1]中选择：- 1 表示标记未被掩蔽，
- 0 表示标记被掩蔽。
- decoder_input_ids (
torch.LongTensor，形状为(batch_size, target_sequence_length)，可选) — 词汇表中解码器输入序列标记的索引。索引可以使用 AutoTokenizer 获得。 有关详细信息，请参见 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
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中的 pad 标记。默认情况下，也将使用因果掩码。 - head_mask (
torch.Tensor，形状为(encoder_layers, encoder_attention_heads)，可选) — 用于使编码器中注意力模块的选定 head 无效的掩码。掩码值在[0, 1]中选择：- 1 表示 head 未被掩蔽，
- 0 表示 head 被掩蔽。
- decoder_head_mask (
torch.Tensor，形状为(decoder_layers, decoder_attention_heads)，可选) — 用于使解码器中注意力模块的选定 head 无效的掩码。掩码值在[0, 1]中选择：- 1 表示 head 未被掩蔽，
- 0 表示 head 被掩蔽。
- cross_attn_head_mask (
torch.Tensor，形状为(decoder_layers, decoder_attention_heads)，可选) — 用于使交叉注意力模块的选定 head 无效的掩码。掩码值在[0, 1]中选择：- 1 表示 head 未被掩蔽，
- 0 表示 head 被掩蔽。
- encoder_outputs (
tuple(tuple(torch.FloatTensor), 可选) — 元组由 (last_hidden_state, 可选:hidden_states, 可选:attentions) 组成，形状为(batch_size, sequence_length, hidden_size)的last_hidden_state，可选) 是编码器最后一层的输出处的隐藏状态序列。用于解码器的交叉注意力。 - 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）。 - output_attentions (
bool，可选) — 是否返回所有注意力层的注意力张量。 有关更多详细信息，请参见返回的张量下的attentions。 - output_hidden_states (
bool，可选) — 是否返回所有层的隐藏状态。 有关更多详细信息，请参见返回的张量下的hidden_states。 - return_dict (
bool，可选) — 是否返回 ModelOutput 而不是普通元组。
返回值
transformers.models.prophetnet.modeling_prophetnet.ProphetNetSeq2SeqModelOutput 或 tuple(torch.FloatTensor)
一个 transformers.models.prophetnet.modeling_prophetnet.ProphetNetSeq2SeqModelOutput 或一个 torch.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时返回) — 长度为config.n_layers的torch.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=True或当config.output_hidden_states=True时返回) —torch.FloatTensor元组（embedding 输出的输出一个，每层的输出一个），形状为(batch_size, decoder_sequence_length, hidden_size)。解码器主流在每一层输出以及初始 embedding 输出处的隐藏状态。
-
decoder_ngram_hidden_states (
tuple(torch.FloatTensor)，可选，当传递output_hidden_states=True或当config.output_hidden_states=True时返回) —torch.FloatTensor元组（embedding 输出的输出一个，每层的输出一个），形状为(batch_size, ngram * decoder_sequence_length, hidden_size)。解码器预测流在每一层输出以及初始 embedding 输出处的隐藏状态。
-
decoder_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 之后，用于计算自注意力 head 中的加权平均值。
-
decoder_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元组（每个层一个）。解码器预测流的注意力权重，经过 attention 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)。解码器互注意力层的注意力权重，经过 attention 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=True或config.output_attentions=True时返回) —torch.FloatTensor的元组 (每层一个)，形状为(batch_size, num_attn_heads, encoder_sequence_length, encoder_sequence_length)。编码器的注意力权重，经过 attention softmax 后，用于计算自注意力头中的加权平均值。
ProphetNetModel 的 forward 方法，覆盖了 __call__ 特殊方法。
尽管 forward 传递的配方需要在该函数内定义，但应该在之后调用 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 statesProphetNetEncoder
class transformers.ProphetNetEncoder
< source >( 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 (torch.nn.Embeddings，形状为 (config.vocab_size, config.hidden_size), 可选): 词嵌入参数。这可以用于使用预定义的词嵌入而不是随机初始化的词嵌入来初始化 ProphetNetEncoder。
forward
< source >( 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.BaseModelOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor，形状为(batch_size, sequence_length)) — 词汇表中输入序列 tokens 的索引。默认情况下，如果您提供 padding，它将被忽略。索引可以使用 AutoTokenizer 获得。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensor，形状为(batch_size, sequence_length), 可选) — 用于避免在 padding token 索引上执行 attention 的 Mask。Mask 值在[0, 1]中选择:- 1 表示 tokens 未被 Mask，
- 0 表示 tokens 已被 Mask。
- head_mask (
torch.Tensor，形状为(encoder_layers, encoder_attention_heads), 可选) — 用于 nullify 编码器中 attention 模块的选定 heads 的 Mask。Mask 值在[0, 1]中选择:- 1 表示 head 未被 Mask，
- 0 表示 head 已被 Mask。
- output_attentions (
bool, 可选) — 是否返回所有 attention 层的 attention tensors。有关更多详细信息，请参阅返回的 tensors 下的attentions。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回的 tensors 下的hidden_states。 - return_dict (
bool, 可选) — 是否返回 ModelOutput 而不是普通元组。
返回值
transformers.modeling_outputs.BaseModelOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.BaseModelOutput 或 torch.FloatTensor 的元组 (如果传递 return_dict=False 或当 config.return_dict=False 时)，包含各种元素，具体取决于配置 (ProphenetConfig) 和输入。
-
last_hidden_state (
torch.FloatTensor，形状为(batch_size, sequence_length, hidden_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)。经过 attention softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
ProphetNetEncoder 的 forward 方法，覆盖了 __call__ 特殊方法。
尽管 forward 传递的配方需要在该函数内定义，但应该在之后调用 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_stateProphetNetDecoder
class transformers.ProphetNetDecoder
< source >( 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 (torch.nn.Embeddings，形状为 (config.vocab_size, config.hidden_size), 可选): 词嵌入参数。这可以用于使用预定义的词嵌入而不是随机初始化的词嵌入来初始化 ProphetNetEncoder。
forward
< source >( 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.ProphetNetDecoderModelOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor，形状为(batch_size, sequence_length)) — 词汇表中输入序列 tokens 的索引。默认情况下，如果您提供 padding，它将被忽略。索引可以使用 AutoTokenizer 获得。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensor，形状为(batch_size, sequence_length), 可选) — 用于避免在 padding token 索引上执行 attention 的 Mask。Mask 值在[0, 1]中选择:- 1 表示 tokens 未被 Mask，
- 0 表示 tokens 已被 Mask。
- head_mask (
torch.Tensor，形状为(encoder_layers, encoder_attention_heads), 可选) — 用于 nullify 编码器中 attention 模块的选定 heads 的 Mask。Mask 值在[0, 1]中选择:- 1 表示 head 未被 Mask，
- 0 表示 head 已被 Mask。
- output_attentions (
bool, 可选) — 是否返回所有 attention 层的 attention tensors。有关更多详细信息，请参阅返回的 tensors 下的attentions。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回的 tensors 下的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 表示标记是被掩蔽的。
返回值
transformers.models.prophetnet.modeling_prophetnet.ProphetNetDecoderModelOutput 或 tuple(torch.FloatTensor)
一个 transformers.models.prophetnet.modeling_prophetnet.ProphetNetDecoderModelOutput 或一个 torch.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时返回) — 长度为config.n_layers的torch.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=True或当config.output_hidden_states=True时返回) —torch.FloatTensor的元组 (每个嵌入输出 + 每层输出一个)，形状为(batch_size, decoder_sequence_length, hidden_size)。解码器主流在每一层输出以及初始 embedding 输出处的隐藏状态。
-
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)。解码器预测流在每一层输出以及初始 embedding 输出处的隐藏状态。
-
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 之后，用于计算自注意力 head 中的加权平均值。
-
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)。解码器预测流的注意力权重，经过 attention 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)。解码器互注意力层的注意力权重，经过 attention softmax 后，用于计算加权平均值。
ProphetNetDecoder 的前向方法，覆盖了 __call__ 特殊方法。
尽管 forward 传递的配方需要在该函数内定义，但应该在之后调用 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_stateProphetNetForConditionalGeneration
class transformers.ProphetNetForConditionalGeneration
< 源代码 >( 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 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 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor，形状为(batch_size, sequence_length)) — 词汇表中输入序列标记的索引。如果您提供填充，默认情况下将忽略填充。索引可以使用 AutoTokenizer 获取。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- 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()。
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，用户可以选择仅输入最后一个decoder_input_ids(那些没有将其过去的键值状态提供给此模型的) ，形状为(batch_size, 1)而不是所有形状为(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 而不是普通元组。 - labels (形状为
(batch_size,)的torch.LongTensor，可选) — 用于计算序列分类/回归损失的标签。索引应在[-100, 0, ..., config.vocab_size - 1]中。所有设置为 `-100` 的标签都会被忽略（掩码），损失仅针对[0, ..., config.vocab_size]中的标签计算
返回值
transformers.models.prophetnet.modeling_prophetnet.ProphetNetSeq2SeqLMOutput 或 tuple(torch.FloatTensor)
一个 transformers.models.prophetnet.modeling_prophetnet.ProphetNetSeq2SeqLMOutput 或一个 `torch.FloatTensor` 的元组（如果传递了 `return_dict=False` 或当 `config.return_dict=False` 时），包含取决于配置 (`ProphenetConfig`) 和输入的各种元素。
-
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]，可选，当传递use_cache=True或当config.use_cache=True时返回) — 长度为config.n_layers的torch.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=True或当config.output_hidden_states=True时返回) —torch.FloatTensor元组（embedding 输出的输出一个，每层的输出一个），形状为(batch_size, decoder_sequence_length, hidden_size)。解码器主流在每一层输出以及初始 embedding 输出处的隐藏状态。
-
decoder_ngram_hidden_states (
tuple(torch.FloatTensor)，可选，当传递output_hidden_states=True或当config.output_hidden_states=True时返回) —torch.FloatTensor元组（embedding 输出的输出一个，每层的输出一个），形状为(batch_size, ngram * decoder_sequence_length, hidden_size)。解码器预测流在每一层输出以及初始 embedding 输出处的隐藏状态。
-
decoder_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 之后，用于计算自注意力 head 中的加权平均值。
-
decoder_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时返回) —torch.FloatTensor的元组 (每层一个)，形状为(batch_size, num_attn_heads, encoder_sequence_length, decoder_sequence_length)。解码器互注意力层的注意力权重，经过 attention 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=True` 或当 `config.output_attentions=True` 时返回) — 形状为 `(batch_size, num_attn_heads, encoder_sequence_length, encoder_sequence_length)` 的 `torch.FloatTensor` 元组（每层一个）。编码器的注意力权重，在注意力 softmax 之后，用于计算自注意力头中的加权平均值。
The ProphetNetForConditionalGeneration 的 forward 方法，覆盖了 __call__ 特殊方法。
尽管 forward 传递的配方需要在该函数内定义，但应该在之后调用 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 tokensProphetNetForCausalLM
class transformers.ProphetNetForCausalLM
< source >( 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
< source >( 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.ProphetNetDecoderLMOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (形状为
(batch_size, sequence_length)的 `torch.LongTensor`) — 词汇表中输入序列标记的索引。默认情况下，如果您提供填充，则会忽略填充。索引可以使用 AutoTokenizer 获得。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- 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 而不是普通元组。
- encoder_hidden_states (形状为
(batch_size, sequence_length, hidden_size)的 `torch.FloatTensor`，可选) — 编码器最后一层输出的隐藏状态序列。如果模型配置为解码器，则在交叉注意力中使用。 - encoder_attention_mask (形状为
(batch_size, sequence_length)的 `torch.FloatTensor`，可选) — 用于避免对编码器输入的填充标记索引执行注意力的掩码。如果模型配置为解码器，则此掩码在交叉注意力中使用。掩码值在 `[0, 1]` 中选择： - cross_attn_head_mask (形状为
(decoder_layers, decoder_attention_heads)的 `torch.Tensor`，可选) — 用于使交叉注意力模块的选定头无效的掩码。掩码值在 `[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`，用户可以选择仅输入形状为 `(batch_size, 1)` 的最后一个 `decoder_input_ids`（那些没有将其过去的键值状态提供给此模型的 `decoder_input_ids`），而不是所有形状为 `(batch_size, sequence_length)` 的 `decoder_input_ids`。
- use_cache (`bool`，可选) — 如果设置为 `True`，则返回 `past_key_values` 键值状态，并且可以用于加速解码（请参阅 `past_key_values`）。
- 1 表示未被掩码的标记，
- 0 表示被掩码的标记。
- labels (形状为
(batch_size, sequence_length)的 `torch.LongTensor`，可选) — 用于计算从左到右的语言建模损失（下一个单词预测）的标签。索引应在 `[-100, 0, ..., config.vocab_size]` 中（请参阅 `input_ids` 文档字符串）。索引设置为 `-100` 的标记将被忽略（掩码），损失仅针对标签在 `[0, ..., config.vocab_size]` 中的标记计算
返回值
transformers.models.prophetnet.modeling_prophetnet.ProphetNetDecoderLMOutput 或 tuple(torch.FloatTensor)
一个 transformers.models.prophetnet.modeling_prophetnet.ProphetNetDecoderLMOutput 或一个 `torch.FloatTensor` 的元组（如果传递了 `return_dict=False` 或当 `config.return_dict=False` 时），包含取决于配置 (`ProphenetConfig`) 和输入的各种元素。
-
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]，可选，当传递use_cache=True或当config.use_cache=True时返回) — 长度为config.n_layers的torch.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=True或当config.output_hidden_states=True时返回) —torch.FloatTensor的元组 (每个嵌入输出 + 每层输出一个)，形状为(batch_size, decoder_sequence_length, hidden_size)。解码器主流在每一层输出以及初始 embedding 输出处的隐藏状态。
-
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)。解码器预测流在每一层输出以及初始 embedding 输出处的隐藏状态。
-
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 之后，用于计算自注意力 head 中的加权平均值。
-
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)。解码器预测流的注意力权重，经过 attention 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)。解码器互注意力层的注意力权重，经过 attention softmax 后，用于计算加权平均值。
The ProphetNetForCausalLM 的 forward 方法，覆盖了 __call__ 特殊方法。
尽管 forward 传递的配方需要在该函数内定义，但应该在之后调用 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