defog/sqlcoder-34b-alpha
177108
1---2license: cc-by-4.03language:4- en5pipeline_tag: text-generation6---7 8# Defog SQLCoder9**Updated on Nov 14 to reflect benchmarks for SQLCoder-34B**10 11Defog's SQLCoder is a state-of-the-art LLM for converting natural language questions to SQL queries.12 13[Interactive Demo](https://defog.ai/sqlcoder-demo/) | [🤗 HF Repo](https://huggingface.co/defog/sqlcoder-34b-alpha) | [♾️ Colab](https://colab.research.google.com/drive/1z4rmOEiFkxkMiecAWeTUlPl0OmKgfEu7?usp=sharing) | [🐦 Twitter](https://twitter.com/defogdata)14 15## TL;DR16SQLCoder-34B is a 34B parameter model that outperforms `gpt-4` and `gpt-4-turbo` for natural language to SQL generation tasks on our [sql-eval](https://github.com/defog-ai/sql-eval) framework, and significantly outperforms all popular open-source models.17 18SQLCoder-34B is fine-tuned on a base CodeLlama model.19 20## Results on novel datasets not seen in training21| model | perc_correct |22|-|-|23| defog-sqlcoder-34b | 84.0 |24| gpt4-turbo-2023-11-09 | 82.5 |25| gpt4-2023-11-09 | 82.5 |26| defog-sqlcoder2 | 77.5 |27| gpt4-2023-08-28 | 74.0 |28| defog-sqlcoder-7b | 71.0 |29| gpt-3.5-2023-10-04 | 66.0 |30| claude-2 | 64.5 |31| gpt-3.5-2023-08-28 | 61.0 |32| claude_instant_1 | 61.0 |33| text-davinci-003 | 52.5 |34 3536 37 38## License39The code in this repo (what little there is of it) is Apache-2 licensed. The model weights have a `CC BY-SA 4.0` license. The TL;DR is that you can use and modify the model for any purpose – including commercial use. However, if you modify the weights (for example, by fine-tuning), you must open-source your modified weights under the same license terms.40 41## Training42Defog was trained on more than 20,000 human-curated questions. These questions were based on 10 different schemas. None of the schemas in the training data were included in our evaluation framework. 43 44You can read more about our [training approach](https://defog.ai/blog/open-sourcing-sqlcoder2-7b/) and [evaluation framework](https://defog.ai/blog/open-sourcing-sqleval/).45 46## Results by question category47We classified each generated question into one of 5 categories. The table displays the percentage of questions answered correctly by each model, broken down by category.48| | date | group_by | order_by | ratio | join | where |49| -------------- | ---- | -------- | -------- | ----- | ---- | ----- |50| sqlcoder-34b | 80 | 94.3 | 88.6 | 74.3 | 82.9 | 82.9 |51| gpt-4 | 68 | 94.3 | 85.7 | 77.1 | 85.7 | 80 |52| sqlcoder2-15b | 76 | 80 | 77.1 | 60 | 77.1 | 77.1 |53| sqlcoder-7b | 64 | 82.9 | 74.3 | 54.3 | 74.3 | 74.3 |54| gpt-3.5 | 68 | 77.1 | 68.6 | 37.1 | 71.4 | 74.3 |55| claude-2 | 52 | 71.4 | 74.3 | 57.1 | 65.7 | 62.9 |56| claude-instant | 48 | 71.4 | 74.3 | 45.7 | 62.9 | 60 |57| gpt-3 | 32 | 71.4 | 68.6 | 25.7 | 57.1 | 54.3 |58 59<img width="831" alt="image" src="https://github.com/defog-ai/sqlcoder/assets/5008293/79c5bdc8-373c-4abd-822e-e2c2569ed353">60 61 62## Using SQLCoder63You can use SQLCoder via the `transformers` library by downloading our model weights from the Hugging Face repo. We have added sample code for [inference](./inference.py) on a [sample database schema](./metadata.sql). 64```bash65python inference.py -q "Question about the sample database goes here"66 67# Sample question:68# Do we get more revenue from customers in New York compared to customers in San Francisco? Give me the total revenue for each city, and the difference between the two.69```70 71You can also use a demo on our website [here](https://defog.ai/sqlcoder-demo)72 73## Hardware Requirements74SQLCoder-34B has been tested on a 4xA10 GPU with `float16` weights. You can also load an 8-bit and 4-bit quantized version of the model on consumer GPUs with 20GB or more of memory – like RTX 4090, RTX 3090, and Apple M2 Pro, M2 Max, or M2 Ultra Chips with 20GB or more of memory.75 76## Todo77 78- [x] Open-source the v1 model weights79- [x] Train the model on more data, with higher data variance80- [ ] Tune the model further with Reward Modelling and RLHF81- [ ] Pretrain a model from scratch that specializes in SQL analysis82