Update README.md (#1)

- Update README.md (b35fc6ffd761a017a7289e7b1d4e51cbf5defc72)


Co-authored-by: Potsawee Manakul <[email protected]>

README.md

@@ -1,3 +1,4 @@
+
 ---
 license: apache-2.0
 language:
@@ -7,40 +8,47 @@ pipeline_tag: text-generation
 tags:
 - pretrained
 ---
-# Model Card for Typhoon-7B
+# Typhoon-7B: Thai Large Language Model
 
-**Typhoon 7B** is a pretrained Thai language adaption of Mistral-7B with 7 billion parameters.
+**Typhoon-7B** is a *pretrained* Thai 🇹🇭 large language model with 7 billion parameters, and it is based on Mistral-7B.
 
-**Typhoon 7B** outperforms all open-source Thai language models as of this publishing, and its performance is on par with GPT-3.5 while being 2.62 times more efficient.
+**Typhoon-7B** outperforms all open-source Thai language models at the time of writing as evaluated on Thai examination benchmarks, and its instruction-tuned variant achieves the best results in instruction-following tasks. Also, its performance in Thai is on par with GPT-3.5 while being 2.62 times more efficient in tokenizing Thai text.
 
 
 <div align="center">
-  <img src="https://storage.googleapis.com/scb10x-ai-lab-public/assets/typhoon_benchmark.png" alt="Typhoon benchmark" width="100%" style="margin-left:'auto' margin-right:'auto' display:'block'"/>
+<img src="https://storage.googleapis.com/scb10x-ai-lab-public/assets/typhoon_benchmark.png" alt="Typhoon benchmark" width="100%" style="margin-left:'auto' margin-right:'auto' display:'block'"/>
 </div>
 
-For full details of this model please read our [paper]() and [release blog post]().
-
-
-## Requirements
-
-Transformers, 4.34.0 or newer.
+For full details of this model, please read our [paper]() and [release blog post]().
 
 
-## Model date
+## Model Description
+- **Model type**: A 7B pretrained decoder-only model
+- **Requirement**: transformers 4.34.0 or newer.
+- **Primary Language(s)**: Thai 🇹🇭 and English 🇬🇧
+- **License**: Apache-2.0 (Commercial)
 
-**Typhoon 7B** was trained at December, 2023.
+## Performance on Thai Benchmark
 
+| **Model**           | **ONET** | **IC** | **TGAT** | **TPAT-1** | **A-Level** |
+|---------------------|----------|--------|----------|------------|-------------|
+| Typhoon-7B          | 0.379    | 0.393  | 0.700    | 0.414      | 0.324       |
+| SeaLLM-7B           | 0.342    | 0.256  | 0.589    | 0.336      | 0.305       |
+| OpenThaiGPT-beta-7B | 0.180    | 0.278  | 0.411    | 0.319      | 0.243       |
+| WangChanGLM         | 0.192    | 0.271  | 0.167    | 0.172      | 0.175       |
+| SEA-LION-7B         | 0.179    | 0.290  | 0.244    | 0.198      | 0.175       |
+| Avg. Human          | 0.318    | -      | 0.472    | 0.406      | -           |
 
-## License
-Apache-2.0 (Commercial)
+## Intended Uses & Limitations
 
-
-## Notice
-
-Typhoon 7B is a pretrained base model; it cannot understand human instructions without using a few-shot or fine-tune approach on an instruct dataset,
-and does not have any moderation mechanisms.
+This model is a pretrained base model. Thus, it may not be able to follow  human instructions without using one/few-shot learning or instruction fine-tuning. The model does not have any moderation mechanisms, and may generate harmful or inappropriate responses.
 
 
 ## SCB10X AI Team
  
-Kunat Pipatanakul, Phatrasek Jirabovonvisut, Potsawee Manakul, Sittipong Sripaisarnmongkol, Ruangsak Patomwong, Pathomporn Chokchainant, Kasima Tharnpipitchai
+- Kunat Pipatanakul, Phatrasek Jirabovonvisut, Potsawee Manakul, Sittipong Sripaisarnmongkol, Ruangsak Patomwong, Pathomporn Chokchainant, Kasima Tharnpipitchai
+- Corresponding Author: [email protected] 
+- If you find Typhoon-7B useful for your work, please cite it using:
+```
+
+```