Create README.md

2024-09-12 19:14:44 +08:00
parent 7b6a14e3e9
commit d882c0faa0
17 changed files with 148 additions and 54 deletions
--- a/.gitattributes
+++ b/.gitattributes
@@ -1,37 +1,49 @@
 *.7z filter=lfs diff=lfs merge=lfs -text
 *.arrow filter=lfs diff=lfs merge=lfs -text
 *.bin filter=lfs diff=lfs merge=lfs -text
-*.bin.* filter=lfs diff=lfs merge=lfs -text
 *.bz2 filter=lfs diff=lfs merge=lfs -text
+*.ckpt filter=lfs diff=lfs merge=lfs -text
 *.ftz filter=lfs diff=lfs merge=lfs -text
 *.gz filter=lfs diff=lfs merge=lfs -text
 *.h5 filter=lfs diff=lfs merge=lfs -text
 *.joblib filter=lfs diff=lfs merge=lfs -text
 *.lfs.* filter=lfs diff=lfs merge=lfs -text
+*.mlmodel filter=lfs diff=lfs merge=lfs -text
 *.model filter=lfs diff=lfs merge=lfs -text
 *.msgpack filter=lfs diff=lfs merge=lfs -text
+*.npy filter=lfs diff=lfs merge=lfs -text
+*.npz filter=lfs diff=lfs merge=lfs -text
 *.onnx filter=lfs diff=lfs merge=lfs -text
 *.ot filter=lfs diff=lfs merge=lfs -text
 *.parquet filter=lfs diff=lfs merge=lfs -text
 *.pb filter=lfs diff=lfs merge=lfs -text
+*.pickle filter=lfs diff=lfs merge=lfs -text
+*.pkl filter=lfs diff=lfs merge=lfs -text
 *.pt filter=lfs diff=lfs merge=lfs -text
 *.pth filter=lfs diff=lfs merge=lfs -text
 *.rar filter=lfs diff=lfs merge=lfs -text
+*.safetensors filter=lfs diff=lfs merge=lfs -text
 saved_model/**/* filter=lfs diff=lfs merge=lfs -text
 *.tar.* filter=lfs diff=lfs merge=lfs -text
+*.tar filter=lfs diff=lfs merge=lfs -text
 *.tflite filter=lfs diff=lfs merge=lfs -text
 *.tgz filter=lfs diff=lfs merge=lfs -text
+*.wasm filter=lfs diff=lfs merge=lfs -text
 *.xz filter=lfs diff=lfs merge=lfs -text
 *.zip filter=lfs diff=lfs merge=lfs -text
-*.zstandard filter=lfs diff=lfs merge=lfs -text
-*.tfevents* filter=lfs diff=lfs merge=lfs -text
-*.db* filter=lfs diff=lfs merge=lfs -text
-*.ark* filter=lfs diff=lfs merge=lfs -text
-**/*ckpt*data* filter=lfs diff=lfs merge=lfs -text
-**/*ckpt*.meta filter=lfs diff=lfs merge=lfs -text
-**/*ckpt*.index filter=lfs diff=lfs merge=lfs -text
-*.safetensors filter=lfs diff=lfs merge=lfs -text
-*.ckpt filter=lfs diff=lfs merge=lfs -text
-*.gguf* filter=lfs diff=lfs merge=lfs -text
-*.ggml filter=lfs diff=lfs merge=lfs -text
-*.llamafile* filter=lfs diff=lfs merge=lfs -text
+*.zst filter=lfs diff=lfs merge=lfs -text
+*tfevents* filter=lfs diff=lfs merge=lfs -text
+sqlcoder-7b-2.Q2_K.gguf filter=lfs diff=lfs merge=lfs -text
+sqlcoder-7b-2.Q4_K_S.gguf filter=lfs diff=lfs merge=lfs -text
+sqlcoder-7b-2.Q4_K_M.gguf filter=lfs diff=lfs merge=lfs -text
+sqlcoder-7b-2.Q3_K_L.gguf filter=lfs diff=lfs merge=lfs -text
+sqlcoder-7b-2.Q3_K_M.gguf filter=lfs diff=lfs merge=lfs -text
+sqlcoder-7b-2.Q3_K_S.gguf filter=lfs diff=lfs merge=lfs -text
+sqlcoder-7b-2.Q8_0.gguf filter=lfs diff=lfs merge=lfs -text
+sqlcoder-7b-2.Q6_K.gguf filter=lfs diff=lfs merge=lfs -text
+sqlcoder-7b-2.Q5_K_M.gguf filter=lfs diff=lfs merge=lfs -text
+sqlcoder-7b-2.Q5_K_S.gguf filter=lfs diff=lfs merge=lfs -text
+sqlcoder-7b-2.Q5_0.gguf filter=lfs diff=lfs merge=lfs -text
+sqlcoder-7b-2.Q5_1.gguf filter=lfs diff=lfs merge=lfs -text
+sqlcoder-7b-2.Q4_1.gguf filter=lfs diff=lfs merge=lfs -text
+sqlcoder-7b-2.Q4_0.gguf filter=lfs diff=lfs merge=lfs -text
--- a/README.md
+++ b/README.md
@@ -1,47 +1,86 @@
 ---
-license: Apache License 2.0
-
-#model-type:
-##如 gpt、phi、llama、chatglm、baichuan 等
-#- gpt
-
-#domain:
-##如 nlp、cv、audio、multi-modal
-#- nlp
-
-#language:
-##语言代码列表 https://help.aliyun.com/document_detail/215387.html?spm=a2c4g.11186623.0.0.9f8d7467kni6Aa
-#- cn 
-
-#metrics:
-##如 CIDEr、Blue、ROUGE 等
-#- CIDEr
-
-#tags:
-##各种自定义，包括 pretrained、fine-tuned、instruction-tuned、RL-tuned 等训练方法和其他
-#- pretrained
-
-#tools:
-##如 vllm、fastchat、llamacpp、AdaSeq 等
-#- vllm
+license: cc-by-sa-4.0
+library_name: transformers
+pipeline_tag: text-generation
+base_model: defog/sqlcoder-7b-2
 ---
-### 当前模型的贡献者未提供更加详细的模型介绍。模型文件和权重，可浏览“模型文件”页面获取。
-#### 您可以通过如下git clone命令，或者ModelScope SDK来下载模型

-SDK下载
-```bash
-#安装ModelScope
-pip install modelscope
+# QuantFactory/sqlcoder-7b-2-GGUF
+This is quantized version of [defog/sqlcoder-7b-2](https://huggingface.co/defog/sqlcoder-7b-2) created using llama.cpp
+
+# Model Card for SQLCoder-7B-2
+
+A capable large language model for natural language to SQL generation.
+
+![image/png](https://cdn-uploads.huggingface.co/production/uploads/603bbad3fd770a9997b57cb6/AYUE2y14vy2XkD9MZpScu.png)
+
+## Model Details
+
+### Model Description
+
+<!-- Provide a longer summary of what this model is. -->
+
+This is the model card of a 🤗 transformers model that has been pushed on the Hub. This model card has been automatically generated.
+
+- **Developed by:** [Defog, Inc](https://defog.ai)
+- **Model type:** [Text to SQL]
+- **License:** [CC-by-SA-4.0]
+- **Finetuned from model:** [CodeLlama-7B]
+
+### Model Sources [optional]
+- [**HuggingFace:**](https://huggingface.co/defog/sqlcoder-70b-alpha)
+- [**GitHub:**](https://github.com/defog-ai/sqlcoder)
+- [**Demo:**](https://defog.ai/sqlcoder-demo/)
+
+## Uses
+
+This model is intended to be used by non-technical users to understand data inside their SQL databases. It is meant as an analytics tool, and not as a database admin tool.
+
+This model has not been trained to reject malicious requests from users with write access to databases, and should only be used by users with read-only access.
+
+## How to Get Started with the Model
+
+Use the code [here](https://github.com/defog-ai/sqlcoder/blob/main/inference.py) to get started with the model.
+
+## Prompt
+
+Please use the following prompt for optimal results. Please remember to use `do_sample=False` and `num_beams=4` for optimal results.
+
 ```
-```python
-#SDK模型下载
-from modelscope import snapshot_download
-model_dir = snapshot_download('QuantFactory/sqlcoder-7b-2-GGUF')
-```
-Git下载
-```
-#Git模型下载
-git clone https://www.modelscope.cn/QuantFactory/sqlcoder-7b-2-GGUF.git
+### Task
+Generate a SQL query to answer [QUESTION]{user_question}[/QUESTION]
+
+### Database Schema
+The query will run on a database with the following schema:
+{table_metadata_string_DDL_statements}
+
+### Answer
+Given the database schema, here is the SQL query that [QUESTION]{user_question}[/QUESTION]
+[SQL]
 ```

-<p style="color: lightgrey;">如果您是本模型的贡献者，我们邀请您根据<a href="https://modelscope.cn/docs/ModelScope%E6%A8%A1%E5%9E%8B%E6%8E%A5%E5%85%A5%E6%B5%81%E7%A8%8B%E6%A6%82%E8%A7%88" style="color: lightgrey; text-decoration: underline;">模型贡献文档</a>，及时完善模型卡片内容。</p>
+## Evaluation
+
+This model was evaluated on [SQL-Eval](https://github.com/defog-ai/sql-eval), a PostgreSQL based evaluation framework developed by Defog for testing and alignment of model capabilities.
+
+You can read more about the methodology behind SQLEval [here](https://defog.ai/blog/open-sourcing-sqleval/).
+
+### Results
+
+We classified each generated question into one of 6 categories. The table displays the percentage of questions answered correctly by each model, broken down by category.
+
+|                | date | group_by | order_by | ratio | join | where |
+| -------------- | ---- | -------- | -------- | ----- | ---- | ----- |
+| sqlcoder-70b   | 96   | 91.4     | 97.1     | 85.7  | 97.1 | 91.4  |
+| sqlcoder-7b-2  | 96   | 91.4     | 94.3     | 91.4  | 94.3 | 77.1  |
+| sqlcoder-34b   | 80   | 94.3     | 85.7     | 77.1  | 85.7 | 80    |
+| gpt-4          | 72   | 94.3     | 97.1     | 80    | 91.4 | 80    |
+| gpt-4-turbo    | 76   | 91.4     | 91.4     | 62.8  | 88.6 | 77.1  |
+| natural-sql-7b | 56   | 88.6     | 85.7     | 60    | 88.6 | 80    |
+| sqlcoder-7b    | 64   | 82.9     | 74.3     | 54.3  | 74.3 | 74.3  |
+| gpt-3.5        | 72   | 77.1     | 82.8     | 34.3  | 65.7 | 71.4  |
+| claude-2       | 52   | 71.4     | 74.3     | 57.1  | 65.7 | 62.9  |
+
+## Model Card Contact
+
+Contact us on X at [@defogdata](https://twitter.com/defogdata), or on email at [founders@defog.ai](mailto:founders@defog.ai)
--- a/configuration.json
+++ b/configuration.json
@@ -0,0 +1 @@
+{"framework": "pytorch", "task": "text-generation", "allow_remote": true}
--- a/sqlcoder-7b-2.Q2_K.gguf
+++ b/sqlcoder-7b-2.Q2_K.gguf
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:8c29a20e25228660402b8db66a34595fe7a9cb642a6e86eb532bce9a8eb6e41d
+size 2532939776
--- a/sqlcoder-7b-2.Q3_K_L.gguf
+++ b/sqlcoder-7b-2.Q3_K_L.gguf
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:3cb95fa71631853212ef1b8ddfa371abfb39e84b1d5b5ac400ad6c10b3c34367
+size 3597193728
--- a/sqlcoder-7b-2.Q3_K_M.gguf
+++ b/sqlcoder-7b-2.Q3_K_M.gguf
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:d1dcc4216af291da186de6b7ef3c02613bd70dc4bf436377bcba8e31ade2c24d
+size 3298087424
--- a/sqlcoder-7b-2.Q3_K_S.gguf
+++ b/sqlcoder-7b-2.Q3_K_S.gguf
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:15208119b47da4d6411f46db34817b5f23e9fcffc09ff60adf8cba7a5ed1a40a
+size 2948387328
--- a/sqlcoder-7b-2.Q4_0.gguf
+++ b/sqlcoder-7b-2.Q4_0.gguf
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:661f35b7ce2b5ae03f5fec9d2ef0ca862bde3df2e80dcd4920ba8b4300a04a6c
+size 3825898496
--- a/sqlcoder-7b-2.Q4_1.gguf
+++ b/sqlcoder-7b-2.Q4_1.gguf
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:912ebbe99b931b474134a6d72546c0dea44ac8ad904712cb9604a6c8ecffafc7
+size 4238844928
--- a/sqlcoder-7b-2.Q4_K_M.gguf
+++ b/sqlcoder-7b-2.Q4_K_M.gguf
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:a23c04123a719b2ce30e01452b6e79c620f56dbbbf7f9ad5bd30e75efc3c0bc2
+size 4081095680
--- a/sqlcoder-7b-2.Q4_K_S.gguf
+++ b/sqlcoder-7b-2.Q4_K_S.gguf
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:a20678260cdf114064fbce4cd732d06fcc7ddd9cebebf9124e0ae6abbbeee6ae
+size 3856831488
--- a/sqlcoder-7b-2.Q5_0.gguf
+++ b/sqlcoder-7b-2.Q5_0.gguf
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:43ed1f97f612087d1fc123b4654150d826d2cf315d647c420edb5bb7fe7960ec
+size 4651791360
--- a/sqlcoder-7b-2.Q5_1.gguf
+++ b/sqlcoder-7b-2.Q5_1.gguf
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:8615c942fa447e24d2fe6a68ea8026b38a2d8510fb84cacf89b7384228042477
+size 5064737792
--- a/sqlcoder-7b-2.Q5_K_M.gguf
+++ b/sqlcoder-7b-2.Q5_K_M.gguf
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:03b6a230c8643b2fb6baaf06c8d3509b38609ca87297d37a7a24ed2dff8d7000
+size 4783256576
--- a/sqlcoder-7b-2.Q5_K_S.gguf
+++ b/sqlcoder-7b-2.Q5_K_S.gguf
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:ce3a98d61c593137e1f3e8087b36f9887109268debdd22765d66cc2ef2726558
+size 4651791360
--- a/sqlcoder-7b-2.Q6_K.gguf
+++ b/sqlcoder-7b-2.Q6_K.gguf
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:8ddf218b766e74b53b4ce7f01122cc342eb73f78dc213aaaf5b1ebde2c332289
+size 5529302528
--- a/sqlcoder-7b-2.Q8_0.gguf
+++ b/sqlcoder-7b-2.Q8_0.gguf
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:72cbcc932d8af6f208158a0784b55d30c370b5eb093c47e528ee3704b35fc166
+size 7161229824
				`@@ -0,0 +1 @@`
				`{"framework": "pytorch", "task": "text-generation", "allow_remote": true}`