Datasets:
Improve dataset card: Add metadata, paper/project links, results, and sample usage
#2
by
nielsr
HF Staff
- opened
This PR significantly enhances the dataset card for the Recitation Segmentations Dataset by incorporating comprehensive information for better discoverability and usability.
Key changes include:
- Metadata:
- Added
task_categories: automatic-speech-recognitionto align with the paper's focus on ASR-based pronunciation error detection. - Included
language: aras the dataset consists of Holy Quranic recitations in Arabic. - Set
license: cc-by-nc-4.0to accurately reflect the license of the underlying audio data fromeveryayah.com, as referenced in the GitHub repository. - Added relevant
tagssuch asquran,arabic,speech-segmentation, andaudiofor improved searchability.
- Added
- Paper/Project/Code Links: Prominently featured links to the associated research paper, the project page, and the GitHub repository.
- Introduction: Added a concise introduction summarizing the paper's abstract to provide immediate context for the dataset.
- Results: Included the model's performance metrics from the GitHub README, showcasing the dataset's utility.
- Sample Usage: Provided a Python code snippet, directly sourced from the GitHub README, demonstrating how to use the
recitations-segmenterlibrary which is built upon this dataset. Installation prerequisites are also included to guide users. - License Statement: Explicitly stated the dataset's license within the Markdown content.
These updates provide a more informative and accessible resource for the Hugging Face community.
Thank
obadx
changed pull request status to
merged