Improve dataset card: Add tags, fix license and language codes, uncomment image, clean up content

README.md

@@ -1,4 +1,15 @@
 ---
+language:
+- ar
+- en
+license: cc-by-sa-4.0
+size_categories:
+- 10K<n<100K
+task_categories:
+- translation
+tags:
+- classical-arabic
+pretty_name: ATHAR
 dataset_info:
   features:
   - name: arabic
@@ -21,30 +32,22 @@ configs:
     path: data/train-*
   - split: test
     path: data/test-*
-task_categories:
-- translation
-language:
-- ar
-- en
-pretty_name: ATHAR
-size_categories:
-- 10K<n<100K
-license: cc-by-sa-4.0
 ---
 
+# Dataset card
 
-<!-- 
-# Dataset Card for "ATHAR"
+## Description
 
-# ATHAR: A High-Quality and Diverse Dataset for Classical Arabic to English Translation
+### ATHAR: A High-Quality and Diverse Dataset for Classical Arabic to English Translation
 
 > Welcome to ATHAR Dataset
 
+The ATHAR dataset is a comprehensive collection of classical Arabic texts translated into English. This dataset contains approximately 66,000 rows of translated texts, including the original Classical Arabic texts and their English translations.
+
 <p align="center">
 <img src="https://cdn-uploads.huggingface.co/production/uploads/64af7c627ab7586520ed8688/SwkKk3Z6kT5VZ3Oj-bVMC.jpeg" width = "150px"/>
-  <p align="center"> [ <a href="https://arxiv.org/abs/2407.19835">Paper</a> ]<!-- - <a href="https://github.com/ARBML/CIDAR">GitHub</a> ]</p>
-
 </p>
+<p align="center"> [ <a href="https://arxiv.org/abs/2407.19835">Paper</a> ]</p>
 
 
 ![image/jpeg](https://cdn-uploads.huggingface.co/production/uploads/64af7c627ab7586520ed8688/SwkKk3Z6kT5VZ3Oj-bVMC.jpeg) 
@@ -64,75 +67,10 @@ license: cc-by-sa-4.0
 </div>
 
 
-## Datasets Summary
-
-The ATHAR dataset is divided into two main subsets: test data and training data.
-
-   | Name             | Description                                                                                                             |
-   |------------------|-------------------------------------------------------------------------------------------------------------------------|
-   | `Training Data`  | Contains 65,043 rows of classical Arabic texts and their English translations, used for training translation models.    |
-   | `Test Data`      | Contains 1,000 rows of classical Arabic texts and their English translations, reserved for evaluating model performance.|
-
-
-
-
-
-## Dataset Structure
-
-Each entry in the dataset is represented by a row with the following fields:
-
-   | Field     | Description                                                                                                 |
-   |-----------|-------------------------------------------------------------------------------------------------------------|
-   | `Arabic(str)`  | The original text in classical Arabic.                                                                 |
-   | `English(str)` | The English translation of the classical Arabic text.                                                  |
-
-
-
-
-## Loading The Dataset
-You can download the dataset directly from HuggingFace or use the following code:
-
-```python
-from datasets import load_dataset
-
-athar = load_dataset("mohamed-khalil/ATHAR")
-```
-
-
-## Sample From The Dataset:
-
-Below is a sample from the ATHAR dataset, showcasing a classical Arabic text and its English translation.
-
- **`Arabic`**: فَلم يزل الْفلس يعبد حَتَّى ظهرت دَعْوَة النَّبِي عَلَيْهِ السَّلَام فَبعث إِلَيْهِ على ابْن أَبِي طَالِبٍ فَهَدَمَهُ وَأَخَذَ سَيْفَيْنِ كَانَ الْحَارِثُ بن أبي شمرٍ الغساني, ملك غَسَّان قَلَّدَهُ إِيَّاهُمَا, يُقَالُ لَهُمَا مِخْذَمٌ وَرَسُوبٌ(وَهُمَا السَّيْفَانِ اللَّذَانِ ذَكَرَهُمَا عَلْقَمَةُ بْنُ عَبْدَةَ فِي شِعْرِهِ). فَقَدِمَ بِهِمَا عَلِيُّ بْنُ أَبِي طَالِبٍ عَلَى النَّبِيِّ صَلَّى اللَّهُ عَلَيْهِ وَسَلَّمَ فَتَقَلَّدَ أَحَدَهُمَا ثُمَّ دَفَعَهُ إِلَى عَلِيِّ بْنِ أَبِي طَالِبٍ, فَهُوَ سَيْفُهُ الَّذِي كَانَ يَتَقَلَّدُهُ
-
- **`English`**: Al-Fals continued to be worshipped until the advent of the Prophet, at which time ‘Ali ibn-abi-Talib was dispatched to destroy it. ‘Ali destroyed the idol and carried away therefrom two swords called Mikhdham and Rasub (the same two swords which ‘Alqamah ibn-’Abadah had mentioned in his poetry), which al-Harith ibn-abi-Shamir, king of Ghassan, had presented al-Fals. ‘Ali brought them to the Prophet who wore one of them and gave it back to him. It was the sword which ‘Ali was always wont to wear
-
- -->
-
-
-
-# Dataset card
-
-## Description
-
-### ATHAR: A High-Quality and Diverse Dataset for Classical Arabic to English Translation
-
-> Welcome to ATHAR Dataset
-
-The ATHAR dataset is a comprehensive collection of classical Arabic texts translated into English. This dataset contains approximately 66,000 rows of translated texts, including the original Classical Arabic texts and their English translations.
-
-<p align="center">
-<!-- <img src="https://cdn-uploads.huggingface.co/production/uploads/64af7c627ab7586520ed8688/SwkKk3Z6kT5VZ3Oj-bVMC.jpeg" width = "150px"/> -->
-  <p align="center"> [ <a href="https://arxiv.org/abs/2407.19835">Paper</a> ]<!-- - <a href="https://github.com/ARBML/CIDAR">GitHub</a> ]</p> -->
-
-</p>
-
-
-
 ## License
 
-The ATHAR dataset and weight diffs are licensed under **CC BY NC 4.0**
-[Creative Commons NonCommercial (CC BY-NC 4.0)](https://creativecommons.org/licenses/by-nc/4.0/deed.en).
+The ATHAR dataset and weight diffs are licensed under **CC BY SA 4.0**
+[Creative Commons Attribution-ShareAlike 4.0 International Public License (CC BY-SA 4.0)](https://creativecommons.org/licenses/by-sa/4.0/deed.en).
 
 
 
@@ -145,7 +83,7 @@ The ATHAR dataset and weight diffs are licensed under **CC BY NC 4.0**
       year={2024},
       eprint={2407.19835},
       archivePrefix={arXiv},
-      primaryClass={cs.CL},
+      primaryClass={cs.CL},\
       url={https://arxiv.org/abs/2407.19835}, 
 }
 ```
@@ -154,13 +92,13 @@ The ATHAR dataset and weight diffs are licensed under **CC BY NC 4.0**
 
 ### Arabic 
 
-* ISO 639-3: eng
+* ISO 639-3: ara
 * ISO 15924: Arab
 * Glottocode: arab1395	 <!-- Classical Arabic Code: clas1259 -->
 
 ### English
 
-* ISO 639-3: ara
+* ISO 639-3: eng
 * ISO 15924: Latn
 * Glottocode: stan1293
 
@@ -250,5 +188,4 @@ Below is a sample from the ATHAR dataset, showcasing a classical Arabic text and
 
  **`Arabic`**: فَلم يزل الْفلس يعبد حَتَّى ظهرت دَعْوَة النَّبِي عَلَيْهِ السَّلَام فَبعث إِلَيْهِ على ابْن أَبِي طَالِبٍ فَهَدَمَهُ وَأَخَذَ سَيْفَيْنِ كَانَ الْحَارِثُ بن أبي شمرٍ الغساني, ملك غَسَّان قَلَّدَهُ إِيَّاهُمَا, يُقَالُ لَهُمَا مِخْذَمٌ وَرَسُوبٌ(وَهُمَا السَّيْفَانِ اللَّذَانِ ذَكَرَهُمَا عَلْقَمَةُ بْنُ عَبْدَةَ فِي شِعْرِهِ). فَقَدِمَ بِهِمَا عَلِيُّ بْنُ أَبِي طَالِبٍ عَلَى النَّبِيِّ صَلَّى اللَّهُ عَلَيْهِ وَسَلَّمَ فَتَقَلَّدَ أَحَدَهُمَا ثُمَّ دَفَعَهُ إِلَى عَلِيِّ بْنِ أَبِي طَالِبٍ, فَهُوَ سَيْفُهُ الَّذِي كَانَ يَتَقَلَّدُهُ
 
- **`English`**: Al-Fals continued to be worshipped until the advent of the Prophet, at which time ‘Ali ibn-abi-Talib was dispatched to destroy it. ‘Ali destroyed the idol and carried away therefrom two swords called Mikhdham and Rasub (the same two swords which ‘Alqamah ibn-’Abadah had mentioned in his poetry), which al-Harith ibn-abi-Shamir, king of Ghassan, had presented al-Fals. ‘Ali brought them to the Prophet who wore one of them and gave it back to him. It was the sword which ‘Ali was always wont to wear
-
+ **`English`**: Al-Fals continued to be worshipped until the advent of the Prophet, at which time ‘Ali ibn-abi-Talib was dispatched to destroy it. ‘Ali destroyed the idol and carried away therefrom two swords called Mikhdham and Rasub (the same two swords which ‘Alqamah ibn-’Abadah had mentioned in his poetry), which al-Harith ibn-abi-Shamir, king of Ghassan, had presented al-Fals. ‘Ali brought them to the Prophet who wore one of them and gave it back to him. It was the sword which ‘Ali was always wont to wear