Update model card: Intended Use, Limitations, code example, BibTeX, licence/email/description fixes

README.md

@@ -0,0 +1,113 @@
+---
+license: cc-by-2.0
+language:
+- en
+- rw
+datasets:
+- mbazaNLP/NMT_Education_parallel_data_en_kin
+- mbazaNLP/Kinyarwanda_English_parallel_dataset
+pipeline_tag: translation
+library_name: transformers
+tags:
+- nllb
+- translation
+- kinyarwanda
+- education
+---
+
+# NLLB-Education — English ↔ Kinyarwanda (Education Domain)
+
+Machine translation model for English ↔ Kinyarwanda, specialised for **education-domain** content.
+Fine-tuned from [facebook/nllb-200-distilled-1.3B](https://huggingface.co/facebook/nllb-200-distilled-1.3B).
+
+**Fine-tuning code:** [Digital-Umuganda/twb_nllb_finetuning](https://github.com/Digital-Umuganda/twb_nllb_finetuning)
+
+## Usage
+
+```python
+from transformers import pipeline
+
+# English → Kinyarwanda
+translator = pipeline(
+    "translation",
+    model="mbazaNLP/NLLB-Education",
+    src_lang="eng_Latn",
+    tgt_lang="kin_Latn",
+    max_length=400,
+)
+result = translator("Education is the foundation of sustainable development.")
+print(result[0]["translation_text"])
+
+# Kinyarwanda → English
+translator_rev = pipeline(
+    "translation",
+    model="mbazaNLP/NLLB-Education",
+    src_lang="kin_Latn",
+    tgt_lang="eng_Latn",
+    max_length=400,
+)
+result = translator_rev("Uburezi ni ishingiro ry'iterambere rirambye.")
+print(result[0]["translation_text"])
+```
+
+## Intended Use
+
+**Suitable for:**
+- Translating education-related content between English and Kinyarwanda
+- Supporting EdTech applications for Rwanda
+- Research into domain-adapted NMT for low-resource African languages
+
+**Not intended for:**
+- General-purpose translation (use `Nllb_finetuned_general_en_kin` instead)
+- Legal, medical, or other high-stakes translation without human review
+
+## Training
+
+Fine-tuned on:
+- [mbazaNLP/NMT_Education_parallel_data_en_kin](https://huggingface.co/datasets/mbazaNLP/NMT_Education_parallel_data_en_kin)
+- [mbazaNLP/Kinyarwanda_English_parallel_dataset](https://huggingface.co/datasets/mbazaNLP/Kinyarwanda_English_parallel_dataset)
+
+Training hardware: A100 40 GB GPU.
+
+## Evaluation
+
+<!-- TODO: add BLEU/spBLEU/chrF++ scores from evaluation -->
+
+| Lang. Direction | BLEU | spBLEU | chrF++ | TER |
+|-----------------|------|--------|--------|-----|
+| Eng → Kin       | —    | —      | —      | —   |
+| Kin → Eng       | —    | —      | —      | —   |
+
+## Limitations
+
+- Domain-adapted for education content; quality may drop on out-of-domain text.
+- Low-frequency Kinyarwanda vocabulary and tonal nuances may not be handled accurately.
+- Outputs should be reviewed by a human translator for high-stakes applications.
+- Maximum reliable input length is approximately 200 tokens.
+
+## Bias and Fairness
+
+Training data reflects written, formal educational language. Colloquial or dialectal Kinyarwanda may be translated with lower quality.
+
+## Bias and Fairness
+
+Machine translation models can reflect and amplify biases present in training data. Known limitations include:
+
+- **Domain bias:** Fine-tuned on specific domain data; performance may be lower on out-of-domain text.
+- **Cultural bias:** Idiomatic expressions, gender-neutral constructs, and culturally specific references in English may not translate accurately or naturally into Kinyarwanda.
+- **Data source bias:** Training data was sourced from specific platforms; text from other sources or registers may yield lower quality translations.
+- **Gender:** English gender-neutral pronouns may be rendered with gendered forms in Kinyarwanda based on distributional patterns in training data.
+
+Validate translation quality on domain-representative samples before deployment in high-stakes contexts (legal, medical, government communications).
+
+## Citation
+
+```bibtex
+@misc{mbazaNLP2023nllb_education,
+  author    = {MBAZA-NLP Community},
+  title     = {{NLLB}-Education: English--Kinyarwanda Machine Translation (Education Domain)},
+  year      = {2023},
+  url       = {https://huggingface.co/mbazaNLP/NLLB-Education},
+  note      = {Hugging Face model repository}
+}
+```