Update README.md

README.md

@@ -1,20 +1,72 @@
 ---
+tags:
+- sql
+- spider
+- text-to-sql
+- sql fine-tune
+- LoRA
+- QLoRa
+- adapter
+datasets:
+- spider
+- richardr1126/spider-natsql-skeleton-context-finetune
 library_name: peft
+license: bigcode-openrail-m
 ---
-## Training procedure
+### QLoRa Spider NatSQL Wizard Coder Adapter Summary
 
+- This QLoRa adapter was created by finetuning [WizardLM/WizardCoder-15B-V1.0](https://huggingface.co/WizardLM/WizardCoder-15B-V1.0) on a NatSQL enhanced Spider context training dataset: [richardr1126/spider-natsql-skeleton-context-finetune](https://huggingface.co/datasets/richardr1126/spider-natsql-skeleton-context-finetune).
+- Finetuning was performed using QLoRa on a single RTX6000 48GB.
+- If you want just the merged model it is her [here](https://huggingface.co/richardr1126/spider-natsql-wizard-coder-merged).
 
-The following `bitsandbytes` quantization config was used during training:
-- load_in_8bit: False
-- load_in_4bit: True
-- llm_int8_threshold: 6.0
-- llm_int8_skip_modules: None
-- llm_int8_enable_fp32_cpu_offload: False
-- llm_int8_has_fp16_weight: False
-- bnb_4bit_quant_type: nf4
-- bnb_4bit_use_double_quant: False
-- bnb_4bit_compute_dtype: float16
-### Framework versions
+## Citation
 
+Please cite the repo if you use the data or code in this repo.
 
-- PEFT 0.4.0.dev0
+```
+@misc{luo2023wizardcoder,
+      title={WizardCoder: Empowering Code Large Language Models with Evol-Instruct}, 
+      author={Ziyang Luo and Can Xu and Pu Zhao and Qingfeng Sun and Xiubo Geng and Wenxiang Hu and Chongyang Tao and Jing Ma and Qingwei Lin and Daxin Jiang},
+      year={2023},
+}
+```
+```
+@article{yu2018spider,
+  title={Spider: A large-scale human-labeled dataset for complex and cross-domain semantic parsing and text-to-sql task},
+  author={Yu, Tao and Zhang, Rui and Yang, Kai and Yasunaga, Michihiro and Wang, Dongxu and Li, Zifan and Ma, James and Li, Irene and Yao, Qingning and Roman, Shanelle and others},
+  journal={arXiv preprint arXiv:1809.08887},
+  year={2018}
+}
+```
+```
+@inproceedings{gan-etal-2021-natural-sql,
+    title = "Natural {SQL}: Making {SQL} Easier to Infer from Natural Language Specifications",
+    author = "Gan, Yujian  and
+      Chen, Xinyun  and
+      Xie, Jinxia  and
+      Purver, Matthew  and
+      Woodward, John R.  and
+      Drake, John  and
+      Zhang, Qiaofu",
+    booktitle = "Findings of the Association for Computational Linguistics: EMNLP 2021",
+    month = nov,
+    year = "2021",
+    address = "Punta Cana, Dominican Republic",
+    publisher = "Association for Computational Linguistics",
+    url = "https://aclanthology.org/2021.findings-emnlp.174",
+    doi = "10.18653/v1/2021.findings-emnlp.174",
+    pages = "2030--2042",
+}
+```
+```
+@article{dettmers2023qlora,
+  title={QLoRA: Efficient Finetuning of Quantized LLMs},
+  author={Dettmers, Tim and Pagnoni, Artidoro and Holtzman, Ari and Zettlemoyer, Luke},
+  journal={arXiv preprint arXiv:2305.14314},
+  year={2023}
+}
+```
+
+## Disclaimer
+
+The resources, including code, data, and model weights, associated with this project are restricted for academic research purposes only and cannot be used for commercial purposes. The content produced by any version of WizardCoder is influenced by uncontrollable variables such as randomness, and therefore, the accuracy of the output cannot be guaranteed by this project. This project does not accept any legal liability for the content of the model output, nor does it assume responsibility for any losses incurred due to the use of associated resources and output results.