Upload llama-3-sqlcoder-8b.Q4_0.gguf with huggingface_hub

README.md

@@ -1,47 +1,53 @@
 ---
-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
+metrics:
+- accuracy
+pipeline_tag: text-generation
+tags:
+- code
+base_model: defog/llama-3-sqlcoder-8b
 ---
-### 当前模型的贡献者未提供更加详细的模型介绍。模型文件和权重，可浏览“模型文件”页面获取。
-#### 您可以通过如下git clone命令，或者ModelScope SDK来下载模型
 
-SDK下载
-```bash
-#安装ModelScope
-pip install modelscope
+# QuantFactory/llama-3-sqlcoder-8b-GGUF
+This is quantized version of [defog/llama-3-sqlcoder-8b](https://huggingface.co/defog/llama-3-sqlcoder-8b) created using llama.cpp
+
+## Model Description
+
+A capable language model for text to SQL generation for Postgres, Redshift and Snowflake that is on-par with the most capable generalist frontier models.
+
+![image/png](https://cdn-uploads.huggingface.co/production/uploads/603bbad3fd770a9997b57cb6/h52Z_OKYBaDDQMFZyU5pF.png)
+
+
+Developed by: Defog, Inc
+Model type: [Text to SQL]
+License: [CC-by-SA-4.0]
+Finetuned from model: [Meta-Llama-3-8B-Instruct]
+
+## Demo Page
+[https://defog.ai/sqlcoder-demo/](https://defog.ai/sqlcoder-demo/)
+
+## Ideal prompt and inference parameters
+Set temperature to 0, and do not do sampling.
+
+### Prompt
 ```
-```python
-#SDK模型下载
-from modelscope import snapshot_download
-model_dir = snapshot_download('QuantFactory/llama-3-sqlcoder-8b-GGUF')
-```
-Git下载
-```
-#Git模型下载
-git clone https://www.modelscope.cn/QuantFactory/llama-3-sqlcoder-8b-GGUF.git
+<|begin_of_text|><|start_header_id|>user<|end_header_id|>
+
+Generate a SQL query to answer this question: `{user_question}`
+{instructions}
+
+DDL statements:
+{create_table_statements}<|eot_id|><|start_header_id|>assistant<|end_header_id|>
+
+The following SQL query best answers the question `{user_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, 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/).
+
+## Contact defog
+Contact defog on X at [@defogdata](https://twitter.com/defogdata), or on email at founders@defog.ai