参数

• 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 (torch.LongTensor 形状为 (batch_size, target_sequence_length), 可选) — 词汇表中解码器输入序列标记的索引。

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

  什么是解码器输入 ID？

  Pegasus 使用 pad_token_id 作为 decoder_input_ids 生成的起始标记。如果使用 past_key_values，则可以选择仅输入最后一个 decoder_input_ids（参见 past_key_values）。

• decoder_attention_mask (torch.LongTensor 形状为 (batch_size, target_sequence_length), 可选) — 默认行为：生成一个忽略 decoder_input_ids 中填充标记的张量。因果掩码也将默认使用。
• head_mask (torch.Tensor 形状为 (encoder_layers, encoder_attention_heads), 可选) — 掩码以使编码器中注意力模块的选定头部无效。在 [0, 1] 中选择掩码值：
  • 1 表示 未掩码 的头部，
  • 0 表示 已掩码 的头部。
• decoder_head_mask (torch.Tensor 形状为 (decoder_layers, decoder_attention_heads), 可选) — 掩码以使解码器中注意力模块的选定头部无效。在 [0, 1] 中选择掩码值：
  • 1 表示 未掩码 的头部，
  • 0 表示 已掩码 的头部。
• cross_attn_head_mask (torch.Tensor 形状为 (decoder_layers, decoder_attention_heads), 可选) — 掩码以使解码器中交叉注意力模块的选定头部无效。在 [0, 1] 中选择掩码值：
  • 1 表示 未掩码 的头部，
  • 0 表示 已掩码 的头部。
• encoder_outputs (tuple(tuple(torch.FloatTensor), optional) — 元组包含 (last_hidden_state, 可选: hidden_states, 可选: attentions) last_hidden_state 形状为 (batch_size, sequence_length, hidden_size), 可选) 是编码器最后一层输出的隐藏状态序列。 用于解码器的交叉注意力。
• past_key_values (tuple(tuple(torch.FloatTensor)), 可选, 当 use_cache=True 传递或当 config.use_cache=True 时返回) — 长度为 config.n_layers 的 tuple(torch.FloatTensor) 元组，每个元组包含 2 个形状为 (batch_size, num_heads, sequence_length, embed_size_per_head) 的张量) 和 2 个形状为 (batch_size, num_heads, encoder_sequence_length, embed_size_per_head) 的附加张量。

  包含预先计算的隐藏状态 (自注意力块和交叉注意力块中的键和值)，可用于 (参见 past_key_values 输入) 加速顺序解码。

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

• inputs_embeds (torch.FloatTensor 形状为 (batch_size, sequence_length, hidden_size), 可选) — 可选地，除了传递 input_ids，还可以选择直接传递嵌入表示。 如果您想要更深入地控制如何将 input_ids 索引转换为关联向量，而不是模型的内部嵌入查找矩阵，这将很有用。
• decoder_inputs_embeds (torch.FloatTensor 形状为 (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 的值。

• 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.modeling_outputs.Seq2SeqModelOutput 或一个 torch.FloatTensor 元组 (如果传递 return_dict=False 或当 config.return_dict=False 时)，包含根据配置 (PegasusConfig) 和输入的不同元素。

• last_hidden_state (torch.FloatTensor 形状为 (batch_size, sequence_length, hidden_size)) — 模型解码器最后一层输出的隐藏状态序列。

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

• past_key_values (tuple(tuple(torch.FloatTensor)), 可选, 当 use_cache=True 传递或当 config.use_cache=True 时返回) — 长度为 config.n_layers 的 tuple(torch.FloatTensor) 元组，每个元组包含 2 个形状为 (batch_size, num_heads, sequence_length, embed_size_per_head) 的张量) 和 2 个形状为 (batch_size, num_heads, encoder_sequence_length, embed_size_per_head) 的附加张量。

  包含预先计算的隐藏状态 (自注意力块和交叉注意力块中的键和值)，可用于 (参见 past_key_values 输入) 加速顺序解码。

• decoder_hidden_states (tuple(torch.FloatTensor), 可选, 当 output_hidden_states=True 传递或当 config.output_hidden_states=True 时返回) — torch.FloatTensor 元组 (一个用于嵌入的输出，如果模型具有嵌入层，+ 一个用于每一层的输出) 形状为 (batch_size, 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 之后，用于计算自注意力头中的加权平均值。

• 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, sequence_length, hidden_size) 的 torch.FloatTensor，可选) — 模型编码器最后一层的输出处的隐藏状态序列。

• encoder_hidden_states (tuple(torch.FloatTensor), 可选，当传递 output_hidden_states=True 或 config.output_hidden_states=True 时返回) — 形状为 (batch_size, sequence_length, hidden_size) 的 torch.FloatTensor 元组（一个用于嵌入层的输出，如果模型具有嵌入层，以及每个层的输出）。

  每个层的编码器输出处的隐藏状态，以及可选的初始嵌入输出。

• encoder_attentions (tuple(torch.FloatTensor), 可选，当传递 output_attentions=True 或 config.output_attentions=True 时返回) — 形状为 (batch_size, num_heads, sequence_length, sequence_length) 的 torch.FloatTensor 元组（每个层一个）。

  编码器的注意力权重，经过注意力 softmax 后，用于计算自注意力头部的加权平均值。

参数

• 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 表示 **掩码** 的标记。

  什么是注意力掩码？

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

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

  解码器输入 ID 是什么？

  Pegasus 使用 pad_token_id 作为 decoder_input_ids 生成的起始标记。如果使用 past_key_values，则可以选择仅输入最后一个 decoder_input_ids（参见 past_key_values）。

• decoder_attention_mask (torch.LongTensor 形状为 (batch_size, target_sequence_length), 可选) — 默认行为：生成一个张量，该张量忽略 decoder_input_ids 中的填充标记。因果掩码也将默认使用。
• head_mask (torch.Tensor 形状为 (encoder_layers, encoder_attention_heads), 可选) — 掩码以使编码器中注意力模块的选定头部无效。在 [0, 1] 中选择掩码值：
  • 1 表示头部未被掩码，
  • 0 表示头部被掩码。
• decoder_head_mask (torch.Tensor 形状为 (decoder_layers, decoder_attention_heads), 可选) — 掩码以使解码器中注意力模块的选定头部无效。在 [0, 1] 中选择掩码值：
  • 1 表示头部未被掩码，
  • 0 表示头部被掩码。
• cross_attn_head_mask (torch.Tensor 形状为 (decoder_layers, decoder_attention_heads), 可选) — 掩码以使解码器中交叉注意力模块的选定头部无效。在 [0, 1] 中选择掩码值：
  • 1 表示头部未被掩码，
  • 0 表示头部被掩码。
• encoder_outputs (tuple(tuple(torch.FloatTensor), 可选) — 元组包含 (last_hidden_state, 可选: hidden_states, 可选: attentions) last_hidden_state 形状为 (batch_size, sequence_length, hidden_size), 可选) 是编码器最后一层输出的隐藏状态序列。用于解码器的交叉注意力。
• past_key_values (tuple(tuple(torch.FloatTensor)), 可选，当传递 use_cache=True 或 config.use_cache=True 时返回) — 长度为 config.n_layers 的 tuple(tuple(torch.FloatTensor)) 元组，每个元组都有 2 个形状为 (batch_size, num_heads, sequence_length, embed_size_per_head) 的张量) 以及 2 个形状为 (batch_size, num_heads, encoder_sequence_length, embed_size_per_head) 的附加张量。

  包含预先计算的隐藏状态（自注意力块和交叉注意力块中的键和值），可用于（参见 past_key_values 输入）加快顺序解码速度。

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

• inputs_embeds (torch.FloatTensor 形状为 (batch_size, sequence_length, hidden_size), 可选) — 可选地，您可以选择直接传递嵌入表示，而不是传递 input_ids。如果您想对如何将 input_ids 索引转换为关联向量（而不是模型的内部嵌入查找矩阵）进行更多控制，这将非常有用。
• decoder_inputs_embeds (torch.FloatTensor 形状为 (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 的值。

• use_cache (bool, 可选) — 如果设置为 True，则会返回 past_key_values 键值状态，可用于加速解码（参见 past_key_values）。
• output_attentions (bool, 可选) — 是否返回所有注意力层的注意力张量。 有关更多详细信息，请参见返回张量中的 attentions。
• output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。 有关更多详细信息，请参见返回张量中的 hidden_states。
• return_dict (bool, 可选) — 是否返回一个 ModelOutput 而不是一个简单的元组。
• labels (torch.LongTensor 形状为 (batch_size, sequence_length), 可选) — 用于计算掩码语言建模损失的标签。 索引应位于 [0, ..., config.vocab_size] 或 -100 中（参见 input_ids 文档字符串）。 索引设置为 -100 的标记将被忽略（掩码），损失仅针对标签位于 [0, ..., config.vocab_size] 中的标记进行计算。

一个 transformers.modeling_outputs.Seq2SeqLMOutput 或一个 torch.FloatTensor 的元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），包含根据配置 (PegasusConfig) 和输入而变化的各种元素。

• loss (torch.FloatTensor 形状为 (1,), 可选, 当提供 labels 时返回) — 语言建模损失。

• logits (torch.FloatTensor 形状为 (batch_size, sequence_length, config.vocab_size)) — 语言建模头的预测得分（在 SoftMax 之前，每个词汇标记的得分）。

• past_key_values (tuple(tuple(torch.FloatTensor)), 可选, 当 use_cache=True 传递或当 config.use_cache=True 时返回) — 长度为 config.n_layers 的 tuple(torch.FloatTensor) 元组，每个元组包含 2 个形状为 (batch_size, num_heads, sequence_length, embed_size_per_head) 的张量) 和 2 个形状为 (batch_size, num_heads, encoder_sequence_length, embed_size_per_head) 的附加张量。

  包含预先计算的隐藏状态 (自注意力块和交叉注意力块中的键和值)，可用于 (参见 past_key_values 输入) 加速顺序解码。

• decoder_hidden_states (tuple(torch.FloatTensor), 可选, 当 output_hidden_states=True 传递或当 config.output_hidden_states=True 时返回) — torch.FloatTensor 元组 (一个用于嵌入的输出，如果模型具有嵌入层，+ 一个用于每一层的输出) 形状为 (batch_size, 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 之后，用于计算自注意力头中的加权平均值。

• 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, sequence_length, hidden_size) 的 torch.FloatTensor，可选) — 模型编码器最后一层的输出处的隐藏状态序列。

• encoder_hidden_states (tuple(torch.FloatTensor), 可选，当传递 output_hidden_states=True 或 config.output_hidden_states=True 时返回) — 形状为 (batch_size, sequence_length, hidden_size) 的 torch.FloatTensor 元组（一个用于嵌入层的输出，如果模型具有嵌入层，以及每个层的输出）。

  编码器在每层输出处的隐藏状态加上初始嵌入输出。

• encoder_attentions (tuple(torch.FloatTensor), 可选，当传递 output_attentions=True 或 config.output_attentions=True 时返回) — 形状为 (batch_size, num_heads, sequence_length, sequence_length) 的 torch.FloatTensor 元组（每个层一个）。

  编码器的注意力权重，经过注意力 softmax 后，用于计算自注意力头部的加权平均值。

参数

• 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 表示 **掩码** 的标记。

  什么是注意力掩码？

• encoder_hidden_states (torch.FloatTensor 形状为 (batch_size, sequence_length, hidden_size), 可选) — 编码器最后一层输出的隐藏状态序列。如果模型配置为解码器，则用于交叉注意力。
• encoder_attention_mask (torch.FloatTensor 形状为 (batch_size, sequence_length), 可选) — 掩码以避免对编码器输入的填充标记索引执行注意力。如果模型配置为解码器，则此掩码用于交叉注意力。在 [0, 1] 中选择掩码值：
• head_mask (torch.Tensor 形状为 (decoder_layers, decoder_attention_heads), 可选) — 掩码以使注意力模块的选定头部无效。在 [0, 1] 中选择掩码值：
  • 1 表示 **未掩码** 的头部，
  • 0 表示 **掩码** 的头部。
• cross_attn_head_mask (torch.Tensor 形状为 (decoder_layers, decoder_attention_heads), 可选) — 掩码以使交叉注意力模块的选定头部无效。在 [0, 1] 中选择掩码值：
  • 1 表示 **未掩码** 的头部，
  • 0 表示 **掩码** 的头部。
• past_key_values (tuple(tuple(torch.FloatTensor)), 可选，在传递 use_cache=True 或 config.use_cache=True 时返回) — 长度为 config.n_layers 的 tuple(tuple(torch.FloatTensor))，每个元组具有 2 个形状为 (batch_size, num_heads, sequence_length, embed_size_per_head) 的张量) 以及 2 个形状为 (batch_size, num_heads, encoder_sequence_length, embed_size_per_head) 的附加张量。仅当模型在序列到序列模型中用作解码器时才需要这两个附加张量。

  包含预先计算的隐藏状态（自注意力块和交叉注意力块中的键和值），这些状态可用于（参见 past_key_values 输入）加速顺序解码。

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

• labels (torch.LongTensor 形状为 (batch_size, sequence_length)，可选) — 用于计算掩码语言模型损失的标签。索引应为 [0, ..., config.vocab_size] 或 -100（参见 input_ids 文档字符串）。索引设置为 -100 的标记会被忽略（掩码），损失仅针对标签在 [0, ..., config.vocab_size] 内的标记进行计算。
• use_cache (bool，可选) — 如果设置为 True，则返回 past_key_values 键值状态，可用于加速解码（参见 past_key_values）。
  • 1 表示未掩码的标记，
  • 0 表示掩码的标记。
• output_attentions (bool，可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参见返回张量中的 attentions。
• output_hidden_states (bool，可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参见返回张量中的 hidden_states。
• return_dict (bool，可选) — 是否返回一个 ModelOutput 而不是一个简单的元组。

一个 transformers.modeling_outputs.CausalLMOutputWithCrossAttentions 或 torch.FloatTensor 的元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），包含根据配置（PegasusConfig）和输入的不同元素。

• loss (torch.FloatTensor 形状为 (1,)，可选，在提供 labels 时返回) — 语言建模损失（用于下一个标记预测）。

• logits (torch.FloatTensor 形状为 (batch_size, sequence_length, config.vocab_size)) — 语言建模头的预测得分（在 SoftMax 之前，每个词汇标记的得分）。

• hidden_states (tuple(torch.FloatTensor)，可选，在传递 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — torch.FloatTensor 的元组（一个用于嵌入的输出，如果模型具有嵌入层，加上一个用于每一层的输出）形状为 (batch_size, sequence_length, hidden_size)。

  模型在每一层输出处的隐藏状态，加上可选的初始嵌入输出。

• attentions (tuple(torch.FloatTensor)，可选，在传递 output_attentions=True 或当 config.output_attentions=True 时返回) — torch.FloatTensor 的元组（每一层一个）形状为 (batch_size, num_heads, sequence_length, sequence_length)。

  注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。

• cross_attentions (tuple(torch.FloatTensor), 可选，当传递 output_attentions=True 或 config.output_attentions=True 时返回) — 形状为 (batch_size, num_heads, sequence_length, sequence_length) 的 torch.FloatTensor 元组（每个层一个）。

  交叉注意力 softmax 后的交叉注意力权重，用于计算交叉注意力头中的加权平均值。

• past_key_values (tuple(tuple(torch.FloatTensor))，可选，在传递 use_cache=True 或当 config.use_cache=True 时返回) — 长度为 config.n_layers 的 torch.FloatTensor 元组的元组，每个元组包含自注意力和交叉注意力层的缓存键值状态，如果模型用于编码器-解码器设置。仅在 config.is_decoder = True 时相关。

  包含预先计算的隐藏状态（注意力块中的键和值），可用于（参见 past_key_values 输入）加速顺序解码。

参数

• input_ids (tf.Tensor 形状为 (batch_size, sequence_length)) — 输入序列词元的词汇索引。

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

  什么是输入 ID？

• attention_mask (tf.Tensor 形状为 (batch_size, sequence_length), 可选) — 避免对填充词元索引执行注意的掩码。在 [0, 1] 中选择掩码值：
  • 1 表示未掩码的词元，
  • 0 表示掩码的词元。

  什么是注意力掩码？

• decoder_input_ids (tf.Tensor 形状为 (batch_size, target_sequence_length), 可选) — 解码器输入序列词元的词汇索引。

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

  什么是解码器输入 ID？

  Pegasus 使用 pad_token_id 作为 decoder_input_ids 生成起始词元。如果使用 past_key_values，则可以选择仅输入最后一个 decoder_input_ids （请参阅 past_key_values）。

• decoder_attention_mask (tf.Tensor 形状为 (batch_size, target_sequence_length), 可选) — 将默认创建，并忽略填充词元。不建议在大多数用例中设置此选项。
• decoder_position_ids (tf.Tensor 形状为 (batch_size, sequence_length), 可选) — 解码器输入序列中每个token在位置嵌入中的索引。在 [0, config.max_position_embeddings - 1] 范围内选择。
• head_mask (tf.Tensor 形状为 (encoder_layers, encoder_attention_heads), 可选) — 用于使编码器中注意力模块的选定头无效的掩码。掩码值在 [0, 1] 范围内选择：
  • 1 表示该头没有被掩码
  • 0 表示该头被掩码
• decoder_head_mask (tf.Tensor 形状为 (decoder_layers, decoder_attention_heads), 可选) — 用于使解码器中注意力模块的选定头无效的掩码。掩码值在 [0, 1] 范围内选择：
  • 1 表示该头没有被掩码
  • 0 表示该头被掩码
• cross_attn_head_mask (tf.Tensor 形状为 (decoder_layers, decoder_attention_heads), 可选) — 用于使交叉注意力模块的选定头无效的掩码。掩码值在 [0, 1] 范围内选择：
  • 1 表示该头没有被掩码
  • 0 表示该头被掩码
• encoder_outputs (tf.FloatTensor, 可选) — 编码器最后一层输出处的隐藏状态。用于解码器的交叉注意力。形状为 (batch_size, sequence_length, hidden_size)，是…的序列
• past_key_values (长度为 config.n_layers 的 Tuple[Tuple[tf.Tensor]]) — 包含注意力块的预计算键和值隐藏状态。可用于加速解码。如果使用 past_key_values，用户可以选择仅输入形状为 (batch_size, 1) 的最后一个 decoder_input_ids（那些没有提供其过去键值状态的）而不是形状为 (batch_size, sequence_length) 的所有 decoder_input_ids。
• inputs_embeds (tf.Tensor 形状为 (batch_size, sequence_length, hidden_size), 可选) — 可选地，您可选择直接传递嵌入表示而不是传递 input_ids。如果您想要对如何将 input_ids 索引转换为关联向量进行更多控制，而不是模型的内部嵌入查找矩阵，这将很有用。
• use_cache (bool, 可选，默认值为 True) — 如果设置为 True，将返回 past_key_values 键值状态，可用于加速解码（参见 past_key_values）。在训练期间设置为 False，在生成期间设置为 True output_attentions (bool, 可选): 是否返回所有注意力层的注意力张量。有关详细信息，请参阅返回张量中的 attentions。此参数仅可在急切模式下使用，在图模式下，将使用配置中的值。
• output_attentions (bool, 可选) — 是否返回所有注意力层的注意力张量。有关详细信息，请参阅返回张量中的 attentions。此参数仅可在急切模式下使用，在图模式下，将使用配置中的值。
• output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量中的 hidden_states。此参数仅可在急切模式下使用，在图形模式下，将使用配置中的值。
• return_dict (bool, 可选) — 是否返回 ModelOutput 而不是普通元组。此参数可在急切模式下使用，在图形模式下，该值将始终设置为 True。
• training (bool, 可选，默认为 False) — 是否在训练模式下使用模型（某些模块，例如 dropout 模块，在训练和评估之间有不同的行为）。

一个 transformers.modeling_tf_outputs.TFSeq2SeqModelOutput 或 tf.Tensor 的元组（如果传递 return_dict=False 或当 config.return_dict=False 时），包含取决于配置 (PegasusConfig) 和输入的各种元素。

• last_hidden_state (tf.Tensor 形状为 (batch_size, sequence_length, hidden_size)) — 模型解码器最后一层的输出处的隐藏状态序列。

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

• past_key_values (List[tf.Tensor], 可选，在传递 use_cache=True 或当 config.use_cache=True 时返回) — 长度为 config.n_layers 的 tf.Tensor 列表，每个张量形状为 (2, batch_size, num_heads, sequence_length, embed_size_per_head)。

  包含解码器的预计算隐藏状态（注意块中的键和值），可用于（请参阅 past_key_values 输入）加速顺序解码。

• decoder_hidden_states (tuple(tf.Tensor), 可选，在传递 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — tf.Tensor 元组（一个用于嵌入的输出，另一个用于每一层的输出）形状为 (batch_size, sequence_length, hidden_size)。

  解码器在每层输出处的隐藏状态加上初始嵌入输出。

• decoder_attentions (tuple(tf.Tensor), 可选，在传递 output_attentions=True 或当 config.output_attentions=True 时返回) — tf.Tensor 元组（每一层一个）形状为 (batch_size, num_heads, sequence_length, sequence_length)。

  解码器的注意力权重，在注意力 Softmax 之后，用于计算自注意力头中的加权平均值。

• cross_attentions (tuple(tf.Tensor), 可选，在传递 output_attentions=True 或当 config.output_attentions=True 时返回) — tf.Tensor 元组（每一层一个）形状为 (batch_size, num_heads, sequence_length, sequence_length)。

  解码器交叉注意力层的注意力权重，经过注意力 softmax 后，用于计算交叉注意力头部的加权平均值。

• encoder_last_hidden_state (tf.Tensor 形状为 (batch_size, sequence_length, hidden_size), 可选) — 模型编码器最后一层的输出处的隐藏状态序列。

• encoder_hidden_states (tuple(tf.Tensor), 可选，在传递 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — tf.Tensor 元组（一个用于嵌入的输出，另一个用于每一层的输出）形状为 (batch_size, sequence_length, hidden_size)。

  编码器在每层输出处的隐藏状态加上初始嵌入输出。

• encoder_attentions (tuple(tf.Tensor), 可选，在传递 output_attentions=True 或当 config.output_attentions=True 时返回) — tf.Tensor 元组（每一层一个）形状为 (batch_size, num_heads, sequence_length, sequence_length)。

  编码器的注意力权重，经过注意力 softmax 后，用于计算自注意力头部的加权平均值。

参数

• input_ids (tf.Tensor 形状为 ({0})) — 句子中每个词在词汇表中的索引。

  可以通过 AutoTokenizer 获取索引。 查看 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call() 获取更多详情。

  什么是 input IDs?

• attention_mask (tf.Tensor 形状为 ({0}), 可选) — 掩码用于避免对填充词索引执行注意力操作。 掩码值选择范围在 [0, 1] 中：
  • 1 表示该词 **没有被掩码**
  • 0 表示该词 **被掩码**

  什么是 attention masks?

• decoder_input_ids (tf.Tensor 形状为 (batch_size, target_sequence_length), 可选) — 解码器输入序列中每个词在词汇表中的索引。

  可以通过 AutoTokenizer 获取索引。 查看 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call() 获取更多详情。

  什么是 decoder input IDs?

  Pegasus 使用 pad_token_id 作为 decoder_input_ids 生成时的起始词。 如果使用 past_key_values，可以选择只输入最后的 decoder_input_ids (查看 past_key_values)。

• decoder_attention_mask (tf.Tensor 形状为 (batch_size, target_sequence_length), 可选) — 默认情况下会自动生成，并忽略填充词。 对于大多数用例，不建议设置此参数。
• decoder_position_ids (tf.Tensor 形状为 (batch_size, sequence_length), 可选) — 解码器输入序列中每个词在位置嵌入中的位置索引。 选择范围在 [0, config.max_position_embeddings - 1] 中。
• head_mask (tf.Tensor 形状为 (encoder_layers, encoder_attention_heads), 可选) — 掩码用于将编码器中注意力模块中选定的注意力头归零。 掩码值选择范围在 [0, 1] 中：
  • 1 表示该注意力头 **没有被掩码**
  • 0 表示该注意力头 **被掩码**
• decoder_head_mask (tf.Tensor 形状为 (decoder_layers, decoder_attention_heads), 可选) — 用于使解码器中注意力模块的选定头无效的掩码。掩码值选择在 [0, 1] 中：
  • 1 表示头 **未被掩盖**
  • 0 表示头 **被掩盖**
• cross_attn_head_mask (tf.Tensor 形状为 (decoder_layers, decoder_attention_heads), 可选) — 用于使交叉注意力模块的选定头无效的掩码。掩码值选择在 [0, 1] 中：
  • 1 表示头 **未被掩盖**
  • 0 表示头 **被掩盖**
• encoder_outputs (tf.FloatTensor, 可选) — 编码器最后一层输出的隐藏状态。用于解码器的交叉注意力。形状为 (batch_size, sequence_length, hidden_size)，是关于 ... 的一个序列。
• past_key_values (Tuple[Tuple[tf.Tensor]] 长度为 config.n_layers) — 包含预先计算的注意力块的关键值隐藏状态。可用于加速解码。如果使用 past_key_values，用户可以选择仅输入最后 decoder_input_ids（那些没有提供过去关键值状态的 decoder_input_ids）形状为 (batch_size, 1)，而不是所有 decoder_input_ids 形状为 (batch_size, sequence_length)。
• inputs_embeds (tf.Tensor 形状为 (batch_size, sequence_length, hidden_size), 可选) — 可选地，您无需传递 input_ids，而是选择直接传递嵌入式表示。如果您希望比模型的内部嵌入查找矩阵更能控制如何将 input_ids 索引转换为关联向量，这将很有用。
• use_cache (bool, 可选，默认为 True) — 如果设置为 True，将返回 past_key_values 键值状态，可用于加速解码（参见 past_key_values）。在训练期间设置为 False，在生成期间设置为 True output_attentions (bool, 可选): 是否返回所有注意力层的注意力张量。有关更多详细信息，请参见返回张量中的 attentions。此参数仅可在急切模式下使用，在图形模式下，将使用配置中的值。
• output_attentions (bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参见返回张量中的 attentions。此参数仅可在急切模式下使用，在图形模式下，将使用配置中的值。
• output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参见返回张量中的 hidden_states。此参数仅可在急切模式下使用，在图形模式下，将使用配置中的值。
• return_dict (bool, 可选) — 是否返回 ModelOutput 而不是普通元组。此参数可在急切模式下使用，在图形模式下，该值始终设置为 True。
• labels (tf.tensor 形状为 (batch_size, sequence_length), 可选) — 用于计算掩码语言建模损失的标签。索引应在 [0, ..., config.vocab_size] 或 -100 中（参见 input_ids 文档字符串）。索引设置为 -100 的标记将被忽略（掩码），损失仅针对标签在 [0, ..., config.vocab_size] 中的标记进行计算。

一个 transformers.modeling_tf_outputs.TFSeq2SeqLMOutput 或一个 tf.Tensor 元组（如果传递了 return_dict=False 或 config.return_dict=False 时），包含根据配置 (PegasusConfig) 和输入而定的各种元素。

• loss (tf.Tensor 形状为 (n,), 可选，在提供 labels 时返回) — 语言建模损失。

• logits (tf.Tensor 形状为 (batch_size, sequence_length, config.vocab_size)) — 语言建模头的预测分数（SoftMax 之前的每个词汇标记的分数）。

• past_key_values (List[tf.Tensor], 可选，在传递 use_cache=True 或当 config.use_cache=True 时返回) — 长度为 config.n_layers 的 tf.Tensor 列表，每个张量形状为 (2, batch_size, num_heads, sequence_length, embed_size_per_head)。

  包含解码器的预计算隐藏状态（注意块中的键和值），可用于（请参阅 past_key_values 输入）加速顺序解码。

• decoder_hidden_states (tuple(tf.Tensor), 可选，在传递 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — tf.Tensor 元组（一个用于嵌入的输出，另一个用于每一层的输出）形状为 (batch_size, sequence_length, hidden_size)。

  解码器在每层输出处的隐藏状态加上初始嵌入输出。

• decoder_attentions (tuple(tf.Tensor), 可选，在传递 output_attentions=True 或当 config.output_attentions=True 时返回) — tf.Tensor 元组（每一层一个）形状为 (batch_size, num_heads, sequence_length, sequence_length)。

  解码器的注意力权重，在注意力 Softmax 之后，用于计算自注意力头中的加权平均值。

• cross_attentions (tuple(tf.Tensor), 可选，在传递 output_attentions=True 或当 config.output_attentions=True 时返回) — tf.Tensor 元组（每一层一个）形状为 (batch_size, num_heads, sequence_length, sequence_length)。

  解码器交叉注意力层的注意力权重，经过注意力 softmax 后，用于计算交叉注意力头部的加权平均值。

• encoder_last_hidden_state (tf.Tensor 形状为 (batch_size, sequence_length, hidden_size), 可选) — 模型编码器最后一层的输出处的隐藏状态序列。

• encoder_hidden_states (tuple(tf.Tensor), 可选，在传递 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — tf.Tensor 元组（一个用于嵌入的输出，另一个用于每一层的输出）形状为 (batch_size, sequence_length, hidden_size)。

  编码器在每层输出处的隐藏状态加上初始嵌入输出。

• encoder_attentions (tuple(tf.Tensor), 可选，在传递 output_attentions=True 或当 config.output_attentions=True 时返回) — tf.Tensor 元组（每一层一个）形状为 (batch_size, num_heads, sequence_length, sequence_length)。

  编码器的注意力权重，经过注意力 softmax 后，用于计算自注意力头部的加权平均值。

参数

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

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

  什么是输入 ID？

• attention_mask (jnp.ndarray 形状为 (batch_size, sequence_length)，可选) — 掩码，用于避免对填充标记索引执行注意力。掩码值选择在 [0, 1] 中：
  • 1 表示未屏蔽的标记，
  • 0 表示屏蔽的标记。

  什么是注意力掩码？

• decoder_input_ids (jnp.ndarray 形状为 (batch_size, target_sequence_length)，可选) — 词汇表中解码器输入序列标记的索引。

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

  什么是解码器输入 ID？

• decoder_attention_mask (jnp.ndarray 形状为 (batch_size, target_sequence_length)，可选) — 默认行为：生成一个张量，该张量忽略 decoder_input_ids 中的填充标记。默认情况下，因果掩码也将被使用。

  如果您想更改填充行为，您应该根据您的需要进行修改。有关默认策略的更多信息，请参阅 论文 中的图 1。

• position_ids (numpy.ndarray 形状为 (batch_size, sequence_length)，可选) — 位置嵌入中每个输入序列标记的位置索引。选择在 [0, config.max_position_embeddings - 1] 范围内。
• decoder_position_ids (numpy.ndarray 形状为 (batch_size, sequence_length)，可选) — 位置嵌入中每个解码器输入序列标记的位置索引。选择在 [0, config.max_position_embeddings - 1] 范围内。
• output_attentions (bool，可选) — 是否返回所有注意力层的注意力张量。有关详细信息，请参阅返回张量下的 attentions。
• output_hidden_states (bool，可选) — 是否返回所有层的隐藏状态。有关详细信息，请参阅返回张量下的 hidden_states。
• return_dict (bool，可选) — 是否返回一个 ModelOutput 而不是一个简单的元组。

一个 transformers.modeling_flax_outputs.FlaxSeq2SeqModelOutput 或一个 torch.FloatTensor 元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），包含根据配置 (PegasusConfig) 和输入而不同的各种元素。

• last_hidden_state (jnp.ndarray 形状为 (batch_size, sequence_length, hidden_size)) — 模型解码器最后一层输出处的隐藏状态序列。

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

• past_key_values (tuple(tuple(jnp.ndarray))，可选，在传递 use_cache=True 或当 config.use_cache=True 时返回) — 长度为 config.n_layers 的 tuple(tuple(jnp.ndarray)) 元组，每个元组包含 2 个形状为 (batch_size, num_heads, sequence_length, embed_size_per_head) 的张量）以及 2 个形状为 (batch_size, num_heads, encoder_sequence_length, embed_size_per_head) 的附加张量。

  包含预先计算的隐藏状态 (自注意力块和交叉注意力块中的键和值)，可用于 (参见 past_key_values 输入) 加速顺序解码。

• decoder_hidden_states (tuple(jnp.ndarray)，可选，在传递 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — jnp.ndarray 元组（一个用于嵌入的输出 + 一个用于每个层的输出），形状为 (batch_size, sequence_length, hidden_

  解码器在每层输出处的隐藏状态加上初始嵌入输出。

• decoder_attentions (jnp.ndarray 的元组, 可选, 当传递 output_attentions=True 或 config.output_attentions=True 时返回) — jnp.ndarray 的元组（每层一个），形状为 (batch_size, num_heads, sequence_length, sequence_length)。

  解码器的注意力权重，在注意力 Softmax 之后，用于计算自注意力头中的加权平均值。

• cross_attentions (jnp.ndarray 的元组, 可选, 当传递 output_attentions=True 或 config.output_attentions=True 时返回) — jnp.ndarray 的元组（每层一个），形状为 (batch_size, num_heads, sequence_length, sequence_length)。

  解码器交叉注意力层的注意力权重，经过注意力 softmax 后，用于计算交叉注意力头部的加权平均值。

• encoder_last_hidden_state (jnp.ndarray，形状为 (batch_size, sequence_length, hidden_size), 可选) — 模型编码器最后一层输出的隐藏状态序列。

• encoder_hidden_states (jnp.ndarray 的元组, 可选, 当传递 output_hidden_states=True 或 config.output_hidden_states=True 时返回) — jnp.ndarray 的元组（一个用于嵌入的输出，一个用于每一层的输出），形状为 (batch_size, sequence_length, hidden_size)。

  编码器在每层输出处的隐藏状态加上初始嵌入输出。

• encoder_attentions (jnp.ndarray 的元组, 可选, 当传递 output_attentions=True 或 config.output_attentions=True 时返回) — jnp.ndarray 的元组（每层一个），形状为 (batch_size, num_heads, sequence_length, sequence_length)。

  编码器的注意力权重，经过注意力 softmax 后，用于计算自注意力头部的加权平均值。