RichardErkhov commited on
Commit
a924e02
1 Parent(s): f66300d

uploaded readme

Browse files
Files changed (1) hide show
  1. README.md +188 -0
README.md ADDED
@@ -0,0 +1,188 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ Quantization made by Richard Erkhov.
2
+
3
+ [Github](https://github.com/RichardErkhov)
4
+
5
+ [Discord](https://discord.gg/pvy7H8DZMG)
6
+
7
+ [Request more models](https://github.com/RichardErkhov/quant_request)
8
+
9
+
10
+ Sailor-7B-Chat - GGUF
11
+ - Model creator: https://huggingface.co/sail/
12
+ - Original model: https://huggingface.co/sail/Sailor-7B-Chat/
13
+
14
+
15
+ | Name | Quant method | Size |
16
+ | ---- | ---- | ---- |
17
+ | [Sailor-7B-Chat.Q2_K.gguf](https://huggingface.co/RichardErkhov/sail_-_Sailor-7B-Chat-gguf/blob/main/Sailor-7B-Chat.Q2_K.gguf) | Q2_K | 2.89GB |
18
+ | [Sailor-7B-Chat.IQ3_XS.gguf](https://huggingface.co/RichardErkhov/sail_-_Sailor-7B-Chat-gguf/blob/main/Sailor-7B-Chat.IQ3_XS.gguf) | IQ3_XS | 3.18GB |
19
+ | [Sailor-7B-Chat.IQ3_S.gguf](https://huggingface.co/RichardErkhov/sail_-_Sailor-7B-Chat-gguf/blob/main/Sailor-7B-Chat.IQ3_S.gguf) | IQ3_S | 3.32GB |
20
+ | [Sailor-7B-Chat.Q3_K_S.gguf](https://huggingface.co/RichardErkhov/sail_-_Sailor-7B-Chat-gguf/blob/main/Sailor-7B-Chat.Q3_K_S.gguf) | Q3_K_S | 3.32GB |
21
+ | [Sailor-7B-Chat.IQ3_M.gguf](https://huggingface.co/RichardErkhov/sail_-_Sailor-7B-Chat-gguf/blob/main/Sailor-7B-Chat.IQ3_M.gguf) | IQ3_M | 3.48GB |
22
+ | [Sailor-7B-Chat.Q3_K.gguf](https://huggingface.co/RichardErkhov/sail_-_Sailor-7B-Chat-gguf/blob/main/Sailor-7B-Chat.Q3_K.gguf) | Q3_K | 3.65GB |
23
+ | [Sailor-7B-Chat.Q3_K_M.gguf](https://huggingface.co/RichardErkhov/sail_-_Sailor-7B-Chat-gguf/blob/main/Sailor-7B-Chat.Q3_K_M.gguf) | Q3_K_M | 3.65GB |
24
+ | [Sailor-7B-Chat.Q3_K_L.gguf](https://huggingface.co/RichardErkhov/sail_-_Sailor-7B-Chat-gguf/blob/main/Sailor-7B-Chat.Q3_K_L.gguf) | Q3_K_L | 3.93GB |
25
+ | [Sailor-7B-Chat.IQ4_XS.gguf](https://huggingface.co/RichardErkhov/sail_-_Sailor-7B-Chat-gguf/blob/main/Sailor-7B-Chat.IQ4_XS.gguf) | IQ4_XS | 4.02GB |
26
+ | [Sailor-7B-Chat.Q4_0.gguf](https://huggingface.co/RichardErkhov/sail_-_Sailor-7B-Chat-gguf/blob/main/Sailor-7B-Chat.Q4_0.gguf) | Q4_0 | 4.2GB |
27
+ | [Sailor-7B-Chat.IQ4_NL.gguf](https://huggingface.co/RichardErkhov/sail_-_Sailor-7B-Chat-gguf/blob/main/Sailor-7B-Chat.IQ4_NL.gguf) | IQ4_NL | 4.22GB |
28
+ | [Sailor-7B-Chat.Q4_K_S.gguf](https://huggingface.co/RichardErkhov/sail_-_Sailor-7B-Chat-gguf/blob/main/Sailor-7B-Chat.Q4_K_S.gguf) | Q4_K_S | 4.23GB |
29
+ | [Sailor-7B-Chat.Q4_K.gguf](https://huggingface.co/RichardErkhov/sail_-_Sailor-7B-Chat-gguf/blob/main/Sailor-7B-Chat.Q4_K.gguf) | Q4_K | 4.44GB |
30
+ | [Sailor-7B-Chat.Q4_K_M.gguf](https://huggingface.co/RichardErkhov/sail_-_Sailor-7B-Chat-gguf/blob/main/Sailor-7B-Chat.Q4_K_M.gguf) | Q4_K_M | 4.44GB |
31
+ | [Sailor-7B-Chat.Q4_1.gguf](https://huggingface.co/RichardErkhov/sail_-_Sailor-7B-Chat-gguf/blob/main/Sailor-7B-Chat.Q4_1.gguf) | Q4_1 | 4.62GB |
32
+ | [Sailor-7B-Chat.Q5_0.gguf](https://huggingface.co/RichardErkhov/sail_-_Sailor-7B-Chat-gguf/blob/main/Sailor-7B-Chat.Q5_0.gguf) | Q5_0 | 5.03GB |
33
+ | [Sailor-7B-Chat.Q5_K_S.gguf](https://huggingface.co/RichardErkhov/sail_-_Sailor-7B-Chat-gguf/blob/main/Sailor-7B-Chat.Q5_K_S.gguf) | Q5_K_S | 5.03GB |
34
+ | [Sailor-7B-Chat.Q5_K.gguf](https://huggingface.co/RichardErkhov/sail_-_Sailor-7B-Chat-gguf/blob/main/Sailor-7B-Chat.Q5_K.gguf) | Q5_K | 5.15GB |
35
+ | [Sailor-7B-Chat.Q5_K_M.gguf](https://huggingface.co/RichardErkhov/sail_-_Sailor-7B-Chat-gguf/blob/main/Sailor-7B-Chat.Q5_K_M.gguf) | Q5_K_M | 5.15GB |
36
+ | [Sailor-7B-Chat.Q5_1.gguf](https://huggingface.co/RichardErkhov/sail_-_Sailor-7B-Chat-gguf/blob/main/Sailor-7B-Chat.Q5_1.gguf) | Q5_1 | 5.44GB |
37
+ | [Sailor-7B-Chat.Q6_K.gguf](https://huggingface.co/RichardErkhov/sail_-_Sailor-7B-Chat-gguf/blob/main/Sailor-7B-Chat.Q6_K.gguf) | Q6_K | 5.91GB |
38
+ | [Sailor-7B-Chat.Q8_0.gguf](https://huggingface.co/RichardErkhov/sail_-_Sailor-7B-Chat-gguf/blob/main/Sailor-7B-Chat.Q8_0.gguf) | Q8_0 | 7.65GB |
39
+
40
+
41
+
42
+
43
+ Original model description:
44
+ ---
45
+ language:
46
+ - en
47
+ - zh
48
+ - id
49
+ - th
50
+ - vi
51
+ - ms
52
+ - lo
53
+ datasets:
54
+ - CohereForAI/aya_dataset
55
+ - CohereForAI/aya_collection
56
+ - Open-Orca/OpenOrca
57
+ tags:
58
+ - multilingual
59
+ - sea
60
+ - sailor
61
+ - sft
62
+ - chat
63
+ - instruction
64
+ widget:
65
+ - text: "如何制作烤鱼?"
66
+ example_title: "Chinese"
67
+ - text: "How to bake fish?"
68
+ example_title: "English"
69
+ - text: "Bagaimana cara memanggang ikan?"
70
+ example_title: "Malay"
71
+ - text: "วิธีย่างปลา?"
72
+ example_title: "Thai"
73
+ - text: "Bagaimana membuat bakaran ikan?"
74
+ example_title: "Indonesian"
75
+ - text: "Làm thế nào để nướng cá?"
76
+ example_title: "Vietnamese"
77
+ license: apache-2.0
78
+ base_model: sail/Sailor-7B
79
+ ---
80
+
81
+ <div align="center">
82
+ <img src="banner_sailor.jpg" width="700"/>
83
+ </div>
84
+
85
+ Sailor is a suite of Open Language Models tailored for South-East Asia (SEA), focusing on languages such as 🇮🇩Indonesian, 🇹🇭Thai, 🇻🇳Vietnamese, 🇲🇾Malay, and 🇱🇦Lao.
86
+ Developed with careful data curation, Sailor models are designed to understand and generate text across diverse linguistic landscapes of SEA region.
87
+ Built from [Qwen 1.5](https://huggingface.co/collections/Qwen/qwen15-65c0a2f577b1ecb76d786524) , Sailor encompasses models of varying sizes, spanning from 0.5B to 7B versions for different requirements.
88
+ We further fine-tune the base model with open-source datasets to get instruction-tuned models, namedly Sailor-Chat.
89
+ Benchmarking results demonstrate Sailor's proficiency in tasks such as question answering, commonsense reasoning, and other tasks in SEA languages.
90
+
91
+ > The logo was generated by MidJourney
92
+
93
+ ## Model Summary
94
+ - **Model Collections:** [Base Model & Chat Model](https://huggingface.co/collections/sail/sailor-65e19a749f978976f1959825)
95
+ - **Project Website:** [sailorllm.github.io](https://sailorllm.github.io/)
96
+ - **Codebase:** [github.com/sail-sg/sailor-llm](https://github.com/sail-sg/sailor-llm)
97
+ - **Technical Report:** [arxiv.org/pdf/2404.03608.pdf](https://arxiv.org/pdf/2404.03608.pdf)
98
+
99
+
100
+ ## Training details
101
+ Sailor is crafted by continually pre-training from language models like the remarkable Qwen 1.5 models, which already has a great performance on SEA languages.
102
+ The pre-training corpus heavily leverages the publicly available corpus, including
103
+ [SlimPajama](https://huggingface.co/datasets/cerebras/SlimPajama-627B),
104
+ [SkyPile](https://huggingface.co/datasets/Skywork/SkyPile-150B),
105
+ [CC100](https://huggingface.co/datasets/cc100) and [MADLAD-400](https://huggingface.co/datasets/allenai/MADLAD-400).
106
+ The instruction tuning corpus are all publicly available including
107
+ [aya_collection](https://huggingface.co/datasets/CohereForAI/aya_collection),
108
+ [aya_dataset](https://huggingface.co/datasets/CohereForAI/aya_dataset),
109
+ [OpenOrca](https://huggingface.co/datasets/Open-Orca/OpenOrca).
110
+
111
+ By employing aggressive data deduplication and careful data cleaning on the collected corpus, we have attained a high-quality dataset spanning various languages.
112
+ Through systematic experiments to determine the weights of different languages, Sailor models undergo training from 200B to 400B tokens, tailored to different model sizes.
113
+ The approach boosts their performance on SEA languages while maintaining proficiency in English and Chinese without significant compromise.
114
+ Finally, we continually pre-train the Qwen1.5-0.5B model with 400 Billion tokens, and other models with 200 Billion tokens to obtain the Sailor models.
115
+
116
+ ## Requirements
117
+ The code of Sailor has been in the latest Hugging face transformers and we advise you to install `transformers>=4.37.0`.
118
+
119
+ ## Quickstart
120
+
121
+ Here provides a code snippet to show you how to load the tokenizer and model and how to generate contents.
122
+
123
+ ```python
124
+ from transformers import AutoModelForCausalLM, AutoTokenizer
125
+ device = "cuda"
126
+
127
+ model = AutoModelForCausalLM.from_pretrained(
128
+ 'sail/Sailor-7B-Chat',
129
+ torch_dtype="auto",
130
+ device_map="auto"
131
+ )
132
+
133
+ tokenizer = AutoTokenizer.from_pretrained('sail/Sailor-7B-Chat')
134
+ system_prompt= 'You are a helpful assistant'
135
+
136
+ prompt = "Beri saya pengenalan singkat tentang model bahasa besar."
137
+ # prompt = "Hãy cho tôi một giới thiệu ngắn gọn về mô hình ngôn ngữ lớn."
138
+ # prompt = "ให้ฉันแนะนำสั้น ๆ เกี่ยวกับโมเดลภาษาขนาดใหญ่"
139
+
140
+ messages = [
141
+ {"role": "system", "content": system_prompt},
142
+ {"role": "question", "content": prompt}
143
+ ]
144
+ text = tokenizer.apply_chat_template(
145
+ messages,
146
+ tokenize=False,
147
+ add_generation_prompt=True
148
+ )
149
+
150
+ model_inputs = tokenizer([text], return_tensors="pt").to(device)
151
+ input_ids = model_inputs.input_ids.to(device)
152
+
153
+ generated_ids = model.generate(
154
+ input_ids,
155
+ max_new_tokens=512,
156
+ )
157
+
158
+ generated_ids = [
159
+ output_ids[len(input_ids):] for input_ids, output_ids in zip(model_inputs.input_ids, generated_ids)
160
+ ]
161
+ response = tokenizer.batch_decode(generated_ids, skip_special_tokens=True)[0]
162
+ print(response)
163
+ ```
164
+
165
+ # License
166
+
167
+ Sailor is distributed under the terms of the Apache License 2.0.
168
+ No restrict on the research and the commercial use, but should comply with the [Qwen License](https://huggingface.co/Qwen/Qwen1.5-1.8B/blob/main/LICENSE).
169
+
170
+ ## Citation
171
+
172
+ If you find sailor useful, please cite our work as follows:
173
+
174
+ ```
175
+ @misc{dou2024sailor,
176
+ title={Sailor: Open Language Models for South-East Asia},
177
+ author={Longxu Dou and Qian Liu and Guangtao Zeng and Jia Guo and Jiahui Zhou and Wei Lu and Min Lin},
178
+ year={2024},
179
+ eprint={2404.03608},
180
+ archivePrefix={arXiv},
181
+ primaryClass={cs.CL}
182
+ }
183
+ ```
184
+
185
+ # Contact Us
186
+
187
+ If you have any questions, please raise an issue or contact us at [doulx@sea.com](mailto:doulx@sea.com) or [liuqian@sea.com](mailto:liuqian@sea.com).
188
+