Update README.md

README.md

@@ -1,3 +1,40 @@
 ---
 license: apache-2.0
 ---
+# Positive Transfer Of The Whisper Speech Transformer To Human And Animal Voice Activity Detection
+We proposed WhisperSeg, utilizing the Whisper Transformer pre-trained for Automatic Speech Recognition (ASR) for both human and animal Voice Activity Detection (VAD). For more details, please refer to our paper
+
+>
+> [**Positive Transfer of the Whisper Speech Transformer to Human and Animal Voice Activity Detection**]()
+> 
+> Nianlong Gu, Kanghwi Lee, Maris Basha, Sumit Kumar Ram, Guanghao You, Richard H. R. Hahnloser <br>
+> University of Zurich and ETH Zurich
+
+This is the Zebra finch dataset customized for Animal Voice Activity Detection (vocal segmentation) in WhisperSeg.
+
+## Download Dataset
+```python
+from huggingface_hub import snapshot_download
+snapshot_download('nccratliri/vad-zebra-finch', local_dir = "data/zebra-finch", repo_type="dataset" )
+```
+
+For more usage details, please refer to the GitHub repository: https://github.com/nianlonggu/WhisperSeg
+
+When using this dataset, please also cite:
+```
+@article {Tomka2023.09.04.555475,
+	author = {Tomas Tomka and Xinyu Hao and Aoxue Miao and Kanghwi Lee and Maris Basha and Stefan Reimann and Anja T Zai and Richard Hahnloser},
+	title = {Benchmarking nearest neighbor retrieval of zebra finch vocalizations across development},
+	elocation-id = {2023.09.04.555475},
+	year = {2023},
+	doi = {10.1101/2023.09.04.555475},
+	publisher = {Cold Spring Harbor Laboratory},
+	abstract = {Vocalizations are highly specialized motor gestures that regulate social interactions. The reliable detection of vocalizations from raw streams of microphone data remains an open problem even in research on widely studied animals such as the zebra finch. A promising method for finding vocal samples from potentially few labelled examples(templates) is nearest neighbor retrieval, but this method has never been extensively tested on vocal segmentation tasks. We retrieve zebra finch vocalizations as neighbors of each other in the sound spectrogram space. Based on merely 50 templates, we find excellent retrieval performance in adults (F1 score of 0.93 +/- 0.07) but not in juveniles (F1 score of 0.64 +/- 0.18), presumably due to the larger vocal variability of the latter. The performance in juveniles improves when retrieval is based on fixed-size template slices (F1 score of 0.72 +/- 0.10) instead of entire templates. Among the several distance metrics we tested such as the cosine and the Euclidean distance, we find that the Spearman distance largely outperforms all others. We release our expert-curated dataset of more than 50{\textquoteright}000 zebra finch vocal segments, which will enable training of data-hungry machine-learning approaches.Competing Interest StatementThe authors have declared no competing interest.},
+	URL = {https://www.biorxiv.org/content/early/2023/09/04/2023.09.04.555475},
+	eprint = {https://www.biorxiv.org/content/early/2023/09/04/2023.09.04.555475.full.pdf},
+	journal = {bioRxiv}
+}
+```
+
+## Contact
+nianlong.gu@uzh.ch