Update README.md

README.md

@@ -1 +1,42 @@
-vhg
+---
+license: mit
+---
+
+
+# VocalSound
+
+This is an audio classification dataset for **Vocal Sound Classification**.
+
+**Classes = 6    ,    Split = Train-Test**
+
+## Structure
+
+- `audios` folder contains audio files.
+- `train.csv` for training split and `test.csv` for the testing split.
+
+## Download
+```python
+import os
+import zipfile
+import shutil
+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/VocalSound", repo_type="dataset", local_dir=os.path.join(audio_datasets_path, "VocalSound"))
+zipfile_path = os.path.join(audio_datasets_path, 'VocalSound', 'VocalSound.zip')
+with zipfile.ZipFile(zipfile_path,"r") as zip_ref:
+    zip_ref.extractall(os.path.join(audio_datasets_path, 'VocalSound'))
+shutil.move(os.path.join(audio_datasets_path, 'VocalSound','VocalSound', 'audios'), os.path.join(audio_datasets_path, 'VocalSound'))
+shutil.move(os.path.join(audio_datasets_path, 'VocalSound','VocalSound', 'train.csv'), os.path.join(audio_datasets_path, 'VocalSound'))
+shutil.move(os.path.join(audio_datasets_path, 'VocalSound','VocalSound', 'test.csv'), os.path.join(audio_datasets_path, 'VocalSound'))
+shutil.rmtree(os.path.join(audio_datasets_path, 'VocalSound', 'VocalSound'))
+os.remove(zipfile_path)
+```
+
+## Acknowledgment
+
+This dataset is a slightly processed/restructured version of data originally released by [Source](https://github.com/YuanGongND/vocalsound).<br>
+Please refer to the respective source for their licensing details and any additional information.
+
+## Contact
+For questions or feedback, please create an issue.