tainc commited on
Commit
47e6226
·
verified ·
1 Parent(s): d6c6d38

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +7 -41
README.md CHANGED
@@ -17,8 +17,12 @@ license: gemma
17
  base_model:
18
  - aisingapore/gemma2-9b-cpt-sea-lionv3-instruct
19
  ---
20
- # Gemma2 9B CPT SEA-LIONv3 Instruct
21
 
 
 
 
 
 
22
  SEA-LION is a collection of Large Language Models (LLMs) which have been pretrained and instruct-tuned for the Southeast Asia (SEA) region.
23
 
24
  Gemma2 9B CPT SEA-LIONv3 Instruct is a multilingual model which has been fine-tuned with around **500,000 English instruction-completion pairs** alongside a larger pool of around **1,000,000 instruction-completion pairs** from other ASEAN languages, such as Indonesian, Thai and Vietnamese.
@@ -28,11 +32,10 @@ SEA-LION stands for _Southeast Asian Languages In One Network_.
28
  - **Developed by:** Products Pillar, AI Singapore
29
  - **Funded by:** Singapore NRF
30
  - **Model type:** Decoder
31
- - **Languages:** English, Chinese, Vietnamese, Indonesian, Thai, Filipino, Tamil, Malay, Khmer, Lao, Burmese, Javanese, Sundanese
32
  - **License:** [Gemma Community License](https://ai.google.dev/gemma/terms)
33
 
34
  ## Description
35
-
36
  This repo contains `GGUF` format model files for [aisingapore/gemma2-9b-cpt-sea-lionv3-instruct](https://huggingface.co/aisingapore/gemma2-9b-cpt-sea-lionv3-instruct).
37
 
38
  #### Model Weights Included in this repository:
@@ -46,44 +49,11 @@ This repo contains `GGUF` format model files for [aisingapore/gemma2-9b-cpt-sea-
46
  - [gemma2-9b-cpt-sea-lionv3-instruct-Q6_K](https://huggingface.co/aisingapore/gemma2-9b-cpt-sea-lionv3-instruct-gguf/blob/main/gemma2-9b-cpt-sea-lionv3-instruct-Q6_K.gguf)
47
  - [gemma2-9b-cpt-sea-lionv3-instruct-Q8_0](https://huggingface.co/aisingapore/gemma2-9b-cpt-sea-lionv3-instruct-gguf/blob/main/gemma2-9b-cpt-sea-lionv3-instruct-Q8_0.gguf)
48
 
49
- ### Usage
50
- Gemma2 9B CPT SEA-LIONv3 Instruct GGUF files have been tested on `llama.cpp`, from pull request [#8772](https://github.com/ggerganov/llama.cpp/pull/8772)
51
-
52
- #### Chat Template:
53
- ```
54
- <bos><start_of_turn>user
55
- {{prompt}}<end_of_turn>
56
- <start_of_turn>model
57
-
58
- ```
59
-
60
- #### Sample`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/gemma2-9b-cpt-sea-lionv3-instruct/gemma2-9b-cpt-sea-lionv3-instruct-F16.gguf -ngl -1 -p "<bos><start_of_turn>user\nApa sentimen dari kalimat berikut ini?\nKalimat: Buku ini sangat membosankan.\nJawaban: <end_of_turn>\n<start_of_turn>model\n"
65
- ```
66
- ```sh
67
- # Running in conversation mode
68
- ./llama-cli -m models/gemma2-9b-cpt-sea-lionv3-instruct/gemma2-9b-cpt-sea-lionv3-instruct-F16.gguf -ngl -1 --color -cnv
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
@@ -97,21 +67,17 @@ Gemma2 9B CPT SEA-LIONv3 Instruct was trained on a wide range of synthetic instr
97
  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.
98
 
99
  ## The Team
100
-
101
- Chan Adwin, Choa Esther, Cheng Nicholas, Huang Yuli, Lau Wayne, Lee Chwan Ren, Leong Wai Yi, Leong Wei Qi, Limkonchotiwat Peerat, Liu Bing Jie Darius, 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
102
 
103
  ## Acknowledgements
104
-
105
  [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.
106
 
107
  ## Contact
108
-
109
  For more info, please contact us using this [SEA-LION Inquiry Form](https://forms.gle/sLCUVb95wmGf43hi6)
110
 
111
  [Link to SEA-LION's GitHub repository](https://github.com/aisingapore/sealion)
112
 
113
  ## Disclaimer
114
-
115
  This is the repository for the commercial instruction-tuned model.
116
  The model has _not_ been aligned for safety.
117
  Developers and users should perform their own safety fine-tuning and related security measures.
 
17
  base_model:
18
  - aisingapore/gemma2-9b-cpt-sea-lionv3-instruct
19
  ---
 
20
 
21
+ <div>
22
+ <img src="gemma_2_9b_sea-lion_v3_gguf_banner.png"/>
23
+ </div>
24
+
25
+ # Gemma2 9B CPT SEA-LIONv3 Instruct
26
  SEA-LION is a collection of Large Language Models (LLMs) which have been pretrained and instruct-tuned for the Southeast Asia (SEA) region.
27
 
28
  Gemma2 9B CPT SEA-LIONv3 Instruct is a multilingual model which has been fine-tuned with around **500,000 English instruction-completion pairs** alongside a larger pool of around **1,000,000 instruction-completion pairs** from other ASEAN languages, such as Indonesian, Thai and Vietnamese.
 
32
  - **Developed by:** Products Pillar, AI Singapore
33
  - **Funded by:** Singapore NRF
34
  - **Model type:** Decoder
35
+ - **Languages supported:** Burmese, Chinese, English, Filipino, Indonesia, Javanese, Khmer, Lao, Malay, Sundanese, Tamil, Thai, Vietnamese
36
  - **License:** [Gemma Community License](https://ai.google.dev/gemma/terms)
37
 
38
  ## Description
 
39
  This repo contains `GGUF` format model files for [aisingapore/gemma2-9b-cpt-sea-lionv3-instruct](https://huggingface.co/aisingapore/gemma2-9b-cpt-sea-lionv3-instruct).
40
 
41
  #### Model Weights Included in this repository:
 
49
  - [gemma2-9b-cpt-sea-lionv3-instruct-Q6_K](https://huggingface.co/aisingapore/gemma2-9b-cpt-sea-lionv3-instruct-gguf/blob/main/gemma2-9b-cpt-sea-lionv3-instruct-Q6_K.gguf)
50
  - [gemma2-9b-cpt-sea-lionv3-instruct-Q8_0](https://huggingface.co/aisingapore/gemma2-9b-cpt-sea-lionv3-instruct-gguf/blob/main/gemma2-9b-cpt-sea-lionv3-instruct-Q8_0.gguf)
51
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
52
  ### Caveats
53
  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.
54
 
55
  ## Limitations
56
  ### Safety
 
57
  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.
58
 
59
  ## Technical Specifications
 
67
  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.
68
 
69
  ## The Team
70
+ Chan Adwin, Cheng Nicholas, Choa Esther, Huang Yuli, Hulagadri Adithya Venkatadri, Lau Wayne, Lee Chwan Ren, Leong Wai Yi, Leong Wei Qi, Limkonchotiwat Peerat, Liu Bing Jie Darius, 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, Teng Walter, Teo Eng Sipp Leslie, Teo Wei Yi, Tjhi William, Yeo Yeow Tong, Yong Xianbin
 
71
 
72
  ## Acknowledgements
 
73
  [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.
74
 
75
  ## Contact
 
76
  For more info, please contact us using this [SEA-LION Inquiry Form](https://forms.gle/sLCUVb95wmGf43hi6)
77
 
78
  [Link to SEA-LION's GitHub repository](https://github.com/aisingapore/sealion)
79
 
80
  ## Disclaimer
 
81
  This is the repository for the commercial instruction-tuned model.
82
  The model has _not_ been aligned for safety.
83
  Developers and users should perform their own safety fine-tuning and related security measures.