Hugging Face's logo

Transformers 文档

XLM-ProphetNet

Hugging Face's logo
加入 Hugging Face 社区

并获得增强的文档体验

开始使用

XLM-ProphetNet

PyTorch

此模型仅处于维护模式，我们不接受任何更改其代码的新 PR。如果您在运行此模型时遇到任何问题，请重新安装支持此模型的最后一个版本：v4.40.2。您可以通过运行以下命令来执行此操作：pip install -U transformers==4.40.2。

Models Spaces

免责声明： 如果您看到任何奇怪的东西，请提交 Github Issue 并指派 @patrickvonplaten

概述

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

XLM-ProphetNet 是一个编码器-解码器模型，可以预测 “ngram” 语言模型的 n 个未来标记，而不仅仅是下一个标记。它的架构与 ProhpetNet 相同，但该模型是在多语言 “wiki100” Wikipedia 转储上训练的。XLM-ProphetNet 的模型架构和预训练目标与 ProphetNet 相同，但 XLM-ProphetNet 是在跨语言数据集 XGLUE 上预训练的。

论文摘要如下：

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

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

资源

XLMProphetNetConfig

class 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, optional, defaults to 0.1) — 全连接层内部激活的 dropout 比率。
  • activation_function (str 或 function, optional, defaults to "gelu") — 编码器和池化器中的非线性激活函数（函数或字符串）。如果为字符串，则支持 "gelu"、"relu"、"silu" 和 "gelu_new"。
  • vocab_size (int, optional, defaults to 30522) — ProphetNET 模型的词汇表大小。定义了调用 XLMProphetNetModel 时传递的 inputs_ids 可以表示的不同 token 的数量。
  • hidden_size (int, optional, defaults to 1024) — 层和池化器层的维度。
  • encoder_ffn_dim (int, optional, defaults to 4096) — 解码器中“中间”（通常称为前馈）层的维度。
  • num_encoder_layers (int, optional, defaults to 12) — 编码器层数。
  • num_encoder_attention_heads (int, optional, defaults to 16) — Transformer 编码器中每个注意力层的注意力头数。
  • decoder_ffn_dim (int, optional, defaults to 4096) — 解码器中 intermediate（通常称为前馈）层的维度。
  • num_decoder_layers (int, optional, defaults to 12) — 解码器层数。
  • num_decoder_attention_heads (int, optional, defaults to 16) — Transformer 解码器中每个注意力层的注意力头数。
  • attention_dropout (float, optional, defaults to 0.1) — 注意力概率的 dropout 比率。
  • dropout (float, optional, defaults to 0.1) — 嵌入、编码器和池化器中所有全连接层的 dropout 概率。
  • max_position_embeddings (int, optional, defaults to 512) — 此模型可能使用的最大序列长度。通常设置为较大的值以防万一（例如，512 或 1024 或 2048）。
  • init_std (float, optional, defaults to 0.02) — 用于初始化所有权重矩阵的 truncated_normal_initializer 的标准差。
  • add_cross_attention (bool, optional, defaults to True) — 是否应将交叉注意力层添加到模型中。
  • is_encoder_decoder (bool, optional, defaults to True) — 这是否是编码器/解码器模型。
  • pad_token_id (int, optional, defaults to 1) — Padding token id。
  • bos_token_id (int, optional, defaults to 0) — 流开始 token id。
  • eos_token_id (int, optional, defaults to 2) — 流结束 token id。
  • ngram (int, optional, defaults to 2) — 要预测的未来 token 的数量。设置为 1 时，与传统的语言模型相同，以预测下一个第一个 token。
  • num_buckets (int, optional, defaults to 32) — 每个注意力层要使用的桶数。这用于相对位置计算。有关更多详细信息，请参阅 [T5 论文](see https://arxiv.org/abs/1910.10683)。
  • relative_max_distance (int, 可选, 默认为 128) — 相对距离大于此数字的将被放入最后一个桶中。这用于相对位置计算。 更多细节请参阅 [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

< >

( 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[typing.Dict[str, typing.Any]] = None **kwargs )

参数

  • vocab_file (str) — 词汇表文件的路径。
  • bos_token (str, 可选, 默认为 "[SEP]") — 预训练期间使用的序列开始 token。 可以用作序列分类器 token。

    当使用特殊 token 构建序列时，这不是用于序列开始的 token。 使用的 token 是 cls_token。
  • eos_token (str, 可选, 默认为 "[SEP]") — 序列结束 token。

    当使用特殊 token 构建序列时，这不是用于序列结束的 token。 使用的 token 是 sep_token。
  • sep_token (str, 可选, 默认为 "[SEP]") — 分隔符 token，用于从多个序列构建序列时，例如用于序列分类的两个序列，或用于问答的文本和问题。 它也用作使用特殊 token 构建的序列的最后一个 token。
  • unk_token (str, 可选, 默认为 "[UNK]") — 未知 token。 词汇表中不存在的 token 无法转换为 ID，而是设置为此 token。
  • pad_token (str, 可选, 默认为 "[PAD]") — 用于填充的 token，例如在批量处理不同长度的序列时。
  • cls_token (str, 可选, 默认为 "[CLS]") — 分类器 token，用于进行序列分类（对整个序列而不是每个 token 进行分类）。 当使用特殊 token 构建序列时，它是序列的第一个 token。
  • mask_token (str, 可选, 默认为 "[MASK]") — 用于掩码值的 token。 这是使用掩码语言建模训练此模型时使用的 token。 这是模型将尝试预测的 token。
  • 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) — 用于每次转换（字符串、token 和 ID）的 SentencePiece 处理器。

改编自 RobertaTokenizer 和 XLNetTokenizer。 基于 SentencePiece。

此 tokenizer 继承自 PreTrainedTokenizer，其中包含大多数主要方法。 用户应参考此超类以获取有关这些方法的更多信息。

build_inputs_with_special_tokens

< >

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

参数

  • token_ids_0 (List[int]) — 将向其添加特殊 token 的 ID 列表
  • token_ids_1 (List[int], 可选) — 用于序列对的可选的第二个 ID 列表。

返回

List[int]

带有适当特殊 token 的 输入 ID 列表。

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

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

convert_tokens_to_string

< >

( tokens )

将 token 序列（子词的字符串）转换为单个字符串。

create_token_type_ids_from_sequences

< >

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

参数

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

返回

List[int]

零列表。

创建从传递的两个序列生成的掩码，用于序列对分类任务。XLMProphetNet 不使用 token type ids，因此返回一个零列表。

get_special_tokens_mask

< >

( token_ids_0: typing.List[int] token_ids_1: typing.Optional[typing.List[int]] = None already_has_special_tokens: bool = False ) → List[int]

参数

  • token_ids_0 (List[int]) — ID 列表。
  • token_ids_1 (List[int], optional) — 序列对的可选的第二个 ID 列表。
  • already_has_special_tokens (bool, optional, defaults to False) — 指示 token 列表是否已使用模型的特殊 token 进行格式化。默认为 False。

返回

List[int]

一个整数列表，范围为 [0, 1]：1 代表特殊 token，0 代表序列 token。

从没有添加特殊 token 的 token 列表中检索序列 ID。当使用 tokenizer 的 prepare_for_model 方法添加特殊 token 时，将调用此方法。

XLMProphetNetModel

class transformers.XLMProphetNetModel

< >

( config: XLMProphetNetConfig )

参数

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

裸 XLMProphetNet 模型，输出原始隐藏状态，顶部没有任何特定的 head。此模型继承自 PreTrainedModel。查看超类文档，了解库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、剪枝 head 等）。

原始 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[typing.Tuple] = None past_key_values: typing.Optional[typing.Tuple[typing.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)) — 词汇表中输入序列 token 的索引。默认情况下，如果您提供 padding，padding 将被忽略。

    索引可以使用 AutoTokenizer 获得。 有关详细信息，请参见 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。

    什么是输入 IDs？

  • attention_mask (torch.Tensor，形状为 (batch_size, sequence_length), optional) — 避免在 padding token 索引上执行 attention 的掩码。掩码值在 [0, 1] 中选择：

    • 1 代表 未被掩盖 的 token，
    • 0 代表 被掩盖 的 token。

    什么是 attention 掩码？

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

    索引可以使用 AutoTokenizer 获得。 有关详细信息，请参见 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。

    什么是解码器输入 IDs？

    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), optional) — 默认行为：生成一个 tensor，该 tensor 忽略 decoder_input_ids 中的 pad token。默认情况下，也将使用因果掩码。
  • head_mask (torch.Tensor，形状为 (encoder_layers, encoder_attention_heads), optional) — 掩盖 encoder 中 attention 模块的选定 head。掩码值在 [0, 1] 中选择：

    • 1 表示 head 未被掩盖，
    • 0 表示 head 被掩盖。
  • decoder_head_mask (torch.Tensor，形状为 (decoder_layers, decoder_attention_heads), optional) — 掩盖 decoder 中 attention 模块的选定 head。掩码值在 [0, 1] 中选择：

    • 1 表示 head 未被掩盖，
    • 0 表示 head 被掩盖。
  • cross_attn_head_mask (torch.Tensor，形状为 (decoder_layers, decoder_attention_heads), optional) — 掩盖 cross-attention 模块的选定 head。掩码值在 [0, 1] 中选择：

    • 1 表示 head 未被掩盖，
    • 0 表示 head 被掩盖。
  • encoder_outputs (tuple(tuple(torch.FloatTensor), optional) — Tuple 由 (last_hidden_state, optional: hidden_states, optional: attentions) 组成， last_hidden_state 的形状为 (batch_size, sequence_length, hidden_size), optional) 是 encoder 最后一层输出的隐藏状态序列。在 decoder 的 cross-attention 中使用。
  • past_key_values (tuple(tuple(torch.FloatTensor))，长度为 config.n_layers，其中每个 tuple 具有 4 个形状为 (batch_size, num_heads, sequence_length - 1, embed_size_per_head) 的 tensor) — 包含 attention 块的预计算的 key 和 value 隐藏状态。可用于加速解码。

    如果使用 past_key_values，用户可以选择仅输入最后的 decoder_input_ids （那些没有将其过去的 key value 状态提供给此模型的） ，形状为 (batch_size, 1) 而不是所有形状为 (batch_size, sequence_length) 的 decoder_input_ids 。

  • use_cache (bool, optional) — 如果设置为 True，则返回 past_key_values key value 状态，并可用于加速解码（请参阅 past_key_values）。
  • output_attentions (bool, optional) — 是否返回所有 attention 层的 attention tensor。 有关更多详细信息，请参见返回的 tensor 下的 attentions。
  • output_hidden_states (bool, optional) — 是否返回所有层的隐藏状态。 有关更多详细信息，请参见返回的 tensor 下的 hidden_states。
  • return_dict (bool, optional) — 是否返回 ModelOutput 而不是普通的 tuple。

返回

transformers.models.deprecated.xlm_prophetnet.modeling_xlm_prophetnet.XLMProphetNetSeq2SeqModelOutput 或 tuple(torch.FloatTensor)

一个 transformers.models.deprecated.xlm_prophetnet.modeling_xlm_prophetnet.XLMProphetNetSeq2SeqModelOutput 或一个 torch.FloatTensor 的 tuple (如果传递 return_dict=False 或当 config.return_dict=False 时)，包括各种元素，具体取决于配置 (XLMProphetNetConfig) 和输入。

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

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

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

  • past_key_values (List[torch.FloatTensor], optional, 当传递 use_cache=True 或当 config.use_cache=True 时返回) — 长度为 config.n_layers 的 torch.FloatTensor 列表，其中每个 tensor 的形状为 (2, batch_size, num_attn_heads, decoder_sequence_length, embed_size_per_head))。

    包含 decoder 的预计算隐藏状态（attention 块中的 key 和 value），可以用于加速顺序解码（请参阅 past_key_values 输入）。

  • decoder_hidden_states (tuple(torch.FloatTensor), optional, 当传递 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — torch.FloatTensor 的 Tuple (embeddings 的输出一个，每层输出一个)，形状为 (batch_size, decoder_sequence_length, hidden_size)。

    decoder 主流在每一层输出以及初始 embedding 输出处的隐藏状态。

  • decoder_ngram_hidden_states (tuple(torch.FloatTensor), optional, 当传递 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — torch.FloatTensor 的 Tuple (embeddings 的输出一个，每层输出一个)，形状为 (batch_size, ngram * decoder_sequence_length, hidden_size)。

    decoder 预测流在每一层输出以及初始 embedding 输出处的隐藏状态。

  • decoder_attentions (tuple(torch.FloatTensor), optional, 当传递 output_attentions=True 或当 config.output_attentions=True 时返回) — torch.FloatTensor 的 Tuple (每层一个)，形状为 (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 states

XLMProphetNetEncoder

class transformers.XLMProphetNetEncoder

< >

( 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

< >

( 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)) — 词汇表中输入序列 tokens 的索引。默认情况下，如果您提供填充，则会忽略填充。

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

    什么是输入 IDs？

  • attention_mask (torch.Tensor，形状为 (batch_size, sequence_length), 可选) — 用于避免在 padding token 索引上执行注意力的掩码。在 [0, 1] 中选择的掩码值：

    • 1 表示 未被掩蔽 的 tokens，
    • 0 表示 被掩蔽 的 tokens。

    什么是注意力掩码？

  • 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_state

XLMProphetNetDecoder

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[typing.Tuple[typing.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)) — 词汇表中输入序列 tokens 的索引。默认情况下，如果您提供填充，则会忽略填充。

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

    什么是输入 IDs？

  • attention_mask (torch.Tensor，形状为 (batch_size, sequence_length), 可选) — 用于避免在 padding token 索引上执行注意力的掩码。在 [0, 1] 中选择的掩码值：

    • 1 表示 未被掩蔽 的 tokens，
    • 0 表示 被掩蔽 的 tokens。

    什么是注意力掩码？

  • 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), 可选) — 用于置空交叉注意力模块中选定 head 的掩码。掩码值选自 [0, 1]:

    • 1 表示 head 不被屏蔽，
    • 0 表示 head 被屏蔽。
  • 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.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)) — 模型 decoder 的最后一层输出的主流隐藏状态序列。

    如果使用 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], optional, 当传递 use_cache=True 或当 config.use_cache=True 时返回) — 长度为 config.n_layers 的 torch.FloatTensor 列表，其中每个 tensor 的形状为 (2, batch_size, num_attn_heads, decoder_sequence_length, embed_size_per_head))。

    包含 decoder 的预计算隐藏状态（attention 块中的 key 和 value），可以用于加速顺序解码（请参阅 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)。

    decoder 主流在每一层输出以及初始 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)。

    decoder 预测流在每一层输出以及初始 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 之后，用于计算自注意力头中的加权平均值。

  • 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_state

XLMProphetNetForConditionalGeneration

class transformers.XLMProphetNetForConditionalGeneration

< >

( config: XLMProphetNetConfig )

参数

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

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

原始 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[typing.Tuple[typing.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__()。

    什么是输入 IDs？

  • 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__()。

    什么是解码器输入 IDs？

    XLMProphetNet 使用 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), 可选) — 用于置空编码器中注意力模块的选定 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) 的张量) — 包含注意力模块的预计算的键和值隐藏状态。可用于加速解码。

    如果使用了 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 之前每个词汇标记的分数）。

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

  • past_key_values (List[torch.FloatTensor], optional, 当传递 use_cache=True 或当 config.use_cache=True 时返回) — 长度为 config.n_layers 的 torch.FloatTensor 列表，其中每个 tensor 的形状为 (2, batch_size, num_attn_heads, decoder_sequence_length, embed_size_per_head))。

    包含 decoder 的预计算隐藏状态（attention 块中的 key 和 value），可以用于加速顺序解码（请参阅 past_key_values 输入）。

  • decoder_hidden_states (tuple(torch.FloatTensor), optional, 当传递 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — torch.FloatTensor 的 Tuple (embeddings 的输出一个，每层输出一个)，形状为 (batch_size, decoder_sequence_length, hidden_size)。

    decoder 主流在每一层输出以及初始 embedding 输出处的隐藏状态。

  • decoder_ngram_hidden_states (tuple(torch.FloatTensor), optional, 当传递 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — torch.FloatTensor 的 Tuple (embeddings 的输出一个，每层输出一个)，形状为 (batch_size, ngram * decoder_sequence_length, hidden_size)。

    decoder 预测流在每一层输出以及初始 embedding 输出处的隐藏状态。

  • decoder_attentions (tuple(torch.FloatTensor), optional, 当传递 output_attentions=True 或当 config.output_attentions=True 时返回) — torch.FloatTensor 的 Tuple (每层一个)，形状为 (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 tokens

XLMProphetNetForCausalLM

class transformers.XLMProphetNetForCausalLM

< >

( config: XLMProphetNetConfig )

参数

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

XLMProphetNetModel 的独立解码器部分，顶部带有一个 lm head。该模型可用于因果语言建模。此模型继承自 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[typing.Tuple[typing.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 或 tuple(torch.FloatTensor)

参数

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

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

    什么是输入 IDs？

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

    • 1 表示标记未被掩蔽，
    • 0 表示标记已被掩蔽。

    什么是注意力掩码？

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

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

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

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

  • use_cache (bool, 可选) — 如果设置为 True，则返回 past_key_values 键值状态，并且可以用于加速解码（请参阅 past_key_values）。

    • 1 表示标记未被掩蔽，
    • 0 表示标记已被掩蔽。
  • labels (torch.LongTensor，形状为 (batch_size, sequence_length)，可选) — 用于计算从左到右语言建模损失（下一个单词预测）的标签。索引应在 [-100, 0, ..., config.vocab_size] 中（请参阅 input_ids docstring）。索引设置为 -100 的标记将被忽略（掩蔽），损失仅针对标签为 n [0, ..., config.vocab_size] 的标记计算

返回

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], optional, 当传递 use_cache=True 或当 config.use_cache=True 时返回) — 长度为 config.n_layers 的 torch.FloatTensor 列表，其中每个 tensor 的形状为 (2, batch_size, num_attn_heads, decoder_sequence_length, embed_size_per_head))。

    包含 decoder 的预计算隐藏状态（attention 块中的 key 和 value），可以用于加速顺序解码（请参阅 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)。

    decoder 主流在每一层输出以及初始 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)。

    decoder 预测流在每一层输出以及初始 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 之后，用于计算自注意力头中的加权平均值。

  • 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
< > 在 GitHub 上更新

←XLM XLM-RoBERTa→