Transformers 文档
CodeGen
并获得增强的文档体验
开始使用
该模型于 2022-03-25 在 HF papers 上发布，并于 2022-06-24 贡献给 Hugging Face Transformers。
CodeGen
概述
CodeGen 模型由 Erik Nijkamp, Bo Pang, Hiroaki Hayashi, Lifu Tu, Huan Wang, Yingbo Zhou, Silvio Savarese 和 Caiming Xiong 在 《程序合成的对话范式》（A Conversational Paradigm for Program Synthesis） 一文中提出。
CodeGen 是一种用于程序合成的自回归语言模型，依次在 The Pile、BigQuery 和 BigPython 数据集上进行训练。
论文摘要如下：
程序合成致力于生成计算机程序作为给定问题规范的解决方案。我们提出了一种通过大语言模型进行对话式程序合成的方法，旨在解决以往方法中面临的巨大程序空间搜索和用户意图规范的挑战。我们的新方法将编写规范和程序的过程视为用户与系统之间的多轮对话。它将程序合成视为一个序列预测问题，其中规范以自然语言表达，并根据条件采样所需的程序。我们在自然语言和编程语言数据上训练了一系列名为 CodeGen 的大语言模型。随着数据中弱监督学习的应用以及数据规模和模型规模的扩大，简单的自回归语言建模中涌现出了对话能力。为了研究模型在对话式程序合成上的表现，我们开发了一个多轮编程基准（MTPB），其中解决每个问题都需要通过用户和模型之间的多轮对话进行多步合成。我们的研究结果表明了对话能力的涌现以及所提出的对话式程序合成范式的有效性。此外，我们的 CodeGen 模型（在 TPU-v4 上训练，参数量高达 16B）在 HumanEval 基准测试上优于 OpenAI 的 Codex。我们将包含检查点的训练库 JaxFormer 作为开源贡献发布：此 HTTPS URL。
此模型由 Hiroaki Hayashi 贡献。原始代码可以在 此处 找到。
检查点命名
- CodeGen 模型检查点适用于不同的预训练数据和可变大小。
- 格式为：
Salesforce/codegen-{size}-{data}，其中size:350M,2B,6B,16Bdata:nl: 在 The Pile 上进行预训练multi: 使用nl初始化，然后在多种编程语言数据上进行进一步预训练mono: 使用multi初始化，然后在 Python 数据上进行进一步预训练
- 例如，
Salesforce/codegen-350M-mono提供了一个 3.5 亿参数的检查点，依次在 The Pile、多种编程语言和 Python 数据集上进行了预训练。
用法示例
from transformers import AutoModelForCausalLM, AutoTokenizer
checkpoint = "Salesforce/codegen-350M-mono"
model = AutoModelForCausalLM.from_pretrained(checkpoint, device_map="auto")
tokenizer = AutoTokenizer.from_pretrained(checkpoint)
text = "def hello_world():"
completion = model.generate(**tokenizer(text, return_tensors="pt").to(model.device))
print(tokenizer.decode(completion[0]))
def hello_world():
print("Hello World")
hello_world()资源
CodeGenConfig
class transformers.CodeGenConfig
< 源码 >( 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 is_encoder_decoder: bool = False 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 vocab_size: int = 50400 n_positions: int = 2048 n_ctx: int = 2048 n_embd: int = 4096 n_layer: int = 28 n_head: int = 16 rotary_dim: int = 64 n_inner: int | None = None activation_function: str = 'gelu_new' resid_pdrop: float | int = 0.0 embd_pdrop: float | int = 0.0 attn_pdrop: float | int = 0.0 layer_norm_epsilon: float = 1e-05 initializer_range: float = 0.02 use_cache: bool = True bos_token_id: int | None = 50256 eos_token_id: int | list[int] | None = 50256 tie_word_embeddings: bool = False )
参数
- vocab_size (
int, optional, 默认为50400) — 模型的词汇表大小。定义了input_ids可以表示的不同 token 的数量。 - n_positions (
int, optional, 默认为2048) — 该模型可能使用的最大序列长度。 - n_ctx (
int, optional, 默认为 2048) — 此属性在CodeGenModel.__init__中使用，没有任何实际效果。 - n_embd (
int, optional, 默认为4096) — 嵌入层和隐藏状态的维度。 - n_layer (
int, optional, 默认为28) — Transformer 解码器中的隐藏层数量。 - n_head (
int, optional, 默认为16) — Transformer 解码器中每个注意力层的注意力头数量。 - rotary_dim (
int, optional, 默认为 64) — 应用旋转位置嵌入（Rotary Position Embedding）的嵌入维度数量。 - n_inner (
int, optional) — 内部前馈层的维度。设置为None时，它将被设定为 n_embd 的 4 倍。 - activation_function (
str, optional, 默认为gelu_new) — 解码器中的非线性激活函数（函数或字符串）。例如，"gelu"、"relu"、"silu"等。 - resid_pdrop (
Union[float, int], optional, 默认为0.0) — 嵌入层、编码器和池化层中所有全连接层的 dropout 概率。 - embd_pdrop (
Union[float, int], optional, 默认为0.0) — 嵌入层的 dropout 比率。 - attn_pdrop (
Union[float, int], optional, 默认为0.0) — 注意力概率的 dropout 比率。 - layer_norm_epsilon (
float, optional, 默认为1e-05) — 层归一化层所使用的 epsilon 值。 - initializer_range (
float, optional, 默认为0.02) — 用于初始化所有权重矩阵的截断正态初始化器（truncated_normal_initializer）的标准差。 - use_cache (
bool, optional, 默认为True) — 模型是否应该返回上一个键/值注意力（并非所有模型都使用）。仅在config.is_decoder=True或模型是纯解码器的生成模型时相关。 - bos_token_id (
int, optional, 默认为50256) — 词汇表中用于流开始（beginning-of-stream）的 token ID。 - eos_token_id (
Union[int, list[int]], optional, 默认为50256) — 词汇表中用于流结束（end-of-stream）的 token ID。 - tie_word_embeddings (
bool, optional, 默认为False) — 是否根据模型的tied_weights_keys映射绑定权重嵌入。
这是 CodeGenModel 的配置类，用于存储其配置信息。它根据指定的参数实例化 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.configCodeGenTokenizer
class transformers.CodeGenTokenizer
< 源码 >( vocab: str | dict[str, int] | None = None merges: str | list[str] | None = None unk_token: str = '<|endoftext|>' bos_token: str = '<|endoftext|>' eos_token: str = '<|endoftext|>' pad_token = None add_prefix_space: bool = False return_token_type_ids: bool = False **kwargs )
参数
- vocab (
str或dict[str, int], 可选) — 自定义词表字典。如果未提供，将从vocab_file加载词表。 - merges (
str或list[str], 可选) — 自定义合并列表。如果未提供，将从merges_file加载合并信息。 - unk_token (
str, 可选, 默认为"<|endoftext|>") — 未知标记。词表中不存在的标记无法转换为 ID，将被设置为此标记。 - bos_token (
str, 可选, 默认为"<|endoftext|>") — 序列起始标记。 - eos_token (
str, 可选, 默认为"<|endoftext|>") — 序列结束标记。 - pad_token (
str, 可选) — 用于填充的标记，例如在对不同长度的序列进行批处理时。 - add_prefix_space (
bool, 可选, 默认为False) — 是否在输入前添加一个初始空格。这允许像对待其他单词一样处理首个单词。（CodeGen 分词器通过前面的空格检测单词的开头）。 - return_token_type_ids (
bool, 可选, 默认为False) — 是否返回标记类型 ID。
构建一个 CodeGen 分词器（基于 HuggingFace 的 tokenizers 库）。基于字节级字节对编码（Byte-Pair-Encoding）。
这个分词器经过训练，将空格视为词元的一部分（有点像 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]您可以通过在实例化此分词器时传递 add_prefix_space=True 来绕过此行为，但由于模型并非以此方式进行预训练，这可能会导致性能下降。
当与
is_split_into_words=True一起使用时，此分词器需要以add_prefix_space=True进行实例化。
该分词器继承自 TokenizersBackend，后者包含其大部分主要方法。用户应参考该父类以获取有关这些方法的更多信息。
CodeGenTokenizerFast
class transformers.CodeGenTokenizer
< 源码 >( vocab: str | dict[str, int] | None = None merges: str | list[str] | None = None unk_token: str = '<|endoftext|>' bos_token: str = '<|endoftext|>' eos_token: str = '<|endoftext|>' pad_token = None add_prefix_space: bool = False return_token_type_ids: bool = False **kwargs )
参数
- vocab (
str或dict[str, int], 可选) — 自定义词表字典。如果未提供，将从vocab_file加载词表。 - merges (
str或list[str], 可选) — 自定义合并列表。如果未提供，将从merges_file加载合并信息。 - unk_token (
str, 可选, 默认为"<|endoftext|>") — 未知标记。词表中不存在的标记无法转换为 ID，将被设置为此标记。 - bos_token (
str, 可选, 默认为"<|endoftext|>") — 序列起始标记。 - eos_token (
str, 可选, 默认为"<|endoftext|>") — 序列结束标记。 - pad_token (
str, 可选) — 用于填充的标记，例如在对不同长度的序列进行批处理时。 - add_prefix_space (
bool, 可选, 默认为False) — 是否在输入前添加一个初始空格。这允许像对待其他单词一样处理首个单词。（CodeGen 分词器通过前面的空格检测单词的开头）。 - return_token_type_ids (
bool, 可选, 默认为False) — 是否返回标记类型 ID。
构建一个 CodeGen 分词器（基于 HuggingFace 的 tokenizers 库）。基于字节级字节对编码（Byte-Pair-Encoding）。
这个分词器经过训练，将空格视为词元的一部分（有点像 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]您可以通过在实例化此分词器时传递 add_prefix_space=True 来绕过此行为，但由于模型并非以此方式进行预训练，这可能会导致性能下降。
当与
is_split_into_words=True一起使用时，此分词器需要以add_prefix_space=True进行实例化。
该分词器继承自 TokenizersBackend，后者包含其大部分主要方法。用户应参考该父类以获取有关这些方法的更多信息。
decode
< 源码 >( token_ids: typing.Union[int, list[int], numpy.ndarray, ForwardRef('torch.Tensor')] skip_special_tokens: bool = False clean_up_tokenization_spaces: bool | None = None truncate_before_pattern: list[str] | None = None **kwargs ) → str
参数
- token_ids (
Union[int, List[int], np.ndarray, torch.Tensor]) — 分词后的输入 ID 列表。可以通过__call__方法获得。 - skip_special_tokens (
bool, 可选, 默认为False) — 解码时是否移除特殊标记。 - clean_up_tokenization_spaces (
bool, 可选) — 是否清理分词产生的空格。如果为None，将默认使用self.clean_up_tokenization_spaces（可在tokenizer_config中获取）。 - truncate_before_pattern (
List[str], 可选, 默认为None) — 一个用于截断返回字符串的正则表达式列表。这可用于删除多余的代码片段（例如，如果观察到新行开头有注释符号“#”，则进行截断）。示例模式可能为 `[”^#”, re.escape(”<|endoftext|>”), ”^'''”, ”
返回
字符串
解码后的句子。
使用分词器和词汇表将 ID 序列转换为字符串，可以选择移除特殊标记并清理分词空间。
类似于执行 self.convert_tokens_to_string(self.convert_ids_to_tokens(token_ids))。
”]`. kwargs（其他关键字参数，可选）：将被传递给底层模型特定的解码方法。
CodeGenModel
class transformers.CodeGenModel
< 源码 >( config model_args: ~utils.generic.ModelArgs | None = None adapter_args: ~utils.generic.AdapterArgs | None = None lora_args: ~utils.generic.LoRAArgs | None = None tokenizer_args: ~utils.generic.TokenizerArgs | None = None dataset_args: ~utils.generic.DatasetArgs | None = None data_args: ~utils.generic.DataArgs | None = None training_args: ~utils.generic.TrainingArgs | None = None generation_args: ~utils.generic.GenerationArgs | None = None vision_tower_args: ~utils.generic.VisionTowerArgs | None = None qlora_args: ~utils.generic.QLoRAArgs | None = None vision_tower_template_args: ~utils.generic.VisionTowerTemplateArgs | None = None video_tower_args: ~utils.generic.VideoTowerArgs | None = None vision_config: ~utils.generic.VisionConfig | None = None video_config: ~utils.generic.VideoConfig | None = None load_dataset: bool | None = None load_data_collator: bool | None = None load_processor: bool | None = None load_lora_adapter: bool | None = None load_adapter: bool | None = None load_qlora_adapter: bool | None = None **kwargs: typing_extensions.Unpack[transformers.modeling_utils.PreTrainedModelKwargs] )
参数
- config (CodeGenModel) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载与模型相关的权重，仅加载配置。请查看 from_pretrained() 方法以加载模型权重。
输出原始隐藏状态且顶部没有任何特定头的裸 Codegen 模型。
该模型继承自 PreTrainedModel。请查看超类文档以了解该库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、剪枝头部等）。
此模型也是一个 PyTorch torch.nn.Module 子类。像普通的 PyTorch Module 一样使用它，并参考 PyTorch 文档了解一般用法和行为的所有相关信息。
forward
< 源码 >( input_ids: torch.LongTensor | None = None past_key_values: transformers.cache_utils.Cache | None = None attention_mask: torch.FloatTensor | None = None token_type_ids: torch.LongTensor | None = None position_ids: torch.LongTensor | None = None inputs_embeds: torch.FloatTensor | None = None use_cache: bool | None = None output_attentions: bool | None = None output_hidden_states: bool | None = None return_dict: bool | None = None **kwargs ) → BaseModelOutputWithPast 或 tuple(torch.FloatTensor)
参数
- input_ids (形状为
(batch_size, sequence_length)的torch.LongTensor, 可选) — 词表中输入序列标记的索引。默认情况下，填充将被忽略。索引可以使用 AutoTokenizer 获得。详细信息请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- past_key_values (
~cache_utils.Cache, 可选) — 预计算的隐藏状态（自注意力块和交叉注意力块中的键和值），可用于加速顺序解码。这通常由模型在先前解码阶段返回的past_key_values组成，当use_cache=True或config.use_cache=True时。仅允许使用 Cache 实例作为输入，请参阅我们的 kv 缓存指南。如果不传递
past_key_values，将默认初始化 DynamicCache。模型将输出与作为输入馈送的缓存格式相同的缓存。
如果使用
past_key_values，用户应仅输入形状为(batch_size, unprocessed_length)的未处理input_ids（那些状态未被给出给此模型的输入），而不是形状为(batch_size, sequence_length)的所有input_ids。 - attention_mask (形状为
(batch_size, sequence_length)的torch.FloatTensor, 可选) — 用于避免对填充标记索引执行注意力的掩码。在[0, 1]中选择掩码值：- 1 表示未掩码的标记，
- 0 表示已掩码的标记。
- token_type_ids (形状为
(batch_size, sequence_length)的torch.LongTensor, 可选) — 用于指示输入的第一部分和第二部分的片段标记索引。在[0, 1]中选择索引：- 0 对应于句子 A 标记，
- 1 对应于句子 B 标记。
- position_ids (形状为
(batch_size, sequence_length)的torch.LongTensor, 可选) — 位置嵌入中每个输入序列标记的位置索引。在[0, config.n_positions - 1]范围内选择。 - inputs_embeds (形状为
(batch_size, sequence_length, hidden_dim)的torch.FloatTensor, 可选) — 或者，您可以选择直接传递嵌入表示，而不是传递input_ids。如果您想比模型内部嵌入查找矩阵更精细地控制如何将 input_ids 索引转换为关联向量，这非常有用。 - use_cache (
bool, 可选) — 如果设置为True，则返回past_key_values键值状态，并可用于加速解码（参见past_key_values）。 - output_attentions (
bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的attentions。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量中的hidden_states。 - return_dict (
bool, 可选) — 是否返回一个 ModelOutput 而不是普通元组。
返回
BaseModelOutputWithPast 或 tuple(torch.FloatTensor)
一个 BaseModelOutputWithPast 或一个 torch.FloatTensor 元组（如果传入了 return_dict=False 或当 config.return_dict=False 时），根据配置（CodeGenConfig）和输入包含不同的元素。
CodeGenModel 的前向传播方法，覆盖了 __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 (
Cache，*可选*，当传入use_cache=True或config.use_cache=True时返回) — 这是一个 Cache 实例。欲了解更多细节，请参阅我们的 KV 缓存指南。Contains pre-computed hidden-states (key and values in the self-attention blocks and optionally if
config.is_encoder_decoder=Truein the cross-attention blocks) that can be used (seepast_key_valuesinput) to speed up sequential decoding.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 后的注意力权重，用于计算自注意力头中的加权平均值。
CodeGenForCausalLM
class transformers.CodeGenForCausalLM
< 源代码 >( config model_args: ~utils.generic.ModelArgs | None = None adapter_args: ~utils.generic.AdapterArgs | None = None lora_args: ~utils.generic.LoRAArgs | None = None tokenizer_args: ~utils.generic.TokenizerArgs | None = None dataset_args: ~utils.generic.DatasetArgs | None = None data_args: ~utils.generic.DataArgs | None = None training_args: ~utils.generic.TrainingArgs | None = None generation_args: ~utils.generic.GenerationArgs | None = None vision_tower_args: ~utils.generic.VisionTowerArgs | None = None qlora_args: ~utils.generic.QLoRAArgs | None = None vision_tower_template_args: ~utils.generic.VisionTowerTemplateArgs | None = None video_tower_args: ~utils.generic.VideoTowerArgs | None = None vision_config: ~utils.generic.VisionConfig | None = None video_config: ~utils.generic.VideoConfig | None = None load_dataset: bool | None = None load_data_collator: bool | None = None load_processor: bool | None = None load_lora_adapter: bool | None = None load_adapter: bool | None = None load_qlora_adapter: bool | None = None **kwargs: typing_extensions.Unpack[transformers.modeling_utils.PreTrainedModelKwargs] )
参数
- config (CodeGenForCausalLM) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载与模型相关的权重，只会加载配置。请查看 from_pretrained() 方法以加载模型权重。
顶部带有语言建模头的 CodeGen 模型 Transformer。
该模型继承自 PreTrainedModel。请查看超类文档以了解该库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、剪枝头部等）。
此模型也是一个 PyTorch torch.nn.Module 子类。像普通的 PyTorch Module 一样使用它，并参考 PyTorch 文档了解一般用法和行为的所有相关信息。
forward
< 源代码 >( input_ids: torch.LongTensor | None = None past_key_values: transformers.cache_utils.Cache | None = None attention_mask: torch.FloatTensor | None = None token_type_ids: torch.LongTensor | None = None position_ids: torch.LongTensor | None = None inputs_embeds: torch.FloatTensor | None = None labels: torch.LongTensor | None = None use_cache: bool | None = None output_attentions: bool | None = None output_hidden_states: bool | None = None return_dict: bool | None = None logits_to_keep: int | torch.Tensor = 0 **kwargs ) → CausalLMOutputWithPast 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor，形状为(batch_size, sequence_length)，可选) — 词表中输入序列标记的索引。默认情况下填充（padding）将被忽略。索引可以使用 AutoTokenizer 获取。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- past_key_values (
~cache_utils.Cache，可选) — 预计算的隐藏状态（自注意力模块和交叉注意力模块中的键和值），可用于加速顺序解码。这通常包含在解码的前一阶段由模型返回的past_key_values，此时use_cache=True或config.use_cache=True。输入仅允许 Cache 实例，请参阅我们的 kv 缓存指南。如果未传入
past_key_values，默认将初始化 DynamicCache。模型将输出与输入相同格式的缓存。
如果使用了
past_key_values，用户应仅输入形状为(batch_size, unprocessed_length)的未处理input_ids（即未将其过去的键值状态提供给此模型的那些），而不是形状为(batch_size, sequence_length)的所有input_ids。 - attention_mask (
torch.FloatTensor，形状为(batch_size, sequence_length)，可选) — 用于避免对填充标记索引执行注意力的掩码。掩码值在[0, 1]中选择：- 1 表示未被掩码的标记，
- 0 表示被掩码的标记。
- token_type_ids (
torch.LongTensor，形状为(batch_size, sequence_length)，可选) — 用于指示输入的第一部分和第二部分的段标记索引。索引在[0, 1]中选择：- 0 对应于 句子 A 标记，
- 1 对应于 句子 B 标记。
- position_ids (
torch.LongTensor，形状为(batch_size, sequence_length)，可选) — 每个输入序列标记在位置嵌入中的位置索引。在范围[0, config.n_positions - 1]内选择。 - inputs_embeds (
torch.FloatTensor，形状为(batch_size, sequence_length, hidden_dim)，可选) — 可选地，你可以选择直接传入嵌入表示，而不是传入input_ids。如果你想比模型内部的嵌入查找矩阵更好地控制如何将 input_ids 索引转换为相关向量，这非常有用。 - labels (
torch.LongTensor，形状为(batch_size, sequence_length)，可选) — 语言建模的标签。请注意，标签在模型内部会被移动（shifted），即你可以设置labels = input_ids。索引在[-100, 0, ..., config.vocab_size]中选择。所有设置为-100的标签都会被忽略（掩码），损失仅对[0, ..., config.vocab_size]中的标签进行计算。 - use_cache (
bool，可选) — 如果设置为True，将返回past_key_values键值状态，可用于加速解码（参见past_key_values）。 - output_attentions (
bool，可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量中的attentions。 - output_hidden_states (
bool，可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量中的hidden_states。 - return_dict (
bool，可选) — 是否返回一个 ModelOutput 而不是普通元组。 - logits_to_keep (
Union[int, torch.Tensor]，可选，默认为0) — 如果为int，则计算最后logits_to_keep个标记的 Logits。如果为0，计算所有input_ids的 Logits（特殊情况）。生成时通常仅需要最后一个标记的 Logits，仅计算该标记可以节省内存，这对于长序列或大词表大小来说非常重要。如果是torch.Tensor，则必须是一维的，对应于要在序列长度维度上保留的索引。这在使用压缩张量格式（批次和序列长度使用单一维度）时非常有用。
返回
CausalLMOutputWithPast or tuple(torch.FloatTensor)
一个 CausalLMOutputWithPast 或一个 torch.FloatTensor 元组（如果传入了 return_dict=False 或当 config.return_dict=False 时），根据配置（CodeGenConfig）和输入包含不同的元素。
CodeGenForCausalLM 的前向传播方法，覆盖了 __call__ 特殊方法。
虽然 forward pass 的实现需要在此函数中定义，但你应该在之后调用
Module实例而不是这个，因为前者负责运行预处理和后处理步骤，而后者会静默地忽略它们。
loss (
torch.FloatTensor形状为(1,)，可选，当提供labels时返回) — 语言建模损失（用于下一个 token 预测）。logits (形状为
(batch_size, sequence_length, config.vocab_size)的torch.FloatTensor) — 语言建模头部的预测分数（SoftMax 之前的每个词汇标记的分数）。past_key_values (
Cache，*可选*，当传入use_cache=True或config.use_cache=True时返回) — 这是一个 Cache 实例。欲了解更多细节，请参阅我们的 KV 缓存指南。包含预计算的隐藏状态（自注意力块中的键和值），可用于（参见
past_key_values输入）加速顺序解码。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 后的注意力权重，用于计算自注意力头中的加权平均值。