Create README.md

README.md

@@ -0,0 +1,55 @@
+
+# JWLang Corpus
+
+## Dataset Summary
+The JWLang Corpus is a collection of audio and corresponding text data from JW Broadcasting videos available on the jw.org website. It is intended for training and fine-tuning automatic speech recognition (ASR) models, specifically OpenAI Whisper.
+
+## Dataset Structure
+- Number of samples: 10,000
+- Data format: Audio (WAV) and Text (SRT)
+- Size: 5 GB
+
+## Splits
+| Split      | Number of samples |
+|------------|-------------------|
+| Train      | 8,000             |
+| Validation | 1,000             |
+| Test       | 1,000             |
+
+## Usage
+To load and use the dataset:
+
+```python
+from datasets import load_dataset
+
+dataset = load_dataset("M2LabOrg/JWLang_Corpus")
+```
+
+## Example Data
+Example text snippet from the dataset:
+```
+{
+  "audio": "path/to/audio.wav",
+  "text": "Example subtitle text."
+}
+```
+
+## License
+```
+CC BY-SA 4.0
+```
+
+## Citation
+If you use this dataset, please cite:
+
+```
+@article{jwlang_corpus,
+  title={JWLang Corpus for ASR Training},
+  author={Michel Mesquita},
+  journal={Unpublished},
+  year={2024},
+}
+```
+
+## Contact
+For any questions or issues, please contact [Michel Mesquita](mailto:[email protected]).