XLM-ProphetNet
此模型仅处于维护模式，我们不接受任何更改其代码的新 PR。如果您在运行此模型时遇到任何问题，请重新安装支持此模型的最后一个版本：v4.40.2。您可以通过运行以下命令来执行此操作： pip install -U transformers==4.40.2。
免责声明： 如果您发现任何异常，请提交 Github Issue 并指派 @patrickvonplaten
概述
XLM-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 日发布。
XLM-ProphetNet 是一个编码器-解码器模型，可以预测“ngram”语言模型的 n 个未来标记，而不仅仅是下一个标记。其架构与 ProhpetNet 相同，但该模型在多语言 “wiki100” 维基百科转储上进行了训练。XLM-ProphetNet 的模型架构和预训练目标与 ProphetNet 相同，但 XLM-ProphetNet 是在跨语言数据集 XGLUE 上预训练的。
该论文的摘要如下：
在本文中，我们提出了一种新的序列到序列预训练模型，名为 ProphetNet，它引入了一种新颖的自监督目标，名为未来 n-gram 预测，以及提出的 n 流自注意力机制。与传统序列到序列模型中一步超前预测的优化不同，ProphetNet 通过 n 步超前预测进行优化，该预测在每个时间步基于先前的上下文标记同时预测接下来的 n 个标记。未来 n-gram 预测显式地鼓励模型规划未来标记，并防止过度拟合强局部相关性。我们分别使用基本规模数据集 (16GB) 和大规模数据集 (160GB) 预训练 ProphetNet。然后，我们在 CNN/DailyMail、Gigaword 和 SQuAD 1.1 基准上进行了抽象摘要和问题生成任务的实验。实验结果表明，与使用相同规模预训练语料库的模型相比，ProphetNet 在所有这些数据集上都取得了新的最先进的结果。
作者的代码可以在这里找到。
资源
XLMProphetNetConfig
class transformers.XLMProphetNetConfig
< 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") — 编码器和池化器中的非线性激活函数（函数或字符串）。如果为字符串，则支持"gelu","relu","silu"和"gelu_new"。 - vocab_size (
int, 可选, 默认为 30522) — ProphetNET 模型的词汇表大小。定义了在调用 XLMProphetNetModel 时可以通过inputs_ids传递的不同 token 的数量。 - 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) — 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) — 模型是否应返回上次的键/值注意力（并非所有模型都使用）。
这是用于存储 XLMProphetNetModel 配置的配置类。它用于根据指定的参数实例化 XLMProphetNet 模型，定义模型架构。使用默认值实例化配置将产生与 XLMProphetNet microsoft/xprophetnet-large-wiki100-cased 架构类似的配置。
配置对象继承自 PretrainedConfig，可用于控制模型输出。有关更多信息，请阅读 PretrainedConfig 的文档。
XLMProphetNetTokenizer
class transformers.XLMProphetNetTokenizer
< source >( vocab_file bos_token = '[SEP]' eos_token = '[SEP]' sep_token = '[SEP]' unk_token = '[UNK]' pad_token = '[PAD]' cls_token = '[CLS]' mask_token = '[MASK]' sp_model_kwargs: Optional = None **kwargs )
参数
- vocab_file (
str) — 词汇表文件的路径。 - bos_token (
str, 可选, 默认为"[SEP]") — 序列开始标记，在预训练期间使用。可以用作序列分类器标记。当使用特殊标记构建序列时，这不是用于序列开始的标记。使用的标记是
cls_token。 - eos_token (
str, 可选, 默认为"[SEP]") — 序列结束标记。当使用特殊标记构建序列时，这不是用于序列结束的标记。使用的标记是
sep_token。 - sep_token (
str, 可选, 默认为"[SEP]") — 分隔符标记，用于从多个序列构建序列时，例如用于序列分类的两个序列，或者用于问答的文本和问题。它也用作使用特殊标记构建的序列的最后一个标记。 - unk_token (
str, 可选, 默认为"[UNK]") — 未知标记。词汇表中不存在的标记无法转换为 ID，而是设置为此标记。 - pad_token (
str, 可选, 默认为"[PAD]") — 用于填充的标记，例如在批处理不同长度的序列时。 - cls_token (
str, 可选, 默认为"[CLS]") — 分类器标记，用于进行序列分类（对整个序列而不是每个标记进行分类）。当使用特殊标记构建时，它是序列的第一个标记。 - mask_token (
str, 可选, 默认为"[MASK]") — 用于掩码值的标记。这是使用掩码语言建模训练此模型时使用的标记。这是模型将尝试预测的标记。 - sp_model_kwargs (
dict, 可选) — 将传递给SentencePieceProcessor.__init__()方法。SentencePiece 的 Python 封装器 可以用于设置以下内容：-
enable_sampling: 启用子词正则化。 -
nbest_size: 用于 unigram 的采样参数。对 BPE-Dropout 无效。nbest_size = {0,1}: 不执行采样。nbest_size > 1: 从 nbest_size 结果中采样。nbest_size < 0: 假设 nbest_size 是无限的，并使用前向过滤和后向采样算法从所有假设（lattice）中采样。
-
alpha: 用于 unigram 采样的平滑参数，以及 BPE-dropout 的合并操作的 dropout 概率。
-
- sp_model (
SentencePieceProcessor) — 用于每次转换（字符串、标记和 ID）的 SentencePiece 处理器。
改编自 RobertaTokenizer 和 XLNetTokenizer。基于 SentencePiece。
此分词器继承自 PreTrainedTokenizer，其中包含大多数主要方法。用户应参考此超类以获取有关这些方法的更多信息。
build_inputs_with_special_tokens
< source >( token_ids_0: List token_ids_1: Optional = None ) → List[int]
通过连接和添加特殊标记，从序列或序列对构建模型输入，用于序列分类任务。 XLMProphetNet 序列具有以下格式
- 单个序列：
X [SEP] - 序列对：
A [SEP] B [SEP]
将标记序列（子词的字符串）转换为单个字符串。
create_token_type_ids_from_sequences
< source >( token_ids_0: List token_ids_1: Optional = None ) → List[int]
从传递的两个序列创建一个掩码，用于序列对分类任务。 XLMProphetNet 不使用标记类型 ID，因此返回零列表。
get_special_tokens_mask
< source >( token_ids_0: List token_ids_1: Optional = None already_has_special_tokens: bool = False ) → List[int]
从没有添加特殊标记的标记列表中检索序列 ID。当使用分词器的 prepare_for_model 方法添加特殊标记时，将调用此方法。
XLMProphetNetModel
class transformers.XLMProphetNetModel
< source >( config: XLMProphetNetConfig )
参数
- config (XLMProphetNetConfig) — 带有模型所有参数的模型配置类。使用配置文件初始化不会加载与模型关联的权重，仅加载配置。查看 from_pretrained() 方法以加载模型权重。
裸 XLMProphetNet 模型，输出原始隐藏状态，顶部没有任何特定的头部。此模型继承自 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 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.deprecated.xlm_prophetnet.modeling_xlm_prophetnet.XLMProphetNetSeq2SeqModelOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor，形状为(batch_size, sequence_length)) — 词汇表中输入序列 tokens 的索引。如果您提供填充，默认情况下填充将被忽略。索引可以使用 AutoTokenizer 获得。 有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensor，形状为(batch_size, sequence_length)，可选) — 掩码，用于避免在填充 token 索引上执行注意力机制。掩码值在[0, 1]中选择：- 1 表示 token 未被掩码，
- 0 表示 token 被掩码。
- decoder_input_ids (
torch.LongTensor，形状为(batch_size, target_sequence_length)，可选) — 词汇表中解码器输入序列 tokens 的索引。索引可以使用 AutoTokenizer 获得。 有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
XLMProphetNet 使用
eos_token_id作为decoder_input_ids生成的起始 token。如果使用past_key_values，则可以选择仅输入最后一个decoder_input_ids（请参阅past_key_values）。 - decoder_attention_mask (
torch.BoolTensor，形状为(batch_size, target_sequence_length)，可选) — 默认行为：生成一个 tensor，该 tensor 忽略decoder_input_ids中的 pad tokens。因果掩码也将默认使用。 - 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) 组成，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)的 tensors) — 包含注意力模块的预计算的 key 和 value 隐藏状态。可用于加速解码。如果使用
past_key_values，用户可以选择仅输入最后一个decoder_input_ids（那些没有将其过去的 key value 状态提供给此模型的），形状为(batch_size, 1)，而不是所有形状为(batch_size, sequence_length)的decoder_input_ids。 - use_cache (
bool，可选) — 如果设置为True，则返回past_key_values键值状态，并可用于加速解码（请参阅past_key_values）。 - output_attentions (
bool，可选) — 是否返回所有注意力层的注意力 tensors。有关更多详细信息，请参阅返回的 tensors 下的attentions。 - output_hidden_states (
bool，可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回的 tensors 下的hidden_states。 - return_dict (
bool，可选) — 是否返回 ModelOutput 而不是普通元组。
返回
transformers.models.deprecated.xlm_prophetnet.modeling_xlm_prophetnet.XLMProphetNetSeq2SeqModelOutput 或 tuple(torch.FloatTensor)
一个 transformers.models.deprecated.xlm_prophetnet.modeling_xlm_prophetnet.XLMProphetNetSeq2SeqModelOutput 或 torch.FloatTensor 的元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），包括各种元素，具体取决于配置 (XLMProphetNetConfig) 和输入。
-
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，每个 tensor 的形状为(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的元组（embeddings 输出的输出 + 每层输出的输出各一个），形状为(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的元组（embeddings 输出的输出 + 每层输出的输出各一个），形状为(batch_size, ngram * decoder_sequence_length, hidden_size)。解码器预测流在每层输出以及初始 embedding 输出处的隐藏状态。
-
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 之后，用于计算自注意力 head 中的加权平均值。
-
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的元组（embeddings 输出的输出 + 每层输出的输出各一个），形状为(batch_size, encoder_sequence_length, hidden_size)。编码器在每层输出以及初始 embedding 输出处的隐藏状态。
-
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 之后，用于计算自注意力 head 中的加权平均值。
transformers.XLMProphetNetModel forward 方法，覆盖了 __call__ 特殊方法。
尽管 forward 传递的配方需要在该函数中定义，但之后应调用 Module 实例而不是此方法，因为前者负责运行预处理和后处理步骤，而后者会静默地忽略它们。
示例
>>> from transformers import AutoTokenizer, XLMProphetNetModel
>>> tokenizer = AutoTokenizer.from_pretrained("patrickvonplaten/xprophetnet-large-uncased-standalone")
>>> model = XLMProphetNetModel.from_pretrained("patrickvonplaten/xprophetnet-large-uncased-standalone")
>>> 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 statesXLMProphetNetEncoder
class transformers.XLMProphetNetEncoder
< source >( config: XLMProphetNetConfig word_embeddings: Embedding = None )
参数
- config (XLMProphetNetConfig) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型关联的权重，仅加载配置。查看 from_pretrained() 方法以加载模型权重。
XLMProphetNetModel 的独立编码器部分。此模型继承自 PreTrainedModel。查看超类文档，了解库为其所有模型实现的通用方法（例如下载或保存、调整输入 embeddings 大小、剪枝 head 等）。
原始 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)，可选)：词 embedding 参数。这可以用于使用预定义的词 embeddings 而不是随机初始化的词 embeddings 初始化 XLMProphetNetEncoder。
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，默认情况下 padding 将被忽略。索引可以使用 AutoTokenizer 获得。 有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensor，形状为(batch_size, sequence_length)，可选) — 用于避免在 padding token 索引上执行 attention 的 Mask。Mask 值在[0, 1]中选择：- 1 表示 token 未被 Mask，
- 0 表示 token 已被 Mask。
- head_mask (
torch.Tensor，形状为(encoder_layers, encoder_attention_heads)，可选) — 用于 nullify 编码器中 attention 模块的选定 head 的 Mask。Mask 值在[0, 1]中选择：- 1 表示 head 未被 Mask，
- 0 表示 head 已被 Mask。
- output_attentions (
bool，可选) — 是否返回所有 attention 层的 attention tensors。 有关更多详细信息，请参见返回的 tensors 下的attentions。 - output_hidden_states (
bool，可选) — 是否返回所有层的 hidden states。 有关更多详细信息，请参见返回的 tensors 下的hidden_states。 - return_dict (
bool，可选) — 是否返回 ModelOutput 而不是纯 tuple。
返回
transformers.modeling_outputs.BaseModelOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.BaseModelOutput 或一个 torch.FloatTensor 的 tuple (如果传递了 return_dict=False 或当 config.return_dict=False 时)，包含各种元素，具体取决于配置 (XLMProphetNetConfig) 和输入。
-
last_hidden_state (
torch.FloatTensor，形状为(batch_size, sequence_length, hidden_size)) — 模型最后一层的输出处的 hidden-states 序列。 -
hidden_states (
tuple(torch.FloatTensor)，可选，当传递了output_hidden_states=True或当config.output_hidden_states=True时返回) —torch.FloatTensor的 Tuple（如果模型具有 embedding 层，则为 embedding 的输出 + 每层输出一个），形状为(batch_size, sequence_length, hidden_size)。模型在每层输出处的 Hidden-states，加上可选的初始 embedding 输出。
-
attentions (
tuple(torch.FloatTensor)，可选，当传递了output_attentions=True或当config.output_attentions=True时返回) —torch.FloatTensor的 Tuple（每层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。attention softmax 之后的 Attention 权重，用于计算 self-attention heads 中的加权平均值。
XLMProphetNetEncoder forward 方法，覆盖了 __call__ 特殊方法。
尽管 forward 传递的配方需要在该函数中定义，但之后应调用 Module 实例而不是此方法，因为前者负责运行预处理和后处理步骤，而后者会静默地忽略它们。
示例
>>> from transformers import AutoTokenizer, XLMProphetNetEncoder
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("patrickvonplaten/xprophetnet-large-uncased-standalone")
>>> model = XLMProphetNetEncoder.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_stateXLMProphetNetDecoder
class transformers.XLMProphetNetDecoder
< source >( config: XLMProphetNetConfig word_embeddings: Optional = None )
参数
- config (XLMProphetNetConfig) — 具有模型所有参数的模型配置类。 使用配置文件初始化不会加载与模型关联的权重，仅加载配置。 查看 from_pretrained() 方法以加载模型权重。
XLMProphetNetModel 的独立解码器部分。 此模型继承自 PreTrainedModel。 查看超类文档以获取库为其所有模型实现的通用方法（例如下载或保存、调整输入 embeddings 大小、剪枝 heads 等）。
原始 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)，可选)：词 embedding 参数。这可以用于使用预定义的词 embeddings 而不是随机初始化的词 embeddings 初始化 XLMProphetNetEncoder。
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.deprecated.xlm_prophetnet.modeling_xlm_prophetnet.XLMProphetNetDecoderModelOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor，形状为(batch_size, sequence_length)) — 词汇表中输入序列 tokens 的索引。如果您提供 padding，默认情况下 padding 将被忽略。索引可以使用 AutoTokenizer 获得。 有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensor，形状为(batch_size, sequence_length)，可选) — 用于避免在 padding token 索引上执行 attention 的 Mask。Mask 值在[0, 1]中选择：- 1 表示 token 未被 Mask，
- 0 表示 token 已被 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，可选) — 是否返回所有层的 hidden states。 有关更多详细信息，请参见返回的 tensors 下的hidden_states。 - return_dict (
bool，可选) — 是否返回 ModelOutput 而不是纯 tuple。 - encoder_hidden_states (
torch.FloatTensor，形状为(batch_size, sequence_length, hidden_size)，可选) — 编码器最后一层的输出处的 hidden-states 序列。 如果模型配置为解码器，则在 cross-attention 中使用。 - encoder_attention_mask (
torch.FloatTensor，形状为(batch_size, sequence_length)，可选) — 用于避免对编码器输入的 padding token 索引执行 attention 的 Mask。 如果模型配置为解码器，则此 mask 在 cross-attention 中使用。 Mask 值在[0, 1]中选择： - cross_attn_head_mask (
torch.Tensor，形状为(decoder_layers, decoder_attention_heads)，可选) — 用于 nullify cross-attention 模块的选定 heads 的 Mask。Mask 值在[0, 1]中选择：- 1 表示 head 未被 Mask，
- 0 表示 head 已被 Mask。
- past_key_values (
tuple(tuple(torch.FloatTensor))，长度为config.n_layers，每个 tuple 具有 4 个形状为(batch_size, num_heads, sequence_length - 1, embed_size_per_head)的 tensors) — 包含 attention blocks 的预计算 key 和 value hidden-states。 可用于加速解码。如果使用
past_key_values，则用户可以选择仅输入形状为(batch_size, 1)的最后一个decoder_input_ids（那些没有将其 past key value states 提供给此模型的），而不是形状为(batch_size, sequence_length)的所有decoder_input_ids。 - use_cache (
bool，可选) — 如果设置为True，则返回past_key_valueskey value states，并且可以用于加速解码（请参阅past_key_values）。- 1 表示 token 未被 Mask，
- 0 表示 token 已被 Mask。
返回
transformers.models.deprecated.xlm_prophetnet.modeling_xlm_prophetnet.XLMProphetNetDecoderModelOutput 或 tuple(torch.FloatTensor)
一个 transformers.models.deprecated.xlm_prophetnet.modeling_xlm_prophetnet.XLMProphetNetDecoderModelOutput 或一个 torch.FloatTensor 的 tuple (如果传递了 return_dict=False 或当 config.return_dict=False 时)，包含各种元素，具体取决于配置 (XLMProphetNetConfig) 和输入。
-
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)) — 模型解码器最后一层输出处的 predict stream hidden-states 序列。 -
past_key_values (
List[torch.FloatTensor]，可选，当传递use_cache=True或当config.use_cache=True时返回) —torch.FloatTensor列表，长度为config.n_layers，每个 tensor 的形状为(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的 Tuple（embedding 输出 + 每层输出一个），形状为(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的 Tuple（embedding 输出 + 每层输出一个），形状为(batch_size, ngram * decoder_sequence_length, hidden_size)。解码器预测流在每层输出以及初始 embedding 输出处的隐藏状态。
-
attentions (
tuple(torch.FloatTensor)，可选，当传递了output_attentions=True或当config.output_attentions=True时返回) —torch.FloatTensor的 Tuple（每层一个），形状为(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的 Tuple（每层一个），形状为(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 之后，用于计算加权平均值
XLMProphetNetDecoder forward 方法，覆盖了 __call__ 特殊方法。
尽管 forward 传递的配方需要在该函数中定义，但之后应调用 Module 实例而不是此方法，因为前者负责运行预处理和后处理步骤，而后者会静默地忽略它们。
示例
>>> from transformers import AutoTokenizer, XLMProphetNetDecoder
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("patrickvonplaten/xprophetnet-large-uncased-standalone")
>>> model = XLMProphetNetDecoder.from_pretrained("patrickvonplaten/xprophetnet-large-uncased-standalone", add_cross_attention=False)
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")
>>> outputs = model(**inputs)
>>> last_hidden_states = outputs.last_hidden_stateXLMProphetNetForConditionalGeneration
class transformers.XLMProphetNetForConditionalGeneration
< source >( config: XLMProphetNetConfig )
参数
- config (XLMProphetNetConfig) — 具有模型所有参数的模型配置类。使用配置文件初始化不会加载与模型相关的权重，仅加载配置。查看 from_pretrained() 方法以加载模型权重。
带有语言建模头的 XLMProphetNet 模型。可用于序列生成任务。此模型继承自 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 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.deprecated.xlm_prophetnet.modeling_xlm_prophetnet.XLMProphetNetSeq2SeqLMOutput or tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor，形状为(batch_size, sequence_length)) — 词汇表中输入序列 tokens 的索引。如果您提供填充，默认情况下会忽略填充。索引可以使用 AutoTokenizer 获取。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensor，形状为(batch_size, sequence_length)，可选) — 掩码，以避免在填充 token 索引上执行注意力机制。掩码值在[0, 1]中选择：- 1 表示 token 未被掩码，
- 0 表示 token 被掩码。
- decoder_input_ids (
torch.LongTensor，形状为(batch_size, target_sequence_length)，可选) — 词汇表中解码器输入序列 tokens 的索引。索引可以使用 AutoTokenizer 获取。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
XLMProphetNet 使用
eos_token_id作为decoder_input_ids生成的起始 token。如果使用past_key_values，则可以选择仅输入最后的decoder_input_ids（请参阅past_key_values）。 - decoder_attention_mask (
torch.BoolTensor，形状为(batch_size, target_sequence_length)，可选) — 默认行为：生成一个张量，该张量忽略decoder_input_ids中的填充 tokens。默认情况下也会使用因果掩码。 - 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 (
torch.LongTensor，形状为(batch_size,)，可选) — 用于计算序列分类/回归损失的标签。索引应在[-100, 0, ..., config.vocab_size - 1]中。所有设置为-100的标签都将被忽略（掩码），损失仅针对[0, ..., config.vocab_size]中的标签计算
返回
transformers.models.deprecated.xlm_prophetnet.modeling_xlm_prophetnet.XLMProphetNetSeq2SeqLMOutput 或 tuple(torch.FloatTensor)
一个 transformers.models.deprecated.xlm_prophetnet.modeling_xlm_prophetnet.XLMProphetNetSeq2SeqLMOutput 或一个 torch.FloatTensor 元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），包含各种元素，具体取决于配置 (XLMProphetNetConfig) 和输入。
-
loss (
torch.FloatTensor，形状为(1,)，可选，当提供labels时返回) — 语言建模损失。 -
logits (
torch.FloatTensor，形状为(batch_size, decoder_sequence_length, config.vocab_size)) — 主流语言建模头的预测得分（SoftMax 之前每个词汇表 token 的得分）。 -
logits_ngram (
torch.FloatTensor，形状为(batch_size, ngram * decoder_sequence_length, config.vocab_size)) — 预测流语言建模头的预测得分（SoftMax 之前每个词汇表 token 的得分）。 -
past_key_values (
List[torch.FloatTensor]，可选，当传递use_cache=True或当config.use_cache=True时返回) —torch.FloatTensor列表，长度为config.n_layers，每个 tensor 的形状为(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的元组（embeddings 输出的输出 + 每层输出的输出各一个），形状为(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的元组（embeddings 输出的输出 + 每层输出的输出各一个），形状为(batch_size, ngram * decoder_sequence_length, hidden_size)。解码器预测流在每层输出以及初始 embedding 输出处的隐藏状态。
-
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 之后，用于计算自注意力 head 中的加权平均值。
-
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的元组（embeddings 输出的输出 + 每层输出的输出各一个），形状为(batch_size, encoder_sequence_length, hidden_size)。编码器在每层输出以及初始 embedding 输出处的隐藏状态。
-
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 之后，用于计算自注意力头中的加权平均值。
XLMProphetNetForConditionalGeneration 前向方法，覆盖了 __call__ 特殊方法。
尽管 forward 传递的配方需要在该函数中定义，但之后应调用 Module 实例而不是此方法，因为前者负责运行预处理和后处理步骤，而后者会静默地忽略它们。
示例
>>> from transformers import AutoTokenizer, XLMProphetNetForConditionalGeneration
>>> tokenizer = AutoTokenizer.from_pretrained("patrickvonplaten/xprophetnet-large-uncased-standalone")
>>> model = XLMProphetNetForConditionalGeneration.from_pretrained("patrickvonplaten/xprophetnet-large-uncased-standalone")
>>> 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 tokensXLMProphetNetForCausalLM
class transformers.XLMProphetNetForCausalLM
< source >( config: XLMProphetNetConfig )
参数
- config (XLMProphetNetConfig) — 具有模型所有参数的模型配置类。使用配置文件初始化不会加载与模型相关的权重，仅加载配置。查看 from_pretrained() 方法以加载模型权重。
XLMProphetNetModel 的独立解码器部分，顶部带有一个 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.deprecated.xlm_prophetnet.modeling_xlm_prophetnet.XLMProphetNetDecoderLMOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor，形状为(batch_size, sequence_length)) — 词汇表中输入序列 tokens 的索引。默认情况下，如果您提供填充，则会忽略填充。索引可以使用 AutoTokenizer 获得。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensor，形状为(batch_size, sequence_length)，可选) — 用于避免对填充 token 索引执行 attention 的掩码。掩码值在[0, 1]中选择：- 1 表示 未被掩盖 的 token，
- 0 表示 被掩盖 的 token。
- head_mask (
torch.Tensor，形状为(encoder_layers, encoder_attention_heads)，可选) — 用于使 encoder 中 attention 模块的选定 head 无效的掩码。掩码值在[0, 1]中选择：- 1 表示 head 未被掩盖，
- 0 表示 head 被掩盖。
- output_attentions (
bool，可选) — 是否返回所有 attention 层的 attention tensors。 有关更多详细信息，请参阅返回 tensors 下的attentions。 - output_hidden_states (
bool，可选) — 是否返回所有层的 hidden states。 有关更多详细信息，请参阅返回 tensors 下的hidden_states。 - return_dict (
bool，可选) — 是否返回 ModelOutput 而不是普通 tuple。 - encoder_hidden_states (
torch.FloatTensor，形状为(batch_size, sequence_length, hidden_size)，可选) — encoder 最后一层输出的 hidden-states 序列。 如果模型配置为 decoder，则在 cross-attention 中使用。 - encoder_attention_mask (
torch.FloatTensor，形状为(batch_size, sequence_length)，可选) — 用于避免对 encoder 输入的填充 token 索引执行 attention 的掩码。 如果模型配置为 decoder，则此掩码在 cross-attention 中使用。掩码值在[0, 1]中选择： - cross_attn_head_mask (
torch.Tensor，形状为(decoder_layers, decoder_attention_heads)，可选) — 用于使 cross-attention 模块的选定 head 无效的掩码。掩码值在[0, 1]中选择：- 1 表示 head 未被掩盖，
- 0 表示 head 被掩盖。
- past_key_values (
tuple(tuple(torch.FloatTensor))，长度为config.n_layers，其中每个 tuple 包含 4 个形状为(batch_size, num_heads, sequence_length - 1, embed_size_per_head)的 tensors) — 包含 attention blocks 的预计算的 key 和 value hidden-states。 可用于加速解码。如果使用
past_key_values，则用户可以选择仅输入最后一个decoder_input_ids（那些没有将其过去的 key value states 提供给此模型的）形状为(batch_size, 1)，而不是所有形状为(batch_size, sequence_length)的decoder_input_ids。 - use_cache (
bool，可选) — 如果设置为True，则返回past_key_valueskey value states，并且可以用于加速解码（请参阅past_key_values）。- 1 表示 未被掩盖 的 token，
- 0 表示 被掩盖 的 token。
- labels (
torch.LongTensor，形状为(batch_size, sequence_length)，可选) — 用于计算从左到右语言建模损失（下一个词预测）的标签。 索引应在[-100, 0, ..., config.vocab_size]中（请参阅input_ids文档字符串）。 索引设置为-100的 tokens 将被忽略（掩盖），损失仅针对标签在[0, ..., config.vocab_size]中的 tokens 计算。
返回
transformers.models.deprecated.xlm_prophetnet.modeling_xlm_prophetnet.XLMProphetNetDecoderLMOutput 或 tuple(torch.FloatTensor)
transformers.models.deprecated.xlm_prophetnet.modeling_xlm_prophetnet.XLMProphetNetDecoderLMOutput 或 torch.FloatTensor 的 tuple（如果传递 return_dict=False 或当 config.return_dict=False 时），包含各种元素，具体取决于配置 (XLMProphetNetConfig) 和输入。
-
loss (
torch.FloatTensor，形状为(1,)，可选，当提供labels时返回) — 语言建模损失。 -
logits (
torch.FloatTensor，形状为(batch_size, decoder_sequence_length, config.vocab_size)) — 主流语言建模头的预测得分（SoftMax 之前每个词汇表 token 的得分）。 -
logits_ngram (
torch.FloatTensor，形状为(batch_size, ngram * decoder_sequence_length, config.vocab_size)) — 预测流语言建模头的预测得分（SoftMax 之前每个词汇表 token 的得分）。 -
past_key_values (
List[torch.FloatTensor]，可选，当传递use_cache=True或当config.use_cache=True时返回) —torch.FloatTensor列表，长度为config.n_layers，每个 tensor 的形状为(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的 Tuple（embedding 输出 + 每层输出一个），形状为(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的 Tuple（embedding 输出 + 每层输出一个），形状为(batch_size, ngram * decoder_sequence_length, hidden_size)。解码器预测流在每层输出以及初始 embedding 输出处的隐藏状态。
-
attentions (
tuple(torch.FloatTensor)，可选，当传递了output_attentions=True或当config.output_attentions=True时返回) —torch.FloatTensor的 Tuple（每层一个），形状为(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的 Tuple（每层一个），形状为(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 之后，用于计算加权平均值
XLMProphetNetForCausalLM forward 方法，覆盖了 __call__ 特殊方法。
尽管 forward 传递的配方需要在该函数中定义，但之后应调用 Module 实例而不是此方法，因为前者负责运行预处理和后处理步骤，而后者会静默地忽略它们。
示例
>>> from transformers import AutoTokenizer, XLMProphetNetForCausalLM
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("patrickvonplaten/xprophetnet-large-uncased-standalone")
>>> model = XLMProphetNetForCausalLM.from_pretrained("patrickvonplaten/xprophetnet-large-uncased-standalone")
>>> 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("patrickvonplaten/xprophetnet-large-uncased-standalone")
>>> model = EncoderDecoderModel.from_encoder_decoder_pretrained(
... "google-bert/bert-large-uncased", "patrickvonplaten/xprophetnet-large-uncased-standalone"
... )
>>> 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