Update README.md

README.md

@@ -1,3 +1,121 @@
----
-license: cc-by-4.0
----
+---
+license: cc-by-4.0
+---
+# Eng-PidginEdu Dataset
+
+## Overview
+
+Eng-PidginEdu is a large-scale English–Nigerian Pidgin parallel corpus designed to support machine translation and educational accessibility research. The dataset contains **30,618 sentence pairs** spanning **8 core secondary school subjects**, with approximately **1.28 million tokens** and **99.997% alignment quality**.
+
+This dataset addresses the critical gap in educational resources for Nigerian Pidgin, a lingua franca spoken by over 75 million people, enabling the development of AI systems that improve access to education across linguistically diverse regions.
+
+---
+
+## Dataset Composition
+
+* **Total sentence pairs:** 30,618
+
+* **Subjects covered:**
+
+  * Computer Science
+  * Business Studies
+  * Government
+  * Civic Education
+  * Social Studies
+  * Biology
+  * English Language
+  * History
+
+* **Splits:**
+
+  * Train: 24,493
+  * Validation: 3,061
+  * Test: 3,063
+
+* **Languages:**
+
+  * Source: English (`en`)
+  * Target: Nigerian Pidgin (`pcm`)
+
+---
+
+## Data Collection Process
+
+The dataset was constructed from publicly accessible Nigerian secondary school textbooks and open educational resources aligned with national curriculum standards. Texts were digitized and processed through:
+
+1. Automated text extraction (PyPDF2, python-docx)
+2. Sentence segmentation (NLTK punkt tokenizer)
+3. Multi-stage cleaning (spaCy, textacy, regex filtering)
+
+Translations were generated using a hybrid pipeline:
+
+* Machine translation using **Davlan/mt5-small-en-pcm**
+* Rule-based quality filtering
+* Human-in-the-loop validation by native Nigerian Pidgin speakers
+
+This process ensured high-quality, educationally faithful translations.
+
+---
+
+## Key Features
+
+* Large-scale educational parallel corpus for a low-resource language
+* Multi-domain coverage across 8 subjects
+* Human-validated translations
+* Support for code-switching and natural Pidgin variation
+* Designed for real-world educational deployment
+
+---
+
+## Intended Use
+
+This dataset is intended for:
+
+* Machine translation (English ↔ Nigerian Pidgin)
+* Educational AI systems
+* Low-resource NLP research
+* Multilingual learning platforms
+
+---
+
+## Limitations
+
+* Domain-specific (education-focused)
+* Contains orthographic variation in Pidgin
+* Includes code-switching, which may affect standard evaluation metrics
+* Not representative of all dialectal variations of Nigerian Pidgin
+
+---
+
+## Bias and Ethical Considerations
+
+* Biased toward formal educational language
+* Uneven subject distribution (e.g., Computer Science overrepresented)
+* Reflects real-world linguistic variation rather than standardized forms
+
+No personal or sensitive data is included.
+
+---
+
+## Licensing
+
+This dataset is released under the **CC-BY-4.0 License**.
+
+---
+
+## Citation
+
+If you use this dataset, please cite:
+
+Oladipupo, F. (2026). *Eng-PidginEdu: Scaling Nigerian Pidgin Educational Content through Community-Driven Machine Translation*. 
+
+---
+
+## Acknowledgements
+
+We acknowledge the contributions of native Nigerian Pidgin speakers who participated in validation, and the open educational resources that made this dataset possible.
+
+---
+
+
+