tainc commited on
Commit
ca50ece
·
verified ·
1 Parent(s): ff70463

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +6 -77
README.md CHANGED
@@ -8,12 +8,12 @@ language:
8
  - vi
9
  base_model:
10
  - aisingapore/llama3-8b-cpt-sea-lionv2.1-instruct
 
11
  ---
12
- # Llama 3 8B CPT SEA-Lionv2.1 Instruct
13
-
14
  SEA-LION is a collection of Large Language Models (LLMs) which has been pretrained and instruct-tuned for the Southeast Asia (SEA) region.
15
 
16
- Llama 3 8B CPT SEA-Lionv2.1 Instruct is a multilingual model which has been fine-tuned with around **100,000 English instruction-completion pairs** alongside a smaller pool of around **50,000 instruction-completion pairs** from other ASEAN languages, such as Indonesian, Thai and Vietnamese.
17
  These instructions have been carefully curated and rewritten to ensure the model was trained on truly open, commercially permissive and high quality datasets.
18
 
19
  Llama3 8B CPT SEA-Lionv2.1 Instruct has undergone additional supervised fine-tuning and alignment compared to the now deprecated Llama3 8B CPT SEA-Lionv2 Instruct. These improvements have increased the model's capabilities in chat interactions and its ability to follow instructions accurately.
@@ -23,11 +23,10 @@ SEA-LION stands for _Southeast Asian Languages In One Network_.
23
  - **Developed by:** Products Pillar, AI Singapore
24
  - **Funded by:** Singapore NRF
25
  - **Model type:** Decoder
26
- - **Languages:** English, Indonesian, Thai, Vietnamese, Tamil
27
- - **License:** [Llama 3 Community License](https://huggingface.co/meta-llama/Meta-Llama-3-8B/blob/main/LICENSE)
28
 
29
  ## Description
30
-
31
  This repo contains `GGUF` format model files for [aisingapore/llama3-8b-cpt-sea-lionv2.1-instruct](https://huggingface.co/aisingapore/llama3-8b-cpt-sea-lionv2.1-instruct).
32
 
33
  #### Model Weights Included in this repository:
@@ -40,50 +39,11 @@ This repo contains `GGUF` format model files for [aisingapore/llama3-8b-cpt-sea-
40
  - [llama3-8b-cpt-sea-lionv2.1-instruct-Q6_K](https://huggingface.co/aisingapore/llama3-8b-cpt-sealionv2-instruct-gguf/blob/main/llama3-8b-cpt-sea-lionv2.1-instruct-Q6_K.gguf)
41
  - [llama3-8b-cpt-sea-lionv2.1-instruct-Q8_0](https://huggingface.co/aisingapore/llama3-8b-cpt-sealionv2-instruct-gguf/blob/main/llama3-8b-cpt-sea-lionv2.1-instruct-Q8_0.gguf)
42
 
43
- ### Usage
44
- Llama 3 8B CPT SEA-Lionv2.1 Instruct GGUF files have been tested on the latest version of `llama.cpp`, from pull request [#8772](https://github.com/ggerganov/llama.cpp/pull/8772)
45
-
46
- #### Prompt Template:
47
- ```
48
- <|begin_of_text|><|start_header_id|>system<|end_header_id|>
49
-
50
- {{system_prompt}}<|eot_id|>
51
- <|start_header_id|>user<|end_header_id|>
52
-
53
- {{prompt}}<|eot_id|>
54
- <|start_header_id|>assistant<|end_header_id|>
55
-
56
-
57
- ```
58
-
59
-
60
- #### Recommended `llama.cpp` command:
61
- To execute the following commands, ensure you are in the `llama.cpp` root directory and that your models are located in the `models` folder:
62
- ```sh
63
- # Running one-time input prompt
64
- ./llama-cli -m models/llama3-8b-cpt-sea-lionv2.1-instruct/llama3-8B-cpt-sea-lionv2.1-instruct-Q4_K_M.gguf -ngl -1 --temp 0 -n 128 -p "<|begin_of_text|><|start_header_id|>system<|end_header_id|>\n\nYou are a helpful assistant who answers succinctly.<|eot_id|>\n<|start_header_id|>user<|end_header_id|>\n\nWhat is a sea lion?<|eot_id|>\n<|start_header_id|>assistant<|end_header_id|>\n\n"
65
- ```
66
- ```sh
67
- # Running in conversation mode
68
- ./llama-cli -m models/llama3-8b-cpt-sea-lionv2.1-instruct/llama3-8B-cpt-sea-lionv2.1-instruct-Q4_K_M.gguf -ngl -1 --temp 0 -n 128 -p "You are a helpful assistant who answers succinctly." --color -cnv --chat-template llama3
69
- ```
70
- Please refer to [the llama.cpp documentation](https://github.com/ggerganov/llama.cpp/blob/master/examples/main/README.md) for adjusting the parameters.
71
-
72
- #### To convert & quantize your own SEA-LION model:
73
- Given that you are in the `llama.cpp` root directory:
74
- ```sh
75
- python convert-hf-to-gguf.py {{model path}}
76
- ./quantize ggml-model-f16.gguf {{Quant Type}}
77
- ```
78
-
79
- For more detailed instructions on conversion and quantization, please refer to [llama.cpp documentation](https://github.com/ggerganov/llama.cpp/blob/master/examples/quantize/README.md).
80
-
81
  ### Caveats
82
  It is important for users to be aware that our model exhibits certain limitations that warrant consideration. Like many LLMs, the model can hallucinate and occasionally generates irrelevant content, introducing fictional elements that are not grounded in the provided context. Users should also exercise caution in interpreting and validating the model's responses due to the potential inconsistencies in its reasoning.
83
 
84
  ## Limitations
85
  ### Safety
86
-
87
  Current SEA-LION models, including this commercially permissive release, have not been aligned for safety. Developers and users should perform their own safety fine-tuning and related security measures. In no event shall the authors be held liable for any claim, damages, or other liability arising from the use of the released weights and codes.
88
 
89
  ## Technical Specifications
@@ -101,48 +61,17 @@ Link to dataset: _coming soon_
101
  We encourage researchers, developers, and language enthusiasts to actively contribute to the enhancement and expansion of SEA-LION. Contributions can involve identifying and reporting bugs, sharing pre-training, instruction, and preference data, improving documentation usability, proposing and implementing new model evaluation tasks and metrics, or training versions of the model in additional Southeast Asian languages. Join us in shaping the future of SEA-LION by sharing your expertise and insights to make these models more accessible, accurate, and versatile. Please check out our GitHub for further information on the call for contributions.
102
 
103
  ## The Team
104
-
105
- Choa Esther<br>
106
- Cheng Nicholas<br>
107
- Huang Yuli<br>
108
- Lau Wayne<br>
109
- Lee Chwan Ren<br>
110
- Leong Wai Yi<br>
111
- Leong Wei Qi<br>
112
- Li Yier<br>
113
- Liu Bing Jie Darius<br>
114
- Lovenia Holy<br>
115
- Montalan Jann Railey<br>
116
- Ng Boon Cheong Raymond<br>
117
- Ngui Jian Gang<br>
118
- Nguyen Thanh Ngan<br>
119
- Ong Brandon<br>
120
- Ong Tat-Wee David<br>
121
- Ong Zhi Hao<br>
122
- Rengarajan Hamsawardhini<br>
123
- Siow Bryan<br>
124
- Susanto Yosephine<br>
125
- Tai Ngee Chia<br>
126
- Tan Choon Meng<br>
127
- Teo Eng Sipp Leslie<br>
128
- Teo Wei Yi<br>
129
- Tjhi William<br>
130
- Teng Walter<br>
131
- Yeo Yeow Tong<br>
132
- Yong Xianbin<br>
133
 
134
  ## Acknowledgements
135
-
136
  [AI Singapore](​​https://aisingapore.org/) is a national programme supported by the National Research Foundation, Singapore and hosted by the National University of Singapore. Any opinions, findings and conclusions or recommendations expressed in this material are those of the author(s) and do not reflect the views of the National Research Foundation or the National University of Singapore.
137
 
138
  ## Contact
139
-
140
  For more info, please contact us using this [SEA-LION Inquiry Form](https://forms.gle/sLCUVb95wmGf43hi6)
141
 
142
  [Link to SEA-LION's GitHub repository](https://github.com/aisingapore/sealion)
143
 
144
  ## Disclaimer
145
-
146
  This is the repository for the commercial instruction-tuned model.
147
  The model has _not_ been aligned for safety.
148
  Developers and users should perform their own safety fine-tuning and related security measures.
 
8
  - vi
9
  base_model:
10
  - aisingapore/llama3-8b-cpt-sea-lionv2.1-instruct
11
+ new_version: aisingapore/llama3.1-8b-cpt-sea-lionv3-instruct-gguf
12
  ---
13
+ # Llama3 8B CPT SEA-Lionv2.1 Instruct
 
14
  SEA-LION is a collection of Large Language Models (LLMs) which has been pretrained and instruct-tuned for the Southeast Asia (SEA) region.
15
 
16
+ Llama3 8B CPT SEA-Lionv2.1 Instruct is a multilingual model which has been fine-tuned with around **100,000 English instruction-completion pairs** alongside a smaller pool of around **50,000 instruction-completion pairs** from other ASEAN languages, such as Indonesian, Thai and Vietnamese.
17
  These instructions have been carefully curated and rewritten to ensure the model was trained on truly open, commercially permissive and high quality datasets.
18
 
19
  Llama3 8B CPT SEA-Lionv2.1 Instruct has undergone additional supervised fine-tuning and alignment compared to the now deprecated Llama3 8B CPT SEA-Lionv2 Instruct. These improvements have increased the model's capabilities in chat interactions and its ability to follow instructions accurately.
 
23
  - **Developed by:** Products Pillar, AI Singapore
24
  - **Funded by:** Singapore NRF
25
  - **Model type:** Decoder
26
+ - **Languages supported:** English, Indonesian, Thai, Vietnamese, Tamil
27
+ - **License:** [Llama3 Community License](https://huggingface.co/meta-llama/Meta-Llama-3-8B/blob/main/LICENSE)
28
 
29
  ## Description
 
30
  This repo contains `GGUF` format model files for [aisingapore/llama3-8b-cpt-sea-lionv2.1-instruct](https://huggingface.co/aisingapore/llama3-8b-cpt-sea-lionv2.1-instruct).
31
 
32
  #### Model Weights Included in this repository:
 
39
  - [llama3-8b-cpt-sea-lionv2.1-instruct-Q6_K](https://huggingface.co/aisingapore/llama3-8b-cpt-sealionv2-instruct-gguf/blob/main/llama3-8b-cpt-sea-lionv2.1-instruct-Q6_K.gguf)
40
  - [llama3-8b-cpt-sea-lionv2.1-instruct-Q8_0](https://huggingface.co/aisingapore/llama3-8b-cpt-sealionv2-instruct-gguf/blob/main/llama3-8b-cpt-sea-lionv2.1-instruct-Q8_0.gguf)
41
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
42
  ### Caveats
43
  It is important for users to be aware that our model exhibits certain limitations that warrant consideration. Like many LLMs, the model can hallucinate and occasionally generates irrelevant content, introducing fictional elements that are not grounded in the provided context. Users should also exercise caution in interpreting and validating the model's responses due to the potential inconsistencies in its reasoning.
44
 
45
  ## Limitations
46
  ### Safety
 
47
  Current SEA-LION models, including this commercially permissive release, have not been aligned for safety. Developers and users should perform their own safety fine-tuning and related security measures. In no event shall the authors be held liable for any claim, damages, or other liability arising from the use of the released weights and codes.
48
 
49
  ## Technical Specifications
 
61
  We encourage researchers, developers, and language enthusiasts to actively contribute to the enhancement and expansion of SEA-LION. Contributions can involve identifying and reporting bugs, sharing pre-training, instruction, and preference data, improving documentation usability, proposing and implementing new model evaluation tasks and metrics, or training versions of the model in additional Southeast Asian languages. Join us in shaping the future of SEA-LION by sharing your expertise and insights to make these models more accessible, accurate, and versatile. Please check out our GitHub for further information on the call for contributions.
62
 
63
  ## The Team
64
+ Cheng Nicholas, Choa Esther, Huang Yuli, Lau Wayne, Lee Chwan Ren, Leong Wai Yi, Leong Wei Qi, Li Yier, Liu Bing Jie Darius, Lovenia Holy, Montalan Jann Railey, Ng Boon Cheong Raymond, Ngui Jian Gang, Nguyen Thanh Ngan, Ong Brandon, Ong Tat-Wee David, Ong Zhi Hao, Rengarajan Hamsawardhini, Siow Bryan, Susanto Yosephine, Tai Ngee Chia, Tan Choon Meng, Teo Eng Sipp Leslie, Teo Wei Yi, Tjhi William, Teng Walter, Yeo Yeow Tong, Yong Xianbin
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
65
 
66
  ## Acknowledgements
 
67
  [AI Singapore](​​https://aisingapore.org/) is a national programme supported by the National Research Foundation, Singapore and hosted by the National University of Singapore. Any opinions, findings and conclusions or recommendations expressed in this material are those of the author(s) and do not reflect the views of the National Research Foundation or the National University of Singapore.
68
 
69
  ## Contact
 
70
  For more info, please contact us using this [SEA-LION Inquiry Form](https://forms.gle/sLCUVb95wmGf43hi6)
71
 
72
  [Link to SEA-LION's GitHub repository](https://github.com/aisingapore/sealion)
73
 
74
  ## Disclaimer
 
75
  This is the repository for the commercial instruction-tuned model.
76
  The model has _not_ been aligned for safety.
77
  Developers and users should perform their own safety fine-tuning and related security measures.