Create README.md

README.md

@@ -0,0 +1,81 @@
+---
+language: "en"
+thumbnail:
+tags:
+- speechbrain
+- embeddings
+- Sound
+- pytorch
+- ECAPA-TDNN
+- TDNN
+- audio-classification
+license: "apache-2.0"
+datasets:
+- VGGSound
+metrics:
+- Accuracy
+
+---
+
+<iframe src="https://ghbtns.com/github-btn.html?user=speechbrain&repo=speechbrain&type=star&count=true&size=large&v=2" frameborder="0" scrolling="0" width="170" height="30" title="GitHub"></iframe>
+<br/><br/>
+
+# Sound Recognition with ECAPA embeddings on VGGSound
+
+This repository provides all the necessary tools to perform sound recognition with SpeechBrain using a model pretrained on VGGSound.
+
+For a better experience, we encourage you to learn more about
+[SpeechBrain](https://speechbrain.github.io). 
+
+The given model performance on the test set is:
+
+| Release | Error Rate (%)
+|:-------------:|:--------------:|
+| 28-02-23 | 42.8 | 
+
+
+#### Referencing ECAPA
+```@inproceedings{DBLP:conf/interspeech/DesplanquesTD20,
+  author    = {Brecht Desplanques and
+               Jenthe Thienpondt and
+               Kris Demuynck},
+  editor    = {Helen Meng and
+               Bo Xu and
+               Thomas Fang Zheng},
+  title     = {{ECAPA-TDNN:} Emphasized Channel Attention, Propagation and Aggregation
+               in {TDNN} Based Speaker Verification},
+  booktitle = {Interspeech 2020},
+  pages     = {3830--3834},
+  publisher = {{ISCA}},
+  year      = {2020},
+}
+```
+
+#### Referencing VGGSound
+```@inproceedings{chen2020vggsound,
+  title={Vggsound: A large-scale audio-visual dataset},
+  author={Chen, Honglie and Xie, Weidi and Vedaldi, Andrea and Zisserman, Andrew},
+  booktitle={ICASSP 2020-2020 IEEE International Conference on Acoustics, Speech and Signal Processing (ICASSP)},
+  pages={721--725},
+  year={2020},
+  organization={IEEE}
+}
+```
+
+
+
+# **Citing SpeechBrain**
+Please, cite SpeechBrain if you use it for your research or business.
+
+
+```bibtex
+@misc{speechbrain,
+  title={{SpeechBrain}: A General-Purpose Speech Toolkit},
+  author={Mirco Ravanelli and Titouan Parcollet and Peter Plantinga and Aku Rouhe and Samuele Cornell and Loren Lugosch and Cem Subakan and Nauman Dawalatabad and Abdelwahab Heba and Jianyuan Zhong and Ju-Chieh Chou and Sung-Lin Yeh and Szu-Wei Fu and Chien-Feng Liao and Elena Rastorgueva and François Grondin and William Aris and Hwidong Na and Yan Gao and Renato De Mori and Yoshua Bengio},
+  year={2021},
+  eprint={2106.04624},
+  archivePrefix={arXiv},
+  primaryClass={eess.AS},
+  note={arXiv:2106.04624}
+}
+```