Update README.md

README.md

@@ -1,12 +1,36 @@
 ---
 library_name: transformers
-tags: []
+tags:
+- translation
+- English-Darija
+- NLP
+- AI
+- text-to-text
+- low-resource-languages
+license: mit
+language:
+- en
+- ar
+metrics:
+- bleu
+- rouge
+base_model:
+- google/mt5-base
+pipeline_tag: translation
 ---
 
 # Model Card for Model ID
 
 <!-- Provide a quick summary of what the model is/does. -->
 
+Developed by: LocaleNLP
+Funded by: Internal R&D and NLP Research Grants
+Shared by: LocaleNLP
+Model type: Sequence-to-sequence Transformer model
+Languages Supported: English, Moroccan Darija
+License: Apache 2.0
+Finetuned from model: mT5
+
 
 
 ## Model Details
@@ -15,23 +39,23 @@ tags: []
 
 <!-- Provide a longer summary of what this model is. -->
 
-This is the model card of a 🤗 transformers model that has been pushed on the Hub. This model card has been automatically generated.
+The LocaleNLP English-Darija Model is a transformer-based translation model designed to bridge the language gap between English and Moroccan Darija (a dialect of Arabic spoken in Morocco). It is fine-tuned from mT5 to support text and text translation tasks, improving accessibility for Darija speakers in digital applications.
 
-- **Developed by:** [More Information Needed]
-- **Funded by [optional]:** [More Information Needed]
-- **Shared by [optional]:** [More Information Needed]
-- **Model type:** [More Information Needed]
-- **Language(s) (NLP):** [More Information Needed]
-- **License:** [More Information Needed]
-- **Finetuned from model [optional]:** [More Information Needed]
+- **Developed by:** [LocaleNLP]
+- **Funded by [Internal R&D]:** [Internal R&D and NLP Research Grants]
+- **Shared by [LocaleNLP]:** [More Information Needed]
+- **Model type:** [Sequence-to-sequence Transformer model]
+- **Language(s) (NLP):** [English, Moroccan Darija]
+- **License:** [Apache 2.0]
+- **Finetuned from model [mT5]:** [More Information Needed]
 
 ### Model Sources [optional]
 
 <!-- Provide the basic links for the model. -->
 
-- **Repository:** [More Information Needed]
-- **Paper [optional]:** [More Information Needed]
-- **Demo [optional]:** [More Information Needed]
+- **Repository:** [https://huggingface.co/LocaleNLP/English_darija]
+- **Paper [Coming soon]:** [More Information Needed]
+- **Demo [Try it on LocaleNLP API]:** [https://localenlp.com/]
 
 ## Uses
 
@@ -70,6 +94,15 @@ Users (both direct and downstream) should be made aware of the risks, biases and
 ## How to Get Started with the Model
 
 Use the code below to get started with the model.
+```bash
+from transformers import pipeline
+
+translator = pipeline("translation", model="LocaleNLP/English_darija")
+text = "Hello, how are you?"
+result = translator(text)
+print(result)
+```
+
 
 [More Information Needed]
 
@@ -173,6 +206,14 @@ Carbon emissions can be estimated using the [Machine Learning Impact calculator]
 <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
 
 **BibTeX:**
+```sh
+@misc{LocaleNLP2024EnglishDarija,
+  title={LocaleNLP English-Darija Translation Model},
+  author={LocaleNLP AI Research Team},
+  year={2024},
+  url={https://huggingface.co/LocaleNLP/English_darija}
+}
+```
 
 [More Information Needed]
 
@@ -187,6 +228,11 @@ Carbon emissions can be estimated using the [Machine Learning Impact calculator]
 [More Information Needed]
 
 ## More Information [optional]
+Contact & Support
+For questions or contributions:
+📧 Email: [email protected]
+🌍 Website: https://www.localenlp.com
+GitHub: https://github.com/LocaleNLP
 
 [More Information Needed]