Monero commited on
Commit
5ec5a0f
1 Parent(s): 8c07ab9

Create README.md

Browse files
Files changed (1) hide show
  1. README.md +186 -0
README.md ADDED
@@ -0,0 +1,186 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ license: mit
3
+ datasets:
4
+ - kaiokendev/SuperCOT-dataset
5
+ - neulab/conala
6
+ - yahma/alpaca-cleaned
7
+ - QingyiSi/Alpaca-CoT
8
+ - timdettmers/guanaco-33b
9
+ - JosephusCheung/GuanacoDataset
10
+ ---
11
+ <center><h1><b>Guanaco SuperCOT</b> - Generative Universal Assistant for Natural-language Adaptive Context-aware Omnilingual outputs</h1></center>
12
+
13
+ <html>
14
+ <head>
15
+ <style>
16
+ table {
17
+ border:1px solid #b3adad;
18
+ border-collapse:collapse;
19
+ padding:5px;
20
+ }
21
+ table th {
22
+ border:1px solid #b3adad;
23
+ padding:5px;
24
+ background: #f0f0f0;
25
+ color: #313030;
26
+ }
27
+ table td {
28
+ border:1px solid #b3adad;
29
+ text-align:center;
30
+ padding:5px;
31
+ background: #ffffff;
32
+ color: #313030;
33
+ }
34
+ </style>
35
+ </head>
36
+ <body>
37
+ <table>
38
+ <thead>
39
+ <tr>
40
+ <th>Model:</th>
41
+ <th>Wikitext2</th>
42
+ <th>Ptb-New</th>
43
+ <th>C4-New</th>
44
+ </tr>
45
+ </thead>
46
+ <tbody>
47
+ <tr>
48
+ <td>Guanaco SuperCOT 4bit TS 128g</td>
49
+ <td></td>
50
+ <td></td>
51
+ <td></td>
52
+ </tr>
53
+ </tbody>
54
+ </table>
55
+ </body>
56
+ </html>
57
+
58
+ ### Guanaco SuperCOT
59
+ Guanaco SuperCOT is trained with the aim of making LLaMa follow prompts for Langchain better, by infusing chain-of-thought datasets, code explanations and instructions, snippets, logical deductions and Alpaca GPT-4 prompts. It's also an advanced instruction-following language model built on Meta's LLaMA 33B model. Expanding upon the initial 52K dataset from the Alpaca model, an additional 534,530 entries have been incorporated, covering English, Simplified Chinese, Traditional Chinese (Taiwan), Traditional Chinese (Hong Kong), Japanese, Deutsch, and various linguistic and grammatical tasks. This wealth of data enables Guanaco to perform exceptionally well in multilingual environments.
60
+
61
+ It uses a mixture of the following datasets:
62
+
63
+ [https://huggingface.co/datasets/QingyiSi/Alpaca-CoT](https://huggingface.co/datasets/QingyiSi/Alpaca-CoT)
64
+ - Chain of thought QED
65
+ - Chain of thought Aqua
66
+ - CodeAlpaca
67
+
68
+ [https://huggingface.co/datasets/neulab/conala](https://huggingface.co/datasets/neulab/conala)
69
+ - Code snippets
70
+
71
+ [https://huggingface.co/datasets/yahma/alpaca-cleaned](https://huggingface.co/datasets/yahma/alpaca-cleaned)
72
+ - Alpaca GPT4
73
+
74
+ - [https://huggingface.co/datasets/JosephusCheung/GuanacoDataset](https://huggingface.co/datasets/JosephusCheung/GuanacoDataset)
75
+ - Guacano
76
+
77
+ - [https://huggingface.co/timdettmers/guanaco-33b](https://huggingface.co/timdettmers/guanaco-33b)
78
+ - Guacano 33b LoRa
79
+
80
+ 1\. Prompting
81
+ -------------------------
82
+
83
+ You should prompt the LoRA the same way you would prompt Alpaca or Alpacino.
84
+ The new format is designed to be similar to ChatGPT, allowing for better integration with the Alpaca format and enhancing the overall user experience.
85
+
86
+ Instruction is utilized as a few-shot context to support diverse inputs and responses, making it easier for the model to understand and provide accurate responses to user queries.
87
+
88
+ The format is as follows:
89
+ ```
90
+ ### Instruction:
91
+ User: History User Input
92
+ Assistant: History Assistant Answer
93
+ ### Input:
94
+ System: Knowledge
95
+ User: New User Input
96
+ ### Response:
97
+ New Assistant Answer
98
+ ```
99
+
100
+ This structured format allows for easier tracking of the conversation history and maintaining context throughout a multi-turn dialogue.
101
+ ```
102
+ Below is an instruction that describes a task, paired with an input that provides further context. Write a response that appropriately completes the request.
103
+
104
+ ### Instruction:
105
+ <instruction>
106
+
107
+ ### Input:
108
+ <any additional context. Remove this if it's not neccesary>
109
+
110
+ ### Response:
111
+ <make sure to leave a single new-line here for optimal results>
112
+ ```
113
+
114
+ Remember that with lower parameter sizes, the structure of the prompt becomes more important. The same prompt worded differently can give wildly different answers. Consider using the following suggestion suffixes to improve output quality:
115
+
116
+ - "Think through this step by step"
117
+ - "Let's think about this logically"
118
+ - "Explain your reasoning"
119
+ - "Provide details to support your answer"
120
+ - "Compare and contrast your answer with alternatives"
121
+
122
+ 2\. Role-playing support:
123
+ -------------------------
124
+
125
+ Guanaco now offers advanced role-playing support, similar to Character.AI, in English, Simplified Chinese, Traditional Chinese, Japanese, and Deutsch, making it more versatile for users from different linguistic backgrounds.
126
+
127
+ Users can instruct the model to assume specific roles, historical figures, or fictional characters, as well as personalities based on their input. This allows for more engaging and immersive conversations.
128
+
129
+ The model can use various sources of information to provide knowledge and context for the character's background and behavior, such as encyclopedic entries, first-person narrations, or a list of personality traits.
130
+
131
+ The model will consistently output responses in the format "Character Name: Reply" to maintain the chosen role throughout the conversation, enhancing the user's experience.
132
+
133
+ 3\. Rejection of answers and avoidance of erroneous responses:
134
+ --------------------------------------------------------------
135
+
136
+ The model has been updated to handle situations where it lacks sufficient knowledge or is unable to provide a valid response more effectively.
137
+
138
+ Reserved keywords have been introduced to indicate different scenarios and provide clearer communication with the user:
139
+
140
+ * NO IDEA: Indicates that the model lacks the necessary knowledge to provide an accurate answer, and will explain this to the user, encouraging them to seek alternative sources.
141
+ * FORBIDDEN: Indicates that the model refuses to answer due to specific reasons (e.g., legal, ethical, or safety concerns), which will be inferred based on the context of the query.
142
+ * SFW: Indicates that the model refuses to answer a question because it has been filtered for NSFW content, ensuring a safer and more appropriate user experience.
143
+
144
+ 4\. Continuation of responses for ongoing topics:
145
+ -------------------------------------------------
146
+
147
+ The Guanaco model can now continue answering questions or discussing topics upon the user's request, making it more adaptable and better suited for extended conversations.
148
+
149
+ The contextual structure consisting of System, Assistant, and User roles allows the model to engage in multi-turn dialogues, maintain context-aware conversations, and provide more coherent responses.
150
+
151
+ The model can now accommodate role specification and character settings, providing a more immersive and tailored conversational experience based on the user's preferences.
152
+
153
+ It is important to remember that Guanaco is a 7B-parameter model, and any knowledge-based content should be considered potentially inaccurate. We strongly recommend providing verifiable sources, such as Wikipedia, for knowledge-based answers. In the absence of sources, it is crucial to inform users of this limitation to prevent the dissemination of false information and to maintain transparency.
154
+
155
+ ### Citations
156
+ Alpaca COT datasets
157
+ ```
158
+ @misc{alpaca-cot,
159
+ author = {Qingyi Si, Zheng Lin },
160
+ school = {Institute of Information Engineering, Chinese Academy of Sciences, Beijing, China},
161
+ title = {Alpaca-CoT: An Instruction Fine-Tuning Platform with Instruction Data Collection and Unified Large Language Models Interface},
162
+ year = {2023},
163
+ publisher = {GitHub},
164
+ journal = {GitHub repository},
165
+ howpublished = {\url{https://github.com/PhoebusSi/alpaca-CoT}},
166
+ }
167
+ ```
168
+ Stanford Alpaca
169
+ ```
170
+ @misc{alpaca,
171
+ author = {Rohan Taori and Ishaan Gulrajani and Tianyi Zhang and Yann Dubois and Xuechen Li and Carlos Guestrin and Percy Liang and Tatsunori B. Hashimoto },
172
+ title = {Stanford Alpaca: An Instruction-following LLaMA model},
173
+ year = {2023},
174
+ publisher = {GitHub},
175
+ journal = {GitHub repository},
176
+ howpublished = {\url{https://github.com/tatsu-lab/stanford_alpaca}},
177
+ }
178
+ ```
179
+ Google FLAN
180
+ ```
181
+ @inproceedings{weifinetuned,
182
+ title={Finetuned Language Models are Zero-Shot Learners},
183
+ author={Wei, Jason and Bosma, Maarten and Zhao, Vincent and Guu, Kelvin and Yu, Adams Wei and Lester, Brian and Du, Nan and Dai, Andrew M and Le, Quoc V},
184
+ booktitle={International Conference on Learning Representations}
185
+ }
186
+ ```