Code Trans T5 Base Source Code Summarization Python

🚀 CodeTrans模型：用于Python源代码摘要

CodeTrans模型基于t5基础模型架构，在Python编程语言上进行预训练。它能为Python代码生成描述，助力开发者理解代码逻辑。该模型首次发布于 此仓库 ，在标记化的Python代码函数上进行训练，处理标记化的Python函数时效果最佳。

🚀 快速开始

此CodeTrans模型基于 t5-base 模型构建，拥有自己的SentencePiece词汇模型，在Python源代码摘要数据集上进行单任务训练。以下是使用Transformers的 SummarizationPipeline 调用该模型生成Python函数文档的示例：

from transformers import AutoTokenizer, AutoModelWithLMHead, SummarizationPipeline

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

tokenized_code = '''with open ( CODE_STRING , CODE_STRING ) as in_file : buf = in_file . readlines ( )  with open ( CODE_STRING , CODE_STRING ) as out_file : for line in buf :          if line ==   " ; Include this text   " :              line = line +   " Include below  "          out_file . write ( line ) '''
pipeline([tokenized_code])

你可以在 colab notebook 中运行此示例。

✨ 主要特性

• 功能用途广泛：可用于生成Python函数的描述，也能在其他Python代码任务上进行微调。
• 适应性强：能处理未解析和未标记化的Python代码，对标记化的Python代码处理效果更佳。

📚 详细文档

模型描述

该CodeTrans模型基于 t5-base 模型，具备独立的SentencePiece词汇模型，采用单任务训练方式在Python源代码摘要数据集上进行训练。

预期用途和限制

此模型可用于生成Python函数的描述，或在其他Python代码任务上进行微调。它能处理未解析和未标记化的Python代码，但对标记化的Python代码处理性能更佳。

训练数据

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

评估结果

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

由 Ahmed Elnaggar | LinkedIn 和 Wei Ding | LinkedIn 创建