Transformers 文档
XLM-ProphetNet
并获得增强的文档体验
开始使用
XLM-ProphetNet
此模型目前处于维护模式，我们不接受任何更改其代码的新 PR。如果您在使用此模型时遇到任何问题，请重新安装支持此模型的最新版本：v4.40.2。您可以通过运行以下命令进行操作：pip install -U transformers==4.40.2。
免责声明： 如果您发现任何异常，请提交 Github Issue 并分配给 @patrickvonplaten
概述
XLM-ProphetNet 模型由 Yu Yan、Weizhen Qi、Yeyun Gong、Dayiheng Liu、Nan Duan、Jiusheng Chen、Ruofei Zhang 和 Ming Zhou 于 2020 年 1 月 13 日在 ProphetNet: Predicting Future N-gram for Sequence-to-Sequence Pre-training 中提出。
XLM-ProphetNet 是一个编码器-解码器模型，可以预测未来 N 个 token 进行“ngram”语言建模，而不仅仅是预测下一个 token。其架构与 ProhpetNet 相同，但该模型是在多语言“wiki100”维基百科转储上训练的。XLM-ProphetNet 的模型架构和预训练目标与 ProphetNet 相同，但 XLM-ProphetNet 在跨语言数据集 XGLUE 上进行了预训练。
论文摘要如下：
在本文中，我们提出了一种新的序列到序列预训练模型 ProphetNet，它引入了一种名为“未来 N-gram 预测”的新型自监督目标和所提出的 N 流自注意力机制。与传统序列到序列模型中仅优化下一步预测不同，ProphetNet 通过 N 步预测进行优化，即在每个时间步同时预测接下来的 N 个 token。未来 N-gram 预测明确鼓励模型规划未来的 token，并防止过度拟合强局部相关性。我们分别使用基础规模数据集（16GB）和大规模数据集（160GB）预训练了 ProphetNet。然后，我们对 CNN/DailyMail、Gigaword 和 SQuAD 1.1 基准数据集进行了抽象摘要和问题生成任务的实验。实验结果表明，与使用相同规模预训练语料库的模型相比，ProphetNet 在所有这些数据集上都取得了新的最先进结果。
作者的代码可以在 此处 找到。
资源
XLMProphetNetConfig
类 transformers.XLMProphetNetConfig
< 源 >( activation_dropout: typing.Optional[float] = 0.1 activation_function: typing.Union[str, typing.Callable, NoneType] = 'gelu' vocab_size: typing.Optional[int] = 30522 hidden_size: typing.Optional[int] = 1024 encoder_ffn_dim: typing.Optional[int] = 4096 num_encoder_layers: typing.Optional[int] = 12 num_encoder_attention_heads: typing.Optional[int] = 16 decoder_ffn_dim: typing.Optional[int] = 4096 num_decoder_layers: typing.Optional[int] = 12 num_decoder_attention_heads: typing.Optional[int] = 16 attention_dropout: typing.Optional[float] = 0.1 dropout: typing.Optional[float] = 0.1 max_position_embeddings: typing.Optional[int] = 512 init_std: typing.Optional[float] = 0.02 is_encoder_decoder: typing.Optional[bool] = True add_cross_attention: typing.Optional[bool] = True decoder_start_token_id: typing.Optional[int] = 0 ngram: typing.Optional[int] = 2 num_buckets: typing.Optional[int] = 32 relative_max_distance: typing.Optional[int] = 128 disable_ngram_loss: typing.Optional[bool] = False eps: typing.Optional[float] = 0.0 use_cache: typing.Optional[bool] = True pad_token_id: typing.Optional[int] = 0 bos_token_id: typing.Optional[int] = 1 eos_token_id: typing.Optional[int] = 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) — 解码器中中间（通常称为前馈）层的维度。 - 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) — 用于初始化所有权重矩阵的 truncated_normal_initializer 的标准差。 - add_cross_attention (
bool, 可选, 默认为True) — 是否应向模型添加交叉注意力层。 - is_encoder_decoder (
bool, 可选, 默认为True) — 这是否是编码器/解码器模型。 - pad_token_id (
int, 可选, 默认为 1) — 填充 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) — 每个注意力层使用的桶的数量。用于相对位置计算。有关更多详细信息，请参见 [T5 论文](参见 https://huggingface.co/papers/1910.10683)。 - relative_max_distance (
int, 可选, 默认为 128) — 大于此数的相对距离将被放入最后一个相同的桶中。用于相对位置计算。有关更多详细信息，请参见 [T5 论文](参见 https://huggingface.co/papers/1910.10683)。 - disable_ngram_loss (
bool, 可选, 默认为False) — 是否只预测下一个 token 进行训练。 - eps (
float, 可选, 默认为 0.0) — 控制损失计算中标签平滑的epsilon参数值。如果设置为 0，则不执行标签平滑。 - use_cache (
bool, 可选, 默认为True) — 模型是否应返回最后一个 key/values 注意力（并非所有模型都使用）。
这是一个配置类，用于存储 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: typing.Optional[dict[str, typing.Any]] = 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 无限，并使用前向滤波和后向采样算法从所有假设（格）中采样。
-
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: typing.Optional[list[int]] = None ) → list[int]
通过连接和添加特殊标记，从序列或序列对构建序列分类任务的模型输入。XLMProphetNet 序列的格式如下
- 单个序列：
X [SEP] - 序列对：
A [SEP] B [SEP]
将一系列标记（子词的字符串）转换为单个字符串。
create_token_type_ids_from_sequences
< source >( token_ids_0: list token_ids_1: typing.Optional[list[int]] = None ) → list[int]
从传入的两个序列创建掩码，用于序列对分类任务。XLMProphetNet 不使用标记类型 ID，因此返回零列表。
get_special_tokens_mask
< source >( token_ids_0: list token_ids_1: typing.Optional[list[int]] = 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: typing.Optional[torch.Tensor] = None attention_mask: typing.Optional[torch.Tensor] = None decoder_input_ids: typing.Optional[torch.Tensor] = None decoder_attention_mask: typing.Optional[torch.BoolTensor] = None head_mask: typing.Optional[torch.Tensor] = None decoder_head_mask: typing.Optional[torch.Tensor] = None cross_attn_head_mask: typing.Optional[torch.Tensor] = None encoder_outputs: typing.Optional[tuple] = None past_key_values: typing.Optional[tuple[tuple[torch.Tensor]]] = None inputs_embeds: typing.Optional[torch.Tensor] = None decoder_inputs_embeds: typing.Optional[torch.Tensor] = None use_cache: typing.Optional[bool] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.models.deprecated.xlm_prophetnet.modeling_xlm_prophetnet.XLMProphetNetSeq2SeqModelOutput or 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()。
XLMProphetNet 使用
eos_token_id作为decoder_input_ids生成的起始标记。如果使用past_key_values，可以选择只输入最后一个decoder_input_ids（那些没有将其过去的键值状态提供给此模型的）（形状为(batch_size, 1)），而不是所有decoder_input_ids（形状为(batch_size, sequence_length)）。 - 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)，而不是所有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 而不是普通元组。
返回
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时返回) — 长度为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 之后，用于计算自注意力头中的加权平均。
XLMProphetNetModel 的 forward 方法，覆盖了 __call__ 特殊方法。
虽然前向传播的配方需要在该函数中定义，但在此之后应调用 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。请查看超类文档，了解库为其所有模型实现的一般方法（例如下载或保存、调整输入嵌入大小、修剪头等）
原始 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), 可选)：词嵌入参数。这可用于使用预定义的词嵌入初始化 XLMProphetNetEncoder，而不是随机初始化的词嵌入。
forward
< source >( input_ids: typing.Optional[torch.Tensor] = None attention_mask: typing.Optional[torch.Tensor] = None head_mask: typing.Optional[torch.Tensor] = None inputs_embeds: typing.Optional[torch.Tensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.modeling_outputs.BaseModelOutput 或 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 表示被遮盖的标记。
- 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 而不是普通元组。
返回
transformers.modeling_outputs.BaseModelOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.BaseModelOutput 或 torch.FloatTensor 的元组（如果传递 return_dict=False 或 config.return_dict=False），包含根据配置（XLMProphetNetConfig）和输入的不同元素。
-
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)。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
XLMProphetNetEncoder 的 forward 方法，覆盖了 __call__ 特殊方法。
虽然前向传播的配方需要在该函数中定义，但在此之后应调用 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
< 源文件 >( config: XLMProphetNetConfig word_embeddings: typing.Optional[torch.nn.modules.sparse.Embedding] = None )
参数
- config (XLMProphetNetConfig) — 模型配置类，包含模型的所有参数。用配置文件初始化不会加载与模型相关的权重，只加载配置。请查看 from_pretrained() 方法以加载模型权重。
XLMProphetNetModel 的独立解码器部分。此模型继承自 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), 可选)：词嵌入参数。这可用于使用预定义的词嵌入初始化 XLMProphetNetEncoder，而不是随机初始化的词嵌入。
forward
< 源文件 >( input_ids: typing.Optional[torch.Tensor] = None attention_mask: typing.Optional[torch.Tensor] = None encoder_hidden_states: typing.Optional[torch.Tensor] = None encoder_attention_mask: typing.Optional[torch.Tensor] = None head_mask: typing.Optional[torch.Tensor] = None cross_attn_head_mask: typing.Optional[torch.Tensor] = None past_key_values: typing.Optional[tuple[tuple[torch.Tensor]]] = None inputs_embeds: typing.Optional[torch.Tensor] = None use_cache: typing.Optional[bool] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.models.deprecated.xlm_prophetnet.modeling_xlm_prophetnet.XLMProphetNetDecoderModelOutput 或 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 表示被遮盖的标记。
- 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，用户可以选择仅输入形状为(batch_size, 1)的最后decoder_input_ids（那些没有将其过去键值状态提供给此模型的），而不是形状为(batch_size, sequence_length)的所有decoder_input_ids。 - use_cache (
bool，可选) — 如果设置为True，将返回past_key_values键值状态，可用于加速解码（参见past_key_values）。- 1 表示未被遮盖的标记，
- 0 表示被遮盖的标记。
返回
transformers.models.deprecated.xlm_prophetnet.modeling_xlm_prophetnet.XLMProphetNetDecoderModelOutput 或 tuple(torch.FloatTensor)
一个 transformers.models.deprecated.xlm_prophetnet.modeling_xlm_prophetnet.XLMProphetNetDecoderModelOutput 或 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时返回) — 长度为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)。解码器主流在每层输出处的隐藏状态以及初始嵌入输出。
-
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)。解码器预测流在每层输出处的隐藏状态以及初始嵌入输出。
-
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 之后，用于计算自注意力头中的加权平均。
-
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 之后，用于计算加权平均值。
XLMProphetNetDecoder 的 forward 方法，覆盖了 __call__ 特殊方法。
虽然前向传播的配方需要在该函数中定义，但在此之后应调用 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
< 源文件 >( 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
< 源文件 >( input_ids: typing.Optional[torch.Tensor] = None attention_mask: typing.Optional[torch.Tensor] = None decoder_input_ids: typing.Optional[torch.Tensor] = None decoder_attention_mask: typing.Optional[torch.BoolTensor] = None head_mask: typing.Optional[torch.Tensor] = None decoder_head_mask: typing.Optional[torch.Tensor] = None cross_attn_head_mask: typing.Optional[torch.Tensor] = None encoder_outputs: typing.Optional[torch.Tensor] = None past_key_values: typing.Optional[tuple[tuple[torch.Tensor]]] = None inputs_embeds: typing.Optional[torch.Tensor] = None decoder_inputs_embeds: typing.Optional[torch.Tensor] = None labels: typing.Optional[torch.Tensor] = None use_cache: typing.Optional[bool] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.models.deprecated.xlm_prophetnet.modeling_xlm_prophetnet.XLMProphetNetSeq2SeqLMOutput 或 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()。
XLMProphetNet 使用
eos_token_id作为decoder_input_ids生成的起始标记。如果使用past_key_values，可以选择只输入形状为(batch_size, 1)的最后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 而不是普通元组。 - 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 之前的每个词汇标记的分数）。 -
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 之后，用于计算自注意力头部中的加权平均。
XLMProphetNetForConditionalGeneration 的 forward 方法，覆盖了 __call__ 特殊方法。
虽然前向传播的配方需要在该函数中定义，但在此之后应调用 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
< 源文件 >( 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
< 源文件 >( input_ids: typing.Optional[torch.Tensor] = None attention_mask: typing.Optional[torch.Tensor] = None encoder_hidden_states: typing.Optional[torch.Tensor] = None encoder_attention_mask: typing.Optional[torch.Tensor] = None head_mask: typing.Optional[torch.Tensor] = None cross_attn_head_mask: typing.Optional[torch.Tensor] = None past_key_values: typing.Optional[tuple[tuple[torch.Tensor]]] = None inputs_embeds: typing.Optional[torch.Tensor] = None labels: typing.Optional[torch.Tensor] = None use_cache: typing.Optional[bool] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.models.deprecated.xlm_prophetnet.modeling_xlm_prophetnet.XLMProphetNetDecoderLMOutput or tuple(torch.FloatTensor)
参数
- input_ids (形状为
(batch_size, sequence_length)的torch.LongTensor) — 词汇表中输入序列 token 的索引。如果提供，默认情况下将忽略填充。索引可以使用 AutoTokenizer 获取。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (形状为
(batch_size, sequence_length)的torch.Tensor, 可选) — 避免对填充 token 索引执行注意力操作的掩码。掩码值选择范围为[0, 1]：- 1 表示 token 未被掩盖,
- 0 表示 token 被掩盖.
- 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, 可选) — 用于避免对编码器输入的填充 token 索引执行注意力操作的掩码。如果模型配置为解码器，则此掩码用于交叉注意力。掩码值选择范围为[0, 1]： - cross_attn_head_mask (形状为
(decoder_layers, decoder_attention_heads)的torch.Tensor, 可选) — 用于使交叉注意力模块的选定头部无效的掩码。掩码值选择范围为[0, 1]：- 1 表示头部未被掩盖,
- 0 表示头部被掩盖.
- past_key_values (长度为
config.n_layers的tuple(tuple(torch.FloatTensor))，每个元组包含 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）。- 1 表示 token 未被掩盖,
- 0 表示 token 被掩盖.
- labels (形状为
(batch_size, sequence_length)的torch.LongTensor, 可选) — 用于计算从左到右语言建模损失（下一个词预测）的标签。索引应在[-100, 0, ..., config.vocab_size]范围内（请参阅input_ids文档字符串）。索引设置为-100的 token 将被忽略（掩盖），损失仅针对标签在[0, ..., config.vocab_size]中的 token 计算。
返回
transformers.models.deprecated.xlm_prophetnet.modeling_xlm_prophetnet.XLMProphetNetDecoderLMOutput 或 tuple(torch.FloatTensor)
一个 transformers.models.deprecated.xlm_prophetnet.modeling_xlm_prophetnet.XLMProphetNetDecoderLMOutput 或一个 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 之前的每个词汇标记的分数）。 -
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输入）加速顺序解码。 -
hidden_states (
tuple(torch.FloatTensor)，可选，当传入output_hidden_states=True或config.output_hidden_states=True时返回) —torch.FloatTensor的元组（一个用于嵌入层的输出，加上一个用于每个层的输出），形状为(batch_size, decoder_sequence_length, hidden_size)。解码器主流在每层输出处的隐藏状态以及初始嵌入输出。
-
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)。解码器预测流在每层输出处的隐藏状态以及初始嵌入输出。
-
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 之后，用于计算自注意力头中的加权平均。
-
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 之后，用于计算加权平均值。
XLMProphetNetForCausalLM 的 forward 方法，重写了 __call__ 特殊方法。
虽然前向传播的配方需要在该函数中定义，但在此之后应调用 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