Update README.md

README.md

@@ -1,3 +1,96 @@
----
-license: cc-by-nc-4.0
----
+---
+license: cc-by-nc-4.0
+metrics:
+- cer
+- wer
+library_name: speechbrain
+pipeline_tag: feature-extraction
+tags:
+- speech processing
+- self-supervision
+- african languages
+- fine-tuning
+---
+## Model description
+This self-supervised speech model (a.k.a. SSA-HuBERT-base-5k) is based on a HuBERT Base architecture (~95M params) [1].   
+It was trained on nearly 5 000 hours of speech segments and covers 21 languages and variants spoken in Sub-Saharan Africa.     
+It is a balanced version in gender and languages representation compared to the SSA-HuBERT-base-60k.
+	
+### Pretraining data
+- Dataset: The training dataset was composed of both studio recordings (controlled environment, prepared talks) and street interviews (noisy environment, spontaneous speech). 
+
+- Languages: Bambara (bam), Dyula (dyu), French (fra), Fula (ful), Fulfulde (ffm), Fulfulde (fuh), Gulmancema (gux), Hausa (hau), Kinyarwanda (kin), Kituba (ktu), Lingala (lin), Luba-Lulua (lua), Mossi (mos), Maninkakan (mwk), Sango (sag), Songhai (son), Swahili (swc), Swahili (swh), Tamasheq (taq), Wolof (wol), Zarma (dje).
+
+## ASR fine-tuning
+The SpeechBrain toolkit (Ravanelli et al., 2021) is used to fine-tune the model.    
+Fine-tuning is done for each language using the FLEURS dataset [2].   
+The pretrained model (SSA-HuBERT-base-5k) is considered as a speech encoder and is fully fine-tuned with two 1024 linear layers and a softmax output at the top.     
+ 
+## License
+This model is released under the CC-by-NC 4.0 conditions.
+
+## Publication
+This model were presented at JEP-TALN 2024. 
+The associated paper is available here: [Africa-Centric Self-Supervised Pre-Training for Multilingual Speech Representation in a Sub-Saharan Context](https://inria.hal.science/hal-04623069/)
+
+### Citation
+Please cite our paper when using SSA-HuBERT-base-5k model:    
+
+	Antoine Caubrière, Elodie Gauthier. Représentation de la parole multilingue par apprentissage auto-supervisé dans un contexte subsaharien. 35èmes Journées d'Études sur la Parole (JEP 2024) 31ème Conférence sur le Traitement Automatique des Langues Naturelles (TALN 2024) 26ème Rencontre des Étudiants Chercheurs en Informatique pour le Traitement Automatique des Langues (RECITAL 2024), Jul 2024, Toulouse, France. pp.163-172. ⟨hal-04623069⟩
+
+**Bibtex:**     
+```mk  
+@inproceedings{caubriere:hal-04623069,    
+  TITLE = {{Repr{\'e}sentation de la parole multilingue par apprentissage auto-supervis{\'e} dans un contexte subsaharien}},    
+  AUTHOR = {Caubri{\`e}re, Antoine and Gauthier, Elodie},    
+  URL = {https://inria.hal.science/hal-04623069},    
+  BOOKTITLE = {{35{\`e}mes Journ{\'e}es d'{\'E}tudes sur la Parole (JEP 2024) 31{\`e}me Conf{\'e}rence sur le Traitement Automatique des Langues Naturelles (TALN 2024) 26{\`e}me Rencontre des {\'E}tudiants Chercheurs en Informatique pour le Traitement Automatique des Langues (RECITAL 2024)}},    
+  ADDRESS = {Toulouse, France},    
+  EDITOR = {BALAGUER and Mathieu and BENDAHMAN and Nihed and HO-DAC and Lydia-Mai and MAUCLAIR and Julie and MORENO and Jose G and PINQUIER and Julien},    
+  PUBLISHER = {{ATALA \& AFPC}},    
+  PAGES = {163-172},    
+  YEAR = {2024},    
+  MONTH = Jul,    
+  KEYWORDS = {Apprentissage auto-supervis{\'e} ; Langues subsaharienne ; Reconnaissance de la parole multilingue ; HuBERT},    
+  PDF = {https://inria.hal.science/hal-04623069/file/4347.pdf},    
+  HAL_ID = {hal-04623069},    
+  HAL_VERSION = {v1},    
+}
+```
+
+## Results
+The following results are obtained in a greedy mode (no language model rescoring).    
+Character error rates (CERs) and Word error rates (WERs) are given in the table below, on the 20 languages of the SSA subpart of the FLEURS dataset.
+
+| **Languages**                   | **CER** | **WER** |
+|:--------------------------------|:--------|:--------|
+| **Afrikaans**                   | 23.8    | 68.3    |
+| **Amharic**                     | 15.5    | 51.4    |
+| **Fula**                        | 21.2    | 60.6    |
+| **Ganda**                       | 11.7    | 53.3    |
+| **Hausa**                       | 11.2    | 35.6    |
+| **Igbo**                        | 20.9    | 57.9    |
+| **Kamba**                       | 16.3    | 53.7    |
+| **Lingala**                     | 8.7     | 24.2    |
+| **Luo**                         | 10.2    | 38.5    |
+| **Northen-Sotho**               | 14.4    | 44.6    |
+| **Nyanja**                      | 13.7    | 54.5    |
+| **Oromo**                       | 22.9    | 77.4    |
+| **Shona**                       | 11.2    | 48.2    |
+| **Somali**                      | 21.9    | 64.5    |
+| **Swahili**                     | 8.6     | 28.8    |
+| **Umbundu**                     | 21.7    | 60.8    |
+| **Wolof**                       | 19.2    | 54.2    |
+| **Xhosa**                       | 12.4    | 52.3    |
+| **Yoruba**                      | 25.0    | 68.0    |
+| **Zulu**                        | 12.4    | 53.0    |
+| *Overall average*               | *16.1*  | *52.5*  |
+
+
+## Reproductibilty
+We propose a notebook to reproduce the ASR experiments mentioned in our paper. See `SB_ASR_FLEURS_finetuning.ipynb`.   
+By using the `ASR_FLEURS-swahili_hf.yaml` config file, you will be able to run the recipe on Swahili.     
+
+## References
+[1] Wei-Ning Hsu, Benjamin Bolte, Yao-Hung Hubert Tsai, Kushal Lakhotia, Ruslan Salakhutdinov, and Abdelrahman Mohamed. HuBERT: Self-Supervised Speech Representation Learning by Masked Prediction of Hidden Units. In 2021 IEEE/ACM Transactions on Audio, Speech, and Language Processing, vol. 29, pp.3451–3460, 2021. doi: 10.1109/TASLP.2021.3122291.   
+[2] Alexis Conneau, Min Ma, Simran Khanuja, Yu Zhang, Vera Axelrod, Siddharth Dalmia, Jason Riesa, Clara Rivera, and Ankur Bapna. Fleurs: Few-shot learning evaluation of universal representations of speech. In 2022 IEEE Spoken Language Technology Workshop (SLT), pp. 798–805, 2022. doi: 10.1109/SLT54892.2023.10023141.