varuneshv commited on
Commit
fc50658
·
verified ·
1 Parent(s): 74112ba

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +125 -151
README.md CHANGED
@@ -1,210 +1,184 @@
1
  ---
2
- base_model: unsloth/qwen2.5-coder-3b-instruct-bnb-4bit
3
- library_name: peft
4
- pipeline_tag: text-generation
5
  tags:
6
- - base_model:adapter:unsloth/qwen2.5-coder-3b-instruct-bnb-4bit
7
- - lora
8
- - sft
9
- - transformers
10
- - trl
11
  - unsloth
 
 
 
 
 
 
12
  ---
13
 
14
- # Model Card for Model ID
15
-
16
- <!-- Provide a quick summary of what the model is/does. -->
17
 
 
18
 
 
19
 
20
  ## Model Details
21
 
22
- ### Model Description
23
-
24
- <!-- Provide a longer summary of what this model is. -->
25
-
26
-
27
-
28
- - **Developed by:** [More Information Needed]
29
- - **Funded by [optional]:** [More Information Needed]
30
- - **Shared by [optional]:** [More Information Needed]
31
- - **Model type:** [More Information Needed]
32
- - **Language(s) (NLP):** [More Information Needed]
33
- - **License:** [More Information Needed]
34
- - **Finetuned from model [optional]:** [More Information Needed]
35
-
36
- ### Model Sources [optional]
37
-
38
- <!-- Provide the basic links for the model. -->
39
-
40
- - **Repository:** [More Information Needed]
41
- - **Paper [optional]:** [More Information Needed]
42
- - **Demo [optional]:** [More Information Needed]
43
-
44
- ## Uses
45
-
46
- <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
47
-
48
- ### Direct Use
49
-
50
- <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
51
-
52
- [More Information Needed]
53
-
54
- ### Downstream Use [optional]
55
-
56
- <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
57
-
58
- [More Information Needed]
59
-
60
- ### Out-of-Scope Use
61
-
62
- <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
63
-
64
- [More Information Needed]
65
-
66
- ## Bias, Risks, and Limitations
67
-
68
- <!-- This section is meant to convey both technical and sociotechnical limitations. -->
69
-
70
- [More Information Needed]
71
-
72
- ### Recommendations
73
-
74
- <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
75
 
76
- Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
77
-
78
- ## How to Get Started with the Model
79
-
80
- Use the code below to get started with the model.
81
-
82
- [More Information Needed]
83
-
84
- ## Training Details
85
-
86
- ### Training Data
87
-
88
- <!-- 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. -->
89
-
90
- [More Information Needed]
91
-
92
- ### Training Procedure
93
-
94
- <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
95
-
96
- #### Preprocessing [optional]
97
-
98
- [More Information Needed]
99
-
100
-
101
- #### Training Hyperparameters
102
-
103
- - **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
104
-
105
- #### Speeds, Sizes, Times [optional]
106
-
107
- <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
108
-
109
- [More Information Needed]
110
-
111
- ## Evaluation
112
 
113
- <!-- This section describes the evaluation protocols and provides the results. -->
114
 
115
- ### Testing Data, Factors & Metrics
116
 
117
- #### Testing Data
 
 
 
 
118
 
119
- <!-- This should link to a Dataset Card if possible. -->
120
 
121
- [More Information Needed]
122
 
123
- #### Factors
 
124
 
125
- <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
126
 
127
- [More Information Needed]
 
 
 
128
 
129
- #### Metrics
130
 
131
- <!-- These are the evaluation metrics being used, ideally with a description of why. -->
 
 
132
 
133
- [More Information Needed]
134
 
135
- ### Results
136
 
137
- [More Information Needed]
138
 
139
- #### Summary
140
 
 
 
 
 
141
 
 
142
 
143
- ## Model Examination [optional]
 
 
144
 
145
- <!-- Relevant interpretability work for the model goes here -->
146
 
147
- [More Information Needed]
 
 
 
148
 
149
- ## Environmental Impact
150
 
151
- <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
152
 
153
- 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).
 
 
 
 
 
 
 
154
 
155
- - **Hardware Type:** [More Information Needed]
156
- - **Hours used:** [More Information Needed]
157
- - **Cloud Provider:** [More Information Needed]
158
- - **Compute Region:** [More Information Needed]
159
- - **Carbon Emitted:** [More Information Needed]
160
 
161
- ## Technical Specifications [optional]
162
 
163
- ### Model Architecture and Objective
164
 
165
- [More Information Needed]
 
 
 
 
166
 
167
- ### Compute Infrastructure
168
 
169
- [More Information Needed]
170
 
171
- #### Hardware
 
 
172
 
173
- [More Information Needed]
174
 
175
- #### Software
 
 
176
 
177
- [More Information Needed]
178
 
179
- ## Citation [optional]
 
 
180
 
181
- <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
182
 
183
- **BibTeX:**
184
 
185
- [More Information Needed]
186
 
187
- **APA:**
188
 
189
- [More Information Needed]
190
 
191
- ## Glossary [optional]
 
 
 
 
192
 
193
- <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
194
 
195
- [More Information Needed]
196
 
197
- ## More Information [optional]
 
 
 
198
 
199
- [More Information Needed]
200
 
201
- ## Model Card Authors [optional]
202
 
203
- [More Information Needed]
 
 
 
204
 
205
- ## Model Card Contact
206
 
207
- [More Information Needed]
208
- ### Framework versions
209
 
210
- - PEFT 0.19.1
 
 
 
 
 
 
 
 
1
  ---
2
+ license: apache-2.0
3
+ base_model: Qwen/Qwen2.5-Coder-3B-Instruct
 
4
  tags:
5
+ - code-generation
6
+ - python
7
+ - qwen
 
 
8
  - unsloth
9
+ - lora
10
+ - gguf
11
+ - coding-assistant
12
+ language:
13
+ - en
14
+ pipeline_tag: text-generation
15
  ---
16
 
17
+ # VCoder
 
 
18
 
19
+ VCoder is a Python-focused coding assistant fine-tuned from Qwen2.5-Coder-3B-Instruct using LoRA and Unsloth.
20
 
21
+ The model was trained on 15,000 Python instruction-response examples from the Python Code Instructions 15K dataset and optimized for Python code generation, problem solving, debugging, and algorithm implementation.
22
 
23
  ## Model Details
24
 
25
+ | Attribute | Value |
26
+ |------------|---------|
27
+ | Base Model | Qwen2.5-Coder-3B-Instruct |
28
+ | Fine-Tuning Method | LoRA |
29
+ | Framework | Unsloth |
30
+ | Dataset | Python Code Instructions 15K |
31
+ | Training Samples | 15,000 |
32
+ | GPU | NVIDIA Tesla T4 |
33
+ | Quantized Format | GGUF Q8_0 |
34
+ | Primary Language | Python |
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
35
 
36
+ ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
37
 
38
+ ## Training Pipeline
39
 
40
+ Training was performed incrementally:
41
 
42
+ | Stage | Samples |
43
+ |---------|---------|
44
+ | Stage 1 | 0 - 5,000 |
45
+ | Stage 2 | 5,000 - 10,000 |
46
+ | Stage 3 | 10,000 - 15,000 |
47
 
48
+ The model was trained using parameter-efficient fine-tuning (LoRA), allowing adaptation of the base model while keeping computational requirements low.
49
 
50
+ ---
51
 
52
+ ## Benchmark Results
53
+ ### HumanEval Comparison
54
 
55
+ The model was evaluated against the original Qwen2.5-Coder-3B-Instruct on HumanEval coding tasks.
56
 
57
+ | Model | Pass@1 |
58
+ |---------|---------|
59
+ | Base Qwen2.5-Coder-3B | 61.0% |
60
+ | VCoder | 68.0% |
61
 
62
+ ### Improvement
63
 
64
+ ```text
65
+ +7.0% Pass@1 improvement
66
+ ```
67
 
68
+ This demonstrates that the fine-tuned model performs better on Python coding tasks than the original base model.
69
 
70
+ ---
71
 
72
+ ## Example Usage
73
 
74
+ ### Python
75
 
76
+ ```python
77
+ prompt = """
78
+ ### Instruction:
79
+ Write a Python function to reverse a string.
80
 
81
+ ### Input:
82
 
83
+ ### Response:
84
+ """
85
+ ```
86
 
87
+ ### Example Output
88
 
89
+ ```python
90
+ def reverse_string(text):
91
+ return text[::-1]
92
+ ```
93
 
94
+ ---
95
 
96
+ ## Supported Tasks
97
 
98
+ - Python Code Generation
99
+ - Algorithm Design
100
+ - Data Structures
101
+ - Debugging
102
+ - Code Refactoring
103
+ - Coding Interview Questions
104
+ - Competitive Programming
105
+ - Function Completion
106
 
107
+ ---
 
 
 
 
108
 
109
+ ## GGUF Usage
110
 
111
+ Compatible with:
112
 
113
+ - Ollama
114
+ - LM Studio
115
+ - llama.cpp
116
+ - Open WebUI
117
+ - Jan
118
 
119
+ ### Ollama
120
 
121
+ Create a Modelfile:
122
 
123
+ ```text
124
+ FROM ./VCoder.Q8_0.gguf
125
+ ```
126
 
127
+ Build:
128
 
129
+ ```bash
130
+ ollama create vcoder -f Modelfile
131
+ ```
132
 
133
+ Run:
134
 
135
+ ```bash
136
+ ollama run vcoder
137
+ ```
138
 
139
+ ---
140
 
141
+ ## Training Dataset
142
 
143
+ Dataset used:
144
 
145
+ Python Code Instructions 15K
146
 
147
+ The dataset contains instruction-response pairs focused on Python programming tasks including:
148
 
149
+ - Function generation
150
+ - Data manipulation
151
+ - Algorithms
152
+ - Debugging
153
+ - Problem solving
154
 
155
+ ---
156
 
157
+ ## Limitations
158
 
159
+ - Primarily optimized for Python.
160
+ - Benchmark performed on a subset of HumanEval tasks.
161
+ - May generate incorrect code for highly specialized domains.
162
+ - Should not be used as the sole source of production-critical code.
163
 
164
+ ---
165
 
166
+ ## Acknowledgements
167
 
168
+ - Qwen Team for Qwen2.5-Coder
169
+ - Unsloth for efficient fine-tuning
170
+ - Hugging Face
171
+ - OpenAI HumanEval Benchmark
172
 
173
+ ---
174
 
175
+ ## Citation
 
176
 
177
+ ```bibtex
178
+ @misc{vcoder2026,
179
+ title={VCoder: Python Code Generation Model},
180
+ author={Varunesh V, Prawin R K, Sarguru N},
181
+ year={2026},
182
+ base_model={Qwen2.5-Coder-3B-Instruct}
183
+ }
184
+ ```