Transformers 文档
PLBart
并获得增强的文档体验
开始使用
PLBart
概述
PLBART 模型由 Wasi Uddin Ahmad、Saikat Chakraborty、Baishakhi Ray 和 Kai-Wei Chang 在 《用于程序理解和生成的统一预训练》 中提出。这是一个类 BART 模型，可用于执行代码摘要、代码生成和代码翻译任务。预训练模型 plbart-base 已在 Java、Python 和英语上使用多语言去噪任务进行训练。
摘要如下：
代码摘要和生成支持编程语言 (PL) 和自然语言 (NL) 之间的转换，而代码翻译则有助于将旧代码从一种 PL 迁移到另一种 PL。本文介绍了 PLBART，这是一种序列到序列模型，能够执行广泛的程序和语言理解和生成任务。PLBART 通过去噪自动编码对大量 Java 和 Python 函数及其相关的 NL 文本进行预训练。在英语代码摘要、代码生成和七种编程语言的代码翻译上的实验表明，PLBART 优于或与现有最先进的模型相媲美。此外，在判别任务（例如，程序修复、克隆检测和脆弱代码检测）上的实验证明了 PLBART 在程序理解方面的有效性。此外，分析表明 PLBART 学习程序语法、样式（例如，标识符命名约定）、逻辑流（例如，else 块内的 if 块等效于 else if 块），这些对于程序语义至关重要，因此即使注释有限也能表现出色。
该模型由 gchhablani 贡献。作者的代码可在 此处 找到。
使用示例
PLBart 是一种多语言编码器-解码器（序列到序列）模型，主要用于代码到文本、文本到代码、代码到代码任务。由于该模型是多语言的，因此它期望序列采用不同的格式。一个特殊的语言 ID 标记被添加到源文本和目标文本中。源文本格式为 X [eos, src_lang_code]，其中 X 是源文本。目标文本格式为 [tgt_lang_code] X [eos]。从不使用 bos。
然而，对于微调，在某些情况下，当使用单一语言时，不提供语言标记。请参阅论文以了解更多信息。
如果需要语言代码，常规的 call() 将在您将文本作为第一个参数或使用关键字参数 text 传递时编码源文本格式，如果使用 text_target 关键字参数传递，则将编码目标文本格式。
监督训练
>>> from transformers import PLBartForConditionalGeneration, PLBartTokenizer
>>> tokenizer = PLBartTokenizer.from_pretrained("uclanlp/plbart-base", src_lang="en_XX", tgt_lang="python")
>>> example_python_phrase = "def maximum(a,b,c):NEW_LINE_INDENTreturn max([a,b,c])"
>>> expected_translation_english = "Returns the maximum value of a b c."
>>> inputs = tokenizer(example_python_phrase, text_target=expected_translation_english, return_tensors="pt")
>>> model(**inputs)生成
生成目标文本时，将 decoder_start_token_id 设置为目标语言 ID。以下示例展示了如何使用 uclanlp/plbart-python-en_XX 模型将 Python 翻译成英语。
>>> from transformers import PLBartForConditionalGeneration, PLBartTokenizer
>>> tokenizer = PLBartTokenizer.from_pretrained("uclanlp/plbart-python-en_XX", src_lang="python", tgt_lang="en_XX")
>>> example_python_phrase = "def maximum(a,b,c):NEW_LINE_INDENTreturn max([a,b,c])"
>>> inputs = tokenizer(example_python_phrase, return_tensors="pt")
>>> model = PLBartForConditionalGeneration.from_pretrained("uclanlp/plbart-python-en_XX")
>>> translated_tokens = model.generate(**inputs, decoder_start_token_id=tokenizer.lang_code_to_id["en_XX"])
>>> tokenizer.batch_decode(translated_tokens, skip_special_tokens=True)[0]
"Returns the maximum value of a b c."资源
PLBartConfig
类 transformers.PLBartConfig
< 来源 >( vocab_size = 50005 max_position_embeddings = 1024 encoder_layers = 6 encoder_ffn_dim = 3072 encoder_attention_heads = 12 decoder_layers = 6 decoder_ffn_dim = 3072 decoder_attention_heads = 12 encoder_layerdrop = 0.0 decoder_layerdrop = 0.0 use_cache = True is_encoder_decoder = True activation_function = 'gelu' d_model = 768 dropout = 0.1 attention_dropout = 0.1 activation_dropout = 0.0 init_std = 0.02 classifier_dropout = 0.0 scale_embedding = True pad_token_id = 1 bos_token_id = 0 eos_token_id = 2 forced_eos_token_id = 2 **kwargs )
参数
- vocab_size (
int, 可选, 默认为 50005) — PLBART 模型的词汇表大小。定义了调用 PLBartModel 时可以由inputs_ids表示的不同标记的数量。 - d_model (
int, 可选, 默认为 768) — 层和池化层的维度。 - encoder_layers (
int, 可选, 默认为 6) — 编码器层的数量。 - decoder_layers (
int, 可选, 默认为 6) — 解码器层的数量。 - encoder_attention_heads (
int, 可选, 默认为 12) — Transformer 编码器中每个注意力层的注意力头数。 - decoder_attention_heads (
int, 可选, 默认为 12) — Transformer 解码器中每个注意力层的注意力头数。 - decoder_ffn_dim (
int, 可选, 默认为 3072) — 解码器中“中间”（通常称为前馈）层的维度。 - encoder_ffn_dim (
int, 可选, 默认为 3072) — 解码器中“中间”（通常称为前馈）层的维度。 - activation_function (
str或function, 可选, 默认为"gelu") — 编码器和池化器中的非线性激活函数（函数或字符串）。如果为字符串，则支持"gelu"、"relu"、"silu"和"gelu_new"。 - dropout (
float, 可选, 默认为 0.1) — 嵌入、编码器和池化器中所有全连接层的 dropout 概率。 - attention_dropout (
float, 可选, 默认为 0.1) — 注意力概率的 dropout 比率。 - activation_dropout (
float, 可选, 默认为 0.0) — 全连接层内部激活的 dropout 比率。 - classifier_dropout (
float, 可选, 默认为 0.0) — 分类器的 dropout 比率。 - max_position_embeddings (
int, 可选, 默认为 1024) — 此模型可能使用的最大序列长度。通常为了以防万一设置为较大的值（例如，512、1024 或 2048）。 - init_std (
float, 可选, 默认为 0.02) — 用于初始化所有权重矩阵的截断正态初始化器的标准差。 - encoder_layerdrop (
float, 可选, 默认为 0.0) — 编码器的 LayerDrop 概率。更多详情请参阅 [LayerDrop 论文](参见 https://huggingface.co/papers/1909.11556)。 - decoder_layerdrop (
float, 可选, 默认为 0.0) — 解码器的 LayerDrop 概率。更多详情请参阅 [LayerDrop 论文](参见 https://huggingface.co/papers/1909.11556)。 - scale_embedding (
bool, 可选, 默认为True) — 通过除以 sqrt(d_model) 来缩放嵌入。 - use_cache (
bool, 可选, 默认为True) — 模型是否应返回最后一个键/值注意力（并非所有模型都使用）。 - forced_eos_token_id (
int, 可选, 默认为 2) — 当达到max_length时，强制作为最后生成的 token 的 token ID。通常设置为eos_token_id。
这是用于存储 PLBartModel 配置的配置类。它用于根据指定的参数实例化 PLBART 模型，定义模型架构。使用默认值实例化配置将生成与 PLBART uclanlp/plbart-base 架构类似的配置。
配置对象继承自 PretrainedConfig，可用于控制模型输出。有关更多信息，请阅读 PretrainedConfig 的文档。
示例
>>> from transformers import PLBartConfig, PLBartModel
>>> # Initializing a PLBART uclanlp/plbart-base style configuration
>>> configuration = PLBartConfig()
>>> # Initializing a model (with random weights) from the uclanlp/plbart-base style configuration
>>> model = PLBartModel(configuration)
>>> # Accessing the model configuration
>>> configuration = model.configPLBartTokenizer
class transformers.PLBartTokenizer
< source >( vocab_file bos_token = '<s>' eos_token = '</s>' sep_token = '</s>' cls_token = '<s>' unk_token = '<unk>' pad_token = '<pad>' mask_token = '<mask>' language_codes = 'base' tokenizer_file = None src_lang = None tgt_lang = None sp_model_kwargs: typing.Optional[dict[str, typing.Any]] = None additional_special_tokens = None clean_up_tokenization_spaces = True **kwargs )
参数
- vocab_file (
str) — 词汇表文件的路径。 - src_lang (
str, 可选) — 表示源语言的字符串。 - tgt_lang (
str, 可选) — 表示目标语言的字符串。 - bos_token (
str, 可选, 默认为"<s>") — 序列开始标记。 - eos_token (
str, 可选, 默认为"</s>") — 序列结束标记。 - sep_token (
str, 可选, 默认为"</s>") — 分隔符标记，用于从多个序列构建序列时，例如用于序列分类的两个序列，或用于问答的文本和问题。它也用作使用特殊标记构建的序列的最后一个标记。 - cls_token (
str, 可选, 默认为"<s>") — cls 标记，一个特殊标记，用作所有任务的第一个标记。 - unk_token (
str, 可选, 默认为"<unk>") — 未知标记。不在词汇表中的标记不能转换为 ID，而是设置为此标记。 - pad_token (
str, 可选, 默认为"<pad>") — 用于填充的标记，例如在对不同长度的序列进行批处理时。 - mask_token(
str, 可选, 默认为"<mask>") — 用于掩盖值的标记。在使用掩码任务训练此模型时使用此标记。这仅在"base"分词器类型中使用。对于"multi"分词器，下游任务从不进行掩码。 - language_codes (
str, 可选, 默认为"base") — 使用哪种语言代码。应为"base"或"multi"之一。 - sp_model_kwargs (
dict, 可选) — 将传递给SentencePieceProcessor.__init__()方法。SentencePiece 的 Python 包装器 可用于设置：enable_sampling: 启用子词正则化。nbest_size: Unigram 的采样参数。对于 BPE-Dropout 无效。nbest_size = {0,1}: 不执行采样。nbest_size > 1: 从 nbest_size 结果中采样。nbest_size < 0: 假设 nbest_size 是无限的，并使用前向滤波和后向采样算法从所有假设（格）中采样。
alpha: 用于 Unigram 采样的平滑参数，以及 BPE-dropout 的合并操作的 dropout 概率。
构建 PLBART 分词器。
改编自 RobertaTokenizer 和 XLNetTokenizer。基于 SentencePiece。
源语言文档的分词方法是 <tokens> <eos> <language code>，目标语言文档的分词方法是 `<language code>
示例
>>> from transformers import PLBartTokenizer
>>> tokenizer = PLBartTokenizer.from_pretrained("uclanlp/plbart-python-en_XX", src_lang="python", tgt_lang="en_XX")
>>> example_python_phrase = "def maximum(a,b,c):NEW_LINE_INDENTreturn max([a,b,c])"
>>> expected_translation_english = "Returns the maximum value of a b c."
>>> inputs = tokenizer(example_python_phrase, text_target=expected_translation_english, return_tensors="pt")build_inputs_with_special_tokens
< source >( token_ids_0: list token_ids_1: typing.Optional[list[int]] = None ) → list[int]
通过连接和添加特殊标记，从序列或序列对构建用于序列分类任务的模型输入。PLBART 序列的格式如下，其中 X 表示序列
input_ids（用于编码器）X [eos, src_lang_code]decoder_input_ids：（用于解码器）X [eos, tgt_lang_code]
从不使用 BOS。序列对不是预期的用例，但它们将在没有分隔符的情况下处理。
PLBartModel
class transformers.PLBartModel
< source >( config: PLBartConfig )
参数
- config (PLBartConfig) — 带有模型所有参数的模型配置类。用配置文件初始化并不会加载与模型相关的权重，只加载配置。要加载模型权重，请查看 from_pretrained() 方法。
裸 PLBart 模型输出原始隐藏状态，顶部没有任何特定头部。
此模型继承自 PreTrainedModel。查看超类文档以了解库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头部等）。
此模型也是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参阅 PyTorch 文档以了解与一般用法和行为相关的所有事项。
forward
< source >( input_ids: typing.Optional[torch.LongTensor] = None attention_mask: typing.Optional[torch.LongTensor] = None decoder_input_ids: typing.Optional[torch.LongTensor] = None decoder_attention_mask: typing.Optional[torch.Tensor] = None head_mask: typing.Optional[torch.Tensor] = None decoder_head_mask: typing.Optional[torch.LongTensor] = None cross_attn_head_mask: typing.Optional[torch.Tensor] = None encoder_outputs: typing.Optional[list[torch.FloatTensor]] = None past_key_values: typing.Optional[list[torch.FloatTensor]] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None decoder_inputs_embeds: typing.Optional[torch.FloatTensor] = None use_cache: typing.Optional[bool] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None cache_position: typing.Optional[torch.LongTensor] = None ) → transformers.modeling_outputs.Seq2SeqModelOutput or tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor形状为(batch_size, sequence_length), 可选) — 词汇表中输入序列 token 的索引。默认情况下会忽略填充。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.LongTensor形状为(batch_size, sequence_length), 可选) — 避免对填充 token 索引执行注意力的掩码。掩码值选择范围为[0, 1]：- 1 表示 token 未被掩盖，
- 0 表示 token 已被掩盖。
- decoder_input_ids (
torch.LongTensor形状为(batch_size, target_sequence_length), 可选) — 词汇表中解码器输入序列 token 的索引。索引可以使用 AutoTokenizer 或
PLBartMultiTokenizer获取，具体取决于检查点。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。PLBart 使用特定的语言 ID 标记作为
decoder_input_ids生成的起始标记，该标记根据源语言和目标语言而异，例如 en_XX 为 50003，java 为 50001。如果使用past_key_values，可以选择只输入最后一个decoder_input_ids（那些没有将过去的键值状态提供给此模型的）（请参阅past_key_values）。对于翻译和摘要训练，应提供
decoder_input_ids。如果未提供decoder_input_ids，模型将通过根据论文将input_ids向右移动以进行去噪预训练来创建此张量。 - decoder_attention_mask (` —
- ` 对象 —torch.LongTensor 形状为
(batch_size, target_sequence_length), 可选): 默认行为：生成一个忽略decoder_input_ids中填充 token 的张量。默认情况下也会使用因果掩码。 - head_mask (
torch.Tensor形状为(num_heads,)或(num_layers, num_heads), 可选) — 用于使自注意力模块的选定头部无效的掩码。掩码值选择范围为[0, 1]：- 1 表示头部未被掩盖，
- 0 表示头部已被掩盖。
- decoder_head_mask (
torch.LongTensor形状为(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 (
list[torch.FloatTensor], 可选) — 元组包含 (last_hidden_state, 可选:hidden_states, 可选:attentions)last_hidden_state形状为(batch_size, sequence_length, hidden_size), 可选) 是编码器最后一层输出的隐藏状态序列。用于解码器的交叉注意力。 - past_key_values (
list[torch.FloatTensor], 可选) — 预先计算的隐藏状态（自注意力块和交叉注意力块中的键和值），可用于加速顺序解码。这通常包括模型在解码上一阶段返回的past_key_values，当use_cache=True或config.use_cache=True时。允许两种格式：
- Cache 实例，请参阅我们的 kv cache 指南；
- 长度为
config.n_layers的tuple(torch.FloatTensor)元组，每个元组包含 2 个形状为(batch_size, num_heads, sequence_length, embed_size_per_head)的张量）。这也被称为传统缓存格式。
模型将输出与作为输入提供的缓存格式相同的缓存格式。如果未传递
past_key_values，则将返回传统缓存格式。如果使用
past_key_values，用户可以选择仅输入形状为(batch_size, 1)的最后一个input_ids（那些没有将其过去的键值状态提供给此模型的）而不是形状为(batch_size, sequence_length)的所有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 而不是普通元组。 - cache_position (
torch.LongTensor形状为(sequence_length), 可选) — 描绘输入序列 token 在序列中位置的索引。与position_ids不同，此张量不受填充影响。它用于在正确位置更新缓存并推断完整的序列长度。
返回
transformers.modeling_outputs.Seq2SeqModelOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.Seq2SeqModelOutput 或一个 torch.FloatTensor 元组（如果传递 return_dict=False 或 config.return_dict=False）包含各种元素，具体取决于配置 (PLBartConfig) 和输入。
-
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, 返回条件为output_attentions=True或config.output_attentions=True) —torch.FloatTensor的元组（每个层一个），形状为(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 之后，用于计算自注意力头中的加权平均。
PLBartModel 的前向方法，覆盖了 __call__ 特殊方法。
尽管前向传播的配方需要在此函数中定义，但之后应调用 Module 实例而不是此函数，因为前者负责运行预处理和后处理步骤，而后者会默默地忽略它们。
PLBartForConditionalGeneration
class transformers.PLBartForConditionalGeneration
< source >( config: PLBartConfig )
参数
- config (PLBartConfig) — 模型的配置类，包含模型的所有参数。使用配置文件初始化并不会加载与模型相关的权重，只加载配置。请查看 from_pretrained() 方法来加载模型权重。
带有语言建模头的 PLBART 模型。可用于代码到文本、文本到代码和代码到代码的转换。
此模型继承自 PreTrainedModel。查看超类文档以了解库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头部等）。
此模型也是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参阅 PyTorch 文档以了解与一般用法和行为相关的所有事项。
forward
< source >( input_ids: typing.Optional[torch.LongTensor] = None attention_mask: typing.Optional[torch.LongTensor] = None decoder_input_ids: typing.Optional[torch.LongTensor] = None decoder_attention_mask: typing.Optional[torch.Tensor] = None head_mask: typing.Optional[torch.Tensor] = None decoder_head_mask: typing.Optional[torch.LongTensor] = None cross_attn_head_mask: typing.Optional[torch.Tensor] = None encoder_outputs: typing.Optional[list[torch.FloatTensor]] = None past_key_values: typing.Optional[list[torch.FloatTensor]] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None decoder_inputs_embeds: typing.Optional[torch.FloatTensor] = None labels: typing.Optional[torch.Tensor] = None use_cache: typing.Optional[bool] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None cache_position: typing.Optional[torch.LongTensor] = None ) → transformers.modeling_outputs.Seq2SeqLMOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor，形状为(batch_size, sequence_length)，可选) — 词汇表中输入序列 token 的索引。默认情况下会忽略填充。可以使用 AutoTokenizer 获取索引。有关详细信息，请参见 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.LongTensor，形状为(batch_size, sequence_length)，可选) — 掩码，用于避免在填充 token 索引上执行注意力。掩码值在[0, 1]中选择：- 1 表示 token 未被掩码，
- 0 表示 token 被掩码。
- decoder_input_ids (
torch.LongTensor，形状为(batch_size, target_sequence_length)，可选) — 词汇表中解码器输入序列 token 的索引。索引可以使用 AutoTokenizer 或
PLBartMultiTokenizer获取，具体取决于检查点。有关详细信息，请参见 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。PLBart 使用一个特定的语言 ID token 作为
decoder_input_ids生成的起始 token，该 token 根据源语言和目标语言而变化，例如 en_XX 为 50003，java 为 50001。如果使用past_key_values，则可选地只需输入最后的decoder_input_ids（参见past_key_values）。对于翻译和摘要训练，应提供
decoder_input_ids。如果未提供decoder_input_ids，模型将根据论文中的去噪预训练，通过将input_ids向右移动来创建此张量。 - decoder_attention_mask (` —
- ` obj —torch.LongTensor，形状为
(batch_size, target_sequence_length)，可选): 默认行为：生成一个忽略decoder_input_ids中填充 token 的张量。默认情况下也会使用因果掩码。 - head_mask (
torch.Tensor，形状为(num_heads,)或(num_layers, num_heads)，可选) — 掩码，用于使自注意力模块的选定头部无效。掩码值在[0, 1]中选择：- 1 表示头部未被掩码，
- 0 表示头部被掩码。
- decoder_head_mask (
torch.LongTensor，形状为(decoder_layers, decoder_attention_heads)，可选) — 掩码，用于使解码器中注意力模块的选定头部无效。掩码值在[0, 1]中选择：- 1 表示头部未被掩码，
- 0 表示头部被掩码。
- cross_attn_head_mask (` —
- ` obj —torch.Tensor，形状为
(decoder_layers, decoder_attention_heads)，可选): 掩码，用于使解码器中交叉注意力模块的选定头部无效。掩码值在[0, 1]中选择：- 1 表示头部未被掩码，
- 0 表示头部被掩码。
- encoder_outputs (
list[torch.FloatTensor], 可选) — 元组包含 (last_hidden_state, 可选:hidden_states, 可选:attentions)last_hidden_state形状为(batch_size, sequence_length, hidden_size)，可选) 是编码器最后一层输出的隐藏状态序列。用于解码器的交叉注意力。 - past_key_values (
list[torch.FloatTensor], 可选) — 预先计算的隐藏状态（自注意力块和交叉注意力块中的键和值），可用于加速顺序解码。这通常包括模型在解码上一阶段返回的past_key_values，当use_cache=True或config.use_cache=True时。允许两种格式：
- Cache 实例，请参阅我们的 kv 缓存指南；
- 长度为
config.n_layers的tuple(torch.FloatTensor)元组，每个元组包含 2 个形状为(batch_size, num_heads, sequence_length, embed_size_per_head)的张量）。这也被称为传统缓存格式。
模型将输出与输入相同的缓存格式。如果未传入
past_key_values，则将返回传统缓存格式。如果使用
past_key_values，用户可以可选地只输入最后input_ids（那些没有将其过去的键值状态提供给此模型的）的形状(batch_size, 1)，而不是所有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的值。 - 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）。 - output_attentions (
bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参见返回张量下的attentions。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参见返回张量下的hidden_states。 - return_dict (
bool, 可选) — 是否返回 ModelOutput 而不是普通元组。 - cache_position (
torch.LongTensor，形状为(sequence_length)，可选) — 指示输入序列 token 在序列中的位置的索引。与position_ids不同，此张量不受填充影响。它用于在正确位置更新缓存并推断完整的序列长度。
返回
transformers.modeling_outputs.Seq2SeqLMOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.Seq2SeqLMOutput 或一个 torch.FloatTensor 元组（如果传递了 return_dict=False 或 config.return_dict=False），包含根据配置（PLBartConfig）和输入的不同元素。
-
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, 返回条件为output_attentions=True或config.output_attentions=True) —torch.FloatTensor的元组（每个层一个），形状为(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 之后，用于计算自注意力头中的加权平均。
PLBartForConditionalGeneration 的前向方法，覆盖了 __call__ 特殊方法。
尽管前向传播的配方需要在此函数中定义，但之后应调用 Module 实例而不是此函数，因为前者负责运行预处理和后处理步骤，而后者会默默地忽略它们。
示例掩码填充
>>> from transformers import AutoTokenizer, PLBartForConditionalGeneration
>>> model = PLBartForConditionalGeneration.from_pretrained("uclanlp/plbart-base")
>>> tokenizer = AutoTokenizer.from_pretrained("uclanlp/plbart-base")
>>> # en_XX is the language symbol id <LID> for English
>>> TXT = "<s> Is 0 the <mask> Fibonacci number ? </s> en_XX"
>>> input_ids = tokenizer([TXT], add_special_tokens=False, return_tensors="pt").input_ids
>>> logits = model(input_ids).logits
>>> masked_index = (input_ids[0] == tokenizer.mask_token_id).nonzero().item()
>>> probs = logits[0, masked_index].softmax(dim=0)
>>> values, predictions = probs.topk(5)
>>> tokenizer.decode(predictions).split()
['first', 'same', 'highest', 'result', 'number']PLBartForSequenceClassification
class transformers.PLBartForSequenceClassification
< source >( config: PLBartConfig **kwargs )
参数
- config (PLBartConfig) — 模型的配置类，包含模型的所有参数。使用配置文件初始化并不会加载与模型相关的权重，只加载配置。请查看 from_pretrained() 方法来加载模型权重。
PLBart 模型，顶部带有一个序列分类/头部（在池化输出顶部的一个线性层），例如用于 GLUE 任务。
此模型继承自 PreTrainedModel。查看超类文档以了解库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头部等）。
此模型也是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参阅 PyTorch 文档以了解与一般用法和行为相关的所有事项。
forward
< source >( input_ids: typing.Optional[torch.LongTensor] = None attention_mask: typing.Optional[torch.Tensor] = None decoder_input_ids: typing.Optional[torch.LongTensor] = None decoder_attention_mask: typing.Optional[torch.LongTensor] = None head_mask: typing.Optional[torch.Tensor] = None decoder_head_mask: typing.Optional[torch.Tensor] = None cross_attn_head_mask: typing.Optional[torch.Tensor] = None encoder_outputs: typing.Optional[list[torch.FloatTensor]] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None decoder_inputs_embeds: typing.Optional[torch.FloatTensor] = None labels: typing.Optional[torch.LongTensor] = None use_cache: typing.Optional[bool] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None cache_position: typing.Optional[torch.LongTensor] = None ) → transformers.modeling_outputs.Seq2SeqSequenceClassifierOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor，形状为(batch_size, sequence_length)，可选) — 词汇表中输入序列 token 的索引。默认情况下会忽略填充。可以使用 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 或
PLBartMultiTokenizer获取，具体取决于检查点。有关详细信息，请参见 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。PLBart 使用一个特定的语言 ID token 作为
decoder_input_ids生成的起始 token，该 token 根据源语言和目标语言而变化，例如 en_XX 为 50003，java 为 50001。如果使用past_key_values，则可选地只需输入最后的decoder_input_ids（参见past_key_values）。对于翻译和摘要训练，应提供
decoder_input_ids。如果未提供decoder_input_ids，模型将根据论文中的去噪预训练，通过将input_ids向右移动来创建此张量。 - decoder_attention_mask (` —
- ` obj —torch.LongTensor，形状为
(batch_size, target_sequence_length)，可选): 默认行为：生成一个忽略decoder_input_ids中填充 token 的张量。默认情况下也会使用因果掩码。 - head_mask (
torch.Tensor，形状为(num_heads,)或(num_layers, num_heads)，可选) — 掩码，用于使自注意力模块的选定头部无效。掩码值在[0, 1]中选择：- 1 表示头部未被掩码，
- 0 表示头部被掩码。
- decoder_head_mask (
torch.Tensor，形状为(decoder_layers, decoder_attention_heads)，可选) — 掩码，用于使解码器中注意力模块的选定头部无效。掩码值在[0, 1]中选择：- 1 表示头部未被掩码，
- 0 表示头部被掩码。
- cross_attn_head_mask (` —
- ` obj —torch.Tensor，形状为
(decoder_layers, decoder_attention_heads)，可选): 掩码，用于使解码器中交叉注意力模块的选定头部无效。掩码值在[0, 1]中选择：- 1 表示头部未被掩码，
- 0 表示头部被掩码。
- encoder_outputs (
list[torch.FloatTensor], 可选) — 元组包含 (last_hidden_state, 可选:hidden_states, 可选:attentions)last_hidden_state形状为(batch_size, sequence_length, hidden_size)，可选) 是编码器最后一层输出的隐藏状态序列。用于解码器的交叉注意力。 - 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的值。 - labels (
torch.LongTensor，形状为(batch_size,)，可选) — 用于计算序列分类/回归损失的标签。索引应在[0, ..., config.num_labels - 1]之间。如果config.num_labels > 1，则计算分类损失（交叉熵）。 - use_cache (
bool, 可选) — 如果设置为True，将返回past_key_values键值状态，可用于加速解码（参见past_key_values）。 - output_attentions (
bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参见返回张量下的attentions。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参见返回张量下的hidden_states。 - return_dict (
bool, 可选) — 是否返回 ModelOutput 而不是普通元组。 - cache_position (
torch.LongTensor，形状为(sequence_length)，可选) — 指示输入序列 token 在序列中的位置的索引。与position_ids不同，此张量不受填充影响。它用于在正确位置更新缓存并推断完整的序列长度。
返回
transformers.modeling_outputs.Seq2SeqSequenceClassifierOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.Seq2SeqSequenceClassifierOutput 或一个 torch.FloatTensor 元组（如果传递了 return_dict=False 或 config.return_dict=False），包含根据配置（PLBartConfig）和输入的不同元素。
-
loss (形状为
(1,)的torch.FloatTensor，可选，当提供label时返回) — 分类 (如果 config.num_labels==1 则为回归) 损失。 -
logits (形状为
(batch_size, config.num_labels)的torch.FloatTensor) — 分类（如果 config.num_labels==1，则为回归）分数（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, 返回条件为output_attentions=True或config.output_attentions=True) —torch.FloatTensor的元组（每个层一个），形状为(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 之后，用于计算自注意力头中的加权平均。
PLBartForSequenceClassification 的前向方法，覆盖了 __call__ 特殊方法。
尽管前向传播的配方需要在此函数中定义，但之后应调用 Module 实例而不是此函数，因为前者负责运行预处理和后处理步骤，而后者会默默地忽略它们。
单标签分类示例
>>> import torch
>>> from transformers import AutoTokenizer, PLBartForSequenceClassification
>>> tokenizer = AutoTokenizer.from_pretrained("uclanlp/plbart-base")
>>> model = PLBartForSequenceClassification.from_pretrained("uclanlp/plbart-base")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")
>>> with torch.no_grad():
... logits = model(**inputs).logits
>>> predicted_class_id = logits.argmax().item()
>>> model.config.id2label[predicted_class_id]
...
>>> # To train a model on `num_labels` classes, you can pass `num_labels=num_labels` to `.from_pretrained(...)`
>>> num_labels = len(model.config.id2label)
>>> model = PLBartForSequenceClassification.from_pretrained("uclanlp/plbart-base", num_labels=num_labels)
>>> labels = torch.tensor([1])
>>> loss = model(**inputs, labels=labels).loss
>>> round(loss.item(), 2)
...多标签分类示例
>>> import torch
>>> from transformers import AutoTokenizer, PLBartForSequenceClassification
>>> tokenizer = AutoTokenizer.from_pretrained("uclanlp/plbart-base")
>>> model = PLBartForSequenceClassification.from_pretrained("uclanlp/plbart-base", problem_type="multi_label_classification")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")
>>> with torch.no_grad():
... logits = model(**inputs).logits
>>> predicted_class_ids = torch.arange(0, logits.shape[-1])[torch.sigmoid(logits).squeeze(dim=0) > 0.5]
>>> # To train a model on `num_labels` classes, you can pass `num_labels=num_labels` to `.from_pretrained(...)`
>>> num_labels = len(model.config.id2label)
>>> model = PLBartForSequenceClassification.from_pretrained(
... "uclanlp/plbart-base", num_labels=num_labels, problem_type="multi_label_classification"
... )
>>> labels = torch.sum(
... torch.nn.functional.one_hot(predicted_class_ids[None, :].clone(), num_classes=num_labels), dim=1
... ).to(torch.float)
>>> loss = model(**inputs, labels=labels).lossPLBartForCausalLM
class transformers.PLBartForCausalLM
< source >( config )
参数
- config (PLBartForCausalLM) — 模型的配置类，包含模型的所有参数。使用配置文件初始化并不会加载与模型相关的权重，只加载配置。请查看 from_pretrained() 方法来加载模型权重。
PLBART 解码器，顶部带有一个语言建模头（权重与输入嵌入绑定在一起的线性层）。
此模型继承自 PreTrainedModel。查看超类文档以了解库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头部等）。
此模型也是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参阅 PyTorch 文档以了解与一般用法和行为相关的所有事项。
forward
< 源代码 >( input_ids: typing.Optional[torch.LongTensor] = None attention_mask: typing.Optional[torch.Tensor] = None encoder_hidden_states: typing.Optional[torch.FloatTensor] = None encoder_attention_mask: typing.Optional[torch.FloatTensor] = None head_mask: typing.Optional[torch.Tensor] = None cross_attn_head_mask: typing.Optional[torch.Tensor] = None past_key_values: typing.Optional[list[torch.FloatTensor]] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None labels: typing.Optional[torch.LongTensor] = None use_cache: typing.Optional[bool] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None cache_position: typing.Optional[torch.LongTensor] = None ) → transformers.modeling_outputs.CausalLMOutputWithCrossAttentions 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor，形状为(batch_size, sequence_length)，可选) — 输入序列 token 在词汇表中的索引。默认情况下会忽略填充。索引可以使用 AutoTokenizer 获取。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensor，形状为(batch_size, sequence_length)，可选) — 掩码，用于避免在填充 token 索引上执行注意力。掩码值选择在[0, 1]之间：- 1 表示 token 未被掩码，
- 0 表示 token 已被掩码。
- encoder_hidden_states (
torch.FloatTensor，形状为(batch_size, sequence_length, hidden_size)，可选) — 编码器最后一层输出的隐藏状态序列。如果模型被配置为解码器，则在交叉注意力中使用。 - encoder_attention_mask (
torch.FloatTensor，形状为(batch_size, sequence_length)，可选) — 掩码，用于避免在编码器输入中的填充 token 索引上执行注意力。如果模型被配置为解码器，则此掩码在交叉注意力中使用。掩码值选择在[0, 1]之间：- 1 表示 token 未被掩码，
- 0 表示 token 已被掩码。
- head_mask (
torch.Tensor，形状为(num_heads,)或(num_layers, num_heads)，可选) — 掩码，用于将自注意力模块中选定的头部置空。掩码值选择在[0, 1]之间：- 1 表示头部未被掩码，
- 0 表示头部已被掩码。
- cross_attn_head_mask (
torch.Tensor，形状为(decoder_layers, decoder_attention_heads)，可选) — 掩码，用于将交叉注意力模块中选定的头部置空。掩码值选择在[0, 1]之间：- 1 表示头部未被掩码，
- 0 表示头部已被掩码。
- past_key_values (
list[torch.FloatTensor]，可选) — 预先计算的隐藏状态（自注意力块和交叉注意力块中的键和值），可用于加速顺序解码。这通常包括模型在解码前一阶段返回的past_key_values，当use_cache=True或config.use_cache=True时。允许两种格式：
- 一个 Cache 实例，请参阅我们的 kv 缓存指南；
- 长度为
config.n_layers的tuple(torch.FloatTensor)元组，每个元组包含 2 个形状为(batch_size, num_heads, sequence_length, embed_size_per_head)的张量。这也被称为传统缓存格式。
模型将输出与输入相同的缓存格式。如果未传入
past_key_values，将返回传统缓存格式。如果使用
past_key_values，用户可以选择只输入形状为(batch_size, 1)的最新input_ids（那些没有将过去的键值状态提供给此模型的输入）而不是形状为(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的 token 将被忽略（掩码），损失仅针对标签在[0, ..., config.vocab_size]中的 token 计算。 - use_cache (
bool, 可选) — 如果设置为True，则返回past_key_values键值状态，可用于加速解码（参见past_key_values）。 - output_attentions (
bool, 可选) — 是否返回所有注意力层的注意力张量。有关详细信息，请参阅返回张量下的attentions。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。有关详细信息，请参阅返回张量下的hidden_states。 - return_dict (
bool, 可选) — 是否返回 ModelOutput 而不是普通元组。 - cache_position (
torch.LongTensor，形状为(sequence_length)，可选) — 指示输入序列 token 在序列中位置的索引。与position_ids不同，此张量不受填充影响。它用于在正确位置更新缓存并推断完整的序列长度。
返回
transformers.modeling_outputs.CausalLMOutputWithCrossAttentions 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.CausalLMOutputWithCrossAttentions 或一个 torch.FloatTensor 元组（如果传入 return_dict=False 或当 config.return_dict=False 时），其中包含各种元素，具体取决于配置 (PLBartConfig) 和输入。
-
loss (
torch.FloatTensor形状为(1,)，可选，当提供labels时返回) — 语言建模损失（用于下一个 token 预测）。 -
logits (形状为
(batch_size, sequence_length, config.vocab_size)的torch.FloatTensor) — 语言建模头部的预测分数（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), optional, 返回条件为output_attentions=True或config.output_attentions=True) —torch.FloatTensor的元组（每个层一个），形状为(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输入）加速顺序解码。
PLBartForCausalLM 的 forward 方法，重写了 __call__ 特殊方法。
尽管前向传播的配方需要在此函数中定义，但之后应调用 Module 实例而不是此函数，因为前者负责运行预处理和后处理步骤，而后者会默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, PLBartForCausalLM
>>> tokenizer = AutoTokenizer.from_pretrained("uclanlp/plbart-base")
>>> model = PLBartForCausalLM.from_pretrained("uclanlp/plbart-base", add_cross_attention=False)
>>> 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