Transformers 文档
Pegasus
并获得增强的文档体验
开始使用
该模型于 2019 年 12 月 18 日在 HF papers 上发表，并于 2020 年 11 月 16 日贡献给 Hugging Face Transformers。
Pegasus
Pegasus 是一个在无标签文本上进行预训练，用于执行抽象摘要任务的编码器-解码器（序列到序列）Transformer 模型。Pegasus 联合训练于两个自监督目标函数：掩码语言建模（MLM）和间隙句子生成（GSG）。整个句子会被掩盖，模型必须填充文档中的这些间隙。即使在仅有 1000 个样本的小型数据集上，它也可以通过微调获得良好的性能。
你可以在 Google 组织下找到所有原始的 Pegasus 检查点（checkpoints）。
点击右侧侧边栏中的 Pegasus 模型，可以查看更多关于如何将 Pegasus 应用于不同语言任务的示例。
下面的示例演示了如何使用 Pipeline、AutoModel 以及从命令行进行文本摘要。
from transformers import AutoModelForSeq2SeqLM, AutoTokenizer
tokenizer = AutoTokenizer.from_pretrained(
"google/pegasus-xsum"
)
model = AutoModelForSeq2SeqLM.from_pretrained(
"google/pegasus-xsum",
device_map="auto",
attn_implementation="sdpa"
)
input_text = """Plants are remarkable organisms that produce their own food using a method called photosynthesis.
This process involves converting sunlight, carbon dioxide, and water into glucose, which provides energy for growth.
Plants play a crucial role in sustaining life on Earth by generating oxygen and serving as the foundation of most ecosystems."""
input_ids = tokenizer(input_text, return_tensors="pt").to(model.device)
output = model.generate(**input_ids, cache_implementation="static")
print(tokenizer.decode(output[0], skip_special_tokens=True))量化通过以较低精度表示权重来减少大型模型的内存负担。有关更多可用量化后端，请参阅量化概述。
以下示例使用 bitsandbytes 将权重仅量化为 int4。
from transformers import AutoModelForSeq2SeqLM, AutoTokenizer, BitsAndBytesConfig
quantization_config = BitsAndBytesConfig(
load_in_4bit=True,
bnb_4bit_quant_type="nf4"
)
model = AutoModelForSeq2SeqLM.from_pretrained(
"google/pegasus-xsum",
device_map="auto",
quantization_config=quantization_config
)
tokenizer = AutoTokenizer.from_pretrained(
"google/pegasus-xsum"
)
input_text = """Plants are remarkable organisms that produce their own food using a method called photosynthesis.
This process involves converting sunlight, carbon dioxide, and water into glucose, which provides energy for growth.
Plants play a crucial role in sustaining life on Earth by generating oxygen and serving as the foundation of most ecosystems."""
input_ids = tokenizer(input_text, return_tensors="pt").to(model.device)
output = model.generate(**input_ids, cache_implementation="static")
print(tokenizer.decode(output[0], skip_special_tokens=True))注意事项
AdaFactor是微调 Pegasus 的推荐优化器。- Pegasus 的此实现继承自 BartForConditionalGeneration，但它改为使用静态/正弦位置嵌入。Pegasus 在生成时也以
pad_token_id作为前缀，并使用num_beams=8。
PegasusConfig
class transformers.PegasusConfig
< 源码 >( 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 vocab_size: int = 50265 max_position_embeddings: int = 1024 encoder_layers: int = 12 encoder_ffn_dim: int = 4096 encoder_attention_heads: int = 16 decoder_layers: int = 12 decoder_ffn_dim: int = 4096 decoder_attention_heads: int = 16 encoder_layerdrop: float | int = 0.0 decoder_layerdrop: float | int = 0.0 use_cache: bool = True activation_function: str = 'gelu' d_model: int = 1024 dropout: float | int = 0.1 attention_dropout: float | int = 0.0 activation_dropout: float | int = 0.0 init_std: float = 0.02 decoder_start_token_id: int | None = 0 scale_embedding: bool = False pad_token_id: int | None = 0 eos_token_id: int | list[int] | None = 1 forced_eos_token_id: int | list[int] | None = 1 is_decoder: bool = False tie_word_embeddings: bool = True )
参数
- is_encoder_decoder (
bool, optional, 默认为True) — 模型是否用作编码器/解码器。 - vocab_size (
int, optional, 默认为50265) — 模型的词汇表大小。定义了input_ids可以表示的不同标记（tokens）的数量。 - max_position_embeddings (
int, optional, 默认为1024) — 该模型可能使用的最大序列长度。 - encoder_layers (
int, optional, 默认为12) — Transformer 编码器中的隐藏层数量。如果未设置，将使用与num_layers相同的值。 - encoder_ffn_dim (
int, optional, 默认为4096) — 编码器中“中间”层（通常称为前馈层）的维度。 - encoder_attention_heads (
int, optional, 默认为16) — Transformer 编码器中每个注意力层的注意力头数量。 - decoder_layers (
int, optional, 默认为12) — Transformer 解码器中的隐藏层数量。如果未设置，将使用与num_layers相同的值。 - decoder_ffn_dim (
int, optional, 默认为4096) — 解码器中“中间”层（通常称为前馈层）的维度。 - decoder_attention_heads (
int, optional, 默认为16) — Transformer 解码器中每个注意力层的注意力头数量。 - encoder_layerdrop (
Union[float, int], optional, 默认为0.0) — 编码器的 LayerDrop 概率。有关更多详细信息，请参阅 [LayerDrop 论文](https://huggingface.co/papers/1909.11556)。 - decoder_layerdrop (
Union[float, int], optional, 默认为0.0) — 解码器的 LayerDrop 概率。有关更多详细信息，请参阅 [LayerDrop 论文](https://huggingface.co/papers/1909.11556)。 - use_cache (
bool, optional, 默认为True) — 模型是否应返回最后的键/值注意力（并非所有模型都使用）。仅当config.is_decoder=True或模型为纯解码器生成模型时才相关。 - activation_function (
str, optional, 默认为gelu) — 解码器中的非线性激活函数（函数或字符串）。例如，"gelu"、"relu"、"silu"等。 - d_model (
int, optional, 默认为1024) — 编码器层和池化层的尺寸。 - dropout (
Union[float, int], optional, 默认为0.1) — 所有 dropout 层的比率。 - attention_dropout (
Union[float, int], optional, 默认为0.0) — 注意力概率的 dropout 比率。 - activation_dropout (
Union[float, int], optional, 默认为0.0) — 全连接层内部激活值的 dropout 比率。 - init_std (
float, optional, 默认为0.02) — 用于初始化所有权重矩阵的 truncated_normal_initializer 的标准差。 - decoder_start_token_id (
int, optional, 默认为0) — 如果编码器-解码器模型开始解码时使用的标记不同于bos，则为该标记的 id。 - scale_embedding (
bool, 可选, 默认为False) — 是否通过除以 sqrt(d_model) 来缩放嵌入层。 - pad_token_id (
int, 可选, 默认为0) — 词表中用于填充（padding）的 token ID。 - eos_token_id (
Union[int, list[int]], 可选, 默认为1) — 词表中用于序列结束（end-of-stream）的 token ID。 - forced_eos_token_id (
Union[int, list[int]], 可选, 默认为1) — 当达到max_length时，强制生成的最后一个 token 的 ID。通常设置为eos_token_id。 - is_decoder (
bool, 可选, 默认为False) — 模型是否用作解码器。如果为False，则模型用作编码器。 - tie_word_embeddings (
bool, 可选, 默认为True) — 是否根据模型的tied_weights_keys映射来绑定权重嵌入。
这是用于存储 PegasusModel 配置的配置类。它用于根据指定的参数实例化一个 Pegasus 模型，从而定义模型架构。使用默认值实例化配置将产生与 google/pegasus-large 类似的配置。
配置对象继承自 PreTrainedConfig，可用于控制模型输出。阅读 PreTrainedConfig 的文档以获取更多信息。
示例
>>> from transformers import PegasusConfig, PegasusModel
>>> # Initializing a PEGASUS google/pegasus-large style configuration
>>> configuration = PegasusConfig()
>>> # Initializing a model (with random weights) from the google/pegasus-large style configuration
>>> model = PegasusModel(configuration)
>>> # Accessing the model configuration
>>> configuration = model.configPegasusTokenizer
警告: add_tokens 目前无法使用。
class transformers.PegasusTokenizer
< 源文件 >( vocab: str | list[tuple[str, float]] | None = None pad_token = '<pad>' eos_token = '</s>' unk_token = '<unk>' mask_token = '<mask_2>' mask_token_sent = '<mask_1>' _spm_precompiled_charsmap = None additional_special_tokens = None offset = 103 **kwargs )
参数
- vocab_file (
str, 可选) — 包含实例化分词器所需词表的 SentencePiece 文件（通常具有 .spm 扩展名）。 - pad_token (
str, 可选, 默认为"<pad>") — 用于填充的 token，例如在批处理不同长度的序列时使用。 - eos_token (
str, 可选, 默认为"</s>") — 序列结束 token。当使用特殊 token 构建序列时，这不是用于序列结束的 token。实际使用的 token 是
sep_token。 - unk_token (
str, 可选, 默认为"<unk>") — 未知 token。词表中不存在的 token 无法转换为 ID，会被设置为该 token。 - mask_token (
str, 可选, 默认为"<mask_2>") — 用于掩码单个 token 值的 token。这是在训练模型进行掩码语言建模（MLM）时使用的 token。这是 PEGASUS 编码器在预训练期间尝试预测的 token。它对应于 PEGASUS: Pre-training with Extracted Gap-sentences for Abstractive Summarization 中的 [MASK2]。 - mask_token_sent (
str, 可选, 默认为"<mask_1>") — 用于掩码整个目标句子的 token。这是在训练模型进行间隙句子生成（GSG）时使用的 token。这是 PEGASUS 解码器在预训练期间尝试预测的句子。它对应于 PEGASUS: Pre-training with Extracted Gap-sentences for Abstractive Summarization 中的 [MASK1]。 - additional_special_tokens (
List[str], 可选) — 分词器使用的额外特殊 token。如果没有提供 additional_special_tokens，则使用和 - offset (
int, 可选, 默认为 103) — 额外特殊 token 的偏移量。 - vocab (
str或list[tuple[str, float]], 可选) — 包含(token, score)元组的自定义词表。如果未提供，将初始化一个空白词表。
构建一个 PEGASUS 分词器（由 HuggingFace 的 tokenizers 库支持）。基于 Unigram。
该分词器继承自 TokenizersBackend，后者包含其大部分主要方法。用户应参考该父类以获取有关这些方法的更多信息。
PegasusTokenizerFast
class transformers.PegasusTokenizer
< 源文件 >( vocab: str | list[tuple[str, float]] | None = None pad_token = '<pad>' eos_token = '</s>' unk_token = '<unk>' mask_token = '<mask_2>' mask_token_sent = '<mask_1>' _spm_precompiled_charsmap = None additional_special_tokens = None offset = 103 **kwargs )
参数
- vocab_file (
str, 可选) — 包含实例化分词器所需词表的 SentencePiece 文件（通常具有 .spm 扩展名）。 - pad_token (
str, 可选, 默认为"<pad>") — 用于填充的 token，例如在批处理不同长度的序列时使用。 - eos_token (
str, 可选, 默认为"</s>") — 序列结束 token。当使用特殊 token 构建序列时，这不是用于序列结束的 token。实际使用的 token 是
sep_token。 - unk_token (
str, 可选, 默认为"<unk>") — 未知 token。词表中不存在的 token 无法转换为 ID，会被设置为该 token。 - mask_token (
str, 可选, 默认为"<mask_2>") — 用于掩码单个 token 值的 token。这是在训练模型进行掩码语言建模（MLM）时使用的 token。这是 PEGASUS 编码器在预训练期间尝试预测的 token。它对应于 PEGASUS: Pre-training with Extracted Gap-sentences for Abstractive Summarization 中的 [MASK2]。 - mask_token_sent (
str, 可选, 默认为"<mask_1>") — 用于掩码整个目标句子的 token。这是在训练模型进行间隙句子生成（GSG）时使用的 token。这是 PEGASUS 解码器在预训练期间尝试预测的句子。它对应于 PEGASUS: Pre-training with Extracted Gap-sentences for Abstractive Summarization 中的 [MASK1]。 - additional_special_tokens (
List[str], 可选) — 分词器使用的额外特殊 token。如果没有提供 additional_special_tokens，则使用和 - offset (
int, 可选, 默认为 103) — 额外特殊 token 的偏移量。 - vocab (
str或list[tuple[str, float]], 可选) — 包含(token, score)元组的自定义词表。如果未提供，将初始化一个空白词表。
构建一个 PEGASUS 分词器（由 HuggingFace 的 tokenizers 库支持）。基于 Unigram。
该分词器继承自 TokenizersBackend，后者包含其大部分主要方法。用户应参考该父类以获取有关这些方法的更多信息。
PegasusModel
class transformers.PegasusModel
< 源文件 >( config: PegasusConfig )
参数
- config (PegasusConfig) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载与模型相关的权重，只会加载配置。请查阅 from_pretrained() 方法以加载模型权重。
基础 Pegasus 模型，输出原始隐藏状态，顶部没有任何特定的头。
该模型继承自 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.Tensor | None = None encoder_outputs: tuple[torch.FloatTensor] | 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 **kwargs: typing_extensions.Unpack[transformers.utils.generic.TransformersKwargs] ) → Seq2SeqModelOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (形状为
(batch_size, sequence_length)的torch.Tensor, 可选) — 词表中输入序列 token 的索引。默认情况下将忽略填充（padding）。索引可以使用 AutoTokenizer 获取。详情请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (形状为
(batch_size, sequence_length)的torch.Tensor, 可选) — 避免对填充 token 索引执行注意力机制的掩码。掩码值在[0, 1]中选择：- 1 表示未被掩码的 token，
- 0 表示被掩码的 token。
- decoder_input_ids (形状为
(batch_size, target_sequence_length)的torch.LongTensor, 可选) — 解码器输入序列 token 的词表索引。索引可以使用 AutoTokenizer 获取。详情请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
Pegasus 使用
pad_token_id作为decoder_input_ids生成的起始 token。如果使用了past_key_values，则可以选择仅输入最后的decoder_input_ids（参阅past_key_values）。 - decoder_attention_mask (形状为
(batch_size, target_sequence_length)的torch.LongTensor, 可选) — 默认行为：生成一个忽略decoder_input_ids中填充 token 的张量。默认情况下还将使用因果（causal）掩码。 - encoder_outputs (
tuple[torch.FloatTensor], 可选) — 元组包含 (last_hidden_state, 可选:hidden_states, 可选:attentions)。形状为(batch_size, sequence_length, hidden_size)的last_hidden_state是编码器最后一层的输出隐藏状态序列，用于解码器的交叉注意力机制。 - past_key_values (
~cache_utils.Cache, 可选) — 预先计算的隐藏状态（自注意力模块和交叉注意力模块中的键和值），可用于加速顺序解码。这通常包含模型在解码的先前阶段返回的past_key_values（当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 (
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的值。 - use_cache (
bool，可选) — 如果设置为True，将返回past_key_values键值状态，可用于加速解码（参见past_key_values）。
返回
Seq2SeqModelOutput 或 tuple(torch.FloatTensor)
一个 Seq2SeqModelOutput 或 torch.FloatTensor 元组（如果传入 return_dict=False 或 config.return_dict=False），根据配置 (PegasusConfig) 和输入包含各种元素。
PEGASUS 模型的 forward 方法，覆盖了 __call__ 特殊方法。
虽然 forward pass 的实现需要在此函数中定义，但你应该在之后调用
Module实例而不是这个，因为前者负责运行预处理和后处理步骤，而后者会静默地忽略它们。
last_hidden_state (
torch.FloatTensor，形状为(batch_size, sequence_length, hidden_size)) — 模型解码器最后一层输出的隐藏状态序列。如果使用了
past_key_values，则只输出形状为(batch_size, 1, hidden_size)的序列的最后一个隐藏状态。past_key_values (
EncoderDecoderCache，可选，在传递了use_cache=True或当config.use_cache=True时返回) — 这是一个 EncoderDecoderCache 实例。有关更多详细信息，请参阅我们的 KV 缓存指南。包含预先计算的隐藏状态（自注意力块和交叉注意力块中的键和值），可用于（参见
past_key_values输入）加速顺序解码。decoder_hidden_states (
tuple(torch.FloatTensor), optional, 当传入output_hidden_states=True或当config.output_hidden_states=True时返回) —torch.FloatTensor元组（一个用于嵌入的输出，如果模型有嵌入层，+ 一个用于每个层的输出），形状为(batch_size, sequence_length, hidden_size)。解码器在每个层输出的隐藏状态，加上可选的初始嵌入输出。
decoder_attentions (
tuple(torch.FloatTensor), optional, 当传入output_attentions=True或当config.output_attentions=True时返回) —torch.FloatTensor元组（每个层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。解码器的注意力权重，在注意力 softmax 之后，用于计算自注意力头中的加权平均。
cross_attentions (
tuple(torch.FloatTensor), optional, returned whenoutput_attentions=Trueis passed or whenconfig.output_attentions=True) — Tuple oftorch.FloatTensor(one for each layer) of shape(batch_size, num_heads, sequence_length, sequence_length).解码器交叉注意力层的注意力权重，在注意力 softmax 之后，用于计算交叉注意力头中的加权平均。
encoder_last_hidden_state (
torch.FloatTensor，形状为(batch_size, sequence_length, hidden_size)，可选) — 模型编码器最后一层输出的隐藏状态序列。encoder_hidden_states (
tuple(torch.FloatTensor), optional, 当传入output_hidden_states=True或当config.output_hidden_states=True时返回) —torch.FloatTensor元组（一个用于嵌入的输出，如果模型有嵌入层，+ 一个用于每个层的输出），形状为(batch_size, sequence_length, hidden_size)。编码器在每个层输出的隐藏状态，加上可选的初始嵌入输出。
encoder_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, PegasusModel
>>> tokenizer = AutoTokenizer.from_pretrained("google/pegasus-large")
>>> model = PegasusModel.from_pretrained("google/pegasus-large")
>>> inputs = tokenizer("Studies have been shown that owning a dog is good for you", return_tensors="pt")
>>> decoder_inputs = tokenizer("Studies show that", return_tensors="pt")
>>> outputs = model(input_ids=inputs.input_ids, decoder_input_ids=decoder_inputs.input_ids)
>>> last_hidden_states = outputs.last_hidden_state
>>> list(last_hidden_states.shape)
[1, 4, 1024]PegasusForConditionalGeneration
class transformers.PegasusForConditionalGeneration
< 源代码 >( config: PegasusConfig )
参数
- config (PegasusConfig) — 模型配置类，包含模型的所有参数。仅使用配置文件初始化模型不会加载与模型相关的权重，只会加载配置。请参阅 from_pretrained() 方法来加载模型权重。
带有语言建模头的 PEGASUS 模型。可用于文本摘要。
该模型继承自 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.Tensor | None = None encoder_outputs: tuple[torch.FloatTensor] | 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 **kwargs: typing_extensions.Unpack[transformers.utils.generic.TransformersKwargs] ) → Seq2SeqLMOutput 或 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。
- decoder_input_ids (
torch.LongTensor，形状为(batch_size, target_sequence_length)，可选) — 词表中解码器输入序列 token 的索引。索引可以使用 AutoTokenizer 获取。详情请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
Pegasus 使用
pad_token_id作为decoder_input_ids生成的起始 token。如果使用了past_key_values，可选仅输入最后的decoder_input_ids（参见past_key_values）。 - decoder_attention_mask (
torch.LongTensor，形状为(batch_size, target_sequence_length)，可选) — 默认行为：生成一个忽略decoder_input_ids中填充 token 的张量。因果掩码（Causal mask）也将默认使用。 - encoder_outputs (
tuple[torch.FloatTensor]，可选) — 元组包含 (last_hidden_state, 可选:hidden_states, 可选:attentions)。形状为(batch_size, sequence_length, hidden_size)的last_hidden_state是编码器最后一层的输出隐藏状态序列，用于解码器的交叉注意力机制。 - past_key_values (
~cache_utils.Cache，可选) — 预先计算的隐藏状态（自注意力模块和交叉注意力模块中的键和值），可用于加速顺序解码。这通常包含模型在解码的先前阶段返回的past_key_values（当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 (
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, sequence_length)，可选) — 用于计算掩码语言建模损失的标签。索引应在[0, ..., config.vocab_size]范围内或为 -100（参见input_ids文档字符串）。索引设置为-100的 token 将被忽略（掩码），损失仅对标签在[0, ..., config.vocab_size]中的 token 进行计算。 - use_cache (
bool，可选) — 如果设置为True，将返回past_key_values键值状态，可用于加速解码（参见past_key_values）。
返回
Seq2SeqLMOutput 或 tuple(torch.FloatTensor)
一个 Seq2SeqLMOutput 或 torch.FloatTensor 元组（如果传入 return_dict=False 或 config.return_dict=False），根据配置 (PegasusConfig) 和输入包含各种元素。
PEGASUS 模型的 forward 方法，覆盖了 __call__ 特殊方法。
虽然 forward pass 的实现需要在此函数中定义，但你应该在之后调用
Module实例而不是这个，因为前者负责运行预处理和后处理步骤，而后者会静默地忽略它们。
loss (
torch.FloatTensor，形状为(1,)，可选，当提供labels时返回) — 语言建模损失。logits (形状为
(batch_size, sequence_length, config.vocab_size)的torch.FloatTensor) — 语言建模头部的预测分数（SoftMax 之前的每个词汇标记的分数）。past_key_values (
EncoderDecoderCache，可选，在传递了use_cache=True或当config.use_cache=True时返回) — 这是一个 EncoderDecoderCache 实例。有关更多详细信息，请参阅我们的 KV 缓存指南。包含预先计算的隐藏状态（自注意力块和交叉注意力块中的键和值），可用于（参见
past_key_values输入）加速顺序解码。decoder_hidden_states (
tuple(torch.FloatTensor), optional, 当传入output_hidden_states=True或当config.output_hidden_states=True时返回) —torch.FloatTensor元组（一个用于嵌入的输出，如果模型有嵌入层，+ 一个用于每个层的输出），形状为(batch_size, sequence_length, hidden_size)。解码器在每一层输出时的隐藏状态以及初始嵌入输出。
decoder_attentions (
tuple(torch.FloatTensor), optional, 当传入output_attentions=True或当config.output_attentions=True时返回) —torch.FloatTensor元组（每个层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。解码器的注意力权重，在注意力 softmax 之后，用于计算自注意力头中的加权平均。
cross_attentions (
tuple(torch.FloatTensor), optional, returned whenoutput_attentions=Trueis passed or whenconfig.output_attentions=True) — Tuple oftorch.FloatTensor(one for each layer) of shape(batch_size, num_heads, sequence_length, sequence_length).解码器交叉注意力层的注意力权重，在注意力 softmax 之后，用于计算交叉注意力头中的加权平均。
encoder_last_hidden_state (
torch.FloatTensor，形状为(batch_size, sequence_length, hidden_size)，可选) — 模型编码器最后一层输出的隐藏状态序列。encoder_hidden_states (
tuple(torch.FloatTensor), optional, 当传入output_hidden_states=True或当config.output_hidden_states=True时返回) —torch.FloatTensor元组（一个用于嵌入的输出，如果模型有嵌入层，+ 一个用于每个层的输出），形状为(batch_size, sequence_length, hidden_size)。编码器在每一层输出时的隐藏状态以及初始嵌入输出。
encoder_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, PegasusForConditionalGeneration
>>> model = PegasusForConditionalGeneration.from_pretrained("google/pegasus-xsum")
>>> tokenizer = AutoTokenizer.from_pretrained("google/pegasus-xsum")
>>> ARTICLE_TO_SUMMARIZE = (
... "PG&E stated it scheduled the blackouts in response to forecasts for high winds "
... "amid dry conditions. The aim is to reduce the risk of wildfires. Nearly 800 thousand customers were "
... "scheduled to be affected by the shutoffs which were expected to last through at least midday tomorrow."
... )
>>> inputs = tokenizer(ARTICLE_TO_SUMMARIZE, max_length=1024, return_tensors="pt")
>>> # Generate Summary
>>> summary_ids = model.generate(inputs["input_ids"])
>>> tokenizer.batch_decode(summary_ids, skip_special_tokens=True, clean_up_tokenization_spaces=False)[0]
"California's largest electricity provider has turned off power to hundreds of thousands of customers."PegasusForCausalLM
forward
< 源码 >( input_ids: torch.LongTensor | None = None attention_mask: torch.Tensor | None = None encoder_hidden_states: torch.FloatTensor | None = None encoder_attention_mask: torch.FloatTensor | None = None past_key_values: transformers.cache_utils.Cache | None = None inputs_embeds: torch.FloatTensor | None = None labels: torch.LongTensor | None = None use_cache: bool | None = None logits_to_keep: int | torch.Tensor = 0 **kwargs: typing_extensions.Unpack[transformers.utils.generic.TransformersKwargs] ) → CausalLMOutputWithCrossAttentions 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor，形状为(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.FloatTensor，形状为(batch_size, sequence_length, hidden_size)，可选) — 编码器最后一层输出的隐藏状态序列。如果模型被配置为解码器，则用于交叉注意力计算。 - encoder_attention_mask (
torch.FloatTensor，形状为(batch_size, sequence_length)，可选) — 用于避免对编码器输入的填充标记索引执行注意力计算的掩码。如果模型被配置为解码器，该掩码将用于交叉注意力计算。掩码值选自[0, 1]：- 1 表示未掩码的标记，
- 0 表示已掩码的标记。
- past_key_values (
~cache_utils.Cache，可选) — 预先计算的隐藏状态（自注意力模块和交叉注意力模块中的键和值），可用于加速顺序解码。这通常包含模型在解码的先前阶段返回的past_key_values（当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 (
torch.FloatTensor，形状为(batch_size, sequence_length, hidden_size)，可选) — 可选地，你可以选择直接传入嵌入表示，而不是传入input_ids。这在你想要比模型内部嵌入查找矩阵更多地控制如何将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）。 - logits_to_keep (
Union[int, torch.Tensor]，可选，默认为0) — 如果为int，则计算最后logits_to_keep个标记的逻辑值（logits）。如果为0，则计算所有input_ids的逻辑值（特殊情况）。生成时仅需要最后一个标记的逻辑值，仅针对该标记进行计算可以节省内存，这在长序列或大词汇量的情况下非常显著。如果为torch.Tensor，则必须是一维的，对应于序列长度维度中要保留的索引。这在使用填充张量格式（批次和序列长度使用单一维度）时非常有用。
返回
CausalLMOutputWithCrossAttentions or tuple(torch.FloatTensor)
一个 CausalLMOutputWithCrossAttentions 或一个 torch.FloatTensor 元组（如果传入了 return_dict=False 或当 config.return_dict=False 时），根据配置（PegasusConfig）和输入，包含各种元素。
PegasusForCausalLM 的 forward 方法重写了 __call__ 特殊方法。
虽然 forward pass 的实现需要在此函数中定义，但你应该在之后调用
Module实例而不是这个，因为前者负责运行预处理和后处理步骤，而后者会静默地忽略它们。
loss (
torch.FloatTensor形状为(1,)，可选，当提供labels时返回) — 语言建模损失（用于下一个 token 预测）。logits (形状为
(batch_size, sequence_length, config.vocab_size)的torch.FloatTensor) — 语言建模头部的预测分数（SoftMax 之前的每个词汇标记的分数）。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 后的注意力权重，用于计算自注意力头中的加权平均值。
cross_attentions (
tuple(torch.FloatTensor), optional, returned whenoutput_attentions=Trueis passed or whenconfig.output_attentions=True) — Tuple oftorch.FloatTensor(one for each layer) of shape(batch_size, num_heads, sequence_length, sequence_length).注意力 softmax 后的交叉注意力权重，用于计算交叉注意力头中的加权平均。
past_key_values (
Cache，*可选*，当传入use_cache=True或config.use_cache=True时返回) — 这是一个 Cache 实例。欲了解更多细节，请参阅我们的 KV 缓存指南。包含预先计算的隐藏状态（注意力块中的键和值），可用于（参见
past_key_values输入）加速顺序解码。
示例
>>> from transformers import AutoTokenizer, PegasusForCausalLM
>>> tokenizer = AutoTokenizer.from_pretrained("google/pegasus-large")
>>> model = PegasusForCausalLM.from_pretrained("google/pegasus-large")
>>> 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
>>> expected_shape = [1, inputs.input_ids.shape[-1], model.config.vocab_size]
>>> list(logits.shape) == expected_shape
True