Update README.md

README.md

@@ -16,4 +16,67 @@ configs:
   data_files:
   - split: train
     path: data/train-*
+task_categories:
+- text2text-generation
+- text-to-audio
+- translation
+language:
+- en
+tags:
+- Phonemes
+- Text2Text
+- Text2Phonemes
+pretty_name: BabblePhon
+size_categories:
+- 10K<n<100K
 ---
+
+# BabblePhon
+
+## Introduction
+
+Welcome to the BabblePhon dataset! This dataset consists of 12,406 text-phoneme pairs. The primary objective of this dataset is to serve as a resource for training a Text2Text to translate text into a context-aware phoneme transcriptions.
+
+## Description
+
+The dataset contains synthetic text-phoneme pairs generated for the purpose of training machine learning models. Each entry in the dataset consists of a piece of text paired with its corresponding phoneme transcription.
+
+We employed the use of this prompt when generating synthetic data:
+
+```
+Your purpose is to transcribe text provided into IPA, you will respond with only
+the IPA transcription and nothing else, add quotes if present, keep punctuation. 
+
+for example, you should return it like this (not following this format will break scripts, so follow this):
+Original: yeah, thats if i graduate
+IPA: jə, ðæts ɪf aɪ ˈɡræʤuˌeɪt
+
+transcribe: {to_transcribe}
+```
+
+## Data Quality
+
+It's important to note that this dataset has not undergone manual cleaning. As a result, it may contain errors and inaccuracies. Users should exercise caution when utilizing the dataset for training or evaluation purposes.
+
+## Usage
+
+Researchers and developers can leverage this dataset for various natural language processing tasks, particularly those involving phoneme transcriptions. However, it's recommended to perform additional preprocessing and validation to address potential data inconsistencies.
+
+
+## Acknowledgments
+```
+@article{panayotov2018libritts,
+  title={LibriTTS: A Corpus Derived from LibriSpeech for Text-to-Speech},
+  author={Panayotov, Vassil and Chen, Guoguo and Povey, Daniel and Khudanpur, Sanjeev},
+  journal={arXiv preprint arXiv:1904.02882},
+  year={2018}
+}
+
+@article{yamagishi2019full,
+  title={A full-bandwidth open-source vocoder for high-quality speech synthesis},
+  author={Yamagishi, Junichi and Veaux, Christophe and MacDonald, Kirsten and King, Simon},
+  year={2019},
+  publisher={The Centre for Speech Technology Research (CSTR)},
+}
+```
+