Upload README.md with huggingface_hub

README.md

@@ -1,3 +1,4 @@
+
 ---
 license: llama3
 language:
@@ -5,10 +6,39 @@ language:
 base_model: meta-llama/Meta-Llama-3-8B
 library_name: transformers
 ---
+# Llama3 8B for Sinhala: 100 target vocabulary size + Random target vocabulary initialization + T&B2LS/MTP/512 training
+
+This model is built on top of Llama3 8B adapted for Sinhala using 30K target language sentences sampled from CC-100.
+
+## Model Details
+
+* **Vocabulary**: This model has an additional 100 target vocabulary.
+* **Target vocabulary initialization**: The target weights of the embedding and LM head were initialized using Random initialization.
+* **Training**: This model was additionally pre-trained on 30K target language sentences sampled from CC-100. The training was conducted with the T&B2LS/MTP/512 strategies introduced in the paper.
+
+## Model Description
+
+- **Language:** Sinhala
+- **License:** Llama 3 Community License Agreement
+- **Fine-tuned from model:** meta-llama/Meta-Llama-3-8B
+
+
+## Model Sources
+
+- **Repository:** https://github.com/gucci-j/lowres-cve
+- **Paper:** https://arxiv.org/abs/2406.11477
+
+## How to Get Started with the Model
+Use the code below to get started with the model.
+```python
+from transformers import AutoTokenizer, AutoModelForCausalLM
 
-# Sinhala LLaMA3-8B model
+model = AutoModelForCausalLM.from_pretrained(
+    "atsuki-yamaguchi/Llama-3-8B-si-30K-100-rand"
+)
+tokenizer = AutoTokenizer.from_pretrained(
+    "atsuki-yamaguchi/Llama-3-8B-si-30K-100-rand"
+)
+```
 
-This model was adapted for Sinhala with 30K target language sentences + Random + T&B 2LS + MTP + 512. 
 
-For technical details, please read the paper: https://arxiv.org/abs/2406.11477.  
-For implementation details, please see the code repository: https://github.com/gucci-j/lowres-cve.