Update README.md

README.md

@@ -5,10 +5,28 @@ language:
 - en
 ---
 # Jellyfish-0-13B
-
 <!-- Provide a quick summary of what the model is/does. -->
-![PicToModel][https://i.imgur.com/d8Bl04i.png]
+<img src="https://i.imgur.com/d8Bl04i.png" alt="PicToModel" width="350"/>
+
 ## Model Details
+Jellyfish is a model designed specifically for data preprocessing tasks, including entity matching, data imputation, error detection, and schema matching.
+
+We fine-tuned [Open-Orca/OpenOrca-Platypus2-13B](https://huggingface.co/Open-Orca/OpenOrca-Platypus2-13B) using data derived from benchmark datasets for those data preprocessing tasks.
+
+Its performance is competitive, standing up well against prior state-of-the-art algorithms and larger language models like GPT 3.5 and GPT 4.
+
+We have released two versions of Jellyfish: the main version and a variant called "Jellyfish-reasoning."
+
+As the names suggest, the main version focuses on providing accurate, direct answers. In contrast, Jellyfish-reasoning can generate not only the final answer to a data processing problem but also the reasoning behind its decision.
+
+## Prompt Template
+```
+### Instruction:
+
+<prompt> (without the <>)
+
+### Response:
+```
 
 ### Model Description
 
@@ -21,7 +39,7 @@ language:
 - **Model type:** [More Information Needed]
 - **Language(s) (NLP):** English
 - **License:** cc-by-4.0
-- **Finetuned from model:** [OpenOrca-Platypus2-13B][https://huggingface.co/Open-Orca/OpenOrca-Platypus2-13B]
+- **Finetuned from model:** [Open-Orca/OpenOrca-Platypus2-13B](https://huggingface.co/Open-Orca/OpenOrca-Platypus2-13B)
 
 ## Uses
 
@@ -33,17 +51,6 @@ language:
 
 [More Information Needed]
 
-### Downstream Use [optional]
-
-<!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
-
-[More Information Needed]
-
-### Out-of-Scope Use
-
-<!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
-
-[More Information Needed]
 
 ## Bias, Risks, and Limitations
 
@@ -120,7 +127,11 @@ Use the code below to get started with the model.
 
 #### Summary
 
+#### Software
+
+[hiyouga/LLaMA-Factory](https://github.com/hiyouga/LLaMA-Factory) for fine-tuning.  
 
+[vLLM](https://github.com/vllm-project/vllm) for inference.
 
 ## Model Examination [optional]
 
@@ -132,7 +143,7 @@ Use the code below to get started with the model.
 
 <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
 
-Carbon emissions can be estimated using the [Machine Learning Impact calculator](https://mlco2.github.io/impact#compute) presented in [Lacoste et al. (2019)](https://arxiv.org/abs/1910.09700).
+<!--Carbon emissions can be estimated using the [Machine Learning Impact calculator](https://mlco2.github.io/impact#compute) presented in [Lacoste et al. (2019)](https://arxiv.org/abs/1910.09700).
 
 - **Hardware Type:** [More Information Needed]
 - **Hours used:** [More Information Needed]
@@ -140,29 +151,86 @@ Carbon emissions can be estimated using the [Machine Learning Impact calculator]
 - **Compute Region:** [More Information Needed]
 - **Carbon Emitted:** [More Information Needed]
 
-## Technical Specifications [optional]
-
-### Model Architecture and Objective
-
-[More Information Needed]
-
-### Compute Infrastructure
-
-[More Information Needed]
-
 #### Hardware
 
-[More Information Needed]
+[More Information Needed]-->
 
-#### Software
 
-[More Information Needed]
 
 ## Citation [optional]
 
 <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
 
-**BibTeX:**
+```bibtex
+@article{
+  title = {Can Foundation Models Wrangle Your Data?},
+  author = {Avanika Narayan, Ines Chami, Laurel Orr, Simran Arora, Christopher Ré},
+  booktitle = {arXiv:2205.09911},
+  year = {2022}  
+}
+
+@software{hunterlee2023orcaplaty1
+  title = {OpenOrcaPlatypus: Llama2-13B Model Instruct-tuned on Filtered OpenOrcaV1 GPT-4 Dataset and Merged with divergent STEM and Logic Dataset Model},
+  author = {Ariel N. Lee and Cole J. Hunter and Nataniel Ruiz and Bleys Goodson and Wing Lian and Guan Wang and Eugene Pentland and Austin Cook and Chanvichet Vong and "Teknium"},
+  year = {2023},
+  publisher = {HuggingFace},
+  journal = {HuggingFace repository},
+  howpublished = {\url{https://huggingface.co/Open-Orca/OpenOrca-Platypus2-13B},
+}
+@article{platypus2023,
+    title={Platypus: Quick, Cheap, and Powerful Refinement of LLMs}, 
+    author={Ariel N. Lee and Cole J. Hunter and Nataniel Ruiz},
+    booktitle={arXiv preprint arxiv:2308.07317},
+    year={2023}
+}
+@software{OpenOrcaxOpenChatPreview2,
+  title = {OpenOrcaxOpenChatPreview2: Llama2-13B Model Instruct-tuned on Filtered OpenOrcaV1 GPT-4 Dataset},
+  author = {Guan Wang and Bleys Goodson and Wing Lian and Eugene Pentland and Austin Cook and Chanvichet Vong and "Teknium"},
+  year = {2023},
+  publisher = {HuggingFace},
+  journal = {HuggingFace repository},
+  howpublished = {\url{https://https://huggingface.co/Open-Orca/OpenOrcaxOpenChat-Preview2-13B},
+}
+@software{openchat,
+  title = {{OpenChat: Advancing Open-source Language Models with Imperfect Data}},
+  author = {Wang, Guan and Cheng, Sijie and Yu, Qiying and Liu, Changling},
+  doi = {10.5281/zenodo.8105775},
+  url = {https://github.com/imoneoi/openchat},
+  version = {pre-release},
+  year = {2023},
+  month = {7},
+}
+@misc{mukherjee2023orca,
+      title={Orca: Progressive Learning from Complex Explanation Traces of GPT-4}, 
+      author={Subhabrata Mukherjee and Arindam Mitra and Ganesh Jawahar and Sahaj Agarwal and Hamid Palangi and Ahmed Awadallah},
+      year={2023},
+      eprint={2306.02707},
+      archivePrefix={arXiv},
+      primaryClass={cs.CL}
+}
+@misc{touvron2023llama,
+    title={Llama 2: Open Foundation and Fine-Tuned Chat Models}, 
+    author={Hugo Touvron and Louis Martin and Kevin Stone and Peter Albert and Amjad Almahairi and Yasmine Babaei and Nikolay Bashlykov and Soumya Batra and Prajjwal Bhargava and Shruti Bhosale and Dan Bikel and Lukas Blecher and Cristian Canton Ferrer and Moya Chen and Guillem Cucurull and David Esiobu and Jude Fernandes and Jeremy Fu and Wenyin Fu and Brian Fuller and Cynthia Gao and Vedanuj Goswami and Naman Goyal and Anthony Hartshorn and Saghar Hosseini and Rui Hou and Hakan Inan and Marcin Kardas and Viktor Kerkez and Madian Khabsa and Isabel Kloumann and Artem Korenev and Punit Singh Koura and Marie-Anne Lachaux and Thibaut Lavril and Jenya Lee and Diana Liskovich and Yinghai Lu and Yuning Mao and Xavier Martinet and Todor Mihaylov and Pushkar Mishra and Igor Molybog and Yixin Nie and Andrew Poulton and Jeremy Reizenstein and Rashi Rungta and Kalyan Saladi and Alan Schelten and Ruan Silva and Eric Michael Smith and Ranjan Subramanian and Xiaoqing Ellen Tan and Binh Tang and Ross Taylor and Adina Williams and Jian Xiang Kuan and Puxin Xu and Zheng Yan and Iliyan Zarov and Yuchen Zhang and Angela Fan and Melanie Kambadur and Sharan Narang and Aurelien Rodriguez and Robert Stojnic and Sergey Edunov and Thomas Scialom},
+    year={2023},
+    eprint= arXiv 2307.09288
+}
+@misc{longpre2023flan,
+      title={The Flan Collection: Designing Data and Methods for Effective Instruction Tuning}, 
+      author={Shayne Longpre and Le Hou and Tu Vu and Albert Webson and Hyung Won Chung and Yi Tay and Denny Zhou and Quoc V. Le and Barret Zoph and Jason Wei and Adam Roberts},
+      year={2023},
+      eprint={2301.13688},
+      archivePrefix={arXiv},
+      primaryClass={cs.AI}
+}
+@article{hu2021lora,
+  title={LoRA: Low-Rank Adaptation of Large Language Models},
+  author={Hu, Edward J. and Shen, Yelong and Wallis, Phillip and Allen-Zhu, Zeyuan and Li, Yuanzhi and Wang, Shean and Chen, Weizhu},
+  journal={CoRR},
+  year={2021}
+}
+```
+
+<!--**BibTeX:**
 
 [More Information Needed]
 
@@ -172,8 +240,6 @@ Carbon emissions can be estimated using the [Machine Learning Impact calculator]
 
 ## Glossary [optional]
 
-<!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
-
 [More Information Needed]
 
 ## More Information [optional]
@@ -186,6 +252,6 @@ Carbon emissions can be estimated using the [Machine Learning Impact calculator]
 
 ## Model Card Contact
 
-[More Information Needed]
+[More Information Needed]-->