Create README.md

README.md

@@ -0,0 +1,51 @@
+---
+license: other
+license_name: gemma-terms-of-use
+license_link: https://ai.google.dev/gemma/terms
+datasets:
+- wikimedia/wikipedia
+language:
+- en
+- ta
+base_model: google/gemma-2b
+---
+
+# Gemma 2B Tamil v0.1 Alpha - Base Model [Experimental Release]
+
+This is a Tamil foundational model continually pretrained from Google Gemma 2B. This is an experiment to see if Gemma can be adapted for Tamil without expanding vocabulary. While the responses may be rusty at times, it shows a lot of promise for a 2B parameter model.
+
+> **Please Note:** This model, labeled as a FOUNDATIONAL 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 Tamil, you may find [abhinand/tamil-llama-7b-instruct-v0.1](https://huggingface.co/abhinand/tamil-llama-7b-instruct-v0.1) more suitable for your needs.
+
+**Procedure:**
+
+1. The [Gemma base model](https://huggingface.co/google/gemma-2b) was continually pretrained on all available Tamil Wikipedia data for 3 epochs.
+2. The updated model was then finetuned on a mix of English and Tamil alpaca datasets for 5 epochs. Finetuned model can be found [here](https://huggingface.co/abhinand/gemma-2b-it-tamil-v0.1-alpha).
+
+> **Note:** This project is currently under development (FOR TAMIL). The initial pretraining phase may not have been extensive enough, which suggests that the model's performance could improve by extending the pretraining on a larger dataset, such as CulturaX.
+
+## Model description
+
+- **Model type:** A 2B parameter GPT-like model continually pretrained on all available Tamil data from [Wikipedia dataset](https://huggingface.co/datasets/wikimedia/wikipedia).
+- **Language(s):** Bilingual. English and Tamil.
+- **License:** [Google Gemma Terms of Use](https://ai.google.dev/gemma/terms)
+- **Training Precision:** `bfloat16`
+- **Training Hardware:** 4x Nvidia RTX 3090 GPUs
+- **Training Cost:** $20
+
+## Support my work
+
+If you appreciate this work and would like to support its continued development, consider [buying me a coffee](https://www.buymeacoffee.com/abhinand.b). Your support is invaluable and greatly appreciated.
+
+[!["Buy Me A Coffee"](https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png)](https://www.buymeacoffee.com/abhinand.b)
+
+## 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:
+
+- [Abhinand Balachandran](https://www.linkedin.com/in/abhinand-05/)
+
+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 Tamil language.