Update README.md

README.md

@@ -18,4 +18,53 @@ tags:
 - audio
 size_categories:
 - 1M<n<10M
----
+---
+
+# AudioSet
+
+AudioSet is a large-scale dataset comprising approximately 2 million 10-second YouTube audio clips, categorised into 527 sound classes. 
+We have pre-processed all audio files to a 16 kHz sampling rate and stored them in the WebDataset format for efficient large-scale training and retrieval.
+
+## Download
+
+We recommend using the following commands to download the `confit/audioset-16khz-wds` dataset from HuggingFace. 
+The dataset is available in two versions:
+
+ - 20k: A smaller version with 20,550 clips for quick experimentation.
+ - 2m: The complete dataset with ~2 million clips.
+
+```bash
+# For the 20k version
+huggingface-cli download confit/audioset-16khz-wds --include 20k/train/*.tar  --repo-type=dataset --local-dir /path/to/store
+huggingface-cli download confit/audioset-16khz-wds --include 20k/test/*.tar  --repo-type=dataset --local-dir /path/to/store
+
+# For the 2m version
+huggingface-cli download confit/audioset-16khz-wds --include 2m/train/*.tar  --repo-type=dataset --local-dir /path/to/store
+huggingface-cli download confit/audioset-16khz-wds --include 2m/test/*.tar  --repo-type=dataset --local-dir /path/to/store
+```
+
+## Format and Usage
+
+The dataset is stored in the WebDataset (WDS) format, which is optimised for distributed training and streaming. 
+Each `.tar` archive contains audio files and corresponding metadata.
+
+To load the dataset in Python using webdataset:
+
+```python
+train_base_url = '/path/to/20k/train/shard-{i:05d}.tar'
+train_urls = [train_base_url.format(i=i) for i in range(7)]
+
+test_base_url = '/path/to/20k/test/shard-{i:05d}.tar'
+test_urls = [test_base_url.format(i=i) for i in range(6)]
+
+raw_datasets = load_dataset(
+    "webdataset",
+    data_files={"train": train_urls, "test": test_urls},
+    streaming=False
+)
+```
+
+## License and Usage Restrictions
+
+Please ensure compliance with YouTube's terms of service when using this dataset. 
+Some clips may no longer be available if the original videos have been removed or made private.