Upload README.md with huggingface_hub

README.md

@@ -1,22 +1,137 @@
 ---
+language:
+- vai
+license: cc-by-4.0
+task_categories:
+- automatic-speech-recognition
+- text-to-speech
+task_ids:
+- keyword-spotting
+multilinguality:
+- monolingual
+size_categories:
+- 1K<n<10K
+modalities:
+- audio
+- text
 dataset_info:
   features:
   - name: audio
     dtype: audio
   - name: text
     dtype: string
+  config_name: default
   splits:
   - name: train
-    num_bytes: 6723132373.316
+    num_bytes: 0
     num_examples: 23286
-  download_size: 6957374888
-  dataset_size: 6723132373.316
-configs:
-- config_name: default
-  data_files:
-  - split: train
-    path: data/train-*
+  download_size: 0
+  dataset_size: 0
+tags:
+- speech
+- vai
+- liberia
+- african-languages
+- low-resource
+- parallel-corpus
+pretty_name: Vai Speech-Text Parallel Dataset
 ---
-# Dataset Card for "vai-speech-text-parallel"
 
-[More Information needed](https://github.com/huggingface/datasets/blob/main/CONTRIBUTING.md#how-to-contribute-to-the-dataset-cards)
+# Vai Speech-Text Parallel Dataset
+
+## Dataset Description
+
+This dataset contains 23286 parallel speech-text pairs for Vai, a language spoken primarily in Ghana. The dataset consists of audio recordings paired with their corresponding text transcriptions, making it suitable for automatic speech recognition (ASR) and text-to-speech (TTS) tasks.
+
+### Dataset Summary
+
+- **Language**: Vai - `vai`
+- **Task**: Speech Recognition, Text-to-Speech
+- **Size**: 23286 audio files > 1KB (small/corrupted files filtered out)
+- **Format**: WAV audio files with corresponding text files
+- **Modalities**: Audio + Text
+
+### Supported Tasks
+
+- **Automatic Speech Recognition (ASR)**: Train models to convert Vai speech to text
+- **Text-to-Speech (TTS)**: Use parallel data for TTS model development
+- **Keyword Spotting**: Identify specific Vai words in audio
+- **Phonetic Analysis**: Study Vai pronunciation patterns
+
+## Dataset Structure
+
+### Data Fields
+
+- `audio`: Audio file in WAV format
+- `text`: Corresponding text transcription from paired text file
+
+### Data Splits
+
+The dataset contains a single training split with 23286 filtered audio-text pairs.
+
+## Dataset Creation
+
+### Source Data
+
+The audio data has been sourced ethically from consenting contributors. To protect the privacy of the original authors and speakers, specific source information cannot be shared publicly.
+
+### Data Processing
+
+1. Audio files and corresponding text files were collected from organized folder structure
+2. Text content was read from separate `.txt` files with matching filenames
+3. Files smaller than 1KB were filtered out to ensure audio quality
+4. Empty text files were excluded from the dataset
+5. Audio was processed using the [MMS-300M-1130 Forced Aligner](https://huggingface.co/MahmoudAshraf/mms-300m-1130-forced-aligner) tool for alignment and quality assurance
+
+### Annotations
+
+Text annotations are stored in separate text files with matching filenames to the audio files, representing the spoken content in each audio recording.
+
+## Considerations for Using the Data
+
+### Social Impact of Dataset
+
+This dataset contributes to the preservation and digital representation of Vai, supporting:
+- Language technology development for underrepresented languages
+- Educational resources for Vai language learning
+- Cultural preservation through digital archives
+
+### Discussion of Biases
+
+- The dataset may reflect the pronunciation patterns and dialects of specific regions or speakers
+- Audio quality and recording conditions may vary across samples
+- The vocabulary is limited to the words present in the collected samples
+
+### Other Known Limitations
+
+- Limited vocabulary scope (word-level rather than sentence-level)
+- Potential audio quality variations
+- Regional dialect representation may be uneven
+
+## Additional Information
+
+### Licensing Information
+
+This dataset is released under the Creative Commons Attribution 4.0 International License (CC BY 4.0).
+
+### Acknowledgments
+
+- Audio processing and alignment performed using [MMS-300M-1130 Forced Aligner](https://huggingface.co/MahmoudAshraf/mms-300m-1130-forced-aligner)
+- The original audio is produced by The Bible Society of Liberia in partnership with Davar Audio Bibles
+
+### Citation Information
+
+If you use this dataset in your research, please cite:
+
+```
+@dataset{vai_words_parallel_2025,
+  title={Vai Words Speech-Text Parallel Dataset},
+  year={2025},
+  publisher={Hugging Face},
+  howpublished={\url{https://huggingface.co/datasets/[your-username]/vai-speech-text-parallel}}
+}
+```
+
+### Contact
+
+For questions or concerns about this dataset, please open an issue in the dataset repository.