RetaSy commited on
Commit
99d85be
·
verified ·
1 Parent(s): c58bbb9

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +39 -0
README.md CHANGED
@@ -124,6 +124,45 @@ print(quranic_dataset)
124
 
125
  ### Data Fields
126
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
127
  ### Citation Information
128
 
129
  ```
 
124
 
125
  ### Data Fields
126
 
127
+ `audio` (`dict`): A dictionary containing the path to the downloaded audio file, the decoded audio array, and the sampling rate.
128
+
129
+ `Surah` (`string`): The chapter of the Quran from which the recited verse (Aya) is taken.
130
+
131
+ `Aya` (`string`): The specific verse within a Surah (chapter) of the Quran that is being recited.
132
+
133
+ `duration_ms` (`int64`): The duration of the audio recording in milliseconds.
134
+
135
+ `create_date` (`string`): The date and time when the audio recording was created.
136
+
137
+ `golden` (`bool`): The audio sample is labeled by experts or via crowdsourcing. If the value is true, the audio sample is considered golden, meaning it has been labeled by experts. If the value is false, the sample has been labeled via crowdsourcing.
138
+
139
+ `final_label` (`string`): The consensus label assigned to the audio sample. This label indicates the agreed-upon classification of the recitation based on the annotations provided. The final label is determined either through a majority vote among crowd-sourced annotators or by expert annotators for golden samples. The possible values for this field are:
140
+ - **correct**: When the pronunciation is correct with the diacritics, regardless of the rules of Tajweed.
141
+ - **in_correct**: When the pronunciation is incorrect with the diacritics, regardless of the rules of Tajweed.
142
+ - **not_related_quran**: When the content of the audio clip is incomprehensible or contains words that have nothing to do with the Quran or is empty, this choice should be selected.
143
+ - **not_match_aya**: When the audio clip contains words related to the Quran, but not the given verse, this choice should be selected.
144
+ - **multiple_aya**: When a reciter reads several verses, this choice should be selected regardless of whether the reading is correct or not.
145
+ - **in_complete**: When the reciter reads the verse without completing it, or the verse is not completed for some reason, this choice should be selected.
146
+
147
+ `reciter_id` (`string`): A unique identifier for the individual reciting the Quranic verse in the audio sample.
148
+
149
+ `reciter_country` (`string`): The country of origin of the reciter who performed the Quranic recitation in the audio sample.
150
+
151
+ `reciter_gender` (`string`): The gender of the reciter who performed the Quranic recitation in the audio sample.
152
+
153
+ `reciter_qiraah` (`string`): The qiraah (recitation style) used by the reciter in performing the Quranic recitation in the audio sample.
154
+
155
+ `judgments_num` (`int64`): the number of judgments or annotations provided for each audio sample in the dataset.
156
+
157
+ `annotation_metadata` (`string`): The metadata related to the annotations provided for each audio sample in the dataset. Each annotation consists of several key-value pairs:
158
+ - **label_X**: The assigned label for the X-th annotator, indicating the classification or judgment made by the annotator (e.g., "correct" or "in_correct").
159
+ - **annotatorX_id**: The unique identifier of the X-th annotator who provided the judgment.
160
+ - **annotatorX_SCT**: The number of solved control tasks by the X-th annotator, which assess the annotator's performance on predefined control tasks.
161
+ - **annotatorX_MCC**: The Matthew's Correlation Coefficient (MCC) score of the X-th annotator, measuring the quality of the annotator's classifications.
162
+ - **annotatorX_ACC**: The accuracy (ACC) score of the X-th annotator, representing the proportion of correct classifications made by the annotator.
163
+ - **annotatorX_F1**: The F1 score of the X-th annotator, which is a harmonic mean of precision and recall, indicating the balance between true positives and false positives.
164
+ This detailed metadata provides insights into the annotation process, the performance of individual annotators, and the quality of the annotations assigned to each audio sample.
165
+
166
  ### Citation Information
167
 
168
  ```