Transformers 文档

CodeGen

Transformers

加入 Hugging Face 社区

获取增强的文档体验

在模型、数据集和 Spaces 上协作

更快速的示例，具有加速推理

切换文档主题

开始使用

CodeGen

概述

CodeGen 模型在 A Conversational Paradigm for Program Synthesis 这篇论文中被提出，作者是 Erik Nijkamp、Bo Pang、Hiroaki Hayashi、Lifu Tu、Huan Wang、Yingbo Zhou、Silvio Savarese 和 Caiming Xiong。

CodeGen 是一个用于程序合成的自回归语言模型，它在 The Pile、BigQuery 和 BigPython 上按顺序进行训练。

该论文的摘要如下：

程序合成致力于生成计算机程序作为给定问题规范的解决方案。我们通过大型语言模型提出了一种对话式程序合成方法，该方法解决了先前方法中面临的在广阔程序空间中搜索和用户意图规范的挑战。我们的新方法将编写规范和程序的过程视为用户和系统之间的多轮对话。它将程序合成视为一个序列预测问题，其中规范以自然语言表达，所需的程序是有条件地采样的。我们在自然语言和编程语言数据上训练了一系列大型语言模型，称为 CodeGen。凭借数据中的弱监督以及数据规模和模型规模的扩大，对话能力从简单的自回归语言建模中涌现出来。为了研究模型在对话式程序合成中的行为，我们开发了一个多轮编程基准 (MTPB)，其中解决每个问题都需要通过用户和模型之间的多轮对话进行多步骤合成。我们的研究结果表明了对话能力的出现以及所提出的对话式程序合成范式的有效性。此外，我们的模型 CodeGen（在 TPU-v4 上训练，参数高达 160 亿）在 HumanEval 基准测试中优于 OpenAI 的 Codex。我们将包括检查点在内的训练库 JaxFormer 作为开源贡献提供：this https URL。

此模型由 Hiroaki Hayashi 贡献。原始代码可以在这里找到。

检查点命名

CodeGen 模型的检查点可在不同的预训练数据和可变大小下使用。
格式为：Salesforce/codegen-{size}-{data}，其中
- size: 350M, 2B, 6B, 16B
- data:
  - nl: 在 Pile 上预训练
  - multi: 使用 nl 初始化，然后在多个编程语言数据上进一步预训练
  - mono: 使用 multi 初始化，然后在 Python 数据上进一步预训练
例如，Salesforce/codegen-350M-mono 提供了一个 3.5 亿参数的检查点，该检查点在 Pile、多种编程语言和 Python 上按顺序预训练。

使用示例

>>> from transformers import AutoModelForCausalLM, AutoTokenizer

>>> checkpoint = "Salesforce/codegen-350M-mono"
>>> model = AutoModelForCausalLM.from_pretrained(checkpoint)
>>> tokenizer = AutoTokenizer.from_pretrained(checkpoint)

>>> text = "def hello_world():"

>>> completion = model.generate(**tokenizer(text, return_tensors="pt"))

>>> print(tokenizer.decode(completion[0]))
def hello_world():
    print("Hello World")

hello_world()

资源

因果语言建模任务指南

CodeGenConfig

class transformers.CodeGenConfig

< 源代码 >

( vocab_size = 50400 n_positions = 2048 n_ctx = 2048 n_embd = 4096 n_layer = 28 n_head = 16 rotary_dim = 64 n_inner = None activation_function = 'gelu_new' resid_pdrop = 0.0 embd_pdrop = 0.0 attn_pdrop = 0.0 layer_norm_epsilon = 1e-05 initializer_range = 0.02 use_cache = True bos_token_id = 50256 eos_token_id = 50256 tie_word_embeddings = False **kwargs )

参数

vocab_size (int, 可选, 默认为 50400) — CodeGen 模型的词汇表大小。定义了在调用 CodeGenModel 时传递的 inputs_ids 可以表示的不同 token 的数量。
n_positions (int, 可选, 默认为 2048) — 此模型可能使用的最大序列长度。通常将其设置为较大的值以防万一（例如，512 或 1024 或 2048）。
n_ctx (int, 可选, 默认为 2048) — 此属性在 CodeGenModel.__init__ 中使用，但没有任何实际效果。
n_embd (int, 可选, 默认为 4096) — 嵌入和隐藏状态的维度。
n_layer (int, 可选, 默认为 28) — Transformer 编码器中隐藏层的数量。
n_head (int, 可选, 默认为 16) — Transformer 编码器中每个注意力层的注意力头的数量。
rotary_dim (int, 可选, 默认为 64) — Rotary Position Embedding 应用到的嵌入维度数。
n_inner (int, 可选) — 内部前馈层的维度。None 将将其设置为 n_embd 的 4 倍
activation_function (str, 可选, 默认为 "gelu_new") — 激活函数，可从列表 ["relu", "silu", "gelu", "tanh", "gelu_new"] 中选择。
resid_pdrop (float, 可选, 默认为 0.0) — 嵌入、编码器和池化器中所有全连接层的 dropout 概率。
embd_pdrop (int, 可选, 默认为 0.0) — 嵌入的 dropout 比率。
attn_pdrop (float, 可选, 默认为 0.0) — 注意力的 dropout 比率。
layer_norm_epsilon (float, 可选, 默认为 1e-05) — 在层归一化层中使用的 epsilon 值。
initializer_range (float, 可选, 默认为 0.02) — 用于初始化所有权重矩阵的 truncated_normal_initializer 的标准差。
use_cache (bool, 可选, 默认为 True) — 模型是否应返回最后的键/值注意力（并非所有模型都使用）。
bos_token_id (int, 可选, 默认为 50256) — 流开始 token id。
eos_token_id (int, 可选, 默认为 50256) — 流结束 token id。
tie_word_embeddings (bool, 可选, 默认为 False) — 模型输入和输出词嵌入是否应该绑定。请注意，这仅在模型具有输出词嵌入层时才相关。

这是用于存储 CodeGenModel 配置的配置类。它用于根据指定的参数实例化 CodeGen 模型，定义模型架构。使用默认值实例化配置将产生与 CodeGen Salesforce/codegen-2B-mono 架构类似的配置。配置对象继承自 PretrainedConfig，可用于控制模型输出。请阅读 PretrainedConfig 中的文档以获取更多信息。

示例

>>> from transformers import CodeGenConfig, CodeGenModel

>>> # Initializing a CodeGen 6B configuration
>>> configuration = CodeGenConfig()

>>> # Initializing a model (with random weights) from the configuration
>>> model = CodeGenModel(configuration)

>>> # Accessing the model configuration
>>> configuration = model.config

CodeGenTokenizer

class transformers.CodeGenTokenizer

< source >

参数

vocab_file (str) — 词汇表文件的路径。
merges_file (str) — merges 文件的路径。
errors (str, 可选, 默认为 "replace") — 将字节解码为 UTF-8 时遵循的范例。有关更多信息，请参阅 bytes.decode。
unk_token (str, 可选, 默认为 "<|endoftext|>") — 未知 token。词汇表中不存在的 token 无法转换为 ID，并会被设置为此 token。
bos_token (str, 可选, 默认为 "<|endoftext|>") — 序列的开始 token。
eos_token (str, 可选, 默认为 "<|endoftext|>") — 序列的结束 token。
pad_token (str, 可选) — 用于填充的 token，例如在对不同长度的序列进行批处理时。
add_prefix_space (bool, 可选, 默认为 False) — 是否在输入中添加初始空格。这允许像处理任何其他单词一样处理前导词。（CodeGen tokenizer 通过前面的空格检测单词的开头）。
add_bos_token (bool, 可选, 默认为 False) — 是否在序列的开头添加序列开始 token。
return_token_type_ids (bool, 可选, 默认为 False) — 是否返回 token 类型 ID。

构建 CodeGen tokenizer。基于字节级字节对编码（Byte-Pair-Encoding）。

此 tokenizer 经过训练，将空格视为 token 的一部分（有点像 sentencepiece），因此一个词

在句子开头（没有空格）或不在开头时，编码方式会有所不同

>>> from transformers import CodeGenTokenizer

>>> tokenizer = CodeGenTokenizer.from_pretrained("Salesforce/codegen-350M-mono")
>>> tokenizer("Hello world")["input_ids"]
[15496, 995]

>>> tokenizer(" Hello world")["input_ids"]
[18435, 995]

您可以通过在实例化此 tokenizer 或在某些文本上调用它时传递 add_prefix_space=True 来绕过此行为，但由于模型并非以这种方式预训练，因此可能会导致性能下降。

当与 is_split_into_words=True 一起使用时，此 tokenizer 将在每个单词（甚至是第一个单词）之前添加一个空格。

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

create_token_type_ids_from_sequences

< source >

( token_ids_0: typing.List[int] token_ids_1: typing.Optional[typing.List[int]] = None ) → List[int]

参数

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

返回值

List[int]

根据给定的序列列表，返回 token 类型 ID 列表。

从传递的两个序列创建掩码，用于序列对分类任务。序列对掩码具有以下格式

序列对掩码具有以下格式

0 0 0 0 0 0 0 0 0 0 0 1 1 1 1 1 1 1 1 1
| first sequence    | second sequence |

如果 token_ids_1 为 None，则此方法仅返回掩码的第一部分（0）。

save_vocabulary

< source >

( save_directory: str filename_prefix: typing.Optional[str] = None )

CodeGenTokenizerFast

class transformers.CodeGenTokenizerFast

< source >

参数

vocab_file (str, 可选) — 词汇表文件的路径。
merges_file (str, 可选) — merges 文件的路径。
tokenizer_file (str, 可选) — tokenizers 文件的路径（通常具有 .json 扩展名），其中包含加载 tokenizer 所需的一切。
unk_token (str, 可选, 默认为 "<|endoftext|>") — 未知 token。词汇表中不存在的 token 无法转换为 ID，并会被设置为此 token。
bos_token (str, 可选, 默认为 "<|endoftext|>") — 序列的开始 token。
eos_token (str, 可选, 默认为 "<|endoftext|>") — 序列的结束 token。
add_prefix_space (bool, 可选, 默认为 False) — 是否在输入中添加初始空格。这允许像处理任何其他单词一样处理前导词。（CodeGen tokenizer 通过前面的空格检测单词的开头）。
return_token_type_ids (bool, 可选, 默认为 False) — 是否返回 token 类型 ID。

构建“快速” CodeGen tokenizer（由 HuggingFace 的 tokenizers 库支持）。基于字节级字节对编码（Byte-Pair-Encoding）。

此 tokenizer 经过训练，将空格视为 token 的一部分（有点像 sentencepiece），因此一个词

在句子开头（没有空格）或不在开头时，编码方式会有所不同

>>> from transformers import CodeGenTokenizerFast

>>> tokenizer = CodeGenTokenizerFast.from_pretrained("Salesforce/codegen-350M-mono")
>>> tokenizer("Hello world")["input_ids"]
[15496, 995]

>>> tokenizer(" Hello world")["input_ids"]
[18435, 995]

您可以通过在实例化此 tokenizer 时传递 add_prefix_space=True 来绕过此行为，但由于模型并非以这种方式预训练，因此可能会导致性能下降。

当与 is_split_into_words=True 一起使用时，此 tokenizer 需要使用 add_prefix_space=True 进行实例化。

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

create_token_type_ids_from_sequences

< 源代码 >

( token_ids_0: typing.List[int] token_ids_1: typing.Optional[typing.List[int]] = None ) → List[int]

参数

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

返回值

List[int]

根据给定的序列列表，返回 token 类型 ID 列表。

从传递的两个序列创建掩码，用于序列对分类任务。序列对掩码具有以下格式

序列对掩码具有以下格式

0 0 0 0 0 0 0 0 0 0 0 1 1 1 1 1 1 1 1 1
| first sequence    | second sequence |

如果 token_ids_1 为 None，则此方法仅返回掩码的第一部分（0）。

解码

< 源代码 >

( token_ids: typing.Union[int, typing.List[int], ForwardRef('np.ndarray'), ForwardRef('torch.Tensor'), ForwardRef('tf.Tensor')] skip_special_tokens: bool = False clean_up_tokenization_spaces: bool = None truncate_before_pattern: typing.Optional[typing.List[str]] = None **kwargs ) → str

参数

token_ids (Union[int, List[int], np.ndarray, torch.Tensor, tf.Tensor]) — 标记化的输入 ID 列表。可以使用 __call__ 方法获取。
skip_special_tokens (bool, optional, defaults to False) — 是否在解码中移除特殊标记。
clean_up_tokenization_spaces (bool, optional) — 是否清理标记化空格。如果为 None，则默认为 self.clean_up_tokenization_spaces（在 tokenizer_config 中可用）。
truncate_before_pattern (List[str], optional, defaults to None) — 将用于截断返回字符串的正则表达式字符串列表。这可以用于删除额外的代码片段（例如，如果在新行开头观察到注释符号“#”，则截断）。一个示例模式可以是 `[”^#”, re.escape(”<|endoftext|>”), ”^'''”, ”

返回值

str

解码后的句子。

使用分词器和词汇表将 ID 序列转换为字符串，可以选择删除特殊标记和清理标记化空格。

类似于执行 self.convert_tokens_to_string(self.convert_ids_to_tokens(token_ids))。

”]`。 kwargs (附加关键字参数，可选)：将传递给底层模型特定的解码方法。

CodeGenModel

class transformers.CodeGenModel

< 源代码 >

( config )

参数

config (CodeGenConfig) — 带有模型所有参数的模型配置类。使用配置文件初始化不会加载与模型关联的权重，仅加载配置。查看 from_pretrained() 方法来加载模型权重。

裸 CodeGen Model transformer，输出原始隐藏状态，顶部没有任何特定的 head。此模型是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch Module，并参考 PyTorch 文档以获取与常规用法和行为相关的所有信息。

前向传播

< 源代码 >

( input_ids: typing.Optional[torch.LongTensor] = None past_key_values: typing.Union[transformers.cache_utils.Cache, typing.Tuple[typing.Tuple[torch.Tensor]], NoneType] = None attention_mask: typing.Optional[torch.FloatTensor] = None token_type_ids: typing.Optional[torch.LongTensor] = None position_ids: typing.Optional[torch.LongTensor] = None head_mask: typing.Optional[torch.FloatTensor] = None 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 **kwargs ) → transformers.modeling_outputs.BaseModelOutputWithPast or tuple(torch.FloatTensor)

参数

input_ids (torch.LongTensor of shape (batch_size, sequence_length)) — 词汇表中输入序列标记的索引。

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

什么是输入 ID？
attention_mask (torch.FloatTensor of shape (batch_size, sequence_length), optional) — 避免对 padding 标记索引执行 attention 的掩码。掩码值在 [0, 1] 中选择：
- 1 表示标记未被掩盖，
- 0 表示标记被掩盖。
什么是 attention 掩码？
token_type_ids (torch.LongTensor of shape (batch_size, sequence_length), optional) — 分段标记索引，用于指示输入的第一部分和第二部分。索引在 [0, 1] 中选择：
- 0 对应于 句子 A 标记，
- 1 对应于 句子 B 标记。
什么是标记类型 ID？
position_ids (torch.LongTensor of shape (batch_size, sequence_length), optional) — 每个输入序列标记在位置嵌入中的位置索引。在范围 [0, config.n_positions - 1] 中选择。

什么是位置 ID？
head_mask (torch.FloatTensor of shape (num_attention_heads,) or (n_layer, num_attention_heads), optional) — 用于使自注意力模块的选定 head 无效的掩码。掩码值在 [0, 1] 中选择：
- 1 表示 head 未被掩盖，
- 0 表示 head 被掩盖。
inputs_embeds (torch.FloatTensor of shape (batch_size, sequence_length, hidden_dim), optional) — （可选）您可以选择直接传递嵌入表示，而不是传递 input_ids。如果您希望比模型的内部嵌入查找矩阵更好地控制如何将 input_ids 索引转换为关联的向量，这将非常有用。
past_key_values (Cache or tuple(tuple(torch.FloatTensor)), optional) — 预先计算的隐藏状态（自注意力块和交叉注意力块中的键和值），可以用于加速顺序解码。这通常包括模型在先前解码阶段返回的 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（那些没有将其过去的键值状态提供给此模型的 input_ids），而不是形状为 (batch_size, sequence_length) 的所有 input_ids。
output_attentions (bool, optional) — 是否返回所有 attention 层的 attentions 张量。有关更多详细信息，请参见返回的张量下的 attentions。
output_hidden_states (bool, optional) — 是否返回所有层的隐藏状态。有关更多详细信息，请参见返回的张量下的 hidden_states。
return_dict (bool, optional) — 是否返回 ModelOutput 而不是普通元组。
cache_position (torch.LongTensor，形状为 (sequence_length)，可选) — 指示输入序列 token 在序列中的位置的索引。与 position_ids 相反，此张量不受 padding 的影响。它用于在正确的位置更新缓存，并推断完整的序列长度。

返回值

transformers.modeling_outputs.BaseModelOutputWithPast 或 tuple(torch.FloatTensor)

一个 transformers.modeling_outputs.BaseModelOutputWithPast 或一个 torch.FloatTensor 的元组 (如果传递了 return_dict=False 或者当 config.return_dict=False 时)，包含各种元素，具体取决于配置 (CodeGenConfig) 和输入。

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 时返回) — tuple(tuple(torch.FloatTensor)) 类型，长度为 config.n_layers，其中每个元组包含 2 个形状为 (batch_size, num_heads, sequence_length, embed_size_per_head) 的张量，并且如果 config.is_encoder_decoder=True，则可选地包含 2 个形状为 (batch_size, num_heads, encoder_sequence_length, embed_size_per_head) 的额外张量。

包含预先计算的隐藏状态 (自注意力模块中的键和值，以及如果 config.is_encoder_decoder=True，则在交叉注意力模块中)，这些隐藏状态可以用于 (参见 past_key_values 输入) 加速顺序解码。
hidden_states (tuple(torch.FloatTensor)，可选，当传递 output_hidden_states=True 或 config.output_hidden_states=True 时返回) — torch.FloatTensor 的元组 (如果模型具有 embedding 层，则一个用于 embedding 的输出，+ 每个层的输出一个)，形状为 (batch_size, sequence_length, hidden_size)。

模型在每一层输出端的隐藏状态，加上可选的初始 embedding 输出。
attentions (tuple(torch.FloatTensor)，可选，当传递 output_attentions=True 或 config.output_attentions=True 时返回) — torch.FloatTensor 的元组 (每层一个)，形状为 (batch_size, num_heads, sequence_length, sequence_length)。

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

CodeGenModel 的 forward 方法，覆盖了 __call__ 特殊方法。

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

示例

>>> from transformers import AutoTokenizer, CodeGenModel
>>> import torch

>>> tokenizer = AutoTokenizer.from_pretrained("Salesforce/codegen-2B-mono")
>>> model = CodeGenModel.from_pretrained("Salesforce/codegen-2B-mono")

>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")
>>> outputs = model(**inputs)

>>> last_hidden_states = outputs.last_hidden_state

CodeGenForCausalLM

class transformers.CodeGenForCausalLM

< source >

( config )

参数

config (CodeGenConfig) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型关联的权重，仅加载配置。查看 from_pretrained() 方法以加载模型权重。

带有语言建模头的 CodeGen Model transformer。

此模型是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch Module，并参阅 PyTorch 文档以了解所有与常规用法和行为相关的事项。

前向传播

< source >

( input_ids: typing.Optional[torch.LongTensor] = None past_key_values: typing.Union[transformers.cache_utils.Cache, typing.Tuple[typing.Tuple[torch.Tensor]], NoneType] = None attention_mask: typing.Optional[torch.FloatTensor] = None token_type_ids: typing.Optional[torch.LongTensor] = None position_ids: typing.Optional[torch.LongTensor] = None head_mask: typing.Optional[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 **kwargs ) → transformers.modeling_outputs.CausalLMOutputWithPast 或 tuple(torch.FloatTensor)

参数

input_ids (torch.LongTensor，形状为 (batch_size, sequence_length)) — 输入序列 token 在词汇表中的索引。

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

什么是 input IDs？
attention_mask (torch.FloatTensor，形状为 (batch_size, sequence_length)，可选) — 避免对 padding token 索引执行注意力的掩码。掩码值在 [0, 1] 中选择：
- 1 表示 未被掩码 的 token，
- 0 表示 被掩码 的 token。
什么是 attention masks？
token_type_ids (torch.LongTensor，形状为 (batch_size, sequence_length)，可选) — 分段 token 索引，用于指示输入的第一个和第二个部分。索引在 [0, 1] 中选择：
- 0 对应于 句子 A token，
- 1 对应于 句子 B token。
什么是 token type IDs？
position_ids (torch.LongTensor，形状为 (batch_size, sequence_length)，可选) — 每个输入序列 token 在位置 embedding 中的位置索引。在 [0, config.n_positions - 1] 范围内选择。

什么是 position IDs？
head_mask (torch.FloatTensor，形状为 (num_attention_heads,) 或 (n_layer, num_attention_heads)，可选) — 用于 nullify 自注意力模块中选定 head 的掩码。掩码值在 [0, 1] 中选择：
- 1 表示 head 未被掩码，
- 0 表示 head 被掩码。
inputs_embeds (torch.FloatTensor，形状为 (batch_size, sequence_length, hidden_dim)，可选) — 可选地，您可以选择直接传递 embedding 表示，而不是传递 input_ids。如果您希望比模型的内部 embedding 查找矩阵更精细地控制如何将 input_ids 索引转换为关联向量，这将非常有用。
past_key_values (Cache 或 tuple(tuple(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 (那些没有将其过去的键值状态提供给此模型的 token)，而不是形状为 (batch_size, sequence_length) 的所有 input_ids。
output_attentions (bool，可选) — 是否返回所有注意力层的 attention 张量。有关更多详细信息，请参阅返回张量下的 attentions。
output_hidden_states (bool，可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的 hidden_states。
return_dict (bool，可选) — 是否返回 ModelOutput 而不是普通元组。
cache_position (torch.LongTensor，形状为 (sequence_length)，可选) — 指示输入序列 token 在序列中的位置的索引。与 position_ids 相反，此张量不受 padding 的影响。它用于在正确的位置更新缓存，并推断完整的序列长度。
labels (torch.LongTensor，形状为 (batch_size, sequence_length)，可选) — 用于语言建模的标签。请注意，标签在模型内部已移位，即您可以设置 labels = input_ids。索引在 [-100, 0, ..., config.vocab_size] 中选择。所有设置为 -100 的标签都将被忽略 (掩码)，损失仅针对 [0, ..., config.vocab_size] 中的标签计算。

返回值

transformers.modeling_outputs.CausalLMOutputWithPast 或 tuple(torch.FloatTensor)

一个 transformers.modeling_outputs.CausalLMOutputWithPast 或一个 torch.FloatTensor 的元组 (如果传递了 return_dict=False 或者当 config.return_dict=False 时)，包含各种元素，具体取决于配置 (CodeGenConfig) 和输入。

loss (torch.FloatTensor，形状为 (1,)，可选，当提供 labels 时返回) — 语言建模损失 (用于下一个 token 预测)。
logits (torch.FloatTensor，形状为 (batch_size, sequence_length, config.vocab_size)) — 语言建模头的预测分数 (SoftMax 之前每个词汇表 token 的分数)。
past_key_values (tuple(tuple(torch.FloatTensor))，可选，当传递 use_cache=True 或 config.use_cache=True 时返回) — tuple(tuple(torch.FloatTensor)) 类型，长度为 config.n_layers，其中每个元组包含 2 个形状为 (batch_size, num_heads, sequence_length, embed_size_per_head) 的张量。

包含预先计算的隐藏状态 (自注意力模块中的键和值)，这些隐藏状态可以用于 (参见 past_key_values 输入) 加速顺序解码。
hidden_states (tuple(torch.FloatTensor)，可选，当传递 output_hidden_states=True 或 config.output_hidden_states=True 时返回) — torch.FloatTensor 的元组 (如果模型具有 embedding 层，则一个用于 embedding 的输出，+ 每个层的输出一个)，形状为 (batch_size, sequence_length, hidden_size)。

模型在每一层输出端的隐藏状态，加上可选的初始 embedding 输出。
attentions (tuple(torch.FloatTensor)，可选，当传递 output_attentions=True 或 config.output_attentions=True 时返回) — torch.FloatTensor 的元组 (每层一个)，形状为 (batch_size, num_heads, sequence_length, sequence_length)。

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

CodeGenForCausalLM 的 forward 方法，覆盖了 __call__ 特殊方法。

示例

>>> import torch
>>> from transformers import AutoTokenizer, CodeGenForCausalLM

>>> tokenizer = AutoTokenizer.from_pretrained("Salesforce/codegen-2B-mono")
>>> model = CodeGenForCausalLM.from_pretrained("Salesforce/codegen-2B-mono")

>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")
>>> outputs = model(**inputs, labels=inputs["input_ids"])
>>> loss = outputs.loss
>>> logits = outputs.logits

< > 在 GitHub 上更新

←CANINE CodeLlama→