Update README.md

README.md

@@ -19,3 +19,48 @@ configs:
   - split: train
     path: data/train-*
 ---
+
+## Dataset Overview 
+
+This dataset contains nearly over 679,000 English `speech instruction to text answer` samples, using:
+- The combination of [homebrewltd/instruction-speech-encodec-v1](https://huggingface.co/datasets/homebrewltd/instruction-speech-encodec-v1) and [homebrewltd/instruction-speech-encodec-v1.5](https://huggingface.co/datasets/homebrewltd/instruction-speech-encodec-v1.5)
+- Tokenized using [WhisperVQ](https://huggingface.co/WhisperSpeech/WhisperSpeech/blob/main/whisper-vq-stoks-medium-en%2Bpl.model).
+
+## Usage
+
+```python
+from datasets import load_dataset, Audio
+# Load Instruction Speech dataset
+
+dataset = load_dataset("homebrewltd/raw-speech-whispervq-v1",split='train')
+```
+
+## Dataset Fields
+
+ Field             | Type       | Description                                      |
+|------------------|------------|--------------------------------------------------|
+| `tokens`         | sequence   | Tokenized using Encodec                          |
+| `text`           | sequence   | Converted audio tokens                           |
+
+## Bias, Risks, and Limitations
+
+- Dataset may reflect biases inherent in its source.
+- Current version lacks quality control for prompts and responses.
+- The usage of Encodec may compromise sound tokens quality.
+- Users should consider these limitations when applying the dataset.
+
+## Licensing Information
+
+The dataset is released under the [MIT license](https://opensource.org/license/MIT).
+
+## Citation Information
+
+```
+@article{Instruction Speech 2024,
+  title={Instruction Speech},
+  author={JanAI},
+  year=2024,
+  month=June},
+  url={https://huggingface.co/datasets/jan-hq/instruction-speech}
+```
+