Update README.md

README.md

@@ -1,3 +1,35 @@
----
-license: mit
----
+---
+license: mit
+---
+
+# UrbanSound8K
+
+This is an audio classification dataset for **Sound Event Classification**.
+
+**Classes = 10    ,    Split = Ten-Fold** 
+
+
+## Structure
+- `audios` folder contains audio files.
+- `csv_files` folder contains CSV files for **five-fold** cross-validation.
+- To perform cross-validation on fold 1, `train_1.csv` will be used for the training split and `test_1.csv` for the testing split, with the same pattern followed for the other folds.
+
+## Download
+```python
+import os
+import huggingface_hub
+audio_datasets_path = "DATASET_PATH/Audio-Datasets"
+if not os.path.exists(audio_datasets_path): print(f"Given {audio_datasets_path=} does not exist. Specify a valid path ending with 'Audio-Datasets' folder.")
+huggingface_hub.snapshot_download(repo_id="MahiA/UrbanSound8K", repo_type="dataset", local_dir=os.path.join(audio_datasets_path, "UrbanSound8K"))
+```
+
+
+## Acknowledgment
+This dataset is a slightly processed/restructured version of data originally released by [Source](https://urbansounddataset.weebly.com/urbansound8k.html).<br>
+Please refer to the respective source for their licensing details and any additional information.
+
+
+
+## Contact
+For questions or feedback, please create an issue.
+