Update README.md

README.md

@@ -1,21 +1,64 @@
 ---
 license: apache-2.0
 ---
-# Tunisian Arabic ASR Model with wav2vec2 and code switching
-This repository provides all the necessary tools to perform automatic speech recognition from an end-to-end system pretrained on Tunisian arabic dialect. This model utilizes a code_switching approach and can process english , french and tunisian arabic
+# Overview
+This repository provides all the necessary tools to perform automatic speech recognition from an end-to-end system pretrained on code-switched Tunisian arabic dialect. This model utilizes a code_switching approach and can process English , French and Tunisian Arabic
 ## Performance
-the performance of the mode is : 
-| Release Version |WER (%) | CER (%) |
+The performance of the model on our TunSwitch CS released dataset is summarized below : 
+
+| Dataset   |WER (%) | CER (%) |
 |-----------------|---------|---------|
-| v1.0            |29.47    | 12.44   |
+| TunSwitch CS        |29.47    | 12.44   |
+
+
+More details about the test sets, and the conditions leading to this performance in the paper.
 ## Pipeline
 The architecture comprises three components: 
  * French ASR pretrained with wav2vec2 on french corporas
  * English ASR pretrained with wav2vec2 on english corporas
   * Custom Tunisian ASR pretrained using wav2vec on a tunisian arabic corpora
   All three models will process the audio data. Subsequently, the resulting posteriorgrams will be combined and utilized as input for the Mixer, which will produce the final posteriorgrams.
-## Install
-```python
-pip install speechbrain transformers
+
+## Dataset
+Part of the audio and text data (The ones we collected) used to train and test the model has been provided to encourage and support research within the community. Please find the dataset [here](https://zenodo.org/record/8370566). This Zenodo record contains labeled and unlabeled Tunisian Arabic audio data, along with textual data for language modelling. 
+The folder also contains a 4-gram language model trained with KenLM on data released within the Zenodo record. The .arpa file is called "outdomain.arpa". 
+
+
+## Team
+
+Here are the team members who have contributed to  this project
+
+* [Salah Zaiem](https://fr.linkedin.com/in/salah-zaiem)
+* [Ahmed Amine Ben Aballah](https://www.linkedin.com/in/aabenz/)
+* [Ata Kaboudi](https://www.linkedin.com/in/ata-kaboudi-63365b1a8)
+* [Amir Kanoun](https://tn.linkedin.com/in/ahmed-amir-kanoun)
+
+## Paper
+ More in-depth details and insights are available in a released preprint. Please find the paper [here](https://arxiv.org/abs/2309.11327).
+If you use or refer to this model, please cite : 
+
+```
+@misc{abdallah2023leveraging,
+      title={Leveraging Data Collection and Unsupervised Learning for Code-switched Tunisian Arabic Automatic Speech Recognition}, 
+      author={Ahmed Amine Ben Abdallah and Ata Kabboudi and Amir Kanoun and Salah Zaiem},
+      year={2023},
+      eprint={2309.11327},
+      archivePrefix={arXiv},
+      primaryClass={eess.AS}
+}
+```
+
+
+## Demo
+Here is a working live demo :  [LINK](https://huggingface.co/spaces/SalahZa/Code-Switched-Tunisian-SpeechToText)
+
+
+## Inference 
+
+Please refer to the space demo for proper easy-to-use inference code.
+
+
+## Contact : 
+If you have questions, you can send an email to : zaiemsalah@gmail.com 
 ```