CodeTrans model for code documentation generation python

Pretrained model on programming language python using the t5 base model architecture. It was first released in this repository. This model is trained on tokenized python code functions: it works best with tokenized python functions.

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 python dataset.

Intended uses & limitations

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

How to use

Here is how to use this model to generate python 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_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])

Run this example in colab notebook.

Training data

The supervised training tasks datasets can be downloaded on Link

Evaluation results

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

Test results :

Created by Ahmed Elnaggar | LinkedIn and Wei Ding | LinkedIn