Code Trans T5 Base Code Documentation Generation Python

🚀 用于Python代码文档生成的CodeTrans模型

本模型基于t5-base架构，在Python编程语言上进行预训练。它首次发布于 此仓库。该模型在经过分词处理的Python代码函数上进行训练，因此在处理分词后的Python函数时表现最佳。

🚀 快速开始

模型描述

此CodeTrans模型基于t5-base模型构建，拥有自己的SentencePiece词汇模型。它在CodeSearchNet语料库的Python数据集上进行单任务训练。

预期用途与限制

该模型可用于生成Python函数的描述，也可在其他Python代码任务上进行微调。它可以处理未解析和未分词的Python代码，但如果代码经过分词处理，性能会更好。

使用方法

以下是使用Transformers的SummarizationPipeline来使用该模型生成Python函数文档的示例代码：

from transformers import AutoTokenizer, AutoModelWithLMHead, SummarizationPipeline

pipeline = SummarizationPipeline(
    model=AutoModelWithLMHead.from_pretrained("SEBIS/code_trans_t5_base_code_documentation_generation_python"),
    tokenizer=AutoTokenizer.from_pretrained("SEBIS/code_trans_t5_base_code_documentation_generation_python", skip_special_tokens=True),
    device=0
)

tokenized_code = "def e ( message , exit_code = None ) : print_log ( message , YELLOW , BOLD ) if exit_code is not None : sys . exit ( exit_code )"
pipeline([tokenized_code])

你可以在 Colab笔记本 中运行此示例。

训练数据

有监督训练任务的数据集可以从 此链接 下载。

评估结果

对于代码文档生成任务，不同模型在不同编程语言上取得了以下BLEU分数结果：

作者信息

本模型由 Ahmed Elnaggar | 领英 和 Wei Ding | 领英 创建。