Update README.md

README.md

@@ -4,13 +4,12 @@ thumbnail:
 tags:
 - speechbrain
 - embeddings
-- Sound
-- Keywords
-- Keyword Spotting
+- Language
+- Identification
 - pytorch
 - ECAPA-TDNN
 - TDNN
-- Command Recognition
+- CommonLanguage
 license: "apache-2.0"
 datasets:
 - Urbansound8k
@@ -19,27 +18,27 @@ metrics:
 
 ---
 
-# WORK IN PROGRESS
 
 <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/>
 
-# Command Recognition with ECAPA embeddings on UrbanSoudnd8k
+# Language Identification from Speech Recordings with ECAPA embeddings on CommonLanguage
 
-This repository provides all the necessary tools to perform sound recognition with SpeechBrain using a model pretrained on UrbanSound8k.
-You can download the dataset [here](https://urbansounddataset.weebly.com/urbansound8k.html)
-The provided system can recognize the following 10 keywords:
-```
+This repository provides all the necessary tools to perform language identification from speeech recordinfs with SpeechBrain.
+The system uses a model pretrained on the CommonLanguage dataset (45 languages).
+You can download the dataset [here](https://zenodo.org/record/5036977#.YNzDbXVKg5k)
+The provided system can recognize the following 45 languages from short speech recordings:
 
-dog_bark, children_playing, air_conditioner, street_music, gun_shot, siren, engine_idling, jackhammer, drilling, car_horn
+```
+Arabic, Basque, Breton, Catalan, Chinese_China, Chinese_Hongkong, Chinese_Taiwan, Chuvash, Czech, Dhivehi, Dutch, English, Esperanto, Estonian, French, Frisian, Georgian, German, Greek, Hakha_Chin, Indonesian, Interlingua, Italian, Japanese, Kabyle, Kinyarwanda, Kyrgyz, Latvian, Maltese, Mangolian, Persian, Polish, Portuguese, Romanian, Romansh_Sursilvan, Russian, Sakha, Slovenian, Spanish, Swedish, Tamil, Tatar, Turkish, Ukranian, Welsh
 ```
 
 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 | Accuracy 1-fold (%)
+| Release | Accuracy (%)
 |:-------------:|:--------------:|
-| 04-06-21 | 75.5 | 
+| 30-06-21 | 15.1 | 
 
 
 ## Pipeline description
@@ -56,7 +55,7 @@ pip install speechbrain
 Please notice that we encourage you to read our tutorials and learn more about
 [SpeechBrain](https://speechbrain.github.io).
 
-### Perform Sound Recognition
+### Perform Language  Identification from Speech Recordings
 
 ```python
 import torchaudio
@@ -75,7 +74,7 @@ print(text_lab)
 To perform inference on the GPU, add  `run_opts={"device":"cuda"}`  when calling the `from_hparams` method.
 
 ### Training
-The model was trained with SpeechBrain (8cab8b0c).
+The model was trained with SpeechBrain (a02f860e).
 To train it from scratch follows these steps:
 1. Clone SpeechBrain:
 ```bash
@@ -90,11 +89,11 @@ pip install -e .
 
 3. Run Training:
 ```
-cd recipes/UrbanSound8k/SoundClassification
+cd recipes/CommonLanguage/lang_id
 python train.py hparams/train_ecapa_tdnn.yaml --data_folder=your_data_folder
 ```
 
-You can find our training results (models, logs, etc) [here](https://drive.google.com/drive/folders/1sItfg_WNuGX6h2dCs8JTGq2v2QoNTaUg?usp=sharing).
+You can find our training results (models, logs, etc) [here](https://drive.google.com/drive/folders/1sD2u0MhSmJlx_3RRgwsYzevX81RM8-WE?usp=sharing).
 
 ### Limitations
 The SpeechBrain team does not provide any warranty on the performance achieved by this model when used on other datasets.
@@ -116,17 +115,6 @@ The SpeechBrain team does not provide any warranty on the performance achieved b
 }
 ```
 
-#### Referencing UrbanSound
-```@inproceedings{Salamon:UrbanSound:ACMMM:14,
-    Author = {Salamon, J. and Jacoby, C. and Bello, J. P.},
-    Booktitle = {22nd {ACM} International Conference on Multimedia (ACM-MM'14)},
-    Month = {Nov.},
-    Pages = {1041--1044},
-    Title = {A Dataset and Taxonomy for Urban Sound Research},
-    Year = {2014}}
-```
-
-
 
 # **Citing SpeechBrain**
 Please, cite SpeechBrain if you use it for your research or business.