Pradnya27 commited on
Commit
2aadf1b
·
verified ·
1 Parent(s): c525923

Upload README.md with huggingface_hub

Browse files
Files changed (1) hide show
  1. README.md +73 -190
README.md CHANGED
@@ -1,199 +1,82 @@
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
+ language: en
3
+ license: mit
4
+ tags:
5
+ - code-generation
6
+ - python
7
+ - lora
8
+ - peft
9
+ - causal-lm
10
+ base_model: microsoft/CodeGPT-small-py
11
  ---
12
 
13
+ # CodeGPT LoRA Fine-tuned for Code Generation
 
 
14
 
15
+ Fine-tuned version of CodeGPT using LoRA (Low-Rank Adaptation) for Python code generation.
16
 
17
+ ## 🔗 Links
18
+ - **Live Demo:** https://huggingface.co/spaces/Pradnya27/code-generator
19
+ - **Full Fine-tuned Model:** https://huggingface.co/Pradnya27/codegpt-finetuned-code-generation
20
+ - **GitHub:** https://github.com/pradnyagundu/codegpt-finetuned-code-generation
21
 
22
  ## Model Details
23
+ - **Base model:** microsoft/CodeGPT-small-py (124M parameters)
24
+ - **Method:** LoRA (Low-Rank Adaptation)
25
+ - **Trainable parameters:** 589,824 (0.36% of total)
26
+ - **Model size:** 2.36MB (vs 651MB for full fine-tuning)
27
+ - **Dataset:** Rabinovich/Code-Generation-LLM-LoRA (5000 examples)
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
28
 
29
  ## Training Details
30
+ - **Epochs:** 2
31
+ - **Learning rate:** 3e-4
32
+ - **Batch size:** 8
33
+ - **LoRA rank:** 16
34
+ - **LoRA alpha:** 32
35
+ - **Hardware:** Google Colab T4 GPU
36
+ - **Training time:** ~9 minutes
37
+
38
+ ## Training Results
39
+ | Step | Loss |
40
+ |------|------|
41
+ | 100 | 4.28 |
42
+ | 300 | 3.45 |
43
+ | 500 | 3.28 |
44
+ | 700 | 3.24 |
45
+ | 900 | 3.15 |
46
+ | 1200 | 3.14 |
47
+
48
+ ## Comparison vs Full Fine-tuning
49
+ | | Full Fine-tune | LoRA |
50
+ |---|---|---|
51
+ | Final loss | 2.31 | 3.14 |
52
+ | Model size | 651MB | 2.36MB |
53
+ | Training time | ~14 min | ~9 min |
54
+ | Trainable params | 124M | 589K |
55
+
56
+ ## How to Use
57
+ ```python
58
+ from peft import PeftModel
59
+ from transformers import AutoModelForCausalLM, AutoTokenizer
60
+ import torch
61
+
62
+ base_model = AutoModelForCausalLM.from_pretrained("microsoft/CodeGPT-small-py")
63
+ model = PeftModel.from_pretrained(base_model, "Pradnya27/codegpt-lora-code-generation")
64
+ tokenizer = AutoTokenizer.from_pretrained("microsoft/CodeGPT-small-py")
65
+ tokenizer.pad_token = tokenizer.eos_token
66
+
67
+ prompt = "Generate code: Write a function to check if a number is prime"
68
+ inputs = tokenizer(prompt, return_tensors="pt")
69
+ with torch.no_grad():
70
+ outputs = model.generate(inputs["input_ids"], max_new_tokens=150)
71
+ print(tokenizer.decode(outputs[0], skip_special_tokens=True))
72
+ ```
73
+
74
+ ## Limitations
75
+ - Trained on competitive programming problems — works best for algorithmic tasks
76
+ - Small base model (124M params) limits output quality
77
+ - Full fine-tuning achieves lower loss on this dataset
78
+
79
+ ## Future Work
80
+ - Train on full 34K dataset
81
+ - Increase LoRA rank to r=32 or r=64
82
+ - Evaluate on HumanEval benchmark