Update README.md

README.md

@@ -1,3 +1,55 @@
-YODAS2 is the long-form dataset from YODAS dataset. 
+---
+license: cc-by-3.0
+---
 
-It provides the same dataset as the `espnet/yodas` but this one has been formatted in the long-form where audios are not segmented.
+YODAS2 is the long-form dataset from YODAS dataset.
+
+It provides the same dataset as the `espnet/yodas` but this one has been formatted in the long-form where audios are not segmented.
+
+Additionally, audios are encoded using higher sampling rates (i.e. 24k) in YODAS2.
+
+For detailed information about Yodas dataset, please refer to [our paper](https://arxiv.org/abs/2406.00899) and the [espnet/yodas repo](https://huggingface.co/datasets/espnet/yodas).
+
+## Usage:
+
+
+Each data point corresponds to an entire video on YouTube, it contains the following fields:
+
+- video_id: unique id of this video (note this id is not the video_id in Youtube)
+- duration: total duration in seconds of this video
+- audio
+  - path: local path to wav file if in standard mode, otherwise empty in the streaming mode
+  - sampling_rate: fixed to be 24k. (note that the sampling rate in `espnet/yodas` is 16k)
+  - array: wav samples in float
+- utterances
+  - utt_id: unique id of this utterance
+  - text: transcription of this utterance
+  - start: start timestamp in seconds of this utterance
+  - end: end timestamp in seconds of this utterance
+
+Yodas2 also supports two modes:
+
+**standard mode**: each subset will be downloaded to the local dish before first iterating. 
+
+```python
+from datasets import load_dataset
+
+# Note this will take very long time to download and preprocess
+# you can try small subset for testing purpose
+ds = load_dataset('espnet/yodas2', 'en000')
+print(next(iter(ds['train'])))
+```
+
+**streaming mode** most of the files will be streamed instead of downloaded to your local deivce. It can be used to inspect this dataset quickly.
+
+```python
+from datasets import load_dataset
+
+# this streaming loading will finish quickly
+ds = load_dataset('espnet/yodas2', 'en000', streaming=True)
+
+
+#{'id': '9774', 'utt_id': 'YoRjzEnRcqu-00000-00000716-00000819', 'audio': {'path': None, 'array': array([-0.009552  , -0.01086426, -0.012146  , ..., -0.01992798,
+#       -0.01885986, -0.01074219]), 'sampling_rate': 16000}, 'text': 'There is a saying'}
+print(next(iter(ds['train'])))
+```