Transformers 文档
ProphetNet
并获得增强的文档体验
开始使用
该模型于 2020 年 1 月 13 日在 HF papers 上发布，并于 2020 年 11 月 16 日贡献给 Hugging Face Transformers。
ProphetNet
概述
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 中提出。
ProphetNet 是一个编码器-解码器模型，它不仅能预测下一个词，还能预测用于“ngram”语言建模的 n 个未来词元。
论文摘要如下：
在本文中，我们提出了一种名为 ProphetNet 的新型序列到序列预训练模型，它引入了一种名为未来 n-gram 预测的创新自监督目标，以及提出的 n-流自注意力机制。与传统序列到序列模型中仅预测下一步的优化方式不同，ProphetNet 通过预测下一步的优化方式进行训练，即在每个时间步基于之前的上下文词元同时预测接下来的 n 个词元。未来 n-gram 预测明确鼓励模型为未来的词元进行规划，并防止在局部强相关性上过拟合。我们分别使用基础规模数据集（16GB）和大规模数据集（160GB）对 ProphetNet 进行了预训练。随后，我们在 CNN/DailyMail、Gigaword 和 SQuAD 1.1 基准测试上进行了抽象摘要和问题生成任务的实验。实验结果表明，与使用相同规模预训练语料库的模型相比，ProphetNet 在所有这些数据集上都取得了最新的顶尖结果。
作者的代码可以在这里找到。
使用技巧
- ProphetNet 是一个带有绝对位置嵌入的模型，因此通常建议在右侧填充输入，而不是在左侧。
- 该模型架构基于原始 Transformer，但将解码器中的“标准”自注意力机制替换为由主自注意力机制和自 n-流（预测）自注意力机制组成的架构。
资源
ProphetNetConfig
class transformers.ProphetNetConfig
< 源代码 >( transformers_version: str | None = None architectures: list[str] | None = None output_hidden_states: bool | None = False return_dict: bool | None = True dtype: typing.Union[str, ForwardRef('torch.dtype'), NoneType] = None chunk_size_feed_forward: int = 0 id2label: dict[int, str] | dict[str, str] | None = None label2id: dict[str, int] | dict[str, str] | None = None problem_type: typing.Optional[typing.Literal['regression', 'single_label_classification', 'multi_label_classification']] = None is_encoder_decoder: bool = True activation_dropout: float | int = 0.1 activation_function: str = 'gelu' vocab_size: int = 30522 hidden_size: int = 1024 encoder_ffn_dim: int = 4096 num_encoder_layers: int = 12 num_encoder_attention_heads: int = 16 decoder_ffn_dim: int = 4096 num_decoder_layers: int = 12 num_decoder_attention_heads: int = 16 attention_dropout: float | int = 0.1 dropout: float | int = 0.1 max_position_embeddings: int = 512 init_std: float = 0.02 add_cross_attention: bool = True decoder_start_token_id: int | None = 0 ngram: int = 2 num_buckets: int = 32 relative_max_distance: int = 128 disable_ngram_loss: bool = False eps: float = 0.0 use_cache: bool = True pad_token_id: int | None = 0 bos_token_id: int | None = 1 eos_token_id: int | list[int] | None = 2 is_decoder: bool = False tie_word_embeddings: bool = True )
参数
- is_encoder_decoder (
bool, optional, 默认为True) — 模型是否用作编码器/解码器。 - activation_dropout (
Union[float, int], optional, 默认为0.1) — 全连接层内激活值的 dropout 比率。 - activation_function (
str, optional, 默认为gelu) — 解码器中的非线性激活函数（函数或字符串）。例如："gelu","relu","silu"等。 - vocab_size (
int, optional, 默认为30522) — 模型的词汇表大小。定义了input_ids可以表示的不同词元的数量。 - hidden_size (
int, optional, 默认为1024) — 隐藏表示的维度。 - encoder_ffn_dim (
int, optional, 默认为4096) — 编码器中“中间”（通常称为前馈）层的维度。 - num_encoder_layers (
int, optional, 默认为12) — Transformer 编码器中的隐藏层数量。如果未设置，将使用与num_layers相同的值。 - num_encoder_attention_heads (
int, optional, 默认为16) — Transformer 编码器中每个注意力层的注意力头数量。 - decoder_ffn_dim (
int, optional, 默认为4096) — 解码器中“中间”（通常称为前馈）层的维度。 - num_decoder_layers (
int, optional, 默认为12) — Transformer 解码器中的隐藏层数量。如果未设置，将使用与num_layers相同的值。 - num_decoder_attention_heads (
int, optional, 默认为16) — Transformer 解码器中每个注意力层的注意力头数量。 - attention_dropout (
Union[float, int], optional, 默认为0.1) — 注意力概率的 dropout 比率。 - dropout (
Union[float, int], optional, 默认为0.1) — 所有 dropout 层的比率。 - max_position_embeddings (
int, optional, 默认为512) — 此模型可能使用的最大序列长度。 - init_std (
float, optional, 默认为0.02) — 用于初始化所有权重矩阵的 truncated_normal_initializer 的标准差。 - add_cross_attention (
bool, optional, 默认为True) — 是否应向模型添加交叉注意力层。 - decoder_start_token_id (
int, optional, 默认为0) — 如果编码器-解码器模型以与bos不同的词元开始解码，则为该词元的 ID。 - ngram (
int, optional, 默认为 2) — 要预测的未来词元数量。设置为 1 则与传统语言模型相同，即预测下一个第一个词元。 - num_buckets (
int, optional, 默认为 32) — 每个注意力层使用的分桶（bucket）数量。这是用于相对位置计算的。更多详情请参阅 [T5 论文](see https://huggingface.co/papers/1910.10683)。 - relative_max_distance (
int, optional, 默认为 128) — 大于此数值的相对距离将被归入最后一个相同桶中。这是用于相对位置计算的。更多详情请参阅 [T5 论文](see https://huggingface.co/papers/1910.10683)。 - disable_ngram_loss (
bool, optional, 默认为False) — 是否仅训练预测下一个第一个词元。 - eps (
float, optional, 默认为 0.0) — 控制损失计算中标签平滑的epsilon参数值。如果设为 0，则不执行标签平滑。 - use_cache (
bool, optional, 默认为True) — 模型是否应返回最后的键/值注意力（并非所有模型都使用）。仅在config.is_decoder=True或模型是仅解码器的生成模型时相关。 - pad_token_id (
int, 可选, 默认为0) — 词汇表中用于填充（padding）的 token ID。 - bos_token_id (
int, 可选, 默认为1) — 词汇表中用于表示序列开始（beginning-of-stream）的 token ID。 - eos_token_id (
Union[int, list[int]], 可选, 默认为2) — 词汇表中用于表示序列结束（end-of-stream）的 token ID。 - is_decoder (
bool, 可选, 默认为False) — 该模型是否用作解码器。如果为False，则模型用作编码器。 - tie_word_embeddings (
bool, 可选, 默认为True) — 是否根据模型的tied_weights_keys映射来绑定权重嵌入。
这是用于存储 ProphetNetModel 配置的配置类。它根据指定的参数实例化 ProphetNet 模型，定义模型架构。使用默认值实例化配置将产生与 microsoft/prophetnet-large-uncased 类似的配置。
配置对象继承自 PreTrainedConfig，可用于控制模型输出。阅读 PreTrainedConfig 的文档以获取更多信息。
ProphetNetTokenizer
class transformers.ProphetNetTokenizer
< 源码 >( vocab_file: str do_lower_case: bool | None = True do_basic_tokenize: bool | None = True never_split: collections.abc.Iterable | None = None unk_token: str | None = '[UNK]' sep_token: str | None = '[SEP]' x_sep_token: str | None = '[X_SEP]' pad_token: str | None = '[PAD]' mask_token: str | None = '[MASK]' tokenize_chinese_chars: bool | None = True strip_accents: bool | None = None clean_up_tokenization_spaces: bool = True **kwargs )
参数
- vocab_file (
str) — 包含词汇表的文件。 - do_lower_case (
bool, 可选, 默认为True) — 分词时是否将输入转换为小写。 - do_basic_tokenize (
bool, 可选, 默认为True) — 在进行 WordPiece 分词前，是否进行基础分词。 - never_split (
Iterable, 可选) — 在分词过程中永远不会被分割的 token 集合。仅在do_basic_tokenize=True时有效。 - unk_token (
str, 可选, 默认为"[UNK]") — 未知 token。词汇表中不存在的 token 无法转换为 ID，会被设置为该 token。 - sep_token (
str, 可选, 默认为"[SEP]") — 分隔符 token，用于从多个序列构建序列时，例如用于序列分类的两个序列，或用于问答任务的文本和问题。它也用作由特殊 token 构建的序列的最后一个 token。 - x_sep_token (
str, 可选, 默认为"[X_SEP]") — 特殊的第二个分隔符 token，可由 ProphetNetForConditionalGeneration 生成。它用于在摘要生成中分隔项目符号般的句子，例如。 - pad_token (
str, 可选, 默认为"[PAD]") — 用于填充的 token，例如在批处理长度不同的序列时使用。 - mask_token (
str, 可选, 默认为"[MASK]") — 用于遮蔽（masking）值的 token。这是在训练该模型进行掩码语言建模时使用的 token，也是模型将尝试预测的 token。 - tokenize_chinese_chars (
bool, 可选, 默认为True) — 是否对中文字符进行分词。对于日语，通常建议禁用此选项（参阅此 issue）。
- strip_accents (
bool, 可选) — 是否去除所有重音符号。如果未指定此选项，则将由lowercase的值决定（与原始 BERT 一样）。 - clean_up_tokenization_spaces (
bool, 可选, 默认为True) — 是否在解码后清理空格，清理操作包括移除额外的空格等伪影。
构建一个 ProphetNetTokenizer。基于 WordPiece。
该分词器继承自 PreTrainedTokenizer，其中包含大部分主要方法。用户应参考此超类以获取有关这些方法的更多信息。
build_inputs_with_special_tokens
< 源码 >( token_ids_0: list token_ids_1: list[int] | None = None already_has_special_tokens: bool = False ) → List[int]
通过连接和添加特殊标记，从一个序列或一对序列构建用于序列分类任务的模型输入。BERT 序列的格式如下：
- 单个序列：
[CLS] X [SEP] - 序列对：
[CLS] A [SEP] B [SEP]
将标记序列（字符串）转换为单个字符串。
get_special_tokens_mask
< 源码 >( token_ids_0: list token_ids_1: list[int] | None = None already_has_special_tokens: bool | None = False ) → List[int]
从没有添加特殊标记的标记列表中检索序列ID。此方法在使用分词器prepare_for_model方法添加特殊标记时调用。
ProphetNet 特有的输出
class transformers.models.prophetnet.modeling_prophetnet.ProphetNetSeq2SeqLMOutput
< 源码 >( loss: torch.FloatTensor | None = None logits: torch.FloatTensor | None = None logits_ngram: torch.FloatTensor | None = None past_key_values: transformers.cache_utils.Cache | None = None decoder_hidden_states: tuple[torch.FloatTensor] | None = None decoder_ngram_hidden_states: tuple[torch.FloatTensor] | None = None decoder_attentions: tuple[torch.FloatTensor] | None = None decoder_ngram_attentions: tuple[torch.FloatTensor] | None = None cross_attentions: tuple[torch.FloatTensor] | None = None encoder_last_hidden_state: torch.FloatTensor | None = None encoder_hidden_states: tuple[torch.FloatTensor] | None = None encoder_attentions: tuple[torch.FloatTensor] | None = None )
参数
- loss (形状为
(1,)的torch.FloatTensor，可选，在提供labels时返回) — 语言模型损失。 - logits (形状为
(batch_size, decoder_sequence_length, config.vocab_size)的torch.FloatTensor) — 主流语言模型头的预测得分（SoftMax 之前每个词汇表 token 的得分）。 - logits_ngram (形状为
(batch_size, ngram * decoder_sequence_length, config.vocab_size)的torch.FloatTensor) — 预测流语言模型头的预测得分（SoftMax 之前每个词汇表 token 的得分）。 - past_key_values (
Cache，可选，在传递use_cache=True或config.use_cache=True时返回) — 这是一个 Cache 实例。更多详情请参见我们的 kv cache 指南。包含解码器预计算的隐藏状态（注意力块中的键和值），可用于（参见
past_key_values输入）加速序列解码。 - decoder_hidden_states (
tuple[torch.FloatTensor]，可选，在传递output_hidden_states=True或config.output_hidden_states=True时返回) —torch.FloatTensor元组（模型有嵌入层时，第一个元素为嵌入输出，其余为每一层的输出），形状为(batch_size, 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时返回) — 形状为(batch_size, num_heads, sequence_length, 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_heads, sequence_length, 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时返回) —torch.FloatTensor元组（模型有嵌入层时，第一个元素为嵌入输出，其余为每一层的输出），形状为(batch_size, sequence_length, hidden_size)。编码器在每一层输出的隐藏状态加上初始嵌入输出。
- encoder_attentions (
tuple[torch.FloatTensor]，可选，在传递output_attentions=True或config.output_attentions=True时返回) — 形状为(batch_size, num_heads, sequence_length, sequence_length)的torch.FloatTensor元组（每层一个）。编码器注意力权重（在注意力 SoftMax 之后），用于计算自注意力头中的加权平均值。
- loss (形状为
(1,)的torch.FloatTensor，可选，在提供labels时返回) — 语言模型损失。 - logits (形状为
(batch_size, decoder_sequence_length, config.vocab_size)的torch.FloatTensor) — 主流语言模型头的预测得分（SoftMax 之前每个词汇表 token 的得分）。 - logits_ngram (形状为
(batch_size, ngram * decoder_sequence_length, config.vocab_size)的torch.FloatTensor) — 预测流语言模型头的预测得分（SoftMax 之前每个词汇表 token 的得分）。 - past_key_values (
Cache，可选，在传递use_cache=True或config.use_cache=True时返回) — 这是一个 Cache 实例。更多详情请参见我们的 kv cache 指南。包含解码器预计算的隐藏状态（注意力块中的键和值），可用于（参见
past_key_values输入）加速序列解码。 - decoder_hidden_states (
tuple[torch.FloatTensor]，可选，在传递output_hidden_states=True或config.output_hidden_states=True时返回) —torch.FloatTensor元组（模型有嵌入层时，第一个元素为嵌入输出，其余为每一层的输出），形状为(batch_size, 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时返回) — 形状为(batch_size, num_heads, sequence_length, 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_heads, sequence_length, 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时返回) —torch.FloatTensor元组（模型有嵌入层时，第一个元素为嵌入输出，其余为每一层的输出），形状为(batch_size, sequence_length, hidden_size)。编码器在每一层输出的隐藏状态加上初始嵌入输出。
- encoder_attentions (
tuple[torch.FloatTensor]，可选，在传递output_attentions=True或config.output_attentions=True时返回) — 形状为(batch_size, num_heads, sequence_length, sequence_length)的torch.FloatTensor元组（每层一个）。编码器注意力权重（在注意力 SoftMax 之后），用于计算自注意力头中的加权平均值。
序列到序列语言模型输出的基类。
class transformers.models.prophetnet.modeling_prophetnet.ProphetNetSeq2SeqModelOutput
< 源码 >( last_hidden_state: FloatTensor last_hidden_state_ngram: torch.FloatTensor | None = None past_key_values: transformers.cache_utils.Cache | None = None decoder_hidden_states: tuple[torch.FloatTensor] | None = None decoder_ngram_hidden_states: tuple[torch.FloatTensor] | None = None decoder_attentions: tuple[torch.FloatTensor] | None = None decoder_ngram_attentions: tuple[torch.FloatTensor] | None = None cross_attentions: tuple[torch.FloatTensor] | None = None encoder_last_hidden_state: torch.FloatTensor | None = None encoder_hidden_states: tuple[torch.FloatTensor] | None = None encoder_attentions: tuple[torch.FloatTensor] | None = None )
参数
- last_hidden_state (形状为
(batch_size, decoder_sequence_length, hidden_size)的torch.FloatTensor) — 模型解码器最后一层输出的主流隐藏状态序列。如果使用了
past_key_values，则仅输出形状为(batch_size, 1, hidden_size)的序列的最后一个隐藏状态。 - last_hidden_state_ngram (形状为
(batch_size,ngram * decoder_sequence_length, config.vocab_size)的torch.FloatTensor，可选) — 模型解码器最后一层输出的预测流隐藏状态序列。 - past_key_values (
Cache，可选，在传递use_cache=True或config.use_cache=True时返回) — 这是一个 Cache 实例。更多详情请参见我们的 kv cache 指南。包含解码器预计算的隐藏状态（注意力块中的键和值），可用于（参见
past_key_values输入）加速序列解码。 - decoder_hidden_states (
tuple[torch.FloatTensor]，可选，在传递output_hidden_states=True或config.output_hidden_states=True时返回) —torch.FloatTensor元组（模型有嵌入层时，第一个元素为嵌入输出，其余为每一层的输出），形状为(batch_size, 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时返回) — 形状为(batch_size, num_heads, sequence_length, 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_heads, sequence_length, sequence_length)的torch.FloatTensor元组（每层一个）。解码器交叉注意力层的注意力权重（在注意力 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, sequence_length, hidden_size)。编码器在每一层输出的隐藏状态，加上初始嵌入输出。
- encoder_attentions (
tuple[torch.FloatTensor]，可选，当传入output_attentions=True或config.output_attentions=True时返回) —torch.FloatTensor元组（每层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。编码器的注意力权重，在注意力 softmax 后，用于计算自注意力头中的加权平均值。
- last_hidden_state (形状为
(batch_size, decoder_sequence_length, hidden_size)的torch.FloatTensor) — 模型解码器最后一层输出的主流隐藏状态序列。如果使用了
past_key_values，则仅输出形状为(batch_size, 1, hidden_size)的序列的最后一个隐藏状态。 - last_hidden_state_ngram (形状为
(batch_size,ngram * decoder_sequence_length, config.vocab_size)的torch.FloatTensor，可选) — 模型解码器最后一层输出的预测流隐藏状态序列。 - past_key_values (
Cache，可选，在传递use_cache=True或config.use_cache=True时返回) — 这是一个 Cache 实例。更多详情请参见我们的 kv cache 指南。包含解码器预计算的隐藏状态（注意力块中的键和值），可用于（参见
past_key_values输入）加速序列解码。 - decoder_hidden_states (
tuple[torch.FloatTensor]，可选，在传递output_hidden_states=True或config.output_hidden_states=True时返回) —torch.FloatTensor元组（模型有嵌入层时，第一个元素为嵌入输出，其余为每一层的输出），形状为(batch_size, 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时返回) — 形状为(batch_size, num_heads, sequence_length, 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_heads, sequence_length, sequence_length)的torch.FloatTensor元组（每层一个）。解码器交叉注意力层的注意力权重（在注意力 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, sequence_length, hidden_size)。编码器在每一层输出的隐藏状态，加上初始嵌入输出。
- encoder_attentions (
tuple[torch.FloatTensor]，可选，当传入output_attentions=True或config.output_attentions=True时返回) —torch.FloatTensor元组（每层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。编码器的注意力权重，在注意力 softmax 后，用于计算自注意力头中的加权平均值。
模型编码器输出的基类，也包含：可加速顺序解码的预计算隐藏状态。
class transformers.models.prophetnet.modeling_prophetnet.ProphetNetDecoderModelOutput
< source >( last_hidden_state: FloatTensor last_hidden_state_ngram: torch.FloatTensor | None = None past_key_values: transformers.cache_utils.Cache | None = None hidden_states: tuple[torch.FloatTensor] | None = None hidden_states_ngram: tuple[torch.FloatTensor] | None = None attentions: tuple[torch.FloatTensor] | None = None ngram_attentions: tuple[torch.FloatTensor] | None = None cross_attentions: tuple[torch.FloatTensor] | None = None )
参数
- last_hidden_state (
torch.FloatTensor，形状为(batch_size, decoder_sequence_length, hidden_size)) — 模型解码器最后一层输出的主流隐藏状态序列。如果使用了
past_key_values，则仅输出形状为(batch_size, 1, hidden_size)的序列的最后一个隐藏状态。 - last_hidden_state_ngram (
torch.FloatTensor，形状为(batch_size, ngram * decoder_sequence_length, config.vocab_size)) — 模型解码器最后一层输出的预测流隐藏状态序列。 - past_key_values (
Cache，可选，当传入use_cache=True或config.use_cache=True时返回) — 这是一个 Cache 实例。更多详情请参阅我们的 kv cache 指南。包含解码器预先计算的隐藏状态（注意力块中的键和值），可用于（参见
past_key_values输入）加速序列解码。 - hidden_states (
tuple[torch.FloatTensor]，可选，当传入output_hidden_states=True或config.output_hidden_states=True时返回) —torch.FloatTensor元组（每个层输出对应一个，如果模型有嵌入层，则第一个为嵌入层输出），形状为(batch_size, sequence_length, hidden_size)。模型在每一层输出的隐藏状态，加上可选的初始嵌入输出。
- hidden_states_ngram (
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_heads, sequence_length, 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_heads, sequence_length, sequence_length)。解码器交叉注意力层的注意力权重，在注意力 softmax 后，用于计算交叉注意力头中的加权平均值。
- 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 (
Cache，可选，当传入use_cache=True或config.use_cache=True时返回) — 这是一个 Cache 实例。更多详情请参阅我们的 kv cache 指南。包含解码器预先计算的隐藏状态（注意力块中的键和值），可用于（参见
past_key_values输入）加速序列解码。 - hidden_states (
tuple[torch.FloatTensor]，可选，当传入output_hidden_states=True或config.output_hidden_states=True时返回) —torch.FloatTensor元组（每个层输出对应一个，如果模型有嵌入层，则第一个为嵌入层输出），形状为(batch_size, sequence_length, hidden_size)。模型在每一层输出的隐藏状态，加上可选的初始嵌入输出。
- hidden_states_ngram (
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_heads, sequence_length, 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_heads, sequence_length, sequence_length)。解码器交叉注意力层的注意力权重，在注意力 softmax 后，用于计算交叉注意力头中的加权平均值。
模型输出的基类，也可能包含过去的键/值（以加速顺序解码）。
class transformers.models.prophetnet.modeling_prophetnet.ProphetNetDecoderLMOutput
< source >( loss: torch.FloatTensor | None = None logits: torch.FloatTensor | None = None logits_ngram: torch.FloatTensor | None = None past_key_values: transformers.cache_utils.Cache | None = None hidden_states: tuple[torch.FloatTensor] | None = None hidden_states_ngram: tuple[torch.FloatTensor] | None = None attentions: tuple[torch.FloatTensor] | None = None ngram_attentions: tuple[torch.FloatTensor] | None = None cross_attentions: tuple[torch.FloatTensor] | None = None )
参数
- loss (
torch.FloatTensor，形状为(1,)，可选，当提供labels时返回) — 语言模型损失。 - logits (
torch.FloatTensor，形状为(batch_size, decoder_sequence_length, config.vocab_size)) — 主流语言建模头的预测得分（SoftMax 之前每个词汇表 token 的得分）。 - logits_ngram (
torch.FloatTensor，形状为(batch_size, ngram * decoder_sequence_length, config.vocab_size)) — 预测流语言建模头的预测得分（SoftMax 之前每个词汇表 token 的得分）。 - past_key_values (
Cache，可选，当传入use_cache=True或config.use_cache=True时返回) — 这是一个 Cache 实例。更多详情请参阅我们的 kv cache 指南。包含解码器预先计算的隐藏状态（注意力块中的键和值），可用于（参见
past_key_values输入）加速序列解码。 - hidden_states (
tuple[torch.FloatTensor]，可选，当传入output_hidden_states=True或config.output_hidden_states=True时返回) —torch.FloatTensor元组（每个层输出对应一个，如果模型有嵌入层，则第一个为嵌入层输出），形状为(batch_size, sequence_length, hidden_size)。模型在每一层输出的隐藏状态，加上可选的初始嵌入输出。
- hidden_states_ngram (
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_heads, sequence_length, 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_heads, sequence_length, sequence_length)。解码器交叉注意力层的注意力权重，在注意力 softmax 后，用于计算交叉注意力头中的加权平均值。
- loss (
torch.FloatTensor，形状为(1,)，可选，当提供labels时返回) — 语言模型损失。 - logits (
torch.FloatTensor，形状为(batch_size, decoder_sequence_length, config.vocab_size)) — 主流语言建模头的预测得分（SoftMax 之前每个词汇表 token 的得分）。 - logits_ngram (
torch.FloatTensor，形状为(batch_size, ngram * decoder_sequence_length, config.vocab_size)) — 预测流语言建模头的预测得分（SoftMax 之前每个词汇表 token 的得分）。 - past_key_values (
Cache，可选，当传入use_cache=True或config.use_cache=True时返回) — 这是一个 Cache 实例。更多详情请参阅我们的 kv cache 指南。包含解码器预先计算的隐藏状态（注意力块中的键和值），可用于（参见
past_key_values输入）加速序列解码。 - hidden_states (
tuple[torch.FloatTensor]，可选，当传入output_hidden_states=True或config.output_hidden_states=True时返回) —torch.FloatTensor元组（每个层输出对应一个，如果模型有嵌入层，则第一个为嵌入层输出），形状为(batch_size, sequence_length, hidden_size)。模型在每一层输出的隐藏状态，加上可选的初始嵌入输出。
- hidden_states_ngram (
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_heads, sequence_length, 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_heads, sequence_length, sequence_length)。解码器交叉注意力层的注意力权重，在注意力 softmax 后，用于计算交叉注意力头中的加权平均值。
模型输出的基类，也可能包含过去的键/值（以加速顺序解码）。
ProphetNetModel
class transformers.ProphetNetModel
< source >( config: ProphetNetConfig )
参数
- config (ProphetNetConfig) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载模型相关的权重，仅加载配置。请参阅 from_pretrained() 方法以加载模型权重。
原始的 Prophetnet 模型，输出原始隐藏状态，顶部没有任何特定的层。
该模型继承自 PreTrainedModel。请查看超类文档以了解该库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、剪枝头部等）。
此模型也是一个 PyTorch torch.nn.Module 子类。像普通的 PyTorch Module 一样使用它，并参考 PyTorch 文档了解一般用法和行为的所有相关信息。
forward
< 源代码 >( input_ids: torch.Tensor | None = None attention_mask: torch.Tensor | None = None decoder_input_ids: torch.Tensor | None = None decoder_attention_mask: torch.BoolTensor | None = None encoder_outputs: tuple | None = None past_key_values: transformers.cache_utils.Cache | None = None inputs_embeds: torch.Tensor | None = None decoder_inputs_embeds: torch.Tensor | None = None use_cache: bool | None = None output_attentions: bool | None = None output_hidden_states: bool | None = None return_dict: bool | None = None **kwargs ) → ProphetNetSeq2SeqModelOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (形状为
(batch_size, sequence_length)的torch.Tensor，可选) — 词表中输入序列标记的索引。默认情况下，填充（padding）将被忽略。索引可以使用 AutoTokenizer 获取。详细信息请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (形状为
(batch_size, sequence_length)的torch.Tensor，可选) — 用于避免对填充标记索引执行注意力计算的掩码。掩码值选自[0, 1]：- 1 表示 未掩码 的标记，
- 0 表示 被掩码 的标记。
- decoder_input_ids (形状为
(batch_size, target_sequence_length)的torch.LongTensor，可选) — 词表中解码器输入序列标记的索引。索引可以使用 AutoTokenizer 获取。详细信息请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
ProphetNet 使用
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中填充标记的张量。默认情况下还将使用因果（causal）掩码。 - encoder_outputs (
tuple，可选) — 元组包含 (last_hidden_state, 可选:hidden_states, 可选:attentions)。形状为(batch_size, sequence_length, hidden_size)的last_hidden_state（可选）是编码器最后一层输出的隐藏状态序列。用于解码器的交叉注意力机制。 - past_key_values (
~cache_utils.Cache，可选) — 预计算的隐藏状态（自注意力模块和交叉注意力模块中的 key 和 values），可用于加速顺序解码。这通常包括模型在先前解码阶段返回的past_key_values（当use_cache=True或config.use_cache=True时）。仅允许使用 Cache 实例作为输入，请参阅我们的 kv 缓存指南。如果未传递
past_key_values，则默认初始化 DynamicCache。模型将输出与作为输入馈送的缓存格式相同的缓存。
如果使用了
past_key_values，则用户仅需输入未处理的input_ids（那些其过去键值状态未提供给该模型的input_ids），其形状为(batch_size, unprocessed_length)，而不是形状为(batch_size, sequence_length)的所有input_ids。 - inputs_embeds (形状为
(batch_size, sequence_length, hidden_size)的torch.Tensor，可选) — 作为一个选项，您可以选择直接传递嵌入表示，而不是传递input_ids。如果您想比模型内部的嵌入查找矩阵更精细地控制如何将input_ids索引转换为相关向量，这非常有用。 - decoder_inputs_embeds (形状为
(batch_size, target_sequence_length, hidden_size)的torch.Tensor，可选) — 作为一个选项，您可以选择直接传递嵌入表示，而不是传递decoder_input_ids。如果使用了past_key_values，则可以选择仅输入最后一个decoder_inputs_embeds（请参阅past_key_values）。如果您想比模型内部的嵌入查找矩阵更精细地控制如何将decoder_input_ids索引转换为相关向量，这非常有用。如果
decoder_input_ids和decoder_inputs_embeds均未设置，则decoder_inputs_embeds采用inputs_embeds的值。 - use_cache (
bool，可选) — 如果设置为True，则返回past_key_values键值状态，可用于加速解码（请参阅past_key_values）。 - output_attentions (
bool，可选) — 是否返回所有注意力层的注意力张量。更多详细信息，请参阅返回张量下的attentions。 - output_hidden_states (
bool，可选) — 是否返回所有层的隐藏状态。更多详细信息，请参阅返回张量下的hidden_states。 - return_dict (
bool，可选) — 是否返回一个 ModelOutput 而不是普通的元组。
返回
ProphetNetSeq2SeqModelOutput 或 tuple(torch.FloatTensor)
一个 ProphetNetSeq2SeqModelOutput 或一个 torch.FloatTensor 元组（如果传入了 return_dict=False 或当 config.return_dict=False 时），根据配置（ProphetNetConfig）和输入，包含各种元素。
ProphetNetModel 的前向传播方法，覆盖了 __call__ 特殊方法。
虽然 forward pass 的实现需要在此函数中定义，但你应该在之后调用
Module实例而不是这个，因为前者负责运行预处理和后处理步骤，而后者会静默地忽略它们。
last_hidden_state (形状为
(batch_size, decoder_sequence_length, hidden_size)的torch.FloatTensor) — 模型解码器最后一层输出的主流隐藏状态序列。如果使用了
past_key_values，则只输出形状为(batch_size, 1, hidden_size)的序列的最后一个隐藏状态。last_hidden_state_ngram (形状为
(batch_size, ngram * decoder_sequence_length, config.vocab_size)的torch.FloatTensor，可选) — 模型解码器最后一层输出的预测流隐藏状态序列。past_key_values (
Cache，*可选*，当传入use_cache=True或config.use_cache=True时返回) — 这是一个 Cache 实例。欲了解更多细节，请参阅我们的 KV 缓存指南。包含解码器注意力块的预计算隐藏状态（键和值），可用于（参见
past_key_values输入）加速顺序解码。decoder_hidden_states (
tuple[torch.FloatTensor], 可选, 当传递output_hidden_states=True或当config.output_hidden_states=True时返回) —torch.FloatTensor元组（如果模型有嵌入层，则一个用于嵌入层的输出，+ 一个用于每一层的输出），形状为(batch_size, 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_heads, sequence_length, 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_heads, sequence_length, sequence_length)。解码器交叉注意力层的注意力权重，在注意力 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时返回) —torch.FloatTensor元组（如果模型有嵌入层，则一个用于嵌入层的输出，+ 一个用于每一层的输出），形状为(batch_size, sequence_length, hidden_size)。编码器在每一层输出时的隐藏状态以及初始嵌入输出。
encoder_attentions (
tuple[torch.FloatTensor], 可选, 当传递output_attentions=True或当config.output_attentions=True时返回) —torch.FloatTensor元组（每一层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。编码器的注意力权重，在注意力 softmax 之后，用于计算自注意力头中的加权平均。
示例
>>> from transformers import AutoTokenizer, ProphetNetModel
>>> tokenizer = AutoTokenizer.from_pretrained("microsoft/prophetnet-large-uncased")
>>> model = ProphetNetModel.from_pretrained("microsoft/prophetnet-large-uncased")
>>> input_ids = tokenizer(
... "Studies have been shown that owning a dog is good for you", return_tensors="pt"
... ).input_ids # Batch size 1
>>> decoder_input_ids = tokenizer("Studies show that", return_tensors="pt").input_ids # Batch size 1
>>> outputs = model(input_ids=input_ids, decoder_input_ids=decoder_input_ids)
>>> last_hidden_states = outputs.last_hidden_state # main stream hidden states
>>> last_hidden_states_ngram = outputs.last_hidden_state_ngram # predict hidden statesProphetNetEncoder
class transformers.ProphetNetEncoder
< 源代码 >( config: ProphetNetConfig )
参数
- config (ProphetNetConfig) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载模型相关的权重，仅加载配置。请参阅 from_pretrained() 方法以加载模型权重。
ProphetNetModel 的独立编码器部分。
该模型继承自 PreTrainedModel。请查看超类文档以了解该库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、剪枝头部等）。
此模型也是一个 PyTorch torch.nn.Module 子类。像普通的 PyTorch Module 一样使用它，并参考 PyTorch 文档了解一般用法和行为的所有相关信息。
forward
< 源代码 >( input_ids: torch.Tensor | None = None attention_mask: torch.Tensor | None = None inputs_embeds: torch.Tensor | None = None output_attentions: bool | None = None output_hidden_states: bool | None = None return_dict: bool | None = None **kwargs ) → BaseModelOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (形状为
(batch_size, sequence_length)的torch.Tensor，可选) — 词表中输入序列标记的索引。默认情况下，填充（padding）将被忽略。索引可以使用 AutoTokenizer 获取。详细信息请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (形状为
(batch_size, sequence_length)的torch.Tensor，可选) — 用于避免对填充标记索引执行注意力计算的掩码。掩码值选自[0, 1]：- 1 表示 未掩码 的标记，
- 0 表示 被掩码 的标记。
- inputs_embeds (形状为
(batch_size, sequence_length, hidden_size)的torch.Tensor，可选) — 作为一个选项，您可以选择直接传递嵌入表示，而不是传递input_ids。如果您想比模型内部的嵌入查找矩阵更精细地控制如何将input_ids索引转换为相关向量，这非常有用。 - output_attentions (
bool, optional) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的attentions。 - output_hidden_states (
bool, optional) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的hidden_states。 - return_dict (
bool, optional) — 是否返回一个 ModelOutput 而不是普通元组。
返回
BaseModelOutput 或 tuple(torch.FloatTensor)
一个 BaseModelOutput 或一个 torch.FloatTensor 元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），包含各种元素，具体取决于配置 (ProphetNetConfig) 和输入。
ProphetNetEncoder 的 forward 方法，重写了 __call__ 特殊方法。
虽然 forward pass 的实现需要在此函数中定义，但你应该在之后调用
Module实例而不是这个，因为前者负责运行预处理和后处理步骤，而后者会静默地忽略它们。
last_hidden_state (
torch.FloatTensor, 形状为(batch_size, sequence_length, hidden_size)) — 模型最后一层输出的隐藏状态序列。hidden_states (
tuple(torch.FloatTensor), optional, 当传递output_hidden_states=True或当config.output_hidden_states=True时返回) —torch.FloatTensor的元组（一个用于嵌入层的输出，如果模型有嵌入层；+一个用于每个层的输出），形状为(batch_size, sequence_length, hidden_size)。模型在每个层输出的隐藏状态以及可选的初始嵌入输出。
attentions (
tuple(torch.FloatTensor), optional, 当传递output_attentions=True或当config.output_attentions=True时返回) —torch.FloatTensor的元组（每个层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
示例
>>> from transformers import AutoTokenizer, ProphetNetEncoder
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("microsoft/prophetnet-large-uncased")
>>> model = ProphetNetEncoder.from_pretrained("patrickvonplaten/prophetnet-large-uncased-standalone")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")
>>> outputs = model(**inputs)
>>> last_hidden_states = outputs.last_hidden_stateProphetNetDecoder
class transformers.ProphetNetDecoder
< 源代码 >( config: ProphetNetConfig )
参数
- config (ProphetNetConfig) — 具有模型所有参数的模型配置类。使用配置文件初始化不会加载与模型相关的权重，仅加载配置。请查看 from_pretrained() 方法以加载模型权重。
ProphetNetModel 的独立解码器部分。
该模型继承自 PreTrainedModel。请查看超类文档以了解该库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、剪枝头部等）。
此模型也是一个 PyTorch torch.nn.Module 子类。像普通的 PyTorch Module 一样使用它，并参考 PyTorch 文档了解一般用法和行为的所有相关信息。
forward
< 源代码 >( input_ids: torch.Tensor | None = None attention_mask: torch.Tensor | None = None encoder_hidden_states: torch.Tensor | None = None encoder_attention_mask: torch.Tensor | None = None past_key_values: transformers.cache_utils.Cache | None = None inputs_embeds: torch.Tensor | None = None use_cache: bool | None = None output_attentions: bool | None = None output_hidden_states: bool | None = None return_dict: bool | None = None **kwargs ) → ProphetNetDecoderModelOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.Tensor，形状为(batch_size, sequence_length)，可选) — 词汇表中输入序列 token 的索引。默认情况下，填充（Padding）将被忽略。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensor，形状为(batch_size, sequence_length)，可选) — 用于避免对填充 token 索引执行注意力机制的掩码。掩码值选自[0, 1]：- 1 表示未被掩码的 token，
- 0 表示被掩码的 token。
- encoder_hidden_states (
torch.Tensor，形状为(batch_size, sequence_length, hidden_size)，可选) — 编码器最后一层输出的隐藏状态序列。如果模型配置为解码器，则用于交叉注意力机制。 - encoder_attention_mask (
torch.Tensor，形状为(batch_size, sequence_length)，可选) — 用于避免对编码器输入的填充 token 索引执行注意力机制的掩码。如果模型配置为解码器，该掩码将用于交叉注意力机制。掩码值选自[0, 1]：- 1 表示未被掩码的 token，
- 0 表示被掩码的 token。
- past_key_values (
~cache_utils.Cache，可选) — 预先计算的隐藏状态（自注意力模块和交叉注意力模块中的键和值），可用于加速顺序解码。这通常由模型在解码的先前阶段返回的past_key_values组成，当use_cache=True或config.use_cache=True时。输入仅允许使用 Cache 实例，请参阅我们的 kv 缓存指南。如果不传递
past_key_values，则默认初始化 DynamicCache。模型将输出与作为输入馈送的格式相同的缓存格式。
如果使用
past_key_values，用户应仅输入未处理的input_ids（那些没有向模型提供先前键值状态的 token），形状为(batch_size, unprocessed_length)，而不是形状为(batch_size, sequence_length)的所有input_ids。 - inputs_embeds (
torch.Tensor，形状为(batch_size, sequence_length, hidden_size)，可选) — 作为一个选项，您可以选择直接传递嵌入表示，而不是传递input_ids。如果您想比模型的内部嵌入查找矩阵更精确地控制如何将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 而不是普通元组。
返回
ProphetNetDecoderModelOutput 或 tuple(torch.FloatTensor)
一个 ProphetNetDecoderModelOutput 或一个 torch.FloatTensor 元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），包含各种元素，具体取决于配置 (ProphetNetConfig) 和输入。
ProphetNetDecoder 的 forward 方法，重写了 __call__ 特殊方法。
虽然 forward pass 的实现需要在此函数中定义，但你应该在之后调用
Module实例而不是这个，因为前者负责运行预处理和后处理步骤，而后者会静默地忽略它们。
last_hidden_state (形状为
(batch_size, decoder_sequence_length, hidden_size)的torch.FloatTensor) — 模型解码器最后一层输出的主流隐藏状态序列。如果使用了
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 (
Cache，*可选*，当传入use_cache=True或config.use_cache=True时返回) — 这是一个 Cache 实例。欲了解更多细节，请参阅我们的 KV 缓存指南。包含解码器注意力块的预计算隐藏状态（键和值），可用于（参见
past_key_values输入）加速顺序解码。hidden_states (
tuple[torch.FloatTensor]，可选，在传入output_hidden_states=True或config.output_hidden_states=True时返回) —torch.FloatTensor元组（一个用于嵌入层的输出（如果模型有嵌入层的话） + 一个用于每层输出），形状为(batch_size, sequence_length, hidden_size)。模型在每个层输出的隐藏状态以及可选的初始嵌入输出。
hidden_states_ngram (
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_heads, sequence_length, 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_heads, sequence_length, sequence_length)。解码器交叉注意力层的注意力权重，在注意力 softmax 之后，用于计算交叉注意力头中的加权平均。
示例
>>> from transformers import AutoTokenizer, ProphetNetDecoder
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("microsoft/prophetnet-large-uncased")
>>> model = ProphetNetDecoder.from_pretrained("microsoft/prophetnet-large-uncased", add_cross_attention=False)
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")
>>> outputs = model(**inputs)
>>> last_hidden_states = outputs.last_hidden_stateProphetNetForConditionalGeneration
class transformers.ProphetNetForConditionalGeneration
< 源代码 >( config: ProphetNetConfig )
参数
- config (ProphetNetConfig) — 具有模型所有参数的模型配置类。使用配置文件初始化不会加载与模型相关的权重，仅加载配置。请查看 from_pretrained() 方法以加载模型权重。
带有语言建模头的 ProphetNet 模型。可用于序列生成任务。
该模型继承自 PreTrainedModel。请查看超类文档以了解该库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、剪枝头部等）。
此模型也是一个 PyTorch torch.nn.Module 子类。像普通的 PyTorch Module 一样使用它，并参考 PyTorch 文档了解一般用法和行为的所有相关信息。
forward
< 源代码 >( input_ids: torch.Tensor | None = None attention_mask: torch.Tensor | None = None decoder_input_ids: torch.Tensor | None = None decoder_attention_mask: torch.BoolTensor | None = None encoder_outputs: torch.Tensor | None = None past_key_values: transformers.cache_utils.Cache | None = None inputs_embeds: torch.Tensor | None = None decoder_inputs_embeds: torch.Tensor | None = None labels: torch.Tensor | None = None use_cache: bool | None = None output_attentions: bool | None = None output_hidden_states: bool | None = None return_dict: bool | None = None **kwargs ) → ProphetNetSeq2SeqLMOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.Tensor，形状为(batch_size, sequence_length)，可选) — 词汇表中输入序列 token 的索引。默认情况下，填充（Padding）将被忽略。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensor，形状为(batch_size, sequence_length)，可选) — 用于避免对填充标记索引执行注意力的掩码。掩码值选自[0, 1]：- 1 表示未被掩码的标记，
- 0 表示被掩码的标记。
- decoder_input_ids (
torch.LongTensor，形状为(batch_size, target_sequence_length)，可选) — 解码器输入序列标记在词汇表中的索引。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
ProphetNet 使用
eos_token_id作为decoder_input_ids生成的起始标记。如果使用了past_key_values，则可选地只需输入最后的decoder_input_ids（请参阅past_key_values）。 - decoder_attention_mask (
torch.BoolTensor，形状为(batch_size, target_sequence_length)，可选) — 默认行为：生成一个忽略decoder_input_ids中填充标记的张量。默认情况下还将使用因果掩码（causal mask）。 - encoder_outputs (
torch.Tensor，可选) — 元组包含 (last_hidden_state, 可选:hidden_states, 可选:attentions)；last_hidden_state（形状为(batch_size, sequence_length, hidden_size)，可选）是编码器最后一层输出的隐藏状态序列。用于解码器的交叉注意力机制中。 - past_key_values (
~cache_utils.Cache，可选) — 预计算的隐藏状态（自注意力块和交叉注意力块中的键和值），可用于加速顺序解码。通常由模型在解码的前一阶段返回，当use_cache=True或config.use_cache=True时使用。仅允许输入 Cache 实例，请参阅我们的 kv 缓存指南。如果没有传递
past_key_values，将默认初始化 DynamicCache。模型将输出与输入相同格式的缓存。
如果使用了
past_key_values，用户只需输入未处理的input_ids（即未将其过去键值状态提供给该模型的输入），其形状为(batch_size, unprocessed_length)，而非所有形状为(batch_size, sequence_length)的input_ids。 - inputs_embeds (
torch.Tensor，形状为(batch_size, sequence_length, hidden_size)，可选) — 可选地，您可以选择直接传递嵌入表示，而不是传递input_ids。如果您希望比模型内部的嵌入查找矩阵更精细地控制如何将input_ids索引转换为关联向量，这会很有用。 - decoder_inputs_embeds (
torch.Tensor，形状为(batch_size, target_sequence_length, hidden_size)，可选) — 可选地，您可以选择直接传递嵌入表示，而不是传递decoder_input_ids。如果使用了past_key_values，则可选地只需输入最后的decoder_inputs_embeds（请参阅past_key_values）。如果您希望比模型内部的嵌入查找矩阵更精细地控制如何将decoder_input_ids索引转换为关联向量，这会很有用。如果
decoder_input_ids和decoder_inputs_embeds均未设置，decoder_inputs_embeds将采用inputs_embeds的值。 - labels (
torch.LongTensor，形状为(batch_size,)，可选) — 用于计算序列分类/回归损失的标签。索引应位于[-100, 0, ..., config.vocab_size - 1]范围内。所有设置为-100的标签将被忽略（掩码），损失仅针对[0, ..., config.vocab_size]范围内的标签进行计算。 - use_cache (
bool，可选) — 如果设置为True，将返回past_key_values键值状态，可用于加速解码（请参阅past_key_values）。 - output_attentions (
bool，可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的attentions。 - output_hidden_states (
bool，可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的hidden_states。 - return_dict (
bool，可选) — 是否返回 ModelOutput 而不是纯元组。
返回
ProphetNetSeq2SeqLMOutput 或 tuple(torch.FloatTensor)
一个 ProphetNetSeq2SeqLMOutput 或一个 torch.FloatTensor 元组（如果传入 return_dict=False 或 config.return_dict=False 时），根据配置（ProphetNetConfig）和输入包含各种元素。
ProphetNetForConditionalGeneration 前向传播方法，覆盖了 __call__ 特殊方法。
虽然 forward pass 的实现需要在此函数中定义，但你应该在之后调用
Module实例而不是这个，因为前者负责运行预处理和后处理步骤，而后者会静默地忽略它们。
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 (
Cache，*可选*，当传入use_cache=True或config.use_cache=True时返回) — 这是一个 Cache 实例。欲了解更多细节，请参阅我们的 KV 缓存指南。包含解码器注意力块的预计算隐藏状态（键和值），可用于（参见
past_key_values输入）加速顺序解码。decoder_hidden_states (
tuple[torch.FloatTensor], 可选, 当传递output_hidden_states=True或当config.output_hidden_states=True时返回) —torch.FloatTensor元组（如果模型有嵌入层，则一个用于嵌入层的输出，+ 一个用于每一层的输出），形状为(batch_size, 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_heads, sequence_length, 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_heads, sequence_length, sequence_length)。解码器交叉注意力层的注意力权重，在注意力 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时返回) —torch.FloatTensor元组（如果模型有嵌入层，则一个用于嵌入层的输出，+ 一个用于每一层的输出），形状为(batch_size, sequence_length, hidden_size)。编码器在每一层输出时的隐藏状态以及初始嵌入输出。
encoder_attentions (
tuple[torch.FloatTensor], 可选, 当传递output_attentions=True或当config.output_attentions=True时返回) —torch.FloatTensor元组（每一层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。编码器的注意力权重，在注意力 softmax 之后，用于计算自注意力头中的加权平均。
示例
>>> from transformers import AutoTokenizer, ProphetNetForConditionalGeneration
>>> tokenizer = AutoTokenizer.from_pretrained("microsoft/prophetnet-large-uncased")
>>> model = ProphetNetForConditionalGeneration.from_pretrained("microsoft/prophetnet-large-uncased")
>>> input_ids = tokenizer(
... "Studies have been shown that owning a dog is good for you", return_tensors="pt"
... ).input_ids # Batch size 1
>>> decoder_input_ids = tokenizer("Studies show that", return_tensors="pt").input_ids # Batch size 1
>>> outputs = model(input_ids=input_ids, decoder_input_ids=decoder_input_ids)
>>> logits_next_token = outputs.logits # logits to predict next token as usual
>>> logits_ngram_next_tokens = outputs.logits_ngram # logits to predict 2nd, 3rd, ... next tokensProphetNetForCausalLM
class transformers.ProphetNetForCausalLM
< source >( config: ProphetNetConfig )
参数
- config (ProphetNetConfig) — 具有模型所有参数的模型配置类。使用配置文件初始化不会加载与模型相关的权重，仅加载配置。请查看 from_pretrained() 方法以加载模型权重。
ProphetNetModel 的独立解码器部分，顶部带有一个语言建模（LM）头。该模型可用于因果语言建模。
该模型继承自 PreTrainedModel。请查看超类文档以了解该库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、剪枝头部等）。
此模型也是一个 PyTorch torch.nn.Module 子类。像普通的 PyTorch Module 一样使用它，并参考 PyTorch 文档了解一般用法和行为的所有相关信息。
forward
< source >( input_ids: torch.Tensor | None = None attention_mask: torch.Tensor | None = None encoder_hidden_states: torch.Tensor | None = None encoder_attention_mask: torch.Tensor | None = None past_key_values: transformers.cache_utils.Cache | None = None inputs_embeds: torch.Tensor | None = None labels: torch.Tensor | None = None use_cache: bool | None = None output_attentions: bool | None = None output_hidden_states: bool | None = None return_dict: bool | None = None **kwargs ) → ProphetNetDecoderLMOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.Tensor，形状为(batch_size, sequence_length)，可选) — 输入序列标记在词汇表中的索引。默认情况下将忽略填充（padding）。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensor，形状为(batch_size, sequence_length)，可选) — 用于避免对填充标记索引执行注意力的掩码。掩码值选自[0, 1]：- 1 表示未被掩码的标记，
- 0 表示被掩码的标记。
- encoder_hidden_states (
torch.Tensor，形状为(batch_size, sequence_length, hidden_size)，可选) — 编码器最后一层输出的隐藏状态序列。如果模型被配置为解码器，则用于交叉注意力机制中。 - encoder_attention_mask (
torch.Tensor，形状为(batch_size, sequence_length)，可选) — 用于避免对编码器输入的填充标记索引执行注意力的掩码。如果模型被配置为解码器，此掩码用于交叉注意力机制中。掩码值选自[0, 1]：- 1 表示未被掩码的标记，
- 0 表示被掩码的标记。
- past_key_values (
~cache_utils.Cache, 可选) — 预先计算的隐藏状态（自注意力块和交叉注意力块中的键和值），可用于加速顺序解码。当use_cache=True或config.use_cache=True时，这通常由模型在解码的前一阶段返回。输入仅允许使用 Cache 实例，请参阅我们的 kv cache 指南。如果未传递
past_key_values，则默认初始化 DynamicCache。模型将输出与作为输入传入的格式相同的缓存。
如果使用
past_key_values，用户只需输入未处理的input_ids（即那些其过去的键值状态未提供给此模型的输入），形状为(batch_size, unprocessed_length)，而不是形状为(batch_size, sequence_length)的所有input_ids。 - inputs_embeds (形状为
(batch_size, sequence_length, hidden_size)的torch.Tensor, 可选) — 可选地，你可以选择直接传入嵌入表示，而不是传入input_ids。如果你想比模型内部的嵌入查找矩阵更精细地控制如何将input_ids索引转换为关联向量，这会很有用。 - labels (形状为
(batch_size, sequence_length)的torch.LongTensor, 可选) — 用于计算从左到右语言建模损失（下一个词预测）的标签。索引应在[-100, 0, ..., config.vocab_size]范围内（参见input_ids文档字符串）。索引设置为-100的标记将被忽略（掩码处理），损失仅对标签在[0, ..., config.vocab_size]范围内的标记进行计算。 - use_cache (
bool, 可选) — 如果设置为True，则会返回past_key_values键值状态，并可用于加速解码（参见past_key_values）。 - output_attentions (
bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的attentions。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的hidden_states。 - return_dict (
bool, 可选) — 是否返回一个 ModelOutput，而不是普通的元组。
返回
ProphetNetDecoderLMOutput 或 tuple(torch.FloatTensor)
一个 ProphetNetDecoderLMOutput 或一个 torch.FloatTensor 元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），根据配置（ProphetNetConfig）和输入，包含各种元素。
ProphetNetForCausalLM 的 forward 方法，重写了 __call__ 特殊方法。
虽然 forward pass 的实现需要在此函数中定义，但你应该在之后调用
Module实例而不是这个，因为前者负责运行预处理和后处理步骤，而后者会静默地忽略它们。
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 (
Cache，*可选*，当传入use_cache=True或config.use_cache=True时返回) — 这是一个 Cache 实例。欲了解更多细节，请参阅我们的 KV 缓存指南。包含解码器注意力块的预计算隐藏状态（键和值），可用于（参见
past_key_values输入）加速顺序解码。hidden_states (
tuple[torch.FloatTensor]，可选，在传入output_hidden_states=True或config.output_hidden_states=True时返回) —torch.FloatTensor元组（一个用于嵌入层的输出（如果模型有嵌入层的话） + 一个用于每层输出），形状为(batch_size, sequence_length, hidden_size)。模型在每个层输出的隐藏状态以及可选的初始嵌入输出。
hidden_states_ngram (
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_heads, sequence_length, 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_heads, sequence_length, sequence_length)。解码器交叉注意力层的注意力权重，在注意力 softmax 之后，用于计算交叉注意力头中的加权平均。
示例
>>> from transformers import AutoTokenizer, ProphetNetForCausalLM
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("microsoft/prophetnet-large-uncased")
>>> model = ProphetNetForCausalLM.from_pretrained("microsoft/prophetnet-large-uncased")
>>> assert model.config.is_decoder, f"{model.__class__} has to be configured as a decoder."
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")
>>> outputs = model(**inputs)
>>> logits = outputs.logits
>>> # Model can also be used with EncoderDecoder framework
>>> from transformers import BertTokenizer, EncoderDecoderModel, AutoTokenizer
>>> import torch
>>> tokenizer_enc = BertTokenizer.from_pretrained("google-bert/bert-large-uncased")
>>> tokenizer_dec = AutoTokenizer.from_pretrained("microsoft/prophetnet-large-uncased")
>>> model = EncoderDecoderModel.from_encoder_decoder_pretrained(
... "google-bert/bert-large-uncased", "microsoft/prophetnet-large-uncased"
... )
>>> ARTICLE = (
... "the us state department said wednesday it had received no "
... "formal word from bolivia that it was expelling the us ambassador there "
... "but said the charges made against him are `` baseless ."
... )
>>> input_ids = tokenizer_enc(ARTICLE, return_tensors="pt").input_ids
>>> labels = tokenizer_dec(
... "us rejects charges against its ambassador in bolivia", return_tensors="pt"
... ).input_ids
>>> outputs = model(input_ids=input_ids, decoder_input_ids=labels[:, :-1], labels=labels[:, 1:])
>>> loss = outputs.loss