prawinrk commited on
Commit
75d96c1
·
verified ·
1 Parent(s): 1eecd31

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +126 -149
README.md CHANGED
@@ -1,210 +1,187 @@
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
 
54
+ ![Output](https://cdn-uploads.huggingface.co/production/uploads/6a297050d3837ea7b12cc42f/BV8FY6fJN7KQ43jcpC6hr.png)
55
 
56
+ ### HumanEval Comparison
57
 
58
+ The model was evaluated against the original Qwen2.5-Coder-3B-Instruct on HumanEval coding tasks.
59
 
60
+ | Model | Pass@1 |
61
+ |---------|---------|
62
+ | Base Qwen2.5-Coder-3B | 61.0% |
63
+ | VCoder | 68.0% |
64
 
65
+ ### Improvement
66
 
67
+ ```text
68
+ +7.0% Pass@1 improvement
69
+ ```
70
 
71
+ This demonstrates that the fine-tuned model performs better on Python coding tasks than the original base model.
72
 
73
+ ---
74
 
75
+ ## Example Usage
76
 
77
+ ### Python
78
 
79
+ ```python
80
+ prompt = """
81
+ ### Instruction:
82
+ Write a Python function to reverse a string.
83
 
84
+ ### Input:
85
 
86
+ ### Response:
87
+ """
88
+ ```
89
 
90
+ ### Example Output
91
 
92
+ ```python
93
+ def reverse_string(text):
94
+ return text[::-1]
95
+ ```
96
 
97
+ ---
98
 
99
+ ## Supported Tasks
100
 
101
+ - Python Code Generation
102
+ - Algorithm Design
103
+ - Data Structures
104
+ - Debugging
105
+ - Code Refactoring
106
+ - Coding Interview Questions
107
+ - Competitive Programming
108
+ - Function Completion
109
 
110
+ ---
 
 
 
 
111
 
112
+ ## GGUF Usage
113
 
114
+ Compatible with:
115
 
116
+ - Ollama
117
+ - LM Studio
118
+ - llama.cpp
119
+ - Open WebUI
120
+ - Jan
121
 
122
+ ### Ollama
123
 
124
+ Create a Modelfile:
125
 
126
+ ```text
127
+ FROM ./VCoder.Q8_0.gguf
128
+ ```
129
 
130
+ Build:
131
 
132
+ ```bash
133
+ ollama create vcoder -f Modelfile
134
+ ```
135
 
136
+ Run:
137
 
138
+ ```bash
139
+ ollama run vcoder
140
+ ```
141
 
142
+ ---
143
 
144
+ ## Training Dataset
145
 
146
+ Dataset used:
147
 
148
+ Python Code Instructions 15K
149
 
150
+ The dataset contains instruction-response pairs focused on Python programming tasks including:
151
 
152
+ - Function generation
153
+ - Data manipulation
154
+ - Algorithms
155
+ - Debugging
156
+ - Problem solving
157
 
158
+ ---
159
 
160
+ ## Limitations
161
 
162
+ - Primarily optimized for Python.
163
+ - Benchmark performed on a subset of HumanEval tasks.
164
+ - May generate incorrect code for highly specialized domains.
165
+ - Should not be used as the sole source of production-critical code.
166
 
167
+ ---
168
 
169
+ ## Acknowledgements
170
 
171
+ - Qwen Team for Qwen2.5-Coder
172
+ - Unsloth for efficient fine-tuning
173
+ - Hugging Face
174
+ - OpenAI HumanEval Benchmark
175
 
176
+ ---
177
 
178
+ ## Citation
 
179
 
180
+ ```bibtex
181
+ @misc{vcoder2026,
182
+ title={VCoder: Python Code Generation Model},
183
+ author={Varunesh V, Prawin R K, Sarguru N},
184
+ year={2026},
185
+ base_model={Qwen2.5-Coder-3B-Instruct}
186
+ }
187
+ ```