đ CodeTrans Model for Source Code Summarization (SQL)
A pre - trained model for SQL source code summarization, leveraging the T5 base architecture. It offers high - quality summarization for SQL code snippets.
đ Quick Start
This CodeTrans model is a pre - trained model for SQL source code summarization, initially released in this repository. It is trained on tokenized SQL code functions and performs best with such inputs.
⨠Features
- Based on the
t5 - base
model with its own SentencePiece vocabulary model.
- Utilizes transfer - learning pre - training on 7 unsupervised datasets in the software development domain.
- Fine - tuned for the source code summarization task of SQL code snippets.
đĻ Installation
No specific installation steps are provided in the original README.
đģ Usage Examples
Basic Usage
Here is how to use this model to generate SQL function documentation using Transformers SummarizationPipeline:
from transformers import AutoTokenizer, AutoModelWithLMHead, SummarizationPipeline
pipeline = SummarizationPipeline(
model=AutoModelWithLMHead.from_pretrained("SEBIS/code_trans_t5_base_source_code_summarization_sql_transfer_learning_finetune"),
tokenizer=AutoTokenizer.from_pretrained("SEBIS/code_trans_t5_base_source_code_summarization_sql_transfer_learning_finetune", skip_special_tokens=True),
device=0
)
tokenized_code = "select time ( col0 ) from tab0"
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 transfer - learning pre - training on 7 unsupervised datasets in the software development domain. It is then fine - tuned on the source code summarization task for the SQL code snippets.
Intended uses & limitations
The model could be used to generate the description for the SQL function or be fine - tuned on other SQL code tasks. It can be used on unparsed and untokenized SQL code. However, if the SQL code is tokenized, the performance should be better.
đ§ Technical Details
Training data
The supervised training tasks datasets can be downloaded on Link
Training procedure
Transfer - learning Pretraining
The model was trained on a single TPU Pod V3 - 8 for 500,000 steps in total, using sequence length 512 (batch size 4096). It has a total of approximately 220M parameters and was trained using the encoder - decoder architecture. The optimizer used is AdaFactor with inverse square root learning rate schedule for pre - training.
Fine - tuning
This model was then fine - tuned on a single TPU Pod V2 - 8 for 500 steps in total, using sequence length 512 (batch size 256), using only the dataset only containing SQL code.
Evaluation results
For the source code summarization tasks, different models achieve the following results on different programming languages (in BLEU score):
Test results :
Property |
Details |
Model Type |
CodeTrans for SQL source code summarization |
Training Data |
Can be downloaded from Link |
Language / Model |
Python |
SQL |
C# |
CodeTrans - ST - Small |
8.45 |
17.55 |
19.74 |
CodeTrans - ST - Base |
9.12 |
15.00 |
18.65 |
CodeTrans - TF - Small |
10.06 |
17.71 |
20.40 |
CodeTrans - TF - Base |
10.94 |
17.66 |
21.12 |
CodeTrans - TF - Large |
12.41 |
18.40 |
21.43 |
CodeTrans - MT - Small |
13.11 |
19.15 |
22.39 |
CodeTrans - MT - Base |
13.37 |
19.24 |
23.20 |
CodeTrans - MT - Large |
13.24 |
19.40 |
23.57 |
CodeTrans - MT - TF - Small |
12.10 |
18.25 |
22.03 |
CodeTrans - MT - TF - Base |
10.64 |
16.91 |
21.40 |
CodeTrans - MT - TF - Large |
12.14 |
19.98 |
21.10 |
CODE - NN |
-- |
18.40 |
20.50 |
Created by Ahmed Elnaggar | LinkedIn and Wei Ding | LinkedIn