RetaSy commited on
Commit
f5c90a5
·
verified ·
1 Parent(s): 81de937

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +12 -12
README.md CHANGED
@@ -138,12 +138,12 @@ print(quranic_dataset)
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
 
141
- - **correct**: When the pronunciation is correct with the diacritics, regardless of the rules of Tajweed.
142
- - **in_correct**: When the pronunciation is incorrect with the diacritics, regardless of the rules of Tajweed.
143
- - **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.
144
- - **not_match_aya**: When the audio clip contains words related to the Quran, but not the given verse, this choice should be selected.
145
- - **multiple_aya**: When a reciter reads several verses, this choice should be selected regardless of whether the reading is correct or not.
146
- - **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.
147
 
148
  `reciter_id` (`string`): A unique identifier for the individual reciting the Quranic verse in the audio sample.
149
 
@@ -157,12 +157,12 @@ print(quranic_dataset)
157
 
158
  `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:
159
 
160
- - **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").
161
- - **annotatorX_id**: The unique identifier of the X-th annotator who provided the judgment.
162
- - **annotatorX_SCT**: The number of solved control tasks by the X-th annotator, which assess the annotator's performance on predefined control tasks.
163
- - **annotatorX_MCC**: The Matthew's Correlation Coefficient (MCC) score of the X-th annotator, measuring the quality of the annotator's classifications.
164
- - **annotatorX_ACC**: The accuracy (ACC) score of the X-th annotator, representing the proportion of correct classifications made by the annotator.
165
- - **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.
166
  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.
167
 
168
  ### Citation Information
 
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
 
141
+ * correct: When the pronunciation is correct with the diacritics, regardless of the rules of Tajweed.
142
+ * in_correct: When the pronunciation is incorrect with the diacritics, regardless of the rules of Tajweed.
143
+ * 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.
144
+ * not_match_aya: When the audio clip contains words related to the Quran, but not the given verse, this choice should be selected.
145
+ * multiple_aya: When a reciter reads several verses, this choice should be selected regardless of whether the reading is correct or not.
146
+ * 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.
147
 
148
  `reciter_id` (`string`): A unique identifier for the individual reciting the Quranic verse in the audio sample.
149
 
 
157
 
158
  `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:
159
 
160
+ * 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").
161
+ * annotatorX_id: The unique identifier of the X-th annotator who provided the judgment.
162
+ * annotatorX_SCT: The number of solved control tasks by the X-th annotator, which assess the annotator's performance on predefined control tasks.
163
+ * annotatorX_MCC: The Matthew's Correlation Coefficient (MCC) score of the X-th annotator, measuring the quality of the annotator's classifications.
164
+ * annotatorX_ACC: The accuracy (ACC) score of the X-th annotator, representing the proportion of correct classifications made by the annotator.
165
+ * 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.
166
  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.
167
 
168
  ### Citation Information