Silas Chalwe commited on
Commit
c29c093
Β·
verified Β·
1 Parent(s): b5ba773

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +89 -155
README.md CHANGED
@@ -1,199 +1,133 @@
1
- ---
2
- library_name: transformers
3
- tags: []
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
- This is the model card of a πŸ€— transformers model that has been pushed on the Hub. This model card has been automatically generated.
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]
 
1
+ <p align="center">
2
+ <img src="https://huggingface.co/front/assets/huggingface_logo-noborder.svg" height="80" />
3
+ </p>
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
4
 
5
+ # 🫒 NextInnoMind / next\_bemba\_ai\_medium
6
 
7
+ **Multilingual Whisper ASR (Automatic Speech Recognition)**
8
+ Fine-tuned Whisper model for Bemba and English using language tokens.
9
+ Developed and maintained by **NextInnoMind**, led by **Chalwe Silas**.
10
 
11
+ ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
12
 
13
+ ### πŸ§ͺ Model Type
14
 
15
+ `WhisperForConditionalGeneration` β€” fine-tuned using [openai/whisper-medium](https://huggingface.co/openai/whisper-medium)
16
+ Framework: `Transformers`
17
+ Checkpoint Format: `Safetensors`
18
+ Languages: `Bemba`, `English` (with `<|bem|>` language token support)
19
 
20
+ ---
21
 
22
+ ## πŸ“œ Model Description
23
 
24
+ This model is a Whisper Medium variant fine-tuned for **Bemba** and **English**, enabling robust multilingual transcription. It supports the use of language tokens (e.g., `<|bem|>`) to help guide decoding, particularly for low-resource languages like Bemba.
25
 
26
+ ---
27
 
28
+ ## πŸ“š Training Details
29
 
30
+ * **Base Model**: [`openai/whisper-medium`](https://huggingface.co/openai/whisper-medium)
31
+ * **Dataset**:
32
 
33
+ * BembaSpeech (curated dataset of Bemba audio + transcripts)
34
+ * English subset of [Common Voice](https://huggingface.co/datasets/mozilla-foundation/common_voice_13_0)
35
+ * **Training Time**: 8 epochs (\~55 hours on A100 GPU)
36
+ * **Learning Rate**: 1e-5
37
+ * **Batch Size**: 16
38
+ * **Framework**: Transformers + Accelerate
39
+ * **Tokenizer**: WhisperProcessor with `language="<|bem|>"` and `task="transcribe"`
40
 
41
+ ---
42
 
43
+ ## πŸš€ Usage
44
 
45
+ ```python
46
+ from transformers import pipeline
47
 
48
+ pipe = pipeline(
49
+ "automatic-speech-recognition",
50
+ model="NextInnoMind/next_bemba_ai_medium",
51
+ chunk_length_s=30,
52
+ return_timestamps=True
53
+ )
54
 
55
+ # Example
56
+ result = pipe("path_to_audio.wav")
57
+ print(result["text"])
58
+ ```
59
 
60
+ > πŸ“Œ Tip: For Bemba, use the language token `<|bem|>` to improve transcription accuracy.
61
 
62
+ ---
63
 
64
+ ## πŸ” Applications
 
 
 
 
65
 
66
+ * **Multilingual Education**: Bemba-English subtitles and transcription
67
+ * **Broadcast & Media**: Transcribe bilingual radio or TV content
68
+ * **Research**: Language preservation and Bantu-English linguistic studies
69
+ * **Voice Accessibility**: Multilingual ASR tools and captioning
70
 
71
+ ---
72
 
73
+ ## ⚠️ Limitations & Biases
74
 
75
+ * Slight performance drop with highly noisy or code-switched audio
76
+ * Trained on formal and clean speech; informal speech may lower accuracy
77
+ * `<|bem|>` is required for optimal Bemba decoding
78
 
79
+ ---
80
 
81
+ ## πŸ“Š Evaluation
82
 
83
+ | Language | WER (Word Error Rate) | Dataset |
84
+ | -------- | --------------------- | -------------------- |
85
+ | Bemba | \~15.2% | BembaSpeech Eval Set |
86
+ | English | \~10.5% | Common Voice EN |
87
 
88
+ ---
89
 
90
+ ## 🌱 Environmental Impact
91
 
92
+ * **Hardware**: A100 40GB x1
93
+ * **Training Time**: \~55 hours
94
+ * **Carbon Emissions**: Estimated \~25.8 kg COβ‚‚
95
+ *(via [ML CO2 Impact](https://mlco2.github.io/impact))*
96
 
97
+ ---
98
 
99
+ ## πŸ“„ Citation
100
 
101
+ ```bibtex
102
+ @misc{nextbembaai2025,
103
+ title={NextInnoMind next_bemba_ai_medium: Multilingual Whisper ASR model for Bemba and English},
104
+ author={Silas Chalwe and NextInnoMind},
105
+ year={2025},
106
+ howpublished={\url{https://huggingface.co/NextInnoMind/next_bemba_ai_medium}},
107
+ }
108
+ ```
109
 
110
+ ---
111
 
112
+ ## πŸ§‘β€πŸ’» Maintainers
113
 
114
+ * **Chalwe Silas** (Lead Developer & Dataset Curator)
115
+ * Team **NextInnoMind**
116
 
117
+ πŸ“¬ Contact:
118
 
119
+ * [silaschalwe@outlook.com](mailto:silaschalwe@outlook.com)
120
+ * [mchalwesilas@gmail.com](mailto:mchalwesilas@gmail.com)
121
 
122
+ πŸ”— GitHub: [SilasChalwe](https://github.com/SilasChalwe)
123
 
124
+ ---
125
 
126
+ ## πŸ“Œ Related Resources
127
 
128
+ * [BembaSpeech Dataset](https://huggingface.co/datasets/NextInnoMind/BembaSpeech)
129
+ * [NextInnoMind on GitHub](https://github.com/SilasChalwe)
130
 
131
+ ---
132
 
133
+ Fine tuned in Zambia.