wei commited on
Commit
128574c
1 Parent(s): e7b2560

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +77 -0
README.md CHANGED
@@ -5,3 +5,80 @@ widget:
5
  - text: "public static DateTime ParseUnixDateTime ( double unixTime ) { var dt = new DateTime ( CODE_INTEGER , CODE_INTEGER , CODE_INTEGER , CODE_INTEGER , CODE_INTEGER , CODE_INTEGER , CODE_INTEGER , System . DateTimeKind . Utc ) ; dt = dt . AddSeconds ( unixTimeStamp ) . ToLocalTime ( ) ; return dt ; }"
6
 
7
  ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
5
  - text: "public static DateTime ParseUnixDateTime ( double unixTime ) { var dt = new DateTime ( CODE_INTEGER , CODE_INTEGER , CODE_INTEGER , CODE_INTEGER , CODE_INTEGER , CODE_INTEGER , CODE_INTEGER , System . DateTimeKind . Utc ) ; dt = dt . AddSeconds ( unixTimeStamp ) . ToLocalTime ( ) ; return dt ; }"
6
 
7
  ---
8
+
9
+
10
+ # CodeTrans model for source code summarization csharp
11
+ Pretrained model on programming language csharp using the t5 base model architecture. It was first released in
12
+ [this repository](https://github.com/agemagician/CodeTrans). This model is trained on tokenized csharp code functions: it works best with tokenized csharp functions.
13
+
14
+
15
+ ## Model description
16
+
17
+ 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 csharp code snippets.
18
+
19
+
20
+
21
+ ## Intended uses & limitations
22
+
23
+ The model could be used to generate the description for the csharp function or be fine-tuned on other csharp code tasks. It can be used on unparsed and untokenized csharp code. However, if the csharp code is tokenized, the performance should be better.
24
+
25
+ ### How to use
26
+
27
+ Here is how to use this model to generate csharp function documentation using Transformers SummarizationPipeline:
28
+
29
+ ```python
30
+ from transformers import AutoTokenizer, AutoModelWithLMHead, SummarizationPipeline
31
+
32
+ pipeline = SummarizationPipeline(
33
+ model=AutoModelWithLMHead.from_pretrained("SEBIS/code_trans_t5_base_source_code_summarization_csharp_transfer_learning_finetune"),
34
+ tokenizer=AutoTokenizer.from_pretrained("SEBIS/code_trans_t5_base_source_code_summarization_csharp_transfer_learning_finetune", skip_special_tokens=True),
35
+ device=0
36
+ )
37
+
38
+ tokenized_code = "public static DateTime ParseUnixDateTime ( double unixTime ) { var dt = new DateTime ( CODE_INTEGER , CODE_INTEGER , CODE_INTEGER , CODE_INTEGER , CODE_INTEGER , CODE_INTEGER , CODE_INTEGER , System . DateTimeKind . Utc ) ; dt = dt . AddSeconds ( unixTimeStamp ) . ToLocalTime ( ) ; return dt ; }"
39
+ pipeline([tokenized_code])
40
+ ```
41
+ Run this example in [colab notebook](https://github.com/agemagician/CodeTrans/blob/main/prediction/transfer%20learning%20fine-tuning/source%20code%20summarization/csharp/base_model.ipynb).
42
+ ## Training data
43
+
44
+ The supervised training tasks datasets can be downloaded on [Link](https://www.dropbox.com/sh/488bq2of10r4wvw/AACs5CGIQuwtsD7j_Ls_JAORa/finetuning_dataset?dl=0&subfolder_nav_tracking=1)
45
+
46
+
47
+ ## Training procedure
48
+
49
+ ### Transfer-learning Pretraining
50
+
51
+ The model was trained on a single TPU Pod V3-8 for 500,000 steps in total, using sequence length 512 (batch size 4096).
52
+ It has a total of approximately 220M parameters and was trained using the encoder-decoder architecture.
53
+ The optimizer used is AdaFactor with inverse square root learning rate schedule for pre-training.
54
+
55
+ ### Fine-tuning
56
+
57
+ 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 csharp code.
58
+
59
+
60
+ ## Evaluation results
61
+
62
+ For the source code summarization tasks, different models achieves the following results on different programming languages (in BLEU score):
63
+
64
+ Test results :
65
+
66
+ | Language / Model | Python | SQL | C# |
67
+ | -------------------- | :------------: | :------------: | :------------: |
68
+ | CodeTrans-ST-Small | 8.45 | 17.55 | 19.74 |
69
+ | CodeTrans-ST-Base | 9.12 | 15.00 | 18.65 |
70
+ | CodeTrans-TF-Small | 10.06 | 17.71 | 20.40 |
71
+ | CodeTrans-TF-Base | 10.94 | 17.66 | 21.12 |
72
+ | CodeTrans-TF-Large | 12.41 | 18.40 | 21.43 |
73
+ | CodeTrans-MT-Small | 13.11 | 19.15 | 22.39 |
74
+ | CodeTrans-MT-Base | **13.37** | 19.24 | 23.20 |
75
+ | CodeTrans-MT-Large | 13.24 | 19.40 | **23.57** |
76
+ | CodeTrans-MT-TF-Small | 12.10 | 18.25 | 22.03 |
77
+ | CodeTrans-MT-TF-Base | 10.64 | 16.91 | 21.40 |
78
+ | CodeTrans-MT-TF-Large | 12.14 | **19.98** | 21.10 |
79
+ | CODE-NN | -- | 18.40 | 20.50 |
80
+
81
+
82
+ > Created by [Ahmed Elnaggar](https://twitter.com/Elnaggar_AI) | [LinkedIn](https://www.linkedin.com/in/prof-ahmed-elnaggar/) and Wei Ding | [LinkedIn](https://www.linkedin.com/in/wei-ding-92561270/)
83
+
84
+