Code Trans T5 Base Code Documentation Generation Java

🚀 CodeTrans模型：用于Java代码文档生成

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

🚀 快速开始

本部分将引导你快速了解如何使用CodeTrans模型进行Java代码文档生成。

✨ 主要特性

• 模型架构：基于t5-base模型，拥有自己的SentencePiece词汇模型。
• 训练方式：在CodeSearchNet Corpus Java数据集上进行单任务训练。
• 应用场景：可用于生成Java函数的描述，也可在其他Java代码任务上进行微调。
• 代码适应性：能够处理未解析和未分词的Java代码，但对分词后的代码处理效果更佳。

📦 安装指南

文档未提及安装步骤，故跳过此章节。

💻 使用示例

基础用法

以下是如何使用Transformers的SummarizationPipeline来生成Java函数文档的示例代码：

from transformers import AutoTokenizer, AutoModelWithLMHead, SummarizationPipeline

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

tokenized_code = "public static < T , U > Function < T , U > castFunction  ( Class < U > target ) { return new CastToClass < T , U > ( target ) ; }"
pipeline([tokenized_code])

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

📚 详细文档

模型描述

此CodeTrans模型基于t5-base模型构建，具备独立的SentencePiece词汇模型，并在CodeSearchNet Corpus Java数据集上完成单任务训练。

预期用途与限制

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

🔧 技术细节

训练数据

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

评估结果

在代码文档生成任务中，不同模型在不同编程语言上的评估结果（以BLEU分数衡量）如下：

📄 许可证

文档未提及许可证信息，故跳过此章节。

创作者：Ahmed Elnaggar | LinkedIn 以及 魏丁 | LinkedIn