Update README.md
Browse files
README.md
CHANGED
|
@@ -1,294 +1,9 @@
|
|
| 1 |
---
|
| 2 |
-
|
| 3 |
-
language: en
|
| 4 |
-
library_name: mlx-lm
|
| 5 |
license: apache-2.0
|
| 6 |
-
|
|
|
|
|
|
|
| 7 |
tags:
|
| 8 |
-
-
|
| 9 |
-
- g128
|
| 10 |
-
- text-generation
|
| 11 |
-
- mlx-lm
|
| 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 |
-
# Model Card for Qwen3-Coder-Next-3bit-g128
|
| 27 |
-
|
| 28 |
-
Quantized Qwen/Qwen3-Coder-Next using mlx-lm to 3-bit with group_size 128 for main weights and fine-grained group_size 64 for MoE weights, with the aim of optimizing accuracy for 3bit quantization.
|
| 29 |
-
|
| 30 |
-
## Evaluation Results
|
| 31 |
-
|
| 32 |
-
Testing with mlx_lm.evaluate using mmlu_pro with 50 Qs for each topic across all quantization levels.
|
| 33 |
-
|
| 34 |
-
### Full Quantization Spectrum Comparison
|
| 35 |
-
| Domain | 3-bit default | 3-bit g128 | 4-bit default | 4-bit g128 | 6-bit default | 6-bit g128 | 8-bit default | 8-bit g128 |
|
| 36 |
-
|---|---|---|---|---|---|---|---|---|
|
| 37 |
-
| Math | 0.94 | 0.90 | 0.92 | 0.92 | 0.90 | 0.94 | 0.92 | 0.94 |
|
| 38 |
-
| Computer Science | 0.82 | 0.84 | 0.80 | 0.84 | 0.82 | 0.86 | 0.84 | 0.90 |
|
| 39 |
-
| Engineering | 0.70 | 0.64 | 0.70 | 0.76 | 0.74 | 0.72 | 0.80 | 0.80 |
|
| 40 |
-
| Physics | 0.94 | 0.92 | 0.94 | 0.96 | 0.96 | 0.94 | 0.96 | 0.96 |
|
| 41 |
-
| Chemistry | 0.86 | 0.88 | 0.90 | 0.90 | 0.94 | 0.92 | 0.90 | 0.94 |
|
| 42 |
-
| **Average** | **0.852** | **0.836** | **0.835** | **0.865** | **0.872** | **0.876** | **0.868** | **0.888** |
|
| 43 |
-
|
| 44 |
-
### Key Observations
|
| 45 |
-
|
| 46 |
-
#### Quantization Level Impact
|
| 47 |
-
- **3-bit**:
|
| 48 |
-
- g64/default: 85.2% average
|
| 49 |
-
- g128: 83.6% average (-1.6% vs g64/default)
|
| 50 |
-
- **4-bit**:
|
| 51 |
-
- g64/default: 83.5% average
|
| 52 |
-
- g128: 86.5% average (+3.0% vs g64/default)
|
| 53 |
-
- **6-bit**:
|
| 54 |
-
- g64/default: 87.2% average
|
| 55 |
-
- g128: 87.6% average (+0.4% vs g64/default)
|
| 56 |
-
- **8-bit**:
|
| 57 |
-
- g64/default: 86.8% average
|
| 58 |
-
- g128: 88.8% average (+3.6% vs g64/default)
|
| 59 |
-
|
| 60 |
-
#### Group Size Impact Across Quantization Levels
|
| 61 |
-
| Quantization | g128 vs baseline | Performance Trend |
|
| 62 |
-
|---|---|---|
|
| 63 |
-
| 3-bit | -1.6% | g128 underperforms default |
|
| 64 |
-
| 4-bit | +3.0% | g128 significantly outperforms default |
|
| 65 |
-
| 6-bit | +0.4% | g128 slightly outperforms default |
|
| 66 |
-
| 8-bit | +3.6% | g128 significantly outperforms default |
|
| 67 |
-
|
| 68 |
-
### Important Disclaimer
|
| 69 |
-
|
| 70 |
-
**The 3-bit g128 model shows a different performance pattern compared to higher bit quantizations:**
|
| 71 |
-
|
| 72 |
-
- **3-bit**: g128 underperforms default (-1.6% difference)
|
| 73 |
-
- **4-bit**: g128 outperforms default (+3.0% difference)
|
| 74 |
-
- **6-bit**: g128 slightly outperforms default (+0.4% difference)
|
| 75 |
-
- **8-bit**: g128 significantly outperforms default (+3.6% difference)
|
| 76 |
-
|
| 77 |
-
This suggests that the group_size=128 optimization beneficial for 4-bit, 6-bit, and 8-bit quantizations does not translate to improved performance at the 3-bit level.
|
| 78 |
-
|
| 79 |
-
## Usage
|
| 80 |
-
|
| 81 |
-
```python
|
| 82 |
-
import mlx_lm
|
| 83 |
-
|
| 84 |
-
model_path = "petergilani/Qwen3-Coder-Next-3bit-g128"
|
| 85 |
-
model, tokenizer = mlx_lm.load(model_path)
|
| 86 |
-
|
| 87 |
-
prompt = "Write a Python function to calculate the factorial of a number."
|
| 88 |
-
response = mlx_lm.generate(model, tokenizer, prompt=prompt)
|
| 89 |
-
print(response)
|
| 90 |
-
```
|
| 91 |
-
|
| 92 |
-
## Conversion Details
|
| 93 |
-
|
| 94 |
-
The model was converted using mlx_lm.convert with the following parameters:
|
| 95 |
-
- q_bits=3
|
| 96 |
-
- q_group_size=128
|
| 97 |
-
- Quantization: 3-bit with main weights and fine-grained group_size 64 for MoE weights
|
| 98 |
-
- Sampling parameters used for evaluation: temp=1.0, top_p=0.95, top_k=40
|
| 99 |
-
|
| 100 |
-
## Evaluation Methodology
|
| 101 |
-
|
| 102 |
-
- Tasks: MMLU Pro (math, computer science, engineering, physics, chemistry)
|
| 103 |
-
- Questions per topic: 50
|
| 104 |
-
- Evaluation framework: mlx_lm.evaluate
|
| 105 |
-
- Sampling: temperature=1.0, top_p=0.95, top_k=40, num_shots=1
|
| 106 |
-
|
| 107 |
-
## Model Details
|
| 108 |
-
|
| 109 |
-
- **Base Model:** Qwen/Qwen3-Coder-Next
|
| 110 |
-
- **Library:** mlx-lm
|
| 111 |
-
- **Quantization:** 3-bit with group_size 128 for main weights and group_size 64 for MoE weights
|
| 112 |
-
- **License:** apache-2.0
|
| 113 |
-
- **Pipeline Tag:** text-generation
|
| 114 |
-
|
| 115 |
-
- **Developed by:** petergilani
|
| 116 |
-
- **Funded by [optional]:** [More Information Needed]
|
| 117 |
-
- **Shared by [optional]:** [More Information Needed]
|
| 118 |
-
- **Model type:** [More Information Needed]
|
| 119 |
-
- **Language(s) (NLP):** en
|
| 120 |
-
- **License:** apache-2.0
|
| 121 |
-
- **Finetuned from model [optional]:** Qwen/Qwen3-Coder-Next
|
| 122 |
-
|
| 123 |
-
### Model Sources [optional]
|
| 124 |
-
|
| 125 |
-
<!-- Provide the basic links for the model. -->
|
| 126 |
-
|
| 127 |
-
- **Repository:** https://huggingface.co/petergilani/Qwen3-Coder-Next-3bit-g128
|
| 128 |
-
- **Paper [optional]:** [More Information Needed]
|
| 129 |
-
- **Demo [optional]:** [More Information Needed]
|
| 130 |
-
|
| 131 |
-
## Uses
|
| 132 |
-
|
| 133 |
-
<!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
|
| 134 |
-
|
| 135 |
-
### Direct Use
|
| 136 |
-
|
| 137 |
-
<!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
|
| 138 |
-
|
| 139 |
-
[More Information Needed]
|
| 140 |
-
|
| 141 |
-
### Downstream Use [optional]
|
| 142 |
-
|
| 143 |
-
<!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
|
| 144 |
-
|
| 145 |
-
[More Information Needed]
|
| 146 |
-
|
| 147 |
-
### Out-of-Scope Use
|
| 148 |
-
|
| 149 |
-
<!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
|
| 150 |
-
|
| 151 |
-
[More Information Needed]
|
| 152 |
-
|
| 153 |
-
## Bias, Risks, and Limitations
|
| 154 |
-
|
| 155 |
-
<!-- This section is meant to convey both technical and sociotechnical limitations. -->
|
| 156 |
-
|
| 157 |
-
[More Information Needed]
|
| 158 |
-
|
| 159 |
-
### Recommendations
|
| 160 |
-
|
| 161 |
-
<!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
|
| 162 |
-
|
| 163 |
-
Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
|
| 164 |
-
|
| 165 |
-
## How to Get Started with the Model
|
| 166 |
-
|
| 167 |
-
Use the code below to get started with the model.
|
| 168 |
-
|
| 169 |
-
[More Information Needed]
|
| 170 |
-
|
| 171 |
-
## Training Details
|
| 172 |
-
|
| 173 |
-
### Training Data
|
| 174 |
-
|
| 175 |
-
<!-- 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. -->
|
| 176 |
-
|
| 177 |
-
[More Information Needed]
|
| 178 |
-
|
| 179 |
-
### Training Procedure
|
| 180 |
-
|
| 181 |
-
<!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
|
| 182 |
-
|
| 183 |
-
#### Preprocessing [optional]
|
| 184 |
-
|
| 185 |
-
[More Information Needed]
|
| 186 |
-
|
| 187 |
-
|
| 188 |
-
#### Training Hyperparameters
|
| 189 |
-
|
| 190 |
-
- **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
|
| 191 |
-
|
| 192 |
-
#### Speeds, Sizes, Times [optional]
|
| 193 |
-
|
| 194 |
-
<!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
|
| 195 |
-
|
| 196 |
-
[More Information Needed]
|
| 197 |
-
|
| 198 |
-
## Evaluation
|
| 199 |
-
|
| 200 |
-
<!-- This section describes the evaluation protocols and provides the results. -->
|
| 201 |
-
|
| 202 |
-
### Testing Data, Factors & Metrics
|
| 203 |
-
|
| 204 |
-
#### Testing Data
|
| 205 |
-
|
| 206 |
-
<!-- This should link to a Dataset Card if possible. -->
|
| 207 |
-
|
| 208 |
-
[More Information Needed]
|
| 209 |
-
|
| 210 |
-
#### Factors
|
| 211 |
-
|
| 212 |
-
<!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
|
| 213 |
-
|
| 214 |
-
[More Information Needed]
|
| 215 |
-
|
| 216 |
-
#### Metrics
|
| 217 |
-
|
| 218 |
-
<!-- These are the evaluation metrics being used, ideally with a description of why. -->
|
| 219 |
-
|
| 220 |
-
[More Information Needed]
|
| 221 |
-
|
| 222 |
-
### Results
|
| 223 |
-
|
| 224 |
-
[More Information Needed]
|
| 225 |
-
|
| 226 |
-
#### Summary
|
| 227 |
-
|
| 228 |
-
|
| 229 |
-
|
| 230 |
-
## Model Examination [optional]
|
| 231 |
-
|
| 232 |
-
<!-- Relevant interpretability work for the model goes here -->
|
| 233 |
-
|
| 234 |
-
[More Information Needed]
|
| 235 |
-
|
| 236 |
-
## Environmental Impact
|
| 237 |
-
|
| 238 |
-
<!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
|
| 239 |
-
|
| 240 |
-
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).
|
| 241 |
-
|
| 242 |
-
- **Hardware Type:** [More Information Needed]
|
| 243 |
-
- **Hours used:** [More Information Needed]
|
| 244 |
-
- **Cloud Provider:** [More Information Needed]
|
| 245 |
-
- **Compute Region:** [More Information Needed]
|
| 246 |
-
- **Carbon Emitted:** [More Information Needed]
|
| 247 |
-
|
| 248 |
-
## Technical Specifications [optional]
|
| 249 |
-
|
| 250 |
-
### Model Architecture and Objective
|
| 251 |
-
|
| 252 |
-
[More Information Needed]
|
| 253 |
-
|
| 254 |
-
### Compute Infrastructure
|
| 255 |
-
|
| 256 |
-
[More Information Needed]
|
| 257 |
-
|
| 258 |
-
#### Hardware
|
| 259 |
-
|
| 260 |
-
[More Information Needed]
|
| 261 |
-
|
| 262 |
-
#### Software
|
| 263 |
-
|
| 264 |
-
[More Information Needed]
|
| 265 |
-
|
| 266 |
-
## Citation [optional]
|
| 267 |
-
|
| 268 |
-
<!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
|
| 269 |
-
|
| 270 |
-
**BibTeX:**
|
| 271 |
-
|
| 272 |
-
[More Information Needed]
|
| 273 |
-
|
| 274 |
-
**APA:**
|
| 275 |
-
|
| 276 |
-
[More Information Needed]
|
| 277 |
-
|
| 278 |
-
## Glossary [optional]
|
| 279 |
-
|
| 280 |
-
<!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
|
| 281 |
-
|
| 282 |
-
[More Information Needed]
|
| 283 |
-
|
| 284 |
-
## More Information [optional]
|
| 285 |
-
|
| 286 |
-
[More Information Needed]
|
| 287 |
-
|
| 288 |
-
## Model Card Authors [optional]
|
| 289 |
-
|
| 290 |
-
[More Information Needed]
|
| 291 |
-
|
| 292 |
-
## Model Card Contact
|
| 293 |
-
|
| 294 |
-
[More Information Needed]
|
|
|
|
| 1 |
---
|
| 2 |
+
library_name: mlx
|
|
|
|
|
|
|
| 3 |
license: apache-2.0
|
| 4 |
+
license_link: https://huggingface.co/Qwen/Qwen3-Coder-Next/blob/main/LICENSE
|
| 5 |
+
pipeline_tag: text-generation
|
| 6 |
+
base_model: Qwen/Qwen3-Coder-Next
|
| 7 |
tags:
|
| 8 |
+
- mlx
|
|
|
|
|
|
|
|
|
|
| 9 |
---
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|