claudios commited on
Commit
12de3ed
·
verified ·
1 Parent(s): 07386d4

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +85 -193
README.md CHANGED
@@ -1,199 +1,91 @@
1
  ---
2
- library_name: transformers
3
- tags: []
 
 
4
  ---
5
 
6
- # Model Card for Model ID
7
 
8
- <!-- Provide a quick summary of what the model is/does. -->
9
 
 
10
 
11
-
12
- ## Model Details
13
-
14
- ### Model Description
15
-
16
- <!-- Provide a longer summary of what this model is. -->
17
-
18
- This is the model card of a 🤗 transformers model that has been pushed on the Hub. This model card has been automatically generated.
19
-
20
- - **Developed by:** [More Information Needed]
21
- - **Funded by [optional]:** [More Information Needed]
22
- - **Shared by [optional]:** [More Information Needed]
23
- - **Model type:** [More Information Needed]
24
- - **Language(s) (NLP):** [More Information Needed]
25
- - **License:** [More Information Needed]
26
- - **Finetuned from model [optional]:** [More Information Needed]
27
-
28
- ### Model Sources [optional]
29
-
30
- <!-- Provide the basic links for the model. -->
31
-
32
- - **Repository:** [More Information Needed]
33
- - **Paper [optional]:** [More Information Needed]
34
- - **Demo [optional]:** [More Information Needed]
35
-
36
- ## Uses
37
-
38
- <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
39
-
40
- ### Direct Use
41
-
42
- <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
43
-
44
- [More Information Needed]
45
-
46
- ### Downstream Use [optional]
47
-
48
- <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
49
-
50
- [More Information Needed]
51
-
52
- ### Out-of-Scope Use
53
-
54
- <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
55
-
56
- [More Information Needed]
57
-
58
- ## Bias, Risks, and Limitations
59
-
60
- <!-- This section is meant to convey both technical and sociotechnical limitations. -->
61
-
62
- [More Information Needed]
63
-
64
- ### Recommendations
65
-
66
- <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
67
-
68
- Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
69
-
70
- ## How to Get Started with the Model
71
-
72
- Use the code below to get started with the model.
73
-
74
- [More Information Needed]
75
-
76
- ## Training Details
77
-
78
- ### Training Data
79
-
80
- <!-- This should link to a Dataset Card, perhaps with a short stub of information on what the training data is all about as well as documentation related to data pre-processing or additional filtering. -->
81
-
82
- [More Information Needed]
83
-
84
- ### Training Procedure
85
-
86
- <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
87
-
88
- #### Preprocessing [optional]
89
-
90
- [More Information Needed]
91
-
92
-
93
- #### Training Hyperparameters
94
-
95
- - **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
96
-
97
- #### Speeds, Sizes, Times [optional]
98
-
99
- <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
100
-
101
- [More Information Needed]
102
-
103
- ## Evaluation
104
-
105
- <!-- This section describes the evaluation protocols and provides the results. -->
106
-
107
- ### Testing Data, Factors & Metrics
108
-
109
- #### Testing Data
110
-
111
- <!-- This should link to a Dataset Card if possible. -->
112
-
113
- [More Information Needed]
114
-
115
- #### Factors
116
-
117
- <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
118
-
119
- [More Information Needed]
120
-
121
- #### Metrics
122
-
123
- <!-- These are the evaluation metrics being used, ideally with a description of why. -->
124
-
125
- [More Information Needed]
126
-
127
- ### Results
128
-
129
- [More Information Needed]
130
-
131
- #### Summary
132
-
133
-
134
-
135
- ## Model Examination [optional]
136
-
137
- <!-- Relevant interpretability work for the model goes here -->
138
-
139
- [More Information Needed]
140
-
141
- ## Environmental Impact
142
-
143
- <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
144
-
145
- Carbon emissions can be estimated using the [Machine Learning Impact calculator](https://mlco2.github.io/impact#compute) presented in [Lacoste et al. (2019)](https://arxiv.org/abs/1910.09700).
146
-
147
- - **Hardware Type:** [More Information Needed]
148
- - **Hours used:** [More Information Needed]
149
- - **Cloud Provider:** [More Information Needed]
150
- - **Compute Region:** [More Information Needed]
151
- - **Carbon Emitted:** [More Information Needed]
152
-
153
- ## Technical Specifications [optional]
154
-
155
- ### Model Architecture and Objective
156
-
157
- [More Information Needed]
158
-
159
- ### Compute Infrastructure
160
-
161
- [More Information Needed]
162
-
163
- #### Hardware
164
-
165
- [More Information Needed]
166
-
167
- #### Software
168
-
169
- [More Information Needed]
170
-
171
- ## Citation [optional]
172
-
173
- <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
174
-
175
- **BibTeX:**
176
-
177
- [More Information Needed]
178
-
179
- **APA:**
180
-
181
- [More Information Needed]
182
-
183
- ## Glossary [optional]
184
-
185
- <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
186
-
187
- [More Information Needed]
188
-
189
- ## More Information [optional]
190
-
191
- [More Information Needed]
192
-
193
- ## Model Card Authors [optional]
194
-
195
- [More Information Needed]
196
-
197
- ## Model Card Contact
198
-
199
- [More Information Needed]
 
1
  ---
2
+ license: afl-3.0
3
+ arxiv: 2206.06888
4
+ language:
5
+ - code
6
  ---
7
 
8
+ This is an *unofficial* reupload of [Daoguang/PyCodeGPT](https://huggingface.co/Daoguang/PyCodeGPT) in the `SafeTensors` format using `transformers` `4.40.1`. The goal of this reupload is to prevent older models that are still relevant baselines from becoming stale as a result of changes in HuggingFace. Additionally, I may include minor corrections, such as model max length configuration.
9
 
10
+ Original model card below:
11
 
12
+ ---
13
 
14
+ # PyCodeGPT
15
+ A pre-trained GPT model for Python code completion and generation
16
+
17
+ ## What is it?
18
+
19
+ PyCodeGPT is efficient and effective GPT-Neo-based model for python code generation task, which is similar to [OpenAI Codex](https://openai.com/blog/openai-codex/), [Github Copliot](https://copilot.github.com/), [CodeParrot](https://huggingface.co/blog/codeparrot), [AlphaCode](https://deepmind.com/blog/article/Competitive-programming-with-AlphaCode).
20
+
21
+ ## Training Data
22
+ Due to the small size of public released dataset, we proposed to collect data from GitHub from scratch. We first crawled 1.2M python-related repositories hosted by GitHub. Then, we used these repository URLs to download all contents of each repository from GitHub. After that, we got 60M raw python files under 1MB with a total size of 330GB. Finally, we carefully designed various strategies of data cleaning to get about 96GB data for training. Please refer to the following table for the details.
23
+
24
+ |Model|Repositories|Size and file after filtering|
25
+ |:------:|:---:|:---:|
26
+ | CodeParrot | 0.56M | 12GB (compressed), 5.4M |
27
+ | Codex | 54M | 159GB |
28
+ | PyCodeGPT | 1.2M | 96GB, 13M |
29
+
30
+
31
+ ## Pretrained models
32
+
33
+ we aims to train median-large pre-trained models (model size with 110M) based on GPT-Neo:
34
+ - PyCodeGPT-110M: derived from GPT-Neo 125M with a vocabulary size of 32K.
35
+
36
+ ## GitHub
37
+
38
+ [https://github.com/microsoft/PyCodeGPT](https://github.com/microsoft/PyCodeGPT)
39
+
40
+ ## Evaluation Results
41
+
42
+ Here's our evaluation result on HumanEval dataset:
43
+
44
+ Note: our model can have a comparable accuracy with Codex of similar model size.
45
+
46
+ |Model|Pass@1|Pass@10|Pass@100|
47
+ |:------:|:---:|:---:|:---:|
48
+ |PyCodeGPT-110M |**8.32%** |**13.53%** |**18.3%** |
49
+ |||||
50
+ |GPT-Neo 125M |0.75% |1.88% |2.97% |
51
+ |GPT-Neo 1.3B |4.97% |7.47% |16.3% |
52
+ |GPT-Neo 2.7B |6.41% |11.27% |21.37% |
53
+ |GPT-J 6B |11.62% |15.74% |27.74% |
54
+ |||||
55
+ |TabNine |2.58% |4.35% |7.59% |
56
+ |||||
57
+ |CodeParrot 110M |3.80% |6.57% |12.78% |
58
+ |CodeParrot 1.5B |3.58% |8.03% |14.96% |
59
+ |||||
60
+ |Codex 12M |2.00% |3.62% |8.58% |
61
+ |Codex 25M |3.21% |7.1% |12.89% |
62
+ |Codex 42M |5.06% |8.8% |15.55% |
63
+ |Codex 85M |8.22% |12.81% |22.4% |
64
+ |Codex 300M |13.17% |20.37% |36.27% |
65
+ |Codex 679M |16.22% |25.7% |40.95% |
66
+ |Codex 2.5B |21.36% |35.42% |59.5% |
67
+ |Codex 12B |28.81% |46.81% |72.31% |
68
+ |||||
69
+ |Pretrained Decoder-only 13M (AlphaCode) |1.5% |3.6% |8.6% |
70
+ |Pretrained Decoder-only 29M (AlphaCode) |3.4% |5.8% |11.2% |
71
+ |Pretrained Decoder-only 55M (AlphaCode) |4.2% |8.2% |16.9% |
72
+ |Pretrained Decoder-only 89M (AlphaCode) |4.3% |12.2% |20.0% |
73
+ |Pretrained Decoder-only 302M (AlphaCode) |11.6% |18.8% |31.8% |
74
+ |Pretrained Decoder-only 685M (AlphaCode) |14.2% |24.4% |38.8% |
75
+ |Pretrained Decoder-only 1.1B (AlphaCode) |17.1% |28.2% |45.3% |
76
+ |||||
77
+ |PolyCoder 160M |2.13% |3.35% |4.88% |
78
+ |PolyCoder 400M |2.96% |5.29% |11.59% |
79
+ |PolyCoder 2.7B |5.59% |9.84% |17.68% |
80
+
81
+ ## Reference
82
+ If you want to use the models, you need to cite our following paper:
83
+
84
+ ```
85
+ @inproceedings{CERT,
86
+ title={{CERT}: Continual Pre-training on Sketches for Library-oriented Code Generation},
87
+ author={Zan, Daoguang and Chen, Bei and Yang, Dejian and Lin, Zeqi and Kim, Minsu and Guan, Bei and Wang, Yongji and Chen, Weizhu and Lou, Jian-Guang},
88
+ booktitle={The 2022 International Joint Conference on Artificial Intelligence},
89
+ year={2022}
90
+ }
91
+ ```