Transformers 4.37 中文文档（六十二）

2024-06-26 17:02:47 浏览数 (1)

原文：huggingface.co/docs/transformers

XLM-ProphetNet

原始文本：huggingface.co/docs/transformers/v4.37.2/en/model_doc/xlm-prophetnet

**免责声明：**如果您看到异常情况，请提交GitHub 问题并指定@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 是一个编码器-解码器模型，可以预测“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

<来源>

代码语言：javascript复制
( 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）— 全连接层内激活的丢失比率。
  • activation_function（str或function，可选，默认为"gelu"）— 编码器和池化器中的非线性激活函数（函数或字符串）。如果是字符串，支持"gelu"，"relu"，"silu"和"gelu_new"。
  • vocab_size（int，可选，默认为 30522）— ProphetNET 模型的词汇量。定义了在调用 XLMProphetNetModel 时可以表示的不同标记的数量。
  • hidden_size（int，可选，默认为 1024）— 层和池化层的维度。
  • encoder_ffn_dim（int，可选，默认为 4096）— 解码器中“中间”（通常称为前馈）层的维度。
  • num_encoder_layers（int，可选，默认为 12）— 编码器层数。
  • num_encoder_attention_heads (int, optional, 默认为 16) — Transformer 编码器中每个注意力层的注意力头数。
  • decoder_ffn_dim (int, optional, 默认为 4096) — 解码器中intermediate（通常称为前馈）层的维度。
  • num_decoder_layers (int, optional, 默认为 12) — 解码器层的数量。
  • num_decoder_attention_heads (int, optional, 默认为 16) — Transformer 解码器中每个注意力层的注意力头数。
  • attention_dropout (float, optional, 默认为 0.1) — 注意力概率的丢弃比率。
  • dropout (float, optional, 默认为 0.1) — 嵌入层、编码器和池化器中所有全连接层的丢弃概率。
  • max_position_embeddings (int, optional, 默认为 512) — 该模型可能被使用的最大序列长度。通常设置为一个较大的值以防万一（例如 512、1024 或 2048）。
  • init_std (float, optional, 默认为 0.02) — 用于初始化所有权重矩阵的截断正态初始化器的标准差。
  • add_cross_attention (bool, optional, 默认为True) — 是否应向模型添加交叉注意力层。
  • is_encoder_decoder (bool, optional, 默认为True) — 是否这是一个编码器/解码器模型。
  • pad_token_id (int, optional, 默认为 1) — 填充标记 id。
  • bos_token_id (int, optional, 默认为 0) — 流的起始标记 id。
  • eos_token_id (int, optional, 默认为 2) — 流的结束标记 id。
  • ngram (int, optional, 默认为 2) — 预测未来标记的数量。设置为 1 以与传统语言模型相同，预测下一个第一个标记。
  • num_buckets (int, optional, 默认为 32) — 每个注意力层使用的桶的数量。这是用于相对位置计算的。更多细节请参阅 T5 论文)。
  • relative_max_distance (int, optional, 默认为 128) — 大于此数字的相对距离将放入最后一个相同的桶中。这是用于相对位置计算的。更多细节请参阅 T5 论文)。
  • disable_ngram_loss (bool, optional, 默认为False) — 是否训练仅预测下一个第一个标记。
  • eps (float, optional, 默认为 0.0) — 控制损失计算中标签平滑的epsilon参数值。如果设置为 0，则不执行标签平滑。
  • use_cache (bool, optional, 默认为True) — 模型是否应返回最后的键/值注意力（并非所有模型都使用）。

这是用于存储 XLMProphetNetModel 配置的配置类。根据指定的参数实例化 XLMProphetNet 模型，定义模型架构。使用默认值实例化配置将产生类似于 XLMProphetNet microsoft/xprophetnet-large-wiki100-cased架构的配置。

配置对象继承自 PretrainedConfig，可用于控制模型输出。阅读来自 PretrainedConfig 的文档以获取更多信息。

XLMProphetNetTokenizer

class transformers.XLMProphetNetTokenizer

<来源>

代码语言：javascript复制
( 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 为无限，并使用前向过滤和后向采样算法从所有假设（格）中进行采样。
    • alpha: 用于 unigram 采样的平滑参数，以及用于 BPE-dropout 合并操作的 dropout 概率。
  • sp_model (SentencePieceProcessor) — 用于每次转换（字符串、标记和 ID）的SentencePiece处理器。

改编自 RobertaTokenizer 和 XLNetTokenizer。基于SentencePiece。

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

build_inputs_with_special_tokens

<来源>

代码语言：javascript复制
( token_ids_0: List token_ids_1: Optional = None ) → export const metadata = 'undefined';List[int]

参数

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

返回

List[int]

包含适当特殊标记的 input IDs 列表。

通过连接和添加特殊标记，从序列或序列对构建用于序列分类任务的模型输入。XLMProphetNet 序列的格式如下：

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

<来源>

代码语言：javascript复制
( tokens )

将一系列标记（子词的字符串）转换为单个字符串。

create_token_type_ids_from_sequences

<来源>

代码语言：javascript复制
( token_ids_0: List token_ids_1: Optional = None ) → export const metadata = 'undefined';List[int]

参数

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

返回

List[int]

零的列表。

从传递的两个序列创建一个用于序列对分类任务的掩码。XLMProphetNet 不使用标记类型 ID，因此返回一个零列表。

get_special_tokens_mask

<来源>

代码语言：javascript复制
( token_ids_0: List token_ids_1: Optional = None already_has_special_tokens: bool = False ) → export const metadata = 'undefined';List[int]

参数

  • token_ids_0 (List[int]) — ID 列表。
  • token_ids_1 (List[int], 可选) — 序列对的可选第二个 ID 列表。
  • already_has_special_tokens (bool, 可选, 默认为False) — 标记列表是否已经格式化为模型的特殊标记。

返回

List[int]

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

从没有添加特殊标记的标记列表中检索序列 ID。当使用分词器的prepare_for_model方法添加特殊标记时，将调用此方法。

XLMProphetNetModel

class transformers.XLMProphetNetModel

<来源>

代码语言：javascript复制
( 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

<来源>

代码语言：javascript复制
( 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 ) → export const metadata = 'undefined';transformers.models.xlm_prophetnet.modeling_xlm_prophetnet.XLMProphetNetSeq2SeqModelOutput or tuple(torch.FloatTensor)

参数

  • input_ids (torch.LongTensor，形状为(batch_size, sequence_length)) — 词汇表中输入序列标记的索引。默认情况下将忽略填充。 可以使用 AutoTokenizer 获取索引。查看 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call() 获取详细信息。 什么是输入 ID？
  • attention_mask (torch.Tensor，形状为(batch_size, sequence_length)，可选) — 避免在填充标记索引上执行注意力的掩码。掩码值选择在[0, 1]中：
    • 1 表示未被屏蔽的标记，
    • 0 表示被屏蔽的标记。

    什么是注意力掩码？

  • decoder_input_ids（形状为 (batch_size, target_sequence_length) 的 torch.LongTensor，可选）— 词汇表中解码器输入序列标记的索引。 可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。 什么是解码器输入 ID？ XLMProphetNet 使用 eos_token_id 作为 decoder_input_ids 生成的起始标记。如果使用了 past_key_values，则可选择仅输入最后的 decoder_input_ids（参见 past_key_values）。
  • decoder_attention_mask（形状为 (batch_size, target_sequence_length) 的 torch.BoolTensor，可选）— 默认行为：生成一个张量，忽略 decoder_input_ids 中的填充标记。因果掩码也将默认使用。
  • head_mask（形状为 (encoder_layers, encoder_attention_heads) 的 torch.Tensor，可选）— 用于使编码器中注意力模块的选定头部失效的掩码。掩码值选定在 [0, 1]：
    • 1 表示头部未被屏蔽，
    • 0 表示头部被屏蔽。
  • decoder_head_mask（形状为 (decoder_layers, decoder_attention_heads) 的 torch.Tensor，可选）— 用于使解码器中注意力模块的选定头部失效的掩码。掩码值选定在 [0, 1]：
    • 1 表示头部未被屏蔽，
    • 0 表示头部被屏蔽。
  • cross_attn_head_mask（形状为 (decoder_layers, decoder_attention_heads) 的 torch.Tensor，可选）— 用于使交叉注意力模块的选定头部失效的掩码。掩码值选定在 [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（长度为 config.n_layers 的 tuple(tuple(torch.FloatTensor))，每个元组包含形状为 (batch_size, num_heads, sequence_length - 1, embed_size_per_head) 的 4 个张量）— 包含注意力块的预计算键和值隐藏状态。可用于加速解码。 如果使用了 past_key_values，用户可以选择仅输入最后的 decoder_input_ids（即未将其过去的键值状态提供给此模型的那些）的形状为 (batch_size, 1) 的张量，而不是形状为 (batch_size, sequence_length) 的所有 decoder_input_ids。
  • use_cache（bool，可选）— 如果设置为 True，将返回 past_key_values 键值状态，并可用于加速解码（参见 past_key_values）。
  • output_attentions（bool，可选）— 是否返回所有注意力层的注意力张量。有关更多详细信息，请参见返回张量中的 attentions。
  • output_hidden_states（bool，可选）— 是否返回所有层的隐藏状态。有关更多详细信息，请参见返回张量中的 hidden_states。
  • return_dict（bool，可选）— 是否返回 ModelOutput 而不是普通元组。

返回

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

一个transformers.models.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)，optional) — 模型解码器最后一层的预测流隐藏状态序列。
  • past_key_values (List[torch.FloatTensor]，optional，当传递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), optional, 当传递output_hidden_states=True或config.output_hidden_states=True时返回) — 形状为(batch_size, decoder_sequence_length, hidden_size)的torch.FloatTensor元组。 解码器主流的隐藏状态，在每一层的输出以及初始嵌入输出。
  • decoder_ngram_hidden_states (tuple(torch.FloatTensor), optional, 当传递output_hidden_states=True或config.output_hidden_states=True时返回) — 形状为(batch_size, ngram * decoder_sequence_length, hidden_size)的torch.FloatTensor元组。 解码器预测流的隐藏状态，在每一层的输出以及初始嵌入输出。
  • decoder_attentions (tuple(torch.FloatTensor), optional, 当传递output_attentions=True或config.output_attentions=True时返回) — 形状为(batch_size, num_attn_heads, decoder_sequence_length, decoder_sequence_length)的torch.FloatTensor元组。 解码器的注意力权重，在注意力 softmax 之后，用于计算自注意力头中的加权平均值。
  • decoder_ngram_attentions (tuple(torch.FloatTensor), optional, 当传递output_attentions=True或config.output_attentions=True时返回) — 形状为(batch_size, num_attn_heads, decoder_sequence_length, decoder_sequence_length)的torch.FloatTensor元组。 解码器预测流的注意力权重，在注意力 softmax 之后，用于计算加权平均值
  • cross_attentions (tuple(torch.FloatTensor), optional, 当传递output_attentions=True或config.output_attentions=True时返回) — 形状为(batch_size, num_attn_heads, encoder_sequence_length, decoder_sequence_length)的torch.FloatTensor元组。 解码器的交叉注意力层的注意力权重，在注意力 softmax 之后，用于计算加权平均值
  • encoder_last_hidden_state (torch.FloatTensor，形状为(batch_size, encoder_sequence_length, hidden_size)，optional) — 模型编码器最后一层的隐藏状态序列。
  • encoder_hidden_states（tuple(torch.FloatTensor)，可选，当传递output_hidden_states=True或config.output_hidden_states=True时返回）- 形状为(batch_size, encoder_sequence_length, hidden_size)的torch.FloatTensor元组（一个用于嵌入的输出 一个用于每一层的输出）。 编码器在每一层的输出的隐藏状态加上初始嵌入输出。
  • encoder_attentions（tuple(torch.FloatTensor)，可选，当传递output_attentions=True或config.output_attentions=True时返回）- 形状为(batch_size, num_attn_heads, encoder_sequence_length, encoder_sequence_length)的torch.FloatTensor元组（每层一个）。 编码器的注意力权重，在注意力 softmax 之后，用于计算自注意力头中的加权平均值。

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

虽然前向传递的方法需要在此函数内定义，但应该在此之后调用Module实例，而不是在此之后调用，因为前者负责运行预处理和后处理步骤，而后者会默默地忽略它们。

示例：

代码语言：javascript复制
>>> 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

<来源>

代码语言：javascript复制
( 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（形状为(config.vocab_size, config.hidden_size)的torch.nn.Embeddings，可选）：单词嵌入参数。这可以用于使用预定义的单词嵌入初始化 XLMProphetNetEncoder，而不是随机初始化的单词嵌入。

forward

<来源>

代码语言：javascript复制
( 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 ) → export const metadata = 'undefined';transformers.modeling_outputs.BaseModelOutput or tuple(torch.FloatTensor)

参数

  • input_ids（形状为(batch_size, sequence_length)的torch.LongTensor）- 词汇表中输入序列标记的索引。默认情况下，如果提供填充，则将忽略填充。 可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode()和 PreTrainedTokenizer.call()。 什么是输入 ID？
  • attention_mask (torch.Tensor of shape (batch_size, sequence_length), optional) — 用于避免在填充令牌索引上执行注意力的掩码。掩码值选在[0, 1]之间：
    • 1 代表未被masked的标记，
    • 0 代表被masked的标记。

    什么是注意力掩码？

  • head_mask (torch.Tensor of shape (encoder_layers, encoder_attention_heads), optional) — 用于使编码器中注意力模块的选定头部失效的掩码。掩码值选在[0, 1]之间：
    • 1 表示头部未被masked，
    • 0 indicates the head is masked.
  • output_attentions (bool, optional) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的attentions。
  • output_hidden_states (bool, optional) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的hidden_states。
  • return_dict (bool, optional) — 是否返回一个 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 of shape (batch_size, sequence_length, hidden_size)) — 模型最后一层的隐藏状态序列。
  • hidden_states (tuple(torch.FloatTensor), optional, returned when output_hidden_states=True is passed or when config.output_hidden_states=True) — Tuple of torch.FloatTensor (one for the output of the embeddings, if the model has an embedding layer, one for the output of each layer) of shape (batch_size, sequence_length, hidden_size). 模型在每一层输出的隐藏状态以及可选的初始嵌入输出。
  • attentions (tuple(torch.FloatTensor), optional, returned when output_attentions=True is passed or when config.output_attentions=True) — Tuple of torch.FloatTensor (one for each layer) of shape (batch_size, num_heads, sequence_length, sequence_length). 在注意力 softmax 之后的注意力权重，用于计算自注意力头中的加权平均值。

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

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

示例：

代码语言：javascript复制
>>> 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

<来源>

代码语言：javascript复制
( config: XLMProphetNetConfig word_embeddings: Optional = 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（形状为(config.vocab_size, config.hidden_size)的torch.nn.Embeddings，可选）：词嵌入参数。这可以用于使用预定义的词嵌入初始化 XLMProphetNetEncoder，而不是随机初始化的词嵌入。

forward

<来源>

代码语言：javascript复制
( 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 ) → export const metadata = 'undefined';transformers.models.xlm_prophetnet.modeling_xlm_prophetnet.XLMProphetNetDecoderModelOutput or tuple(torch.FloatTensor)

参数

  • input_ids（形状为(batch_size, sequence_length)的torch.LongTensor）— 词汇表中输入序列令牌的索引。默认情况下将忽略填充。 可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode()和 PreTrainedTokenizer.call()。 什么是输入 ID？
  • attention_mask（形状为(batch_size, sequence_length)的torch.Tensor，可选）— 用于避免在填充令牌索引上执行注意力的掩码。掩码值选择在[0, 1]之间：
    • 对于未被掩盖的令牌为 1，
    • 对于被掩盖的令牌为 0。

    什么是注意力掩码？

  • head_mask（形状为(encoder_layers, encoder_attention_heads)的torch.Tensor，可选）— 用于使编码器中注意力模块的选定头部失效的掩码。掩码值选择在[0, 1]之间：
    • 1 表示头部未被掩盖，
    • 0 表示头部被掩盖。
  • output_attentions（bool，可选）— 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的attentions。
  • output_hidden_states（bool，可选）— 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的hidden_states。
  • return_dict（bool，可选）— 是否返回 ModelOutput 而不是普通元组。
  • encoder_hidden_states（形状为(batch_size, sequence_length, hidden_size)的torch.FloatTensor，可选）— 编码器最后一层的隐藏状态序列。如果模型配置为解码器，则在交叉注意力中使用。
  • encoder_attention_mask（形状为(batch_size, sequence_length)的torch.FloatTensor，可选）— 用于避免在编码器输入的填充令牌索引上执行注意力的掩码。如果模型配置为解码器，则在交叉注意力中使用此掩码。掩码值选择在[0, 1]之间：
  • cross_attn_head_mask（形状为(decoder_layers, decoder_attention_heads)的torch.Tensor，可选）— 用于使交叉注意力模块的选定头部失效的掩码。掩码值选择在[0, 1]之间：
    • 1 表示头部未被掩盖，
    • 0 表示头部被masked。
  • past_key_values (tuple(tuple(torch.FloatTensor)) of length config.n_layers with each tuple having 4 tensors of shape (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, optional) — 如果设置为True，则返回past_key_values键值状态，可用于加速解码（参见past_key_values）。
    • 对于未被masked的标记为 1，
    • 对于被masked的标记为 0。

返回

transformers.models.xlm_prophetnet.modeling_xlm_prophetnet.XLMProphetNetDecoderModelOutput或torch.FloatTensor元组

一个transformers.models.xlm_prophetnet.modeling_xlm_prophetnet.XLMProphetNetDecoderModelOutput或一个torch.FloatTensor元组（如果传递return_dict=False或config.return_dict=False）包含根据配置（XLMProphetNetConfig）和输入的各种元素。

  • last_hidden_state (torch.FloatTensor of shape (batch_size, decoder_sequence_length, hidden_size)) — 模型解码器最后一层的主要隐藏状态序列的输出。 如果仅使用past_key_values，则输出序列的最后一个隐藏状态的形状为(batch_size, 1, hidden_size)。
  • last_hidden_state_ngram (torch.FloatTensor of shape (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列表，每个张量的形状为(2, batch_size, num_attn_heads, decoder_sequence_length, embed_size_per_head)。 包含解码器的预计算隐藏状态（注意力块中的键和值）可用于加速顺序解码（参见past_key_values输入）。
  • hidden_states (tuple(torch.FloatTensor), optional, 当传递output_hidden_states=True或config.output_hidden_states=True时返回) — 形状为(batch_size, decoder_sequence_length, hidden_size)的torch.FloatTensor元组。 解码器每一层的主要流的隐藏状态以及初始嵌入输出。
  • ngram_hidden_states (tuple(torch.FloatTensor), optional, 当传递output_hidden_states=True或config.output_hidden_states=True时返回) — 形状为(batch_size, ngram * decoder_sequence_length, hidden_size)的torch.FloatTensor元组。 解码器预测流每一层的隐藏状态以及初始嵌入输出。
  • attentions (tuple(torch.FloatTensor), optional, 当传递output_attentions=True或config.output_attentions=True时返回) — 形状为(batch_size, num_attn_heads, decoder_sequence_length, decoder_sequence_length)的torch.FloatTensor元组。 解码器的注意力权重，在注意力 softmax 之后，用于计算自注意力头中的加权平均值。
  • ngram_attentions (tuple(torch.FloatTensor), optional, 当传递output_attentions=True或config.output_attentions=True时返回) — 形状为(batch_size, num_attn_heads, decoder_sequence_length, decoder_sequence_length)的torch.FloatTensor元组。 解码器预测流的注意力权重，在注意力 softmax 之后，用于计算
  • cross_attentions（tuple(torch.FloatTensor)，可选，当传递output_attentions=True或当config.output_attentions=True时返回） — 形状为(batch_size, num_attn_heads, encoder_sequence_length, decoder_sequence_length)的torch.FloatTensor元组（每层一个）。 解码器的交叉注意力层的注意力权重，在注意力 softmax 之后，用于计算

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

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

示例：

代码语言：javascript复制
>>> 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

<来源>

代码语言：javascript复制
( 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

<来源>

代码语言：javascript复制
( 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 ) → export const metadata = 'undefined';transformers.models.xlm_prophetnet.modeling_xlm_prophetnet.XLMProphetNetSeq2SeqLMOutput or tuple(torch.FloatTensor)

参数

  • input_ids（形状为(batch_size, sequence_length)的torch.LongTensor） — 词汇表中输入序列标记的索引。默认情况下，如果提供填充，则将忽略填充。 可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode()和 PreTrainedTokenizer.call()。 什么是输入 ID？
  • attention_mask（形状为(batch_size, sequence_length)的torch.Tensor，可选） — 避免在填充标记索引上执行注意力的掩码。掩码值选择在[0, 1]之间：
    • 1 表示未被masked的标记，
    • 0 表示被masked的标记。

    什么是注意力掩码？

  • decoder_input_ids（形状为(batch_size, target_sequence_length)的torch.LongTensor，可选） — 词汇表中解码器输入序列标记的索引。 可以使用 AutoTokenizer 获取索引。有关详细信息，请参见 PreTrainedTokenizer.encode()和 PreTrainedTokenizer.call()。 什么是解码器输入 ID？ XLMProphetNet 使用eos_token_id作为decoder_input_ids生成的起始标记。如果使用past_key_values，则可以选择仅输入最后的decoder_input_ids（参见past_key_values）。
  • decoder_attention_mask（形状为（batch_size，target_sequence_length）的torch.BoolTensor，可选）— 默认行为：生成一个张量，忽略decoder_input_ids中的填充标记。因果掩码也将默认使用。
  • head_mask（形状为（encoder_layers，encoder_attention_heads）的torch.Tensor，可选）— 用于使编码器中注意力模块的选定头部失效的掩码。在[0，1]中选择的掩码值：
    • 1 表示头部未被遮蔽，
    • 0 表示头部被遮蔽。
  • decoder_head_mask（形状为（decoder_layers，decoder_attention_heads）的torch.Tensor，可选）— 用于使解码器中注意力模块的选定头部失效的掩码。在[0，1]中选择的掩码值：
    • 1 表示头部未被遮蔽，
    • 0 表示头部被遮蔽。
  • cross_attn_head_mask（形状为（decoder_layers，decoder_attention_heads）的torch.Tensor，可选）— 用于使交叉注意力模块的选定头部失效的掩码。在[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（长度为config.n_layers的tuple(tuple(torch.FloatTensor))，每个元组包含形状为（batch_size，num_heads，sequence_length - 1，embed_size_per_head）的 4 个张量）— 包含注意力块的预计算键和值隐藏状态。可用于加速解码。 如果使用past_key_values，用户可以选择仅输入最后的decoder_input_ids（即未将其过去的键值状态提供给此模型的那些）的形状为（batch_size，1）而不是形状为（batch_size，sequence_length）的所有decoder_input_ids。
  • use_cache（bool，可选）— 如果设置为True，则返回past_key_values键值状态，并可用于加速解码（参见past_key_values）。
  • output_attentions（bool，可选）— 是否返回所有注意力层的注意力张量。有关更多详细信息，请参见返回张量中的attentions。
  • output_hidden_states（bool，可选）— 是否返回所有层的隐藏状态。有关更多详细信息，请参见返回张量中的hidden_states。
  • return_dict（bool，可选）— 是否返回 ModelOutput 而不是普通元组。
  • labels（形状为（batch_size，）的torch.LongTensor，可选）— 用于计算序列分类/回归损失的标签。索引应在[-100，0，...，config.vocab_size - 1]中。所有标签设置为-100都将被忽略（遮蔽），损失仅计算标签在[0，...，config.vocab_size]中的标签

返回

transformers.models.xlm_prophetnet.modeling_xlm_prophetnet.XLMProphetNetSeq2SeqLMOutput或tuple(torch.FloatTensor)

一个transformers.models.xlm_prophetnet.modeling_xlm_prophetnet.XLMProphetNetSeq2SeqLMOutput或一个torch.FloatTensor元组（如果传递return_dict=False或config.return_dict=False）包含根据配置（XLMProphetNetConfig）和输入的各种元素。

  • loss（形状为(1,)的torch.FloatTensor，可选，当提供labels时返回）- 语言建模损失。
  • logits（形状为(batch_size, decoder_sequence_length, config.vocab_size)的torch.FloatTensor）- 主流语言建模头的预测分数（SoftMax 之前每个词汇标记的分数）。
  • logits_ngram（形状为(batch_size, ngram * decoder_sequence_length, config.vocab_size)的torch.FloatTensor）- 预测流语言建模头的预测分数（SoftMax 之前每个词汇标记的分数）。
  • past_key_values（List[torch.FloatTensor]，可选，当传递use_cache=True或config.use_cache=True时返回）- 长度为config.n_layers的torch.FloatTensor列表，每个张量的形状为(2, batch_size, num_attn_heads, decoder_sequence_length, embed_size_per_head)。 包含解码器的预先计算的隐藏状态（注意力块中的键和值），可用于加速顺序解码。
  • decoder_hidden_states（tuple(torch.FloatTensor)，可选，当传递output_hidden_states=True或config.output_hidden_states=True时返回）- 形状为(batch_size, decoder_sequence_length, hidden_size)的torch.FloatTensor元组（一个用于嵌入的输出 一个用于每一层的输出）。 解码器主流的隐藏状态，在每一层的输出以及初始嵌入输出。
  • decoder_ngram_hidden_states（tuple(torch.FloatTensor)，可选，当传递output_hidden_states=True或config.output_hidden_states=True时返回）- 形状为(batch_size, ngram * decoder_sequence_length, hidden_size)的torch.FloatTensor元组（一个用于嵌入的输出 一个用于每一层的输出）。 解码器预测流的隐藏状态，在每一层的输出以及初始嵌入输出。
  • decoder_attentions（tuple(torch.FloatTensor)，可选，当传递output_attentions=True或config.output_attentions=True时返回）- 形状为(batch_size, num_attn_heads, decoder_sequence_length, decoder_sequence_length)的torch.FloatTensor元组（每层一个）。 解码器的注意力权重，在注意力 softmax 之后，用于计算自注意力头中的加权平均值。
  • decoder_ngram_attentions（tuple(torch.FloatTensor)，可选，当传递output_attentions=True或config.output_attentions=True时返回）- 形状为(batch_size, num_attn_heads, decoder_sequence_length, decoder_sequence_length)的torch.FloatTensor元组（每层一个）。 解码器预测流的注意力权重，在注意力 softmax 之后，用于计算自注意力头中的加权平均值。
  • cross_attentions（tuple(torch.FloatTensor)，可选，当传递output_attentions=True或config.output_attentions=True时返回）- 形状为(batch_size, num_attn_heads, encoder_sequence_length, decoder_sequence_length)的torch.FloatTensor元组（每层一个）。 解码器的交叉注意力层的注意力权重，在注意力 softmax 之后，用于计算加权平均值。
  • encoder_last_hidden_state（形状为(batch_size, encoder_sequence_length, hidden_size)的torch.FloatTensor，可选）- 模型编码器最后一层的隐藏状态序列。
  • encoder_hidden_states（tuple(torch.FloatTensor)，可选，当传递output_hidden_states=True或config.output_hidden_states=True时返回）- 形状为(batch_size, encoder_sequence_length, hidden_size)的torch.FloatTensor元组（一个用于嵌入的输出 一个用于每个层的输出）。 每个层的编码器的隐藏状态加上初始嵌入输出。
  • encoder_attentions（tuple(torch.FloatTensor)，可选，当传递output_attentions=True或config.output_attentions=True时返回）- 形状为(batch_size, num_attn_heads, encoder_sequence_length, encoder_sequence_length)的torch.FloatTensor元组（每个层一个）。编码器的注意力权重，在注意力 softmax 之后，用于计算自注意力头中的加权平均值。

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

虽然前向传递的步骤需要在此函数内定义，但应该在此之后调用Module实例，而不是在此处调用，因为前者负责运行预处理和后处理步骤，而后者会默默地忽略它们。

示例：

代码语言：javascript复制
>>> 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

<来源>

代码语言：javascript复制
( 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

<来源>

代码语言：javascript复制
( 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 ) → export const metadata = 'undefined';transformers.models.xlm_prophetnet.modeling_xlm_prophetnet.XLMProphetNetDecoderLMOutput or tuple(torch.FloatTensor)

参数

  • input_ids（形状为(batch_size, sequence_length)的torch.LongTensor）- 词汇表中输入序列标记的索引。默认情况下将忽略填充。 可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode()和 PreTrainedTokenizer.call()。 什么是输入 ID？
  • attention_mask（形状为(batch_size, sequence_length)的torch.Tensor，可选）- 避免在填充标记索引上执行注意力的掩码。选择的掩码值在[0, 1]中：
    • 对于未被“掩码”的标记，
    • 对于被“掩码”的标记。

    什么是注意力掩码？

  • head_mask（形状为(encoder_layers, encoder_attention_heads)的torch.Tensor，可选）— 用于将编码器中注意力模块的选定头部置零的掩码。掩码值在[0, 1]中选择：
    • 1 表示头部未被“掩码”，
    • 0 表示头部被“掩码”。
  • output_attentions（bool，可选）— 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的attentions。
  • output_hidden_states（bool，可选）— 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的hidden_states。
  • return_dict（bool，可选）— 是否返回 ModelOutput 而不是普通元组。
  • encoder_hidden_states（形状为(batch_size, sequence_length, hidden_size)的torch.FloatTensor，可选）— 编码器最后一层输出的隐藏状态序列。如果模型配置为解码器，则在交叉注意力中使用。
  • encoder_attention_mask（形状为(batch_size, sequence_length)的torch.FloatTensor，可选）— 用于避免对编码器输入的填充标记索引执行注意力。如果模型配置为解码器，则在交叉注意力中使用此掩码。掩码值在[0, 1]中选择：
  • cross_attn_head_mask（形状为(decoder_layers, decoder_attention_heads)的torch.Tensor，可选）— 用于将交叉注意力模块的选定头部置零的掩码。掩码值在[0, 1]中选择：
    • 1 表示头部未被“掩码”，
    • 0 表示头部被“掩码”。
  • past_key_values（长度为config.n_layers的tuple(tuple(torch.FloatTensor))，每个元组包含形状为(batch_size, num_heads, sequence_length - 1, embed_size_per_head)的 4 个张量）— 包含注意力块的预计算键和值隐藏状态。可用于加速解码。 如果使用了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）。
    • 对于未被“掩码”的标记，
    • 对于被“掩码”的标记。
  • labels（形状为(batch_size, sequence_length)的torch.LongTensor，可选）— 用于计算从左到右的语言建模损失（下一个词预测）的标签。索引应在[-100, 0, ..., config.vocab_size]中（参见input_ids文档字符串）。索引设置为-100的标记将被忽略（掩码），损失仅计算具有标签 n [0, ..., config.vocab_size]的标记

返回

transformers.models.xlm_prophetnet.modeling_xlm_prophetnet.XLMProphetNetDecoderLMOutput或tuple(torch.FloatTensor)

一个transformers.models.xlm_prophetnet.modeling_xlm_prophetnet.XLMProphetNetDecoderLMOutput或一个torch.FloatTensor的元组（如果传递了return_dict=False或当config.return_dict=False时）包含根据配置（XLMProphetNetConfig）和输入的各种元素。

  • loss（形状为(1,)的torch.FloatTensor，可选，在提供labels时返回）— 语言建模损失。
  • logits（形状为(batch_size, decoder_sequence_length, config.vocab_size)的torch.FloatTensor）— 主流语言建模头部的预测分数（SoftMax 之前每个词汇标记的分数）。
  • logits_ngram (形状为 (batch_size, ngram * decoder_sequence_length, config.vocab_size)的torch.FloatTensor`) — 预测流语言建模头的预测分数（SoftMax 前每个词汇标记的分数）。
  • past_key_values (List[torch.FloatTensor], 可选的，当传递 use_cache=True 或当 config.use_cache=True 时返回) — 长度为 config.n_layers 的 torch.FloatTensor 列表，每个张量的形状为 (2, batch_size, num_attn_heads, decoder_sequence_length, embed_size_per_head)。 包含解码器的预计算隐藏状态（注意力块中的键和值），可用于加速顺序解码（见 past_key_values 输入）。
  • hidden_states (tuple(torch.FloatTensor), 可选的，当传递 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — 形状为 (batch_size, decoder_sequence_length, hidden_size) 的 torch.FloatTensor 元组（一个用于嵌入的输出 一个用于每层的输出）。 解码器主流的隐藏状态，在每层的输出以及初始嵌入输出。
  • ngram_hidden_states (tuple(torch.FloatTensor), 可选的，当传递 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — 形状为 (batch_size, ngram * decoder_sequence_length, hidden_size) 的 torch.FloatTensor 元组（一个用于嵌入的输出 一个用于每层的输出）。 解码器预测流的隐藏状态，在每层的输出以及初始嵌入输出。
  • attentions (tuple(torch.FloatTensor), 可选的，当传递 output_attentions=True 或当 config.output_attentions=True 时返回) — 形状为 (batch_size, num_attn_heads, decoder_sequence_length, decoder_sequence_length) 的 torch.FloatTensor 元组（每层一个）。 解码器的注意力权重，在注意力 softmax 之后，用于计算自注意力头中的加权平均值。
  • ngram_attentions (tuple(torch.FloatTensor), 可选的，当传递 output_attentions=True 或当 config.output_attentions=True 时返回) — 形状为 (batch_size, num_attn_heads, decoder_sequence_length, decoder_sequence_length) 的 torch.FloatTensor 元组（每层一个）。 解码器预测流的注意力权重，在注意力 softmax 之后，用于计算加权平均值。
  • cross_attentions (tuple(torch.FloatTensor), 可选的，当传递 output_attentions=True 或当 config.output_attentions=True 时返回) — 形状为 (batch_size, num_attn_heads, encoder_sequence_length, decoder_sequence_length) 的 torch.FloatTensor 元组（每层一个）。 解码器的交叉注意力层的注意力权重，在注意力 softmax 之后，用于计算加权平均值。

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

虽然前向传递的步骤需要在这个函数内定义，但应该在之后调用 Module 实例，而不是这个函数，因为前者会处理运行前后处理步骤，而后者会默默地忽略它们。

示例：

代码语言：javascript复制
>>> 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("bert-large-uncased")
>>> tokenizer_dec = AutoTokenizer.from_pretrained("patrickvonplaten/xprophetnet-large-uncased-standalone")
>>> model = EncoderDecoderModel.from_encoder_decoder_pretrained(
...     "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

XLM-RoBERTa

原始文本：huggingface.co/docs/transformers/v4.37.2/en/model_doc/xlm-roberta

概述

XLM-RoBERTa 模型是由 Alexis Conneau、Kartikay Khandelwal、Naman Goyal、Vishrav Chaudhary、Guillaume Wenzek、Francisco Guzmán、Edouard Grave、Myle Ott、Luke Zettlemoyer 和 Veselin Stoyanov 在《规模化无监督跨语言表示学习》一文中提出的。它基于 Facebook 于 2019 年发布的 RoBERTa 模型。这是一个大型的多语言语言模型，训练了 2.5TB 的经过滤的 CommonCrawl 数据。

论文摘要如下：

这篇论文表明，规模化预训练多语言语言模型可以显著提高各种跨语言转移任务的性能。我们在一百种语言上训练了基于 Transformer 的掩码语言模型，使用了超过两太字节的经过滤波的 CommonCrawl 数据。我们的模型，被称为 XLM-R，在各种跨语言基准测试中明显优于多语言 BERT（mBERT），包括 XNLI 上平均准确率提高了 13.8％，MLQA 上平均 F1 分数提高了 12.3％，NER 上平均 F1 分数提高了 2.1％。XLM-R 在低资源语言上表现特别出色，在 XNLI 准确率上为斯瓦希里语提高了 11.8％，乌尔都语提高了 9.2％，超过了之前的 XLM 模型。我们还对实现这些收益所需的关键因素进行了详细的实证评估，包括（1）正向转移和容量稀释之间的权衡，以及（2）规模上高低资源语言的性能。最后，我们首次展示了多语言建模的可能性，而不会牺牲每种语言的性能；XLM-R 在 GLUE 和 XNLI 基准测试上与强大的单语模型竞争力强。我们将公开提供 XLM-R 的代码、数据和模型。

这个模型是由stefan-it贡献的。原始代码可以在这里找到。

使用提示

  • XLM-RoBERTa 是在 100 种不同语言上训练的多语言模型。与一些 XLM 多语言模型不同，它不需要lang张量来理解使用的语言，并且应该能够从输入 id 中确定正确的语言。
  • 使用 RoBERTa 技巧在 XLM 方法上，但不使用翻译语言建模目标。它只在来自一种语言的句子上使用掩码语言建模。

资源

一个官方的 Hugging Face 和社区（由

函数 模型 配置 索引 size

0 人点赞