Transformers 文档

代码生成

Hugging Face's logo
加入 Hugging Face 社区

并获得增强的文档体验

开始使用

代码生成

概述

CodeGen 模型由 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 上训练的模型参数高达 16B)在 HumanEval 基准测试中优于 OpenAI 的 Codex。我们将训练库 JaxFormer(包括检查点)作为开源贡献提供:此 https URL

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

检查点命名

  • CodeGen 模型检查点可在不同的预训练数据上使用,大小各异。
  • 格式为:Salesforce/codegen-{size}-{data},其中
    • size350M2B6B16B
    • 数据:
      • 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)
>>> 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

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 可以表示的不同标记的数量。
  • 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) — 旋转位置嵌入应用到的嵌入维度数。
  • 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) — 嵌入的丢弃率。
  • attn_pdrop (float可选,默认为 0.0) — 注意力的丢弃率。
  • layer_norm_epsilon (float可选,默认为 1e-05) — 层归一化层中使用的 epsilon。
  • initializer_range (float可选,默认为 0.02) — 用于初始化所有权重矩阵的 truncated_normal_initializer 的标准差。
  • use_cache (bool可选,默认为 True) — 模型是否应返回最后的键/值注意力(并非所有模型都使用)。
  • bos_token_id (int可选,默认为 50256) — 流开始标记 ID。
  • eos_token_id (int可选,默认为 50256) — 流结束标记 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

transformers.CodeGenTokenizer

< >

( vocab_file merges_file errors = 'replace' unk_token = '<|endoftext|>' bos_token = '<|endoftext|>' eos_token = '<|endoftext|>' pad_token = None add_prefix_space = False add_bos_token = False return_token_type_ids = False **kwargs )

参数

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

构造一个 CodeGen 分词器。基于字节级的字节对编码。

该分词器已经过训练,可以将空格视为标记的一部分(有点像句子块),因此一个词将

根据其是否在句子开头(没有空格)进行不同的编码

>>> 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 一起使用时,此分词器将在每个单词(甚至是第一个单词)之前添加一个空格。

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

create_token_type_ids_from_sequences

< >

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

参数

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

返回值

List[int]

根据给定序列的标记类型 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_1None,则此方法仅返回掩码的第一部分(0)。

save_vocabulary

< >

( save_directory: str filename_prefix: Optional = None )

CodeGenTokenizerFast

transformers.CodeGenTokenizerFast

< >

( vocab_file = None merges_file = None tokenizer_file = None unk_token = '<|endoftext|>' bos_token = '<|endoftext|>' eos_token = '<|endoftext|>' add_prefix_space = False return_token_type_ids = False **kwargs )

参数

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

构造一个“快速”CodeGen分词器(由 HuggingFace 的 tokenizers 库支持)。基于字节级的字节对编码。

该分词器已经过训练,可以将空格视为标记的一部分(有点像句子块),因此一个词将

根据其是否在句子开头(没有空格)进行不同的编码

>>> 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]

你可以通过在实例化此分词器时传递 add_prefix_space=True 来避免这种行为,但由于模型不是以这种方式预先训练的,因此它可能会导致性能下降。

当与 is_split_into_words=True 一起使用时,需要使用 add_prefix_space=True 实例化此分词器。

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

create_token_type_ids_from_sequences

< >

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

参数

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

返回值

List[int]

根据给定序列的标记类型 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_1None,则此方法仅返回掩码的第一部分(0)。

解码

< >

( token_ids: Union skip_special_tokens: bool = False clean_up_tokenization_spaces: bool = None truncate_before_pattern: Optional = None **kwargs ) str

参数

  • token_ids (Union[int, List[int], np.ndarray, torch.Tensor, tf.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|>”), ”^'''”, ”

返回值

str

解码后的句子。

使用分词器和词汇表将 ID 序列转换为字符串,并带有移除特殊标记和清理分词空格的选项。

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

”]`. kwargs(其他关键字参数,*可选*):将传递到底层模型特定的解码方法。

CodeGenModel

transformers.CodeGenModel

< >

( config )

参数

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

基础的 CodeGen 模型 Transformer,输出原始隐藏状态,顶部没有任何特定的头部。此模型是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块,并参阅 PyTorch 文档以了解有关一般用法和行为的所有内容。

forward

< >

( input_ids: Optional = None past_key_values: Union = None attention_mask: Optional = None token_type_ids: Optional = None position_ids: Optional = None head_mask: Optional = None inputs_embeds: Optional = None use_cache: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None cache_position: Optional = None ) transformers.modeling_outputs.BaseModelOutputWithPasttuple(torch.FloatTensor)

参数

  • input_ids (torch.LongTensor 类型,形状为 (batch_size, sequence_length)) — 词汇表中输入序列标记的索引。

    可以使用 AutoProcenizer 获取索引。 请参阅 PreTrainedTokenizer.encode()PreTrainedTokenizer.call() 了解详细信息。

    什么是输入 ID?

  • 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* 标记。

    什么是标记类型 ID?

  • position_ids (torch.LongTensor , 形状为 (batch_size, sequence_length), 可选) — 每个输入序列标记在位置嵌入中的位置索引。在 [0, config.n_positions - 1] 范围内选择。

    什么是位置 ID?

  • head_mask (torch.FloatTensor , 形状为 (num_attention_heads,)(n_layer, num_attention_heads), 可选) — 用于将自注意力模块的选定头部置零的掩码。掩码值在 [0, 1] 中选择:

    • 1 表示头部**未被掩盖**,
    • 0 表示头部**已被掩盖**。
  • inputs_embeds (torch.FloatTensor , 形状为 (batch_size, sequence_length, hidden_dim), 可选) — 您可以选择直接传递嵌入表示,而不是传递 input_ids。如果您想更好地控制如何将 *input_ids* 索引转换为关联向量,而不是模型的内部嵌入查找矩阵,这将非常有用。
  • past_key_values (Cachetuple(tuple(torch.FloatTensor)), 可选) — 预先计算的隐藏状态(自注意力块和交叉注意力块中的键和值),可用于加速顺序解码。这通常包含在 use_cache=Trueconfig.use_cache=True 时,模型在前一解码阶段返回的 past_key_values

    允许使用两种格式:

    • Cache 实例,请参阅我们的 kv 缓存指南
    • 长度为 config.n_layerstuple(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

  • output_attentions (bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息,请参阅返回张量下的 attentions
  • output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息,请参阅返回张量下的 hidden_states
  • return_dict (bool, 可选) — 是否返回 ModelOutput , 而不是一个普通的元组。
  • cache_position (torch.LongTensor , 形状为 (sequence_length), 可选) — 描述输入序列标记在序列中位置的索引。 与 position_ids 相反,该张量不受填充的影响。 它用于更新缓存中的正确位置并推断完整的序列长度。

返回值

transformers.modeling_outputs.BaseModelOutputWithPasttuple(torch.FloatTensor)

transformers.modeling_outputs.BaseModelOutputWithPast 或一个 torch.FloatTensor 元组(如果传入 return_dict=Falseconfig.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=Trueconfig.use_cache=True 时返回) — 长度为 config.n_layerstuple(torch.FloatTensor) 元组,每个元组有 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=Trueconfig.output_hidden_states=True 时返回) — torch.FloatTensor 元组(如果模型有嵌入层,则一个用于嵌入的输出 + 一个用于每一层的输出),形状为 (batch_size, sequence_length, hidden_size)

    模型在每一层输出处的隐藏状态,以及可选的初始嵌入输出。

  • attentions (tuple(torch.FloatTensor), 可选, 当传入 output_attentions=Trueconfig.output_attentions=True 时返回) — torch.FloatTensor 元组(每一层一个),形状为 (batch_size, num_heads, sequence_length, sequence_length)

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

CodeGenModel 正向方法,覆盖 __call__ 特殊方法。

尽管需要在此函数中定义正向传递的方法,但之后应该调用 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

< >

( config )

参数

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

CodeGen 模型转换器,顶部有一个语言建模头。

该模型是 PyTorch torch.nn.Module 子类。 将其用作常规的 PyTorch 模块,并参考 PyTorch 文档了解有关一般用法和行为的所有事项。

forward

< >

( input_ids: Optional = None past_key_values: Union = None attention_mask: Optional = None token_type_ids: Optional = None position_ids: Optional = None head_mask: Optional = None inputs_embeds: Optional = None labels: Optional = None use_cache: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None cache_position: Optional = None ) transformers.modeling_outputs.CausalLMOutputWithPasttuple(torch.FloatTensor)

参数

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

    索引可以使用 AutoProcenizer 获取。详见 PreTrainedTokenizer.encode()PreTrainedTokenizer.call()

    什么是输入 ID?

  • 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 标记。

    什么是标记类型 ID?

  • position_ids (torch.LongTensor ,形状为 (batch_size, sequence_length),可选) — 位置嵌入中每个输入序列标记的位置索引。在 [0, config.n_positions - 1] 范围内选择。

    什么是位置 ID?

  • head_mask (torch.FloatTensor , 形状为 (num_attention_heads,)(n_layer, num_attention_heads), 可选) — 用于将自注意力模块的选定头部置零的掩码。掩码值在 [0, 1] 中选择:

    • 1 表示头部**未被遮蔽**,
    • 0 表示头部**已被遮蔽**。
  • inputs_embeds (torch.FloatTensor , 形状为 (batch_size, sequence_length, hidden_dim), 可选) — 您可以选择直接传递嵌入表示,而不是传递 input_ids。如果您想更好地控制如何将 *input_ids* 索引转换为关联向量,而不是模型的内部嵌入查找矩阵,这将非常有用。
  • past_key_values (Cachetuple(tuple(torch.FloatTensor)), 可选) — 预先计算的隐藏状态(自注意力块和交叉注意力块中的键和值),可用于加速顺序解码。这通常包含模型在先前解码阶段返回的 past_key_values,此时 use_cache=Trueconfig.use_cache=True

    允许使用两种格式:

    • Cache 实例,请参阅我们的 kv 缓存指南
    • 长度为 config.n_layerstuple(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, 可选) — 是否返回所有注意力层的注意力张量。有关详细信息,请参阅返回张量下的 attentions
  • output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。有关详细信息,请参阅返回张量下的 hidden_states
  • return_dict (bool, 可选) — 是否返回 ModelOutput 而不是普通元组。
  • cache_position (形状为 (sequence_length)torch.LongTensor,可选)— 描述输入序列标记在序列中位置的索引。与 position_ids 相反,此张量不受填充的影响。它用于更新缓存中的正确位置并推断完整的序列长度。
  • labels (形状为 (batch_size, sequence_length)torch.LongTensor,可选)— 用于语言建模的标签。请注意,标签在模型内部是**移位的**,即您可以设置 labels = input_ids。索引在 [-100, 0, ..., config.vocab_size] 中选择。所有设置为 -100 的标签都将被忽略(屏蔽),损失仅针对 [0, ..., config.vocab_size] 中的标签计算。

返回值

transformers.modeling_outputs.CausalLMOutputWithPasttuple(torch.FloatTensor)

一个 transformers.modeling_outputs.CausalLMOutputWithPast 或一个 torch.FloatTensor 的元组(如果传递了 return_dict=Falseconfig.return_dict=False)包含根据配置 (CodeGenConfig) 和输入而定的各种元素。

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

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

  • past_key_valuestuple(tuple(torch.FloatTensor)),可选,在传递 use_cache=Trueconfig.use_cache=True 时返回)— 长度为 config.n_layerstuple(tuple(torch.FloatTensor)) 元组,每个元组都有 2 个形状为 (batch_size, num_heads, sequence_length, embed_size_per_head) 的张量)

    包含预先计算的隐藏状态(自注意力块中的键和值),可以使用这些状态(参见 past_key_values 输入)来加速顺序解码。

  • hidden_states (tuple(torch.FloatTensor), 可选, 当传入 output_hidden_states=Trueconfig.output_hidden_states=True 时返回) — torch.FloatTensor 元组(如果模型有嵌入层,则一个用于嵌入的输出 + 一个用于每一层的输出),形状为 (batch_size, sequence_length, hidden_size)

    模型在每一层输出处的隐藏状态,以及可选的初始嵌入输出。

  • attentions (tuple(torch.FloatTensor), 可选, 当传入 output_attentions=Trueconfig.output_attentions=True 时返回) — torch.FloatTensor 元组(每一层一个),形状为 (batch_size, num_heads, sequence_length, sequence_length)

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

CodeGenForCausalLM 前向方法,覆盖了 __call__ 特殊方法。

尽管需要在此函数中定义正向传递的方法,但之后应该调用 Module 实例而不是该函数,因为前者负责运行前处理和后处理步骤,而后者则默默地忽略它们。

示例

>>> 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 上的更新