dganza commited on
Commit
9be5c2f
·
verified ·
1 Parent(s): aa11c24

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +62 -173
README.md CHANGED
@@ -1,202 +1,91 @@
1
  ---
2
  base_model: badrex/w2v-bert-2.0-kinyarwanda-asr
3
  library_name: peft
 
 
 
 
 
 
 
 
 
4
  ---
5
 
6
- # Model Card for Model ID
7
 
8
- <!-- Provide a quick summary of what the model is/does. -->
 
 
9
 
 
10
 
 
 
 
 
 
11
 
12
- ## Model Details
13
 
14
- ### Model Description
 
 
15
 
16
- <!-- Provide a longer summary of what this model is. -->
17
 
 
 
18
 
 
 
 
19
 
20
- - **Developed by:** [More Information Needed]
21
- - **Funded by [optional]:** [More Information Needed]
22
- - **Shared by [optional]:** [More Information Needed]
23
- - **Model type:** [More Information Needed]
24
- - **Language(s) (NLP):** [More Information Needed]
25
- - **License:** [More Information Needed]
26
- - **Finetuned from model [optional]:** [More Information Needed]
27
-
28
- ### Model Sources [optional]
29
-
30
- <!-- Provide the basic links for the model. -->
31
-
32
- - **Repository:** [More Information Needed]
33
- - **Paper [optional]:** [More Information Needed]
34
- - **Demo [optional]:** [More Information Needed]
35
-
36
- ## Uses
37
-
38
- <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
39
-
40
- ### Direct Use
41
-
42
- <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
43
-
44
- [More Information Needed]
45
-
46
- ### Downstream Use [optional]
47
-
48
- <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
49
-
50
- [More Information Needed]
51
-
52
- ### Out-of-Scope Use
53
-
54
- <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
55
-
56
- [More Information Needed]
57
-
58
- ## Bias, Risks, and Limitations
59
-
60
- <!-- This section is meant to convey both technical and sociotechnical limitations. -->
61
-
62
- [More Information Needed]
63
-
64
- ### Recommendations
65
-
66
- <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
67
-
68
- Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
69
-
70
- ## How to Get Started with the Model
71
-
72
- Use the code below to get started with the model.
73
-
74
- [More Information Needed]
75
-
76
- ## Training Details
77
-
78
- ### Training Data
79
-
80
- <!-- This should link to a Dataset Card, perhaps with a short stub of information on what the training data is all about as well as documentation related to data pre-processing or additional filtering. -->
81
-
82
- [More Information Needed]
83
-
84
- ### Training Procedure
85
-
86
- <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
87
-
88
- #### Preprocessing [optional]
89
-
90
- [More Information Needed]
91
-
92
-
93
- #### Training Hyperparameters
94
-
95
- - **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
96
-
97
- #### Speeds, Sizes, Times [optional]
98
-
99
- <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
100
-
101
- [More Information Needed]
102
 
103
  ## Evaluation
104
 
105
- <!-- This section describes the evaluation protocols and provides the results. -->
106
-
107
- ### Testing Data, Factors & Metrics
108
-
109
- #### Testing Data
110
-
111
- <!-- This should link to a Dataset Card if possible. -->
112
-
113
- [More Information Needed]
114
-
115
- #### Factors
116
-
117
- <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
118
-
119
- [More Information Needed]
120
-
121
- #### Metrics
122
-
123
- <!-- These are the evaluation metrics being used, ideally with a description of why. -->
124
-
125
- [More Information Needed]
126
-
127
- ### Results
128
-
129
- [More Information Needed]
130
-
131
- #### Summary
132
-
133
-
134
-
135
- ## Model Examination [optional]
136
-
137
- <!-- Relevant interpretability work for the model goes here -->
138
-
139
- [More Information Needed]
140
-
141
- ## Environmental Impact
142
-
143
- <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
144
-
145
- Carbon emissions can be estimated using the [Machine Learning Impact calculator](https://mlco2.github.io/impact#compute) presented in [Lacoste et al. (2019)](https://arxiv.org/abs/1910.09700).
146
-
147
- - **Hardware Type:** [More Information Needed]
148
- - **Hours used:** [More Information Needed]
149
- - **Cloud Provider:** [More Information Needed]
150
- - **Compute Region:** [More Information Needed]
151
- - **Carbon Emitted:** [More Information Needed]
152
-
153
- ## Technical Specifications [optional]
154
-
155
- ### Model Architecture and Objective
156
-
157
- [More Information Needed]
158
-
159
- ### Compute Infrastructure
160
-
161
- [More Information Needed]
162
-
163
- #### Hardware
164
-
165
- [More Information Needed]
166
-
167
- #### Software
168
-
169
- [More Information Needed]
170
-
171
- ## Citation [optional]
172
-
173
- <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
174
-
175
- **BibTeX:**
176
-
177
- [More Information Needed]
178
-
179
- **APA:**
180
 
181
- [More Information Needed]
 
182
 
183
- ## Glossary [optional]
 
 
 
 
184
 
185
- <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
186
 
187
- [More Information Needed]
 
 
188
 
189
- ## More Information [optional]
 
 
 
 
 
190
 
191
- [More Information Needed]
192
 
193
- ## Model Card Authors [optional]
 
 
 
 
194
 
195
- [More Information Needed]
196
 
197
- ## Model Card Contact
 
198
 
199
- [More Information Needed]
200
  ### Framework versions
201
 
202
- - PEFT 0.11.1
 
 
1
  ---
2
  base_model: badrex/w2v-bert-2.0-kinyarwanda-asr
3
  library_name: peft
4
+ license: apache-2.0
5
+ language:
6
+ - rw
7
+ tags:
8
+ - automatic-speech-recognition
9
+ - kinyarwanda
10
+ - lora
11
+ - health
12
+ pipeline_tag: automatic-speech-recognition
13
  ---
14
 
15
+ # UBUZIMA AI — Kinyarwanda ASR LoRA adapter
16
 
17
+ A LoRA adapter over [badrex/w2v-bert-2.0-kinyarwanda-asr](https://huggingface.co/badrex/w2v-bert-2.0-kinyarwanda-asr),
18
+ fine-tuned for a Kinyarwanda voice health assistant. Part of the UBUZIMA AI capstone
19
+ project at the African Leadership University, Kigali.
20
 
21
+ ## Model details
22
 
23
+ - **Developed by:** Ganza Didier (African Leadership University)
24
+ - **Model type:** LoRA adapter for Wav2Vec2-BERT 2.0 CTC speech recognition
25
+ - **Language:** Kinyarwanda (rw)
26
+ - **License:** Apache 2.0
27
+ - **Fine-tuned from:** badrex/w2v-bert-2.0-kinyarwanda-asr
28
 
29
+ ### Adapter configuration
30
 
31
+ r = 32, alpha = 64, dropout 0.05, target modules `linear_q` and `linear_v`.
32
+ 3,145,728 trainable parameters (0.54% of the 583.6M base). Feature extractor and
33
+ feature projection frozen.
34
 
35
+ ## Training
36
 
37
+ Fine-tuned in two sequential stages on pooled Afrivoice (health-domain) and Common
38
+ Voice (general-domain) Kinyarwanda speech:
39
 
40
+ - **Stage 1:** 100 hours at a 1:1 Afrivoice:Common Voice ratio.
41
+ - **Stage 2:** warm-started from Stage 1, 500 hours at a 1:4 ratio. This adapter is
42
+ the Stage 2 result.
43
 
44
+ Training regime: fp16 mixed precision on an NVIDIA T4 (Google Colab).
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
45
 
46
  ## Evaluation
47
 
48
+ | Test set | n clips | WER | 95% CI | CER |
49
+ |---|---|---|---|---|
50
+ | Afrivoice (in-domain, health) | 1,560 | 6.76% | [6.44, 7.11] | 1.39% |
51
+ | Common Voice (cross-domain, general) | 16,205 | 31.29% | [30.86, 31.72] | 8.99% |
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
52
 
53
+ WER = word error rate, CER = character error rate. 95% confidence intervals from
54
+ 500-resample bootstrapping.
55
 
56
+ **Contamination note.** The base badrex checkpoint was pretrained on Kinyarwanda
57
+ audio that included portions of the Digital Umuganda health corpus from which the
58
+ Afrivoice subset is drawn. The in-domain figure therefore reflects both this
59
+ adaptation and residual pretraining familiarity; the Common Voice figure is the
60
+ cleaner cross-domain measure of what the adapter added.
61
 
62
+ ## How to use
63
 
64
+ ```python
65
+ from transformers import Wav2Vec2BertForCTC, AutoProcessor
66
+ from peft import PeftModel
67
 
68
+ base = "badrex/w2v-bert-2.0-kinyarwanda-asr"
69
+ model = Wav2Vec2BertForCTC.from_pretrained(base)
70
+ model = PeftModel.from_pretrained(model, "dganza/ubuzima-w2v-bert-lora")
71
+ model = model.merge_and_unload() # fold LoRA in for faster inference
72
+ processor = AutoProcessor.from_pretrained("dganza/ubuzima-w2v-bert-lora")
73
+ ```
74
 
75
+ ## Intended use and limitations
76
 
77
+ Research prototype for Kinyarwanda health-*information* delivery. **Not a medical
78
+ device; does not diagnose.** Dialect coverage is limited to the standard Kinyarwanda
79
+ represented in the training corpora. Cross-domain performance (Common Voice, 31% WER)
80
+ is substantially weaker than in-domain (Afrivoice, 7% WER), so out-of-domain use
81
+ should expect that gap.
82
 
83
+ ## Citation
84
 
85
+ Ganza, D. (2026). *UBUZIMA AI: A Kinyarwanda voice health assistant* [Capstone
86
+ project]. African Leadership University. Supervisor: Emmanuel Adjei.
87
 
 
88
  ### Framework versions
89
 
90
+ - PEFT 0.12.0
91
+ - Transformers 4.44.2