uploaded readme

README.md

@@ -0,0 +1,69 @@
+Quantization made by Richard Erkhov.
+
+[Github](https://github.com/RichardErkhov)
+
+[Discord](https://discord.gg/pvy7H8DZMG)
+
+[Request more models](https://github.com/RichardErkhov/quant_request)
+
+
+pygmalion-instruct - bnb 4bits
+- Model creator: https://huggingface.co/alpindale/
+- Original model: https://huggingface.co/alpindale/pygmalion-instruct/
+
+
+
+
+Original model description:
+---
+license: mit
+---
+
+## Model Details
+
+Experimental model. Trained with the [Pygmalion](https://huggingface.co/PygmalionAI/pygmalion-6b/tree/dev) and the [WizardLM](https://huggingface.co/ehartford/WizardLM-7B-Uncensored) datasets.
+
+The purpose of this model is to enable complex Instruct prompting but with the RP capabilties of Pygmalion. 
+
+### Prompting format
+```
+instruction:
+output:
+```
+
+<!-- Provide the basic links for the model. -->
+
+- **Repository:** [More Information Needed]
+- **Paper [optional]:** [More Information Needed]
+- **Demo [optional]:** [More Information Needed]
+
+### Uses
+
+The intended use-case is Role-Playing with Instruct prompts. Guiding the bot towards a certain conversation style should be easier this way. Subject to experimentation.
+
+
+
+### Out-of-Scope Use
+
+- Assistant Bot [subject to providing incorrect instructions]
+- Complex multi-character chat
+
+### Risks
+
+The model can generate potentially harmful or NSFW outputs. Please use with caution.
+
+### Citation
+
+WizardLM:
+```
+@misc{xu2023wizardlm,
+      title={WizardLM: Empowering Large Language Models to Follow Complex Instructions}, 
+      author={Can Xu and Qingfeng Sun and Kai Zheng and Xiubo Geng and Pu Zhao and Jiazhan Feng and Chongyang Tao and Daxin Jiang},
+      year={2023},
+      eprint={2304.12244},
+      archivePrefix={arXiv},
+      primaryClass={cs.CL}
+}
+```
+
+