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

CodeTrans模型基于t5-small架构，在Java编程语言上进行预训练。它能为Java函数生成描述，也可针对其他Java代码任务进行微调。该模型在标记化的Java代码函数上效果最佳。

🚀 快速开始

如何使用

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

from transformers import AutoTokenizer, AutoModelWithLMHead, SummarizationPipeline

pipeline = SummarizationPipeline(
    model=AutoModelWithLMHead.from_pretrained("SEBIS/code_trans_t5_small_code_documentation_generation_java"),
    tokenizer=AutoTokenizer.from_pretrained("SEBIS/code_trans_t5_small_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中运行此示例。

✨ 主要特性

• 基于t5-small模型架构，拥有自己的SentencePiece词汇模型。
• 在CodeSearchNet Corpus Java数据集上进行单任务训练。
• 可用于生成Java函数描述，也能在其他Java代码任务上进行微调。
• 可处理未解析和未标记化的Java代码，但对标记化的Java代码性能更佳。

📦 安装指南

文档未提及安装相关内容，暂不展示。

💻 使用示例

基础用法

from transformers import AutoTokenizer, AutoModelWithLMHead, SummarizationPipeline

pipeline = SummarizationPipeline(
    model=AutoModelWithLMHead.from_pretrained("SEBIS/code_trans_t5_small_code_documentation_generation_java"),
    tokenizer=AutoTokenizer.from_pretrained("SEBIS/code_trans_t5_small_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])

📚 详细文档

模型描述

此CodeTrans模型基于t5-small模型，拥有自己的SentencePiece词汇模型，在CodeSearchNet Corpus Java数据集上进行单任务训练。

预期用途和限制

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

🔧 技术细节

文档未提及技术实现细节相关内容，暂不展示。

📄 许可证

文档未提及许可证信息，暂不展示。

📊 训练数据

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

📈 评估结果

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

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