Update README.md

README.md

@@ -11,4 +11,53 @@ tags:
 - Cantonese
 - chat
 - Llama3
----
+---
+
+# Llama-3-Cantonese-8B-Instruct
+
+## Model Overview
+
+Llama-3-Cantonese-8B-Instruct is a Cantonese language model based on Meta-Llama-3-8B-Instruct, fine-tuned using LoRA. It aims to enhance Cantonese text generation and comprehension capabilities, supporting various tasks such as dialogue generation, text summarization, and question-answering.
+
+## Model Features
+
+- **Base Model**: Meta-Llama-3-8B-Instruct
+- **Fine-tuning Method**: LoRA instruction tuning
+- **Training Steps**: 4562 steps
+- **Primary Language**: Cantonese
+- **Datasets**:
+  - [jed351/cantonese-wikipedia](https://huggingface.co/datasets/jed351/cantonese-wikipedia)
+  - [lordjia/Cantonese_English_Translation](https://huggingface.co/datasets/lordjia/Cantonese_English_Translation)
+- **Training Tools**: [LLaMA-Factory](https://github.com/hiyouga/LLaMA-Factory)
+
+## Usage
+
+You can easily load and use this model with Hugging Face's Transformers library. Here is a simple example:
+
+```python
+from transformers import AutoModelForCausalLM, AutoTokenizer
+
+tokenizer = AutoTokenizer.from_pretrained("lordjia/Llama-3-Cantonese-8B-Instruct")
+model = AutoModelForCausalLM.from_pretrained("lordjia/Llama-3-Cantonese-8B-Instruct")
+
+input_text = "唔該你用廣東話講下你係邊個。"
+inputs = tokenizer(input_text, return_tensors="pt")
+outputs = model.generate(**inputs)
+print(tokenizer.decode(outputs[0], skip_special_tokens=True))
+```
+
+## Quantized Version
+
+A 4-bit quantized version of this model is also available: [llama3-cantonese-8b-instruct-q4_0.gguf](https://huggingface.co/lordjia/Llama-3-Cantonese-8B-Instruct/blob/main/llama3-cantonese-8b-instruct-q4_0.gguf).
+
+## License
+
+This model is licensed under the Llama 3 Community License. Please review the terms before use.
+
+## Contributors
+
+- LordJia
+
+## Acknowledgements
+
+Thanks to Hugging Face for providing the platform and tools, and to all the developers and researchers contributing to the open-source community.