devanshty commited on
Commit
cb6c992
Β·
verified Β·
1 Parent(s): a5d5bd5

Upload README.md with huggingface_hub

Browse files
Files changed (1) hide show
  1. README.md +174 -209
README.md CHANGED
@@ -1,209 +1,174 @@
1
- ---
2
- base_model: Qwen/Qwen2.5-Coder-7B-Instruct
3
- library_name: peft
4
- pipeline_tag: text-generation
5
- tags:
6
- - base_model:adapter:Qwen/Qwen2.5-Coder-7B-Instruct
7
- - lora
8
- - sft
9
- - transformers
10
- - trl
11
- ---
12
-
13
- # Model Card for Model ID
14
-
15
- <!-- Provide a quick summary of what the model is/does. -->
16
-
17
-
18
-
19
- ## Model Details
20
-
21
- ### Model Description
22
-
23
- <!-- Provide a longer summary of what this model is. -->
24
-
25
-
26
-
27
- - **Developed by:** [More Information Needed]
28
- - **Funded by [optional]:** [More Information Needed]
29
- - **Shared by [optional]:** [More Information Needed]
30
- - **Model type:** [More Information Needed]
31
- - **Language(s) (NLP):** [More Information Needed]
32
- - **License:** [More Information Needed]
33
- - **Finetuned from model [optional]:** [More Information Needed]
34
-
35
- ### Model Sources [optional]
36
-
37
- <!-- Provide the basic links for the model. -->
38
-
39
- - **Repository:** [More Information Needed]
40
- - **Paper [optional]:** [More Information Needed]
41
- - **Demo [optional]:** [More Information Needed]
42
-
43
- ## Uses
44
-
45
- <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
46
-
47
- ### Direct Use
48
-
49
- <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
50
-
51
- [More Information Needed]
52
-
53
- ### Downstream Use [optional]
54
-
55
- <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
56
-
57
- [More Information Needed]
58
-
59
- ### Out-of-Scope Use
60
-
61
- <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
62
-
63
- [More Information Needed]
64
-
65
- ## Bias, Risks, and Limitations
66
-
67
- <!-- This section is meant to convey both technical and sociotechnical limitations. -->
68
-
69
- [More Information Needed]
70
-
71
- ### Recommendations
72
-
73
- <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
74
-
75
- Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
76
-
77
- ## How to Get Started with the Model
78
-
79
- Use the code below to get started with the model.
80
-
81
- [More Information Needed]
82
-
83
- ## Training Details
84
-
85
- ### Training Data
86
-
87
- <!-- 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. -->
88
-
89
- [More Information Needed]
90
-
91
- ### Training Procedure
92
-
93
- <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
94
-
95
- #### Preprocessing [optional]
96
-
97
- [More Information Needed]
98
-
99
-
100
- #### Training Hyperparameters
101
-
102
- - **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
103
-
104
- #### Speeds, Sizes, Times [optional]
105
-
106
- <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
107
-
108
- [More Information Needed]
109
-
110
- ## Evaluation
111
-
112
- <!-- This section describes the evaluation protocols and provides the results. -->
113
-
114
- ### Testing Data, Factors & Metrics
115
-
116
- #### Testing Data
117
-
118
- <!-- This should link to a Dataset Card if possible. -->
119
-
120
- [More Information Needed]
121
-
122
- #### Factors
123
-
124
- <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
125
-
126
- [More Information Needed]
127
-
128
- #### Metrics
129
-
130
- <!-- These are the evaluation metrics being used, ideally with a description of why. -->
131
-
132
- [More Information Needed]
133
-
134
- ### Results
135
-
136
- [More Information Needed]
137
-
138
- #### Summary
139
-
140
-
141
-
142
- ## Model Examination [optional]
143
-
144
- <!-- Relevant interpretability work for the model goes here -->
145
-
146
- [More Information Needed]
147
-
148
- ## Environmental Impact
149
-
150
- <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
151
-
152
- 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).
153
-
154
- - **Hardware Type:** [More Information Needed]
155
- - **Hours used:** [More Information Needed]
156
- - **Cloud Provider:** [More Information Needed]
157
- - **Compute Region:** [More Information Needed]
158
- - **Carbon Emitted:** [More Information Needed]
159
-
160
- ## Technical Specifications [optional]
161
-
162
- ### Model Architecture and Objective
163
-
164
- [More Information Needed]
165
-
166
- ### Compute Infrastructure
167
-
168
- [More Information Needed]
169
-
170
- #### Hardware
171
-
172
- [More Information Needed]
173
-
174
- #### Software
175
-
176
- [More Information Needed]
177
-
178
- ## Citation [optional]
179
-
180
- <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
181
-
182
- **BibTeX:**
183
-
184
- [More Information Needed]
185
-
186
- **APA:**
187
-
188
- [More Information Needed]
189
-
190
- ## Glossary [optional]
191
-
192
- <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
193
-
194
- [More Information Needed]
195
-
196
- ## More Information [optional]
197
-
198
- [More Information Needed]
199
-
200
- ## Model Card Authors [optional]
201
-
202
- [More Information Needed]
203
-
204
- ## Model Card Contact
205
-
206
- [More Information Needed]
207
- ### Framework versions
208
-
209
- - PEFT 0.19.1
 
1
+ ---
2
+ license: apache-2.0
3
+ base_model: Qwen/Qwen2.5-Coder-7B-Instruct
4
+ library_name: peft
5
+ pipeline_tag: text-generation
6
+ tags:
7
+ - code
8
+ - code-review
9
+ - bug-fixing
10
+ - qwen
11
+ - qwen2.5-coder
12
+ - qlora
13
+ - peft
14
+ - trl
15
+ - static-analysis
16
+ model-index:
17
+ - name: Code-Autopsy
18
+ results:
19
+ - task:
20
+ type: text-generation
21
+ name: Code Bug Diagnosis & Refactoring
22
+ metrics:
23
+ - name: Validation Loss
24
+ type: loss
25
+ value: 0.2442
26
+ - name: Token Accuracy
27
+ type: accuracy
28
+ value: 93.20%
29
+ ---
30
+
31
+ <div align="center">
32
+
33
+ # πŸ”¬ Code-Autopsy (QLoRA)
34
+ ### Deep Structural Bug Diagnosis & Remediation Model
35
+
36
+ [![Base Model](https://img.shields.io/badge/Base_Model-Qwen2.5--Coder--7B--Instruct-blue.svg)](https://huggingface.co/Qwen/Qwen2.5-Coder-7B-Instruct)
37
+ [![PEFT](https://img.shields.io/badge/Fine--Tuning-QLoRA_(4--bit_NF4)-purple.svg)](https://github.com/huggingface/peft)
38
+ [![W&B Cloud Run](https://img.shields.io/badge/Weights_&_Biases-Live_Dashboard-gold.svg)](https://wandb.ai/devanshtyagi1903-innothoughts/code-autopsy/runs/gc70q2q2)
39
+ [![License](https://img.shields.io/badge/License-Apache_2.0-green.svg)](LICENSE)
40
+
41
+ </div>
42
+
43
+ ---
44
+
45
+ ## πŸ“Œ Model Summary
46
+
47
+ **Code-Autopsy** is a specialized code intelligence model fine-tuned on top of **Qwen2.5-Coder-7B-Instruct** using 4-bit QLoRA. It operates like an autonomous forensic compiler: given buggy, defective, or vulnerable code snippets across Python, JavaScript, and other languages, it outputs a clean, structured diagnostic report:
48
+
49
+ 1. **Bug Identified:** Exact forensic analysis of the flaw (e.g. mutable default arguments, ZeroDivisionError, unawaited asynchronous promises, race conditions).
50
+ 2. **Root Cause:** In-depth explanation of *why* the defect occurs at the runtime/memory level.
51
+ 3. **Fixed Code:** Corrected, refactored, and production-ready implementation.
52
+
53
+ ---
54
+
55
+ ## πŸ“Š Training Metrics & Cloud Logs
56
+
57
+ The model was trained for **3 full epochs (246 steps)** on a curated dataset of code bugs and algorithmic repairs.
58
+
59
+ | Metric | Initial (Epoch 0.06) | Final (Epoch 3.0) | Delta |
60
+ | :--- | :---: | :---: | :---: |
61
+ | **Training Loss** | `2.162` | **`0.255`** | **-88.2%** πŸ“‰ |
62
+ | **Validation Loss (`eval_loss`)** | `1.397` | **`0.2442`** | **-82.5%** πŸ“‰ |
63
+ | **Token Accuracy** | `60.29%` | **`93.20%`** | **+32.91%** πŸ“ˆ |
64
+ | **Gradient Norm** | `0.27` | `0.39` | Stable |
65
+
66
+ > 🌐 **Interactive Training Logs & Loss Curves:**
67
+ > View the live dashboard, loss charts, and hardware telemetry on [Weights & Biases](https://wandb.ai/devanshtyagi1903-innothoughts/code-autopsy/runs/gc70q2q2).
68
+
69
+ ---
70
+
71
+ ## βš™οΈ Hyperparameters & Hardware Configuration
72
+
73
+ * **Base Model:** `Qwen/Qwen2.5-Coder-7B-Instruct`
74
+ * **Quantization:** 4-bit NF4 (`bitsandbytes` double quant)
75
+ * **Compute Dtype:** `bfloat16`
76
+ * **LoRA Rank ($r$):** `16`
77
+ * **LoRA Alpha ($lpha$):** `32`
78
+ * **LoRA Target Modules:** `q_proj`, `v_proj`
79
+ * **Optimizer:** `adamw_8bit`
80
+ * **Peak Learning Rate:** `2e-4` (with Cosine Decay and 5% Warmup)
81
+ * **Effective Batch Size:** `8` (Per-device `1`, Gradient Accumulation `8`)
82
+ * **Hardware:** NVIDIA GeForce RTX 5060 (8GB VRAM)
83
+
84
+ ---
85
+
86
+ ## πŸš€ Quickstart: Running Inference
87
+
88
+ ```python
89
+ import torch
90
+ from transformers import AutoModelForCausalLM, AutoTokenizer, BitsAndBytesConfig
91
+ from peft import PeftModel
92
+
93
+ BASE_MODEL = "Qwen/Qwen2.5-Coder-7B-Instruct"
94
+ ADAPTER_REPO = "devanshty/Code-Autopsy"
95
+
96
+ # 1. Load Tokenizer & 4-bit Base Model
97
+ tokenizer = AutoTokenizer.from_pretrained(BASE_MODEL, trust_remote_code=True)
98
+ bnb_config = BitsAndBytesConfig(
99
+ load_in_4bit=True,
100
+ bnb_4bit_quant_type="nf4",
101
+ bnb_4bit_compute_dtype=torch.bfloat16,
102
+ bnb_4bit_use_double_quant=True
103
+ )
104
+
105
+ base_model = AutoModelForCausalLM.from_pretrained(
106
+ BASE_MODEL,
107
+ quantization_config=bnb_config,
108
+ device_map="auto",
109
+ torch_dtype=torch.bfloat16,
110
+ trust_remote_code=True
111
+ )
112
+
113
+ # 2. Load Fine-Tuned Code-Autopsy Adapter
114
+ model = PeftModel.from_pretrained(base_model, ADAPTER_REPO)
115
+ model.eval()
116
+
117
+ # 3. Format Diagnostic Prompt
118
+ code_snippet = '''def append_item(val, lst=[]):
119
+ lst.append(val)
120
+ return lst'''
121
+
122
+ prompt = f"""<|im_start|>system
123
+ You are a code review expert. Analyze the provided code, identify any bugs or issues, explain the root cause, and provide a corrected version.<|im_end|>
124
+ <|im_start|>user
125
+ Language: python
126
+
127
+ ```python
128
+ {code_snippet}
129
+ ```<|im_end|>
130
+ <|im_start|>assistant
131
+ """
132
+
133
+ inputs = tokenizer(prompt, return_tensors="pt").to(model.device)
134
+ with torch.no_grad():
135
+ outputs = model.generate(
136
+ **inputs,
137
+ max_new_tokens=512,
138
+ do_sample=False,
139
+ pad_token_id=tokenizer.eos_token_id
140
+ )
141
+
142
+ print(tokenizer.decode(outputs[0][inputs.input_ids.shape[1]:], skip_special_tokens=True))
143
+ ```
144
+
145
+ ---
146
+
147
+ ## πŸ” Diagnostic Output Format
148
+
149
+ The model generates responses structured in Markdown:
150
+
151
+ ```markdown
152
+ ## Bug Identified
153
+ Mutable default argument `lst=[]` used in function definition.
154
+
155
+ ## Root Cause
156
+ In Python, default arguments are evaluated once when the function is defined, not each time it is called. Modifying `lst` mutates the single shared list object across subsequent calls.
157
+
158
+ ## Fixed Code
159
+ ```python
160
+ def append_item(val, lst=None):
161
+ if lst is None:
162
+ lst = []
163
+ lst.append(val)
164
+ return lst
165
+ ```
166
+ ```
167
+
168
+ ---
169
+
170
+ ## πŸ“œ Citation & Credits
171
+
172
+ * **Author:** Devansh Tyagi ([devanshty](https://huggingface.co/devanshty))
173
+ * **Base Architecture:** Alibaba Cloud Qwen Team (`Qwen2.5-Coder-7B-Instruct`)
174
+ * **Frameworks:** πŸ€— Hugging Face `transformers`, `peft`, `trl`, and Weights & Biases `wandb`.