Create README.md

README.md

@@ -0,0 +1,125 @@
+---
+license: apache-2.0
+task_categories:
+- translation
+language:
+- ur
+tags:
+- urdu
+- translation
+- Transliteration
+- parallel
+- dataset
+pretty_name: Roman Urdu Parl
+size_categories:
+- 1M<n<10M
+---
+
+# Roman Urdu Parallel Dataset - Split
+
+This dataset is just another version of Roman-Urdu-Parl dataset split into train, validation and test set properly. Details follow below.
+This repository contains a split version of the Roman-Urdu Parallel Dataset (Roman-Urdu-Parl) structured specifically to facilitate fair evaluation in machine transliteration tasks between Urdu and Roman-Urdu. 
+The Roman-Urdu language lacks standard orthography, leading to a wide range of transliteration variations for the same Urdu sentence. 
+This dataset addresses the need for non-overlapping train, test, and validation sets, mitigating data leakage that could otherwise inflate evaluation metrics.
+
+
+## Original Dataset Overview
+The original Roman-Urdu-Parl dataset consists of 6,365,808 rows, featuring parallel sentences in Urdu and Roman-Urdu. 
+These numbers can be replicated using the script at: scripts/check_stats.py
+The unique characteristics of the original dataset are as follows:
+
+- Unique Urdu sentences: 1,087,220
+- Unique Roman-Urdu sentences: 3,999,102
+- Rows where both sentences match: 167
+- Rows where both sentences differ: 6,365,641
+- Urdu sentences appearing only once: 90,637
+- Roman-Urdu sentences appearing only once: 3,165,765
+- Unique pairs of Urdu and Roman-Urdu sentences: 4,003,784
+- Short sentences (fewer than 3 words): 2,321
+
+## Motivation for a Structured Splitting Approach
+### Summary
+In the original dataset, variations in Roman-Urdu transliterations of the same Urdu sentence pose a risk of data leakage if randomly split into training, validation, and test sets.
+Random splits may cause the same Urdu sentence (or its Roman-Urdu variations) to appear in multiple sets, leading the model to "memorize" rather than generalize transliteration patterns.
+This structured split addresses the issue by ensuring unique sets with no overlap between training, validation, and test sets, thus promoting generalization.
+The script to split the dataset is at : splitting_rup_data.py
+
+### Detailed Motivation
+The Roman-Urdu language is an informal, non-standardized way of writing Urdu using the Roman alphabet, which allows for considerable variation in transliteration. 
+Different speakers may transliterate the same Urdu sentence in numerous ways, leading to a high degree of variability in Roman-Urdu spellings. 
+For instance, words like “کتاب” in Urdu can be written in Roman-Urdu as “kitaab,” “kitab,” or “kittab,” depending on the writer’s style and regional dialect influences.
+
+The original Roman-Urdu Parallel (Roman-Urdu-Parl) dataset takes advantage of this variability to create a large corpus of 6.365 million parallel sentences by pairing 1.1 million core Urdu sentences with multiple Roman-Urdu transliterations. 
+This variability-rich approach is invaluable for developing robust transliteration models. 
+However, this very characteristic introduces significant challenges for data splitting and evaluation, especially if the goal is to build a model capable of generalizing rather than memorizing specific transliterations.
+
+### Issues with Random Splitting
+A typical random splitting approach might divide the dataset into training, validation, and test sets without accounting for sentence variability. 
+This could lead to the following issues:
+
+1. Overlap of Sentence Variations Across Sets:
+Given the substantial transliteration variability, random splitting is likely to place different Roman-Urdu variations of the same Urdu sentence in multiple sets (e.g., training and test). As a result:
+a. Data Leakage: The model may encounter different transliterations of the same sentence across training and evaluation sets, effectively "seeing" a portion of the test or validation data during training. This exposure creates data leakage, enabling the model to memorize specific transliteration patterns rather than learning to generalize.
+b. Inflated Evaluation Scores: Due to data leakage, the model’s evaluation metrics—such as BLEU scores—could be artificially inflated. These metrics would then fail to reflect the model's true performance on genuinely unseen data, compromising the reliability of model assessments.
+
+2. Challenges in Model Generalization:
+If the same Urdu sentence (with different transliterations) appears in both training and evaluation sets, the model risks overfitting to common patterns rather than developing a nuanced understanding of transliteration rules.
+The model's performance on genuinely novel sentence structures and transliteration styles is therefore likely to be less reliable.
+
+### Importance of a Structured Split
+To address these issues, a structured data split is essential. 
+By creating a split that ensures no Urdu sentence and its variations appear in more than one set (training, validation, or test).
+
+## Dataset Splitting Strategy
+To prevent data leakage and ensure a balanced evaluation, the dataset is split according to the following strategy:
+
+1. Unique Sentence Selection for Validation and Test Sets:
+  Validation Set: 1,000 unique Urdu sentences with only one variation in the whole data of 6.3 million.
+  Test Set: Another 1,000 unique Urdu sentences (also with one variation) excluding those in the validation set.
+
+2. Replicated Sentence Selection (2-10 Variations):
+  Validation Set: 2,000 Urdu sentences that have between 2 and 10 Roman-Urdu variations. All variations these 2000 urdu sentences are added in this.
+  Test Set: An additional 2,000 Urdu sentences with 2-10 variations, ensuring no overlap with validation.
+
+3. Training Set Composition:
+  All remaining sentences and their variations, excluding those selected for the validation and test sets, are included in the training set.
+
+4. Smaller Subsets for Efficient Evaluation:
+Smaller Validation and Test Sets: These subsets are created to speed up evaluations during model development, with each containing 3,000 sentences (unique and replicated).
+Its also ensured that only one sentence is selected out of all the variations of an urdu sentence.
+
+## Checking if Training Sentences Are Composed of Test Sentences or Their Repetitions
+To ensure robust model performance and prevent data leakage, we checked if any training sentences were composed entirely of repeated test(or validation) sentences or their fragments. 
+In the original dataset, some sentences were simply repetitions of shorter sentences (e.g., "A B C D" and "A B C D A B C D"), which could lead to overfitting if these patterns appeared across training and test sets. 
+A Python script was developed to identify and flag these cases, allowing us to remove or separate such repetitive sentences across the dataset splits. This approach helps the model learn genuine transliteration patterns and avoids artificially inflated evaluation scores, promoting better generalization to unseen data.
+The python script is at: scripts/check_substring.py
+with our new split dataset this count is zero.
+
+## Key Features of the Split
+
+- No Overlap Between Sets: Ensures that no Urdu sentence (or its variations) appears in more than one set, effectively preventing data leakage.
+- Variation Inclusion: The comprehensive test and validation sets include all variations of selected Urdu sentences, providing a robust evaluation of the model's ability to handle transliteration diversity.
+- Smaller Subsets for Rapid Testing: Allows for quick testing during model development while preserving dataset integrity.
+- Random Sampling with Fixed Seed: Reproducibility is ensured by using a fixed random state.
+- Balanced Evaluation: Incorporates both unique sentences and replicated sentences with multiple variations for a complete assessment.
+- Data Integrity Checks: Verifies that no Urdu sentences are shared between the sets, ensuring an accurate measure of generalization.
+
+## Citation 
+
+Original Dataset paper:
+
+@article{alam2022roman,
+  title={Roman-urdu-parl: Roman-urdu and urdu parallel corpus for urdu language understanding},
+  author={Alam, Mehreen and Hussain, Sibt Ul},
+  journal={Transactions on Asian and Low-Resource Language Information Processing},
+  volume={21},
+  number={1},
+  pages={1--20},
+  year={2022},
+  publisher={ACM New York, NY}
+}
+
+## Dataset Card Authors [optional]
+
+I wouldnt call myself the author of this dataset because its the work of the greats. I just had to work on this data, so I created the splits properly. 
+Still if you are interested then my name is Umer (you can contact me on linkedin, username: UmerTariq1)