Update dataset card: Add metadata, links, and improve sample usage

#2
by nielsr HF Staff - opened
Files changed (1) hide show
  1. README.md +36 -14
README.md CHANGED
@@ -1,4 +1,16 @@
1
  ---
 
 
 
 
 
 
 
 
 
 
 
 
2
  configs:
3
  - config_name: moshaf_metadata
4
  data_files:
@@ -140,21 +152,41 @@ configs:
140
  name: arabic_name
141
  ---
142
 
143
- # المصاحف القرآنية
 
 
 
 
144
 
145
- مصاحف مجمعمة من القراء المتقنين لبناء نماذج ذكاء اصطناعي لخدمة القرآن الكريم. أنظر [هنا](https://github.com/obadx/prepare-quran-dataset) لأكواد بناء قاعدة التلاوات القرآنية
 
 
146
 
147
  ![stats](./assets/stats.png)
148
 
149
  ![reciters](./assets/reciter.png)
150
 
151
- ## البيانات الوصفية للمصاحف
 
 
152
 
153
  ```python
 
 
154
  ds = load_dataset('obadx/mualem-recitations-original', name='moshaf_metadata')['train']
 
155
 
 
 
 
 
 
 
 
 
156
  ```
157
 
 
158
 
159
  ### وصف أوجه حفص
160
 
@@ -202,11 +234,6 @@ ds = load_dataset('obadx/mualem-recitations-original', name='moshaf_metadata')['
202
 
203
  ## البيانات الوصفية للقراء
204
 
205
- ```python
206
- ds = load_dataset('obadx/mualem-recitations-original', name='reciters_metadata')['train']
207
-
208
- ```
209
-
210
  ## وصف للتلاوات القرآنية
211
 
212
  كل مصحف معاه متغير اسمه `path` يدل على مسار المصحف. كل مصحف مخزن في directory مسمىً ب `id` للمصحف
@@ -229,13 +256,8 @@ ds = load_dataset('obadx/mualem-recitations-original', name='reciters_metadata')
229
 
230
  يتكون `id` المصحف من شقين `{رقم القارئ}_{رقم المصحف لهذا القارئ}`. لتحميل التلاوات باستخدما Huggingface Dataset
231
 
232
- ```python
233
- ds = load_dataset('audiofolder', data_dir='/path/to/mualem-recitations-original/dataset')['train']
234
-
235
- ```
236
-
237
  ## ملاحظات مهمة
238
 
239
  * لاتزال تهيئة التلاوات القرآنية قيد التطوير.
240
  * التلاوات ذات `is_annotated` ب `True` هي التي تم الانتهاء منها.
241
- * تم رفع التلاوات القرآنية بصيفتها الأصلية مثل mp3 لإعطاء الباحثين معالجة الملفات بحرية
 
1
  ---
2
+ language:
3
+ - ar
4
+ - en
5
+ task_categories:
6
+ - automatic-speech-recognition
7
+ license: mit
8
+ tags:
9
+ - quran
10
+ - arabic
11
+ - religious
12
+ - speech
13
+ - pronunciation-assessment
14
  configs:
15
  - config_name: moshaf_metadata
16
  data_files:
 
152
  name: arabic_name
153
  ---
154
 
155
+ # Automatic Pronunciation Error Detection and Correction of the Holy Quran's Learners Using Deep Learning
156
+ [Paper: Automatic Pronunciation Error Detection and Correction of the Holy Quran's Learners Using Deep Learning](https://huggingface.co/papers/2509.00094)
157
+ [Project Page: Prepare Quran Dataset](https://obadx.github.io/prepare-quran-dataset/)
158
+ [Code (Dataset Preparation): https://github.com/obadx/prepare-quran-dataset](https://github.com/obadx/prepare-quran-dataset)
159
+ [Code (Recitations Segmenter Tool): https://github.com/obadx/recitations-segmenter](https://github.com/obadx/recitations-segmenter)
160
 
161
+ # المصاحف القرآنية
162
+
163
+ مَصاحف مجمَّعة من القُرَّاء المتقنين لبناء نماذج ذكاء اصطناعي لخدمة القرآن الكريم.
164
 
165
  ![stats](./assets/stats.png)
166
 
167
  ![reciters](./assets/reciter.png)
168
 
169
+ ## Sample Usage
170
+
171
+ Load the dataset's `moshaf_metadata` configuration:
172
 
173
  ```python
174
+ from datasets import load_dataset
175
+
176
  ds = load_dataset('obadx/mualem-recitations-original', name='moshaf_metadata')['train']
177
+ ```
178
 
179
+ Load the raw audio files from the dataset directory:
180
+
181
+ ```python
182
+ from datasets import load_dataset
183
+
184
+ # Make sure to replace '/path/to/mualem-recitations-original/dataset' with the actual path
185
+ # where the audio files are located after downloading the dataset.
186
+ ds = load_dataset('audiofolder', data_dir='/path/to/mualem-recitations-original/dataset')['train']
187
  ```
188
 
189
+ ## البيانات الوصفية للمصاحف
190
 
191
  ### وصف أوجه حفص
192
 
 
234
 
235
  ## البيانات الوصفية للقراء
236
 
 
 
 
 
 
237
  ## وصف للتلاوات القرآنية
238
 
239
  كل مصحف معاه متغير اسمه `path` يدل على مسار المصحف. كل مصحف مخزن في directory مسمىً ب `id` للمصحف
 
256
 
257
  يتكون `id` المصحف من شقين `{رقم القارئ}_{رقم المصحف لهذا القارئ}`. لتحميل التلاوات باستخدما Huggingface Dataset
258
 
 
 
 
 
 
259
  ## ملاحظات مهمة
260
 
261
  * لاتزال تهيئة التلاوات القرآنية قيد التطوير.
262
  * التلاوات ذات `is_annotated` ب `True` هي التي تم الانتهاء منها.
263
+ * تم رفع التلاوات القرآنية بصيفتها الأصلية مثل mp3 لإعطاء الباحثين معالجة الملفات بحرية