create readme file (#1)

- create readme file (79560748c94513d5fb383967b12eb74d42cfb164)


Co-authored-by: Naymul Islam <[email protected]>

README.md

@@ -0,0 +1,48 @@
+---
+language:
+- bn
+- en
+license: llama3
+base_model: meta-llama/Meta-Llama-3.1-8B
+---
+
+# Bangla LLaMA 8B Bangla2B Base v0.1 [pre-trained]
+
+Welcome to the inaugural release of the Bangla LLaMA 8B unolp-culturax base model – an important step in advancing LLMs for the Bangla language. This model is ready for immediate inference and is also primed for further fine-tuning to cater to your specific NLP tasks.
+
+> **Please Note:** This model, labeled as a foundational Bangla Language Model (LLM), is designed primarily for Causal Language Modeling (LM) purposes. In other words, if you are looking for an instruction following model in Bangla, you may find [BanglaLLM/BanglaLLama-8b-unolp-culturax-instruct-v0.1]() more suitable for your needs.
+
+## Model description
+
+The Bangla LLaMA models have been enhanced and tailored specifically with an extensive Bangla vocabulary of 16,000 tokens, building upon the foundation set by the original LLaMA-3.
+
+- **Model type:** A 8B parameter model for Causal LM pre-trained on unolp/culturax dataset.
+- **Language(s):** Bangla and English
+- **License:** GNU General Public License v3.0
+- **Source Model:** [meta-llama/Meta-Llama-3-8B](https://huggingface.co/meta-llama/Meta-Llama-3-8B)
+- **Training Precision:** `float16`
+- **Code:** [GitHub](https://github.com/abhinand5/bangla-llama)
+
+## Related Models
+
+| Model                    | Type                        | Data              | Base Model           | # Params | Download Links                                                         |
+|--------------------------|-----------------------------|-------------------|----------------------|------|------------------------------------------------------------------------|
+| Bangla LLaMA 7B Base      | Base model                  | 12GB              | LLaMA 7B             | 7B   | [HF Hub](https://huggingface.co/BanglaLLM/bangla-llama-7b-base-v0.1)     |
+| Bangla LLaMA 13B Base     | Base model                  | 4GB               | LLaMA 13B            | 13B  | [HF Hub](https://huggingface.co/BanglaLLM/bangla-llama-13b-base-v0.1)    |
+| Bangla LLaMA 7B Instruct  | Instruction following model | 145k instructions | Bangla LLaMA 7B Base  | 7B   | [HF Hub](https://huggingface.co/BanglaLLM/bangla-llama-7b-instruct-v0.1) |
+| Bangla LLaMA 13B Instruct | Instruction following model | 145k instructions | Bangla LLaMA 13B Base | 13B  | [HF Hub](BanglaLLM/bangla-llama-13b-instruct-v0.1)                       |
+
+## Usage Note
+
+It's important to note that the models have not undergone detoxification. Therefore, while they possess impressive linguistic capabilities, there is a possibility for them to generate content that could be deemed harmful or offensive. We urge users to exercise discretion and supervise the model's outputs closely, especially in public or sensitive applications.
+
+## Meet the Developers
+
+Get to know the creators behind this innovative model and follow their contributions to the field:
+
+- [Abdullah Khan Zehady](https://www.linkedin.com/in/abdullah-khan-zehady-915ba024/)
+
+## Citation
+
+
+We hope this model serves as a valuable tool in your NLP toolkit and look forward to seeing the advancements it will enable in the understanding and generation of the Bangla language.