nairaxo commited on
Commit
ee7c7ec
1 Parent(s): ecea6c6

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +12 -18
README.md CHANGED
@@ -19,13 +19,12 @@ metrics:
19
  <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>
20
  <br/><br/>
21
 
22
- # About
23
- ### DVoice
24
- DVoice is a community initiative that aims to provide Africa low resources languages with data and models to facilitate their use of voice technologies. The lack of data on these languages makes it necessary to collect data using methods that are specific to each one. Two different approaches are currently used: the DVoice platforms ([https://dvoice.ma](https://dvoice.ma) and [https://dvoice.sn](https://dvoice.sn)), which are based on Mozilla Common Voice, for collecting authentic recordings from the community, and transfer learning techniques for automatically labeling recordings that are retrived from social modias. The DVoice platform currently manages 7 languages including Darija (Moroccan Arabic dialect) whose dataset appears on this version, Wolof, Mandingo, Serere, Pular, Diola and Soninke.
25
 
26
  For this project, AIOX Labs the SI2M Laboratory are joining forces to build the future of technologies together.
27
 
28
- ### AIOX Labs
29
  Based in Rabat, London and Paris, AIOX-Labs mobilizes artificial intelligence technologies to meet the business needs and data projects of companies.
30
 
31
  - He is at the service of the growth of groups, the optimization of processes or the improvement of the customer experience.
@@ -35,12 +34,12 @@ Based in Rabat, London and Paris, AIOX-Labs mobilizes artificial intelligence te
35
 
36
  Website: [https://www.aiox-labs.com/](https://www.aiox-labs.com/)
37
 
38
- ### SI2M Laboratory
39
  The Information Systems, Intelligent Systems and Mathematical Modeling Research Laboratory (SI2M) is an academic research laboratory of the National Institute of Statistics and Applied Economics (INSEA). The research areas of the laboratories are Information Systems, Intelligent Systems, Artificial Intelligence, Decision Support, Network and System Security, Mathematical Modelling.
40
 
41
  Website: [SI2M Laboratory](https://insea.ac.ma/index.php/pole-recherche/equipe-de-recherche/150-laboratoire-de-recherche-en-systemes-d-information-systemes-intelligents-et-modelisation-mathematique)
42
 
43
- ### SpeechBrain
44
  SpeechBrain is an open-source and all-in-one speech toolkit. It is designed to be simple, extremely flexible, and user-friendly. Competitive or state-of-the-art performance is obtained in various domains.
45
  Website: https://speechbrain.github.io/
46
  GitHub: https://github.com/speechbrain/speechbrain
@@ -55,12 +54,7 @@ SpeechBrain. For a better experience, we encourage you to learn more about
55
  |:-------------:|:---------------------------:| -----:| -----:| -----:|
56
  | v2.0 | 8.83 | 22.78 | 9.46 | 23.16 |
57
 
58
- # About DVoice
59
- DVoice is a community initiative that aims to provide African languages and dialects with data and models to facilitate their use of voice technologies. The lack of data on these languages makes it necessary to collect data using methods that are specific to each language. Two different approaches are currently used: the DVoice platforms ([https://dvoice.ma](https://dvoice.ma) and [https://dvoice.sn](https://dvoice.sn)), which are based on Mozilla Common Voice, for collecting authentic recordings from the community, and transfer learning techniques for automatically labeling the recordings. The DVoice platform currently manages 7 languages including Darija (Moroccan Arabic dialect) whose dataset appears on this version, Wolof, Mandingo, Serere, Pular, Diola and Soninke.
60
-
61
- This Swahili ASR model was obtained by combining the [VoxLingua107](http://bark.phon.ioc.ee/voxlingua107/) Swahili Dataset with transfer learning and speech augmentation modules.
62
-
63
- ## Pipeline description
64
  This ASR system is composed of 2 different but linked blocks:
65
  - Tokenizer (unigram) that transforms words into subword units and trained with
66
  the train transcriptions.
@@ -69,7 +63,7 @@ The obtained final acoustic representation is given to the CTC greedy decoder.
69
  The system is trained with recordings sampled at 16kHz (single channel).
70
  The code will automatically normalize your audio (i.e., resampling + mono channel selection) when calling *transcribe_file* if needed.
71
 
72
- ## Install SpeechBrain
73
  First of all, please install tranformers and SpeechBrain with the following command:
74
  ```
75
  pip install speechbrain transformers
@@ -77,23 +71,23 @@ pip install speechbrain transformers
77
  Please notice that we encourage you to read the SpeechBrain tutorials and learn more about
78
  [SpeechBrain](https://speechbrain.github.io).
79
 
80
- ### Transcribing your own audio files (in Swahili)
81
  ```python
82
  from speechbrain.pretrained import EncoderASR
83
  asr_model = EncoderASR.from_hparams(source="nairaxo/dvoice-swahili", savedir="pretrained_models/asr-wav2vec2-dvoice-sw")
84
  asr_model.transcribe_file('./the_path_to_your_audio_file')
85
  ```
86
 
87
- ### Inference on GPU
88
  To perform inference on the GPU, add `run_opts={"device":"cuda"}` when calling the `from_hparams` method.
89
 
90
- ### Training
91
  To train the model from scratch, please see our GitHub tutorial [here](https://github.com/AIOXLABS/DVoice).
92
 
93
- ### Limitations
94
  The SpeechBrain team does not provide any warranty on the performance achieved by this model when used on other datasets.
95
 
96
- #### Referencing SpeechBrain
97
  ```
98
  @misc{SB2021,
99
  author = {Ravanelli, Mirco and Parcollet, Titouan and Rouhe, Aku and Plantinga, Peter and Rastorgueva, Elena and Lugosch, Loren and Dawalatabad, Nauman and Ju-Chieh, Chou and Heba, Abdel and Grondin, Francois and Aris, William and Liao, Chien-Feng and Cornell, Samuele and Yeh, Sung-Lin and Na, Hwidong and Gao, Yan and Fu, Szu-Wei and Subakan, Cem and De Mori, Renato and Bengio, Yoshua },
19
  <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>
20
  <br/><br/>
21
 
22
+ # DVoice
23
+ DVoice is a community initiative that aims to provide Africa low resources languages with data and models to facilitate their use of voice technologies. The lack of data on these languages makes it necessary to collect data using methods that are specific to each one. Two different approaches are currently used: the DVoice platforms ([https://dvoice.ma](https://dvoice.ma) and [https://dvoice.sn](https://dvoice.sn)), which are based on Mozilla Common Voice, for collecting authentic recordings from the community, and transfer learning techniques for automatically labeling recordings that are retrived from social medias. The DVoice platform currently manages 7 languages including Darija (Moroccan Arabic dialect) whose dataset appears on this version, Wolof, Mandingo, Serere, Pular, Diola and Soninke.
 
24
 
25
  For this project, AIOX Labs the SI2M Laboratory are joining forces to build the future of technologies together.
26
 
27
+ # AIOX Labs
28
  Based in Rabat, London and Paris, AIOX-Labs mobilizes artificial intelligence technologies to meet the business needs and data projects of companies.
29
 
30
  - He is at the service of the growth of groups, the optimization of processes or the improvement of the customer experience.
34
 
35
  Website: [https://www.aiox-labs.com/](https://www.aiox-labs.com/)
36
 
37
+ # SI2M Laboratory
38
  The Information Systems, Intelligent Systems and Mathematical Modeling Research Laboratory (SI2M) is an academic research laboratory of the National Institute of Statistics and Applied Economics (INSEA). The research areas of the laboratories are Information Systems, Intelligent Systems, Artificial Intelligence, Decision Support, Network and System Security, Mathematical Modelling.
39
 
40
  Website: [SI2M Laboratory](https://insea.ac.ma/index.php/pole-recherche/equipe-de-recherche/150-laboratoire-de-recherche-en-systemes-d-information-systemes-intelligents-et-modelisation-mathematique)
41
 
42
+ # SpeechBrain
43
  SpeechBrain is an open-source and all-in-one speech toolkit. It is designed to be simple, extremely flexible, and user-friendly. Competitive or state-of-the-art performance is obtained in various domains.
44
  Website: https://speechbrain.github.io/
45
  GitHub: https://github.com/speechbrain/speechbrain
54
  |:-------------:|:---------------------------:| -----:| -----:| -----:|
55
  | v2.0 | 8.83 | 22.78 | 9.46 | 23.16 |
56
 
57
+ # Pipeline description
 
 
 
 
 
58
  This ASR system is composed of 2 different but linked blocks:
59
  - Tokenizer (unigram) that transforms words into subword units and trained with
60
  the train transcriptions.
63
  The system is trained with recordings sampled at 16kHz (single channel).
64
  The code will automatically normalize your audio (i.e., resampling + mono channel selection) when calling *transcribe_file* if needed.
65
 
66
+ # Install SpeechBrain
67
  First of all, please install tranformers and SpeechBrain with the following command:
68
  ```
69
  pip install speechbrain transformers
71
  Please notice that we encourage you to read the SpeechBrain tutorials and learn more about
72
  [SpeechBrain](https://speechbrain.github.io).
73
 
74
+ # Transcribing your own audio files (in Swahili)
75
  ```python
76
  from speechbrain.pretrained import EncoderASR
77
  asr_model = EncoderASR.from_hparams(source="nairaxo/dvoice-swahili", savedir="pretrained_models/asr-wav2vec2-dvoice-sw")
78
  asr_model.transcribe_file('./the_path_to_your_audio_file')
79
  ```
80
 
81
+ # Inference on GPU
82
  To perform inference on the GPU, add `run_opts={"device":"cuda"}` when calling the `from_hparams` method.
83
 
84
+ # Training
85
  To train the model from scratch, please see our GitHub tutorial [here](https://github.com/AIOXLABS/DVoice).
86
 
87
+ # Limitations
88
  The SpeechBrain team does not provide any warranty on the performance achieved by this model when used on other datasets.
89
 
90
+ # Referencing SpeechBrain
91
  ```
92
  @misc{SB2021,
93
  author = {Ravanelli, Mirco and Parcollet, Titouan and Rouhe, Aku and Plantinga, Peter and Rastorgueva, Elena and Lugosch, Loren and Dawalatabad, Nauman and Ju-Chieh, Chou and Heba, Abdel and Grondin, Francois and Aris, William and Liao, Chien-Feng and Cornell, Samuele and Yeh, Sung-Lin and Na, Hwidong and Gao, Yan and Fu, Szu-Wei and Subakan, Cem and De Mori, Renato and Bengio, Yoshua },