إضافة التوثيق

README.md

@@ -67,3 +67,157 @@ configs:
   - split: train
     path: data/train-*
 ---
+
+
+
+
+* قاعدة بيانات معيارية صغيرة الحجم (159 عينة) لأجل تقييم أداء نماذج الذكاء الاصطناعي لكشف أخطاء التلاوة وقواعد  تجويد  القرآن الكريم.
+* لقد تم بناء هذه قاعدة البيانات على  [qdat](https://huggingface.co/datasets/obadx/qdat) من  [الورقة البحثية](https://www.researchgate.net/profile/Ban-Sharief/publication/350785609_QDAT_A_data_set_for_Reciting_the_Quran/links/6071a3a192851c8a7bb7afd2/QDAT-A-data-set-for-Reciting-the-Quran.pdf)
+* المقاطع عبارة عن قارءة لآية: {قَالُوا۟ لَا عِلْمَ لَنَآ إِنَّكَ أَنتَ عَلَّٰمُ ٱلْغُيُوبِ} بسورة المائدة من الآية 109
+
+# آلية بناء البيانات المعيارية
+كان لدى qdat بعض العيوب مما أدى لبناء qdat_bench أهمها:
+* عدم تغطية كل قواعد التجويد
+* كانت تحتوي على 161 قارئ وقام كل قارئ بتسجيل 10 مقاطع لنفس الأحكام والقواعد فقمنا باختيار مقطع لك قارئ
+
+## هيكل البيانات
+
+### الميزات الرئيسية:
+
+- **audio**: الملف الصوتي (معدل العينة: غير محدد، أحادي القناة)
+- **id**: معرف فريد لكل عنصر
+- **original_id**: المعرف الأصلي في مجموعة البيانات الأصلية
+- **gender**: جنس القارئ (ذكر/أنثى)
+- **age**: عمر القارئ
+- **phonetic_transcript**: النص الصوتي باستخدام حزمة [quran-transcript](https://github.com/obadx/quran-transcript)
+
+### أحكام المدود:
+
+- `qalo_alif_len`: طول مد الألف في كلمة "قالوا" (0-8)
+- `qalo_waw_len`: طول مد الواو في كلمة "قالوا" (0-8) 
+- `laa_alif_len`: طول مد الألف في كلمة "لا" (0-8)
+- `separate_madd`: طول المد المنفصل في "لنا إنك" (0-8)
+- `allam_alif_len`: طول مد الألف في كلمة "علام" (0-8)
+- `madd_aared_len`: طول المد العارض للسكون (0-8)
+
+### أحكام الغنة:
+
+- `noon_moshaddadah_len`: طول النون المشددة في "إنَّك" (0=جزئي, 1=كامل)
+- `noon_mokhfah_len`: طول النون المخفاة في "أنت" (0=نون, 1=جزئي, 2=كامل)
+
+### أحكام القلقلة:
+
+- `qalqalah`: وجود القلقلة في "الغيوب" (0=لا يوجد, 1=يوجد)
+
+### صفات الحروف:
+
+كل مجموعة حروف صوتية مثل: "اااا" في ال `phonetic_transcript` لها 10 صفات في العمود `sifat` على هيئة dictionary 
+
+- `ghonna`: الغنة
+- `hams_or_jahr`: الهمس أو الجهر
+- `istitala`: الاستطالة
+- `itbaq`: الإطباق
+- `phonemes`: الأصوات
+- `qalqla`: القلقلة
+- `safeer`: الصفير
+- `shidda_or_rakhawa`: الشدة أو الرخاوة
+- `tafashie`: التفشي
+- `tafkheem_or_taqeeq`: التفخيم أو الترقيق
+- `tikraar`: التكرار
+
+## الاستخدام
+
+```python
+from datasets import load_dataset
+
+ds = load_dataset('obadx/qdat_bench')
+print(ds['train'][0])  # عرض العينة الأولى
+```
+
+## الإحصائيات
+
+- عدد العينات: 159
+- Split: train فقط
+
+![age_gender_histograms](age_gender_histograms.png)
+
+![corectness_histogram](correctness_histogram.png)
+
+![tajweed_columns_histograms](tajweed_columns_histograms.png)
+
+
+# English
+
+# QDat-Bench Dataset
+
+A benchmark dataset for evaluating model performance in processing Quranic audio recordings with focus on Tajweed rules.
+
+## Description
+
+This dataset contains Quranic audio recordings with detailed annotations for Tajweed characteristics. It is designed to serve as a benchmark for evaluating audio processing models in recognizing Tajweed rules.
+
+## Data Structure
+
+### Main Features:
+
+- **audio**: Audio file (sampling rate: None, mono channel)
+- **id**: Unique identifier for each element
+- **original_id**: The item's ID in the original dataset
+- **gender**: Reciter's gender (male/female)
+- **age**: Reciter's age
+- **phonetic_transcript**: Phonetic transcription using `quran-transcript` package
+
+### Madd (Prolongation) Rules:
+
+- `qalo_alif_len`: Length of normal madd alif in word "قالوا" (0-8)
+- `qalo_waw_len`: Length of normal madd waw in word "قالوا" (0-8)
+- `laa_alif_len`: Length of normal madd alif in word "لا" (0-8)
+- `separate_madd`: Length of separate madd for "لنا إنك" (0-8)
+- `allam_alif_len`: Length of normal madd alif in word "علام" (0-8)
+- `madd_aared_len`: Length of madd aared for sukoon (0-8)
+
+### Ghunnah (Nasalization) Rules:
+
+- `noon_moshaddadah_len`: Length of noon moshaddadah in "إنَّك" (0=partial, 1=complete)
+- `noon_mokhfah_len`: Length of noon mokhfah in "أنت" (0=noon, 1=partial, 2=complete)
+
+### Qalqalah (Echo) Rules:
+
+- `qalqalah`: Existence of qalqalah for "الغيوب" (0=no qalqalah, 1=has qalqalah)
+
+### Letter Characteristics:
+
+Contains a list of characteristics for each letter:
+
+- `ghonna`: Ghunnah (nasalization)
+- `hams_or_jahr`: Hams (whisper) or Jahr (clarity)
+- `istitala`: Istitala (elongation)
+- `itbaq`: Itbaq (adhesion)
+- `phonemes`: Phonemes
+- `qalqla`: Qalqalah (echo)
+- `safeer`: Safeer (whistling)
+- `shidda_or_rakhawa`: Shidda (strength) or Rakhawa (softness)
+- `tafashie`: Tafashie (diffusion)
+- `tafkheem_or_taqeeq`: Tafkheem (emphasis) or Taqeeq (thinning)
+- `tikraar`: Tikraar (repetition)
+
+## Usage
+
+```python
+from datasets import load_dataset
+
+ds = load_dataset('obadx/qdat_bench')
+print(ds['train'][0])  # Display first sample
+```
+
+## Statistics
+
+- Number of samples: 159
+- Split: train only
+
+
+![age_gender_histograms](age_gender_histograms.png)
+
+![corectness_histogram](correctness_histogram.png)
+
+![tajweed_columns_histograms](tajweed_columns_histograms.png)