Update README.md

README.md

@@ -4,4 +4,81 @@ language:
 base_model:
 - google-t5/t5-small
 pipeline_tag: translation
----
+---
+
+## Overview
+
+thinkKenya’s **Luo–Swahili Translation Model** is a fine-tuned T5-small designed to translate between the Luo (dav) and Swahili (swa) languages. It was trained on a parallel corpus of approximately 29,300 Luo–Swahili sentence pairs drawn from the larger “Kenyan Low-Resource Language Data” dataset. thinkKenya—also known as Tech Innovators Network Kenya—is a community-driven technology initiative founded in 2019 to support digital transformation and applied open innovation across Kenya, with a special focus on African local languages.
+
+## Model Details
+
+* **Model name**: `thinkKenya/luo_swa_translation_model`
+* **Architecture**: T5-small (60.5M parameters) ([Hugging Face][1])
+* **Framework**: Hugging Face Transformers (safetensors weights) ([Hugging Face][1])
+* **Base checkpoint**: `google-t5/t5-small` ([Hugging Face][1])
+* **Tensor type**: F32 ([Hugging Face][1])
+* **Training status**: In progress (latest reported step: 146,600) ([Hugging Face][1])
+
+## Dataset
+
+* **Dataset name**: `thinkKenya/kenyan-low-resource-language-data` ([Hugging Face][2])
+* **Task**: Translation (parallel text) ([Hugging Face][2])
+* **Languages**: Swahili (ISO: swa) ([Hugging Face][2])
+* **Subset used**: `luo_swa` (29.3k rows total; train split: 21.3k rows; test split: 5.33k rows) ([Hugging Face][2], [Hugging Face][2])
+* **Format**: Parquet
+* **License**: CC-BY-4.0 ([Hugging Face][2])
+
+## Organization: Tech Innovators Network Kenya (thinkKenya)
+
+### Mission & History
+
+Tech Innovators Network Kenya (THiNK) is a community-driven technology initiative founded in 2019, aimed at assisting businesses and citizens in their digital transformation journeys through applied open innovation ([LinkedIn][3]). Their primary objectives include supporting local language AI, fintech solutions, and ecosystem development for innovators across Kenya ([Hugging Face][4]).
+
+### Key Focus Areas
+
+* **African local languages**: Building datasets and models for under-resourced languages ([Hugging Face][5])
+* **Digital transformation**: Consulting and technology services for Kenyan businesses ([LinkedIn][3])
+* **Community building**: Convening forums like the AI Community of Practice to foster collaboration ([Community of Practitioners in AI][6])
+
+## Training Configuration
+
+| Component          | Details                                                              |
+| ------------------ | -------------------------------------------------------------------- |
+| Model weights      | `model.safetensors` (242 MB)                                         |
+| Tokenizer files    | `tokenizer.json`, `special_tokens_map.json`, `tokenizer_config.json` |
+| Config file        | `config.json`                                                        |
+| Training args      | `training_args.bin`                                                  |
+| Framework versions | Transformers ≥4.x, Datasets ≥2.x                                     |
+
+## Example Usage
+
+```python
+from transformers import T5Tokenizer, T5ForConditionalGeneration
+
+tokenizer = T5Tokenizer.from_pretrained("thinkKenya/luo_swa_translation_model")
+model     = T5ForConditionalGeneration.from_pretrained("thinkKenya/luo_swa_translation_model")
+
+input_text = "translate Luo to Swahili: Wuki ghwa choki"
+inputs     = tokenizer(input_text, return_tensors="pt")
+outputs    = model.generate(**inputs)
+print(tokenizer.decode(outputs[0], skip_special_tokens=True))
+```
+
+## Limitations
+
+* **Training in progress**: May produce unstable or under-trained outputs due to ongoing fine-tuning ([Hugging Face][1]).
+* **Domain coverage**: Limited to conversational and narrative sentences present in the corpus—out-of-domain text may yield poor translations.
+* **Evaluation metrics**: No public BLEU/ROUGE scores yet; users should perform their own evaluations.
+
+## Citation
+
+```bibtex
+@misc{luo_swa_translation_model,
+  title        = {Luo–Swahili Translation Model},
+  author       = {thinkKenya (Tech Innovators Network Kenya)},
+  year         = {2024},
+  publisher    = {Hugging Face},
+  howpublished = {\url{https://huggingface.co/thinkKenya/luo_swa_translation_model}},
+}
+```
+