README.md

---
base_model: onekq-ai/OneSQL-v0.1-Qwen-1.5B
tags:
- text-generation-inference
- transformers
- qwen2
- gguf
license: apache-2.0
language:
- en
---

# Introduction

This model is the GGUF version of [OneSQL-v0.1-Qwen-1.5B](https://huggingface.co/onekq-ai/OneSQL-v0.1-Qwen-1.5B). You can also find it on [Ollama](https://ollama.com/onekq/OneSQL-v0.1-Qwen).

# Performances

The self-evaluation EX score of the original model is **31.55** (compared to **63.33** by the 32B model on the [BIRD leaderboard](https://bird-bench.github.io/).
Below is the self-evaluation results for each quantization.

| Quantization |EX score|
|------------|------|
| Q2_K       | 2.50 |
| Q3_K_S     | 9.85 |
| Q3_K_M     | 11.80 |
| Q3_K_L     | 11.80 |
| Q4_0       | 13.77 |
| Q4_1       | 12.74 |
| Q4_K_S     | 13.32 |
| Q4_K_M     | 12.39 |
| Q5_0       | 13.95 |
| Q5_1       | 13.05 |
| **Q5_K_S**     | **14.36** |
| Q5_K_M     | 14.10 |
| Q6_K       | 13.95 |
| Q8_0       | 13.24 |

# Quick start

To use this model, craft your prompt to start with your database schema in the form of **CREATE TABLE**, followed by your natural language query preceded by **--**.
Make sure your prompt ends with **SELECT** in order for the model to finish the query for you. There is no need to set other parameters like temperature or max token limit.

```sh
PROMPT="CREATE TABLE students (
    id INTEGER PRIMARY KEY,
    name TEXT,
    age INTEGER,
    grade TEXT
);

-- Find the three youngest students
SELECT "

ollama run onekq-ai/OneSQL-v0.1-Qwen:1.5B-Q5_K_S "$PROMPT"
```

The model response is the finished SQL query without **SELECT**
```sql
* FROM students ORDER BY age ASC LIMIT 3
```

# Caveats

The performance drop from the original model is due to quantization itself, and the lack of beam search support in llama.cpp framework. Use at your own discretion.