Update README.md

README.md

@@ -6,6 +6,127 @@ colorTo: green
 sdk: static
 pinned: false
 ---
-Testing Readme change
+**Dataset Source**:
+ - Original Source: The English sentences were sourced from https://www.gutenberg.org/ .
+ - Translation Tool: Google Translate was used for translating the sentences from English to Yoruba.
 
-Edit this `README.md` markdown file to author your organization card.
+**Dataset Format**:
+ - english: The original English sentence.
+ - yoruba: The Yoruba translation of the sentence.
+ - source: the source of the English sentences.
+## Example:
+|en	|yo	|source|
+|-----|----------------------------|--------------------------|
+|The subconscious offensiveness of their attitude has constituted old Jolyon's 'home' the psychological moment of the family history, made it the prelude of their drama.|	Iwa ibinu èrońgbà ti iṣesi wọn ti jẹ “ile” atijọ ti Jolyon ni akoko imọ-jinlẹ ti itan-akọọlẹ ẹbi, jẹ ki o jẹ iṣaaju ti eré wọn.	https://www.gutenberg.org/ebooks/2559.txt.utf-8|
+|The Forsytes were resentful of something, not individually, but as a family; this resentment expressed itself in an added perfection of raiment, an exuberance of family cordiality, an exaggeration of family importance, and--the sniff.|	Awọn Forsytes binu si nkan kan, kii ṣe olukuluku, ṣugbọn gẹgẹbi idile; ibinu yii ṣe afihan ararẹ ni pipe ti aṣọ ti a fi kun, igbadun ti ifarabalẹ idile, iṣaju ti pataki idile, ati --ifun.|	https://www.gutenberg.org/ebooks/2559.txt.utf-8 |
+|Danger--so indispensable in bringing out the fundamental quality of any society, group, or individual--was what the Forsytes scented; the premonition of danger put a burnish on their armour.|	Ewu - nitorinaa ko ṣe pataki lati mu didara ipilẹ ti awujọ, ẹgbẹ, tabi ẹni kọọkan jade - jẹ ohun ti awọn Forsytes rùn; premonition ti ewu fi kan iná lori wọn ihamọra.|	https://www.gutenberg.org/ebooks/2559.txt.utf-8|
+
+**Dataset Size**:
+ - Number of Entries:
+ - File Size:
+**Usage**:
+This dataset can be used for:
+ - Training machine translation models for Yoruba.
+ - Analyzing translation quality and limitations in automated tools.
+ - Supporting linguistic research and NLP projects for low-resource languages.
+
+**Limitations and Considerations**:
+ - Quality of Translations: As translations were generated using Google Translate, some sentences may not reflect perfect accuracy. Manual validation is recommended for critical applications.
+ - Cultural and Contextual Nuances: Machine translations might miss idiomatic expressions or cultural nuances present in the source language.
+ - Biases: Any biases inherent in Google Translate's model may propagate into this dataset.
+
+Licensing:
+Source Material License: [Specify the license of the original English sentences, if applicable.]
+Translated Dataset License: [Specify the license for your dataset, e.g., Creative Commons Attribution 4.0 (CC BY 4.0).]
+
+## tags:
+
+  - machine-translation
+
+  - speech-to-text
+
+  - yoruba-language
+
+  - african-languages
+
+## task_categories:
+
+  - text-classification
+
+  - machine-translation
+
+---
+
+
+
+# Dataset Card for [Dataset Name]
+
+
+
+## Dataset Summary
+
+
+
+[Brief description of the dataset, including its purpose and key features. For example:  
+
+"This dataset contains bilingual pairs of Yoruba and English sentences for tasks such as machine translation, text classification, and language modeling. The dataset is designed to address the lack of resources for African languages in NLP."]
+
+
+
+## Supported Tasks and Applications
+
+
+
+### Tasks
+
+
+
+[List supported tasks and examples, e.g.:]
+
+- **Machine Translation:** Translating Yoruba to English and vice versa.
+
+- **Language Modeling:** Building and evaluating language models for Yoruba.
+
+
+
+### Applications
+
+
+
+[List practical applications of the dataset, e.g., translation tools, chatbots, etc.]
+
+
+
+## Languages
+
+
+
+This dataset includes data in:
+
+- **Yoruba**: A tonal language spoken by over 45 million people in Nigeria and West Africa.
+
+- **English**: Standard English translations of the Yoruba sentences.
+
+
+
+## Dataset Structure
+
+
+
+### Data Instances
+
+
+
+Each instance in the dataset is represented as a pair of Yoruba and English sentences. An example instance is as follows:
+
+
+
+```json
+
+{
+
+  "yoruba": "Ẹ kaaro.",
+
+  "english": "Good morning."
+
+}