From 5c8b5f92cd1a60bc2c782f900d59032231e1e9a3 Mon Sep 17 00:00:00 2001
From: Kunat <kunato@users.noreply.huggingface.co>
Date: Wed, 8 May 2024 10:49:04 +0000
Subject: [PATCH] Create README.md

---
 README.md | 50 ++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 50 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..92e8a62
--- /dev/null
+++ b/README.md
@@ -0,0 +1,50 @@
+---
+license: llama3
+language:
+- th
+- en
+---
+**Typhoon-v1.5-8B: Thai Large Language Model (Pretrained)**
+
+**Typhoon-8B** is a *pretrained only* Thai 🇹🇭 large language model with 8 billion parameters, and it is based on Llama3-8B.
+
+For release notes, please see our blog.
+
+## **Model Description**
+
+- **Model type**: A 8B pretrained decoder-only model based on Llama architecture.
+- **Requirement**: transformers 4.38.0 or newer.
+- **Primary Language(s)**: Thai 🇹🇭 and English 🇬🇧
+- **License**: [Llama 3 Community License](https://llama.meta.com/llama3/license/)
+
+## **Intended Uses & Limitations**
+
+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.
+
+## **Follow us**
+
+**https://twitter.com/opentyphoon**
+
+## **Support**
+
+**https://discord.gg/CqyBscMFpg**
+
+## **SCB10X AI Team**
+
+- Kunat Pipatanakul, Potsawee Manakul, Sittipong Sripaisarnmongkol, Pathomporn Chokchainant, Kasima Tharnpipitchai
+- If you find Typhoon-8B useful for your work, please cite it using:
+
+```
+@article{pipatanakul2023typhoon,
+    title={Typhoon: Thai Large Language Models}, 
+    author={Kunat Pipatanakul and Phatrasek Jirabovonvisut and Potsawee Manakul and Sittipong Sripaisarnmongkol and Ruangsak Patomwong and Pathomporn Chokchainant and Kasima Tharnpipitchai},
+    year={2023},
+    journal={arXiv preprint arXiv:2312.13951},
+    url={https://arxiv.org/abs/2312.13951}
+}
+```
+
+## **Contact Us**
+
+- General & Collaboration: **[kasima@scb10x.com](mailto:kasima@scb10x.com)**, **[pathomporn@scb10x.com](mailto:pathomporn@scb10x.com)**
+- Technical: **[kunat@scb10x.com](mailto:kunat@scb10x.com)**
\ No newline at end of file