parthtamu commited on
Commit
04e3534
·
verified ·
1 Parent(s): ee89432

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +105 -166
README.md CHANGED
@@ -1,199 +1,138 @@
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
+ base_model: meta-llama/Llama-3.2-3B
5
+ datasets:
6
+ - sahil2801/CodeAlpaca-20k
7
+ tags:
8
+ - code-generation
9
+ - lora
10
+ - qlora
11
+ - peft
12
+ - fine-tuned
13
+ - llama
14
+ - instruction-tuning
15
+ library_name: peft
16
+ pipeline_tag: text-generation
17
  ---
18
 
19
+ # Llama-3.2-3B · CodeAlpaca LoRA Adapter
 
 
20
 
21
+ A LoRA adapter fine-tuned on [CodeAlpaca-20k](https://huggingface.co/datasets/sahil2801/CodeAlpaca-20k)
22
+ for instruction-following code generation tasks. Built on top of
23
+ [meta-llama/Llama-3.2-3B](https://huggingface.co/meta-llama/Llama-3.2-3B) with
24
+ 4-bit NF4 quantization via `bitsandbytes`. Only **~1% of parameters** are
25
+ trainable — the rest of the base model is frozen.
26
 
27
+ ---
28
 
29
  ## Model Details
30
 
31
+ | Field | Value |
32
+ |------------------|--------------------------------------------|
33
+ | **Base Model** | meta-llama/Llama-3.2-3B |
34
+ | **Adapter Type** | LoRA (via PEFT) |
35
+ | **Task** | Instruction-following code generation |
36
+ | **Language** | English |
37
+ | **License** | MIT |
38
+ | **Author** | Parth Deshmukh |
39
+ | **Date** | April 2026 |
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
40
 
41
+ ---
42
 
43
+ ## Training Configuration
44
+
45
+ | Config | Value |
46
+ |----------------------|-------------------------------------------------|
47
+ | **LoRA Rank (r)** | 8 |
48
+ | **LoRA Alpha** | 16 |
49
+ | **LoRA Dropout** | 0.05 |
50
+ | **Target Modules** | `q_proj`, `v_proj` |
51
+ | **Quantization** | 4-bit NF4 (`bitsandbytes` BitsAndBytesConfig) |
52
+ | **Compute dtype** | float16 |
53
+ | **Batch size** | 2 (+ gradient accumulation steps = 4) |
54
+ | **Mixed Precision** | fp16 |
55
+ | **Hardware** | Google Colab T4 GPU (16GB VRAM) |
56
+ | **Experiment Tracking** | MLflow + Weights & Biases |
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
57
 
58
+ ---
59
 
60
+ ## Dataset
61
 
62
+ - **Name:** [CodeAlpaca-20k](https://huggingface.co/datasets/sahil2801/CodeAlpaca-20k)
63
+ - **Size:** ~20,000 code instruction samples
64
+ - **Split:** 90/10 train/test (~18,000 train, ~2,000 test)
65
+ - **Columns:** `instruction`, `input`, `output`
66
+ - **Prompt format:**
67
+ Instruction:
68
+ {instruction}
69
 
70
+ Input:
71
+ {input}
72
 
73
+ Response:
74
+ {output}
75
 
76
+ text
77
 
78
+ ---
79
 
80
+ ## Evaluation Results
81
 
82
+ Evaluated on **200 held-out test samples** from CodeAlpaca-20k using 4-bit
83
+ quantized inference. Metrics computed with `evaluate` (ROUGE-L) and
84
+ `bert_score` (BERTScore-F1).
85
 
86
+ | Model | ROUGE-L | BERTScore-F1 |
87
+ |------------------------------------|---------|--------------|
88
+ | Base (Llama-3.2-3B, no adapter) | 0.3303 | 0.7835 |
89
+ | **Fine-tuned (this adapter)** | **0.5458** | **0.8856** |
90
+ | **Delta** | **+0.2155 (+65.2%)** | **+0.1021 (+13.0%)** |
91
 
92
+ > ROUGE-L of 0.5458 is at the top of the competitive range for fine-tuned
93
+ > code generation models (0.43–0.55), confirming that LoRA fine-tuning
94
+ > successfully taught the model consistent instruction-following and code
95
+ > formatting behavior.
96
 
97
+ ---
98
 
99
+ ## How to Use
100
 
101
+ Load the base model with 4-bit quantization, then apply this adapter using
102
+ PEFT's `PeftModel.from_pretrained()`.
103
 
104
+ **Prompt format:**
105
+ Instruction:
106
+ Write a Python function that reverses a string.
107
 
108
+ Input:
109
+ Response:
110
+ text
111
 
112
+ **Inference parameters used during evaluation:**
113
+ - `max_new_tokens`: 200
114
+ - `do_sample`: False
115
+ - `repetition_penalty`: 1.1
116
+ - `pad_token_id`: tokenizer.eos_token_id
117
 
118
+ ---
119
 
120
+ ## Limitations
121
 
122
+ - Trained for only **1–3 epochs** on 18k samples — may struggle with highly
123
+ complex or multi-file code tasks.
124
+ - Optimized for **single-instruction, single-response** code generation;
125
+ not designed for multi-turn conversation.
126
+ - Performance is measured on CodeAlpaca-style prompts; may degrade on very
127
+ different prompt formats.
128
+ - Base model is **3B parameters** — larger models (7B+) would likely achieve
129
+ higher absolute scores.
130
 
131
+ ---
132
 
133
+ ## Project
134
 
135
+ This adapter was built as part of a 7-day end-to-end LLM fine-tuning project
136
+ covering LoRA/QLoRA concepts, dataset preparation, training, evaluation,
137
+ deployment, and CI/CD. Full project repository:
138
+ [github.com/your-username/llm-lora-finetuning](https://github.com/your-username/llm-lora-finetuning)