Update README.md
Browse files
README.md
CHANGED
@@ -1,3 +1,50 @@
|
|
1 |
---
|
2 |
license: mit
|
3 |
---
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
---
|
2 |
license: mit
|
3 |
---
|
4 |
+
|
5 |
+
## Model Details
|
6 |
+
|
7 |
+
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.
|
8 |
+
|
9 |
+
The purpose of this model is to enable complex Instruct prompting but with the RP capabilties of Pygmalion.
|
10 |
+
|
11 |
+
### Prompting format
|
12 |
+
```
|
13 |
+
instruction:
|
14 |
+
output:
|
15 |
+
```
|
16 |
+
|
17 |
+
<!-- Provide the basic links for the model. -->
|
18 |
+
|
19 |
+
- **Repository:** [More Information Needed]
|
20 |
+
- **Paper [optional]:** [More Information Needed]
|
21 |
+
- **Demo [optional]:** [More Information Needed]
|
22 |
+
|
23 |
+
### Uses
|
24 |
+
|
25 |
+
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.
|
26 |
+
|
27 |
+
|
28 |
+
|
29 |
+
### Out-of-Scope Use
|
30 |
+
|
31 |
+
- Assistant Bot [subject to providing incorrect instructions]
|
32 |
+
- Complex multi-character chat
|
33 |
+
|
34 |
+
### Risks
|
35 |
+
|
36 |
+
The model can generate potentially harmful or NSFW outputs. Please use with caution.
|
37 |
+
|
38 |
+
### Citation
|
39 |
+
|
40 |
+
WizardLM:
|
41 |
+
```
|
42 |
+
@misc{xu2023wizardlm,
|
43 |
+
title={WizardLM: Empowering Large Language Models to Follow Complex Instructions},
|
44 |
+
author={Can Xu and Qingfeng Sun and Kai Zheng and Xiubo Geng and Pu Zhao and Jiazhan Feng and Chongyang Tao and Daxin Jiang},
|
45 |
+
year={2023},
|
46 |
+
eprint={2304.12244},
|
47 |
+
archivePrefix={arXiv},
|
48 |
+
primaryClass={cs.CL}
|
49 |
+
}
|
50 |
+
```
|