Code Trans T5 Base Code Documentation Generation Java

🚀 CodeTrans Model for Java Code Documentation Generation

This is a pre - trained model for the Java programming language, leveraging the T5 base model architecture. It was initially released in this repository. The model is trained on tokenized Java code functions and performs optimally with such tokenized functions.

✨ Features

• Based on the t5 - base model with its own SentencePiece vocabulary model.
• Trained using single - task training on the CodeSearchNet Corpus Java dataset.
• Can generate descriptions for Java functions or be fine - tuned for other Java code tasks.
• Can handle unparsed and untokenized Java code, but performs better with tokenized code.

📦 Installation

No specific installation steps are provided in the original document.

💻 Usage Examples

Basic Usage

Here is how to use this model to generate Java function documentation using Transformers SummarizationPipeline:

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

Run this example in colab notebook.

📚 Documentation

Model description

This CodeTrans model is based on the t5 - base model. It has its own SentencePiece vocabulary model. It used single - task training on CodeSearchNet Corpus Java dataset.

Intended uses & limitations

The model could be used to generate the description for the Java function or be fine - tuned on other Java code tasks. It can be used on unparsed and untokenized Java code. However, if the Java code is tokenized, the performance should be better.

🔧 Technical Details

The supervised training tasks datasets can be downloaded on Link

Evaluation results

For the code documentation tasks, different models achieve the following results on different programming languages (in BLEU score):

Created by Ahmed Elnaggar | LinkedIn and Wei Ding | LinkedIn