Silas Chalwe commited on
Commit
2a22d39
Β·
verified Β·
1 Parent(s): 844e1ce

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +91 -155
README.md CHANGED
@@ -1,199 +1,135 @@
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
+ ---
2
+ library_name: transformers
3
+ pipeline_tag: text-to-audio
4
+ ---
5
+ <p align="center">
6
+ <img src="https://huggingface.co/front/assets/huggingface_logo-noborder.svg" height="80" />
7
+ </p>
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
8
 
9
+ # 🫒 NextInnoMind / next\_bemba\_ai
10
 
11
+ **Bemba Whisper ASR (Automatic Speech Recognition)**
12
+ Fine-tuned Whisper model for the Bemba language only.
13
+ Developed and maintained by **NextInnoMind**, led by **Chalwe Silas**.
14
 
15
+ ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
16
 
17
+ ### πŸ§ͺ Model Type
18
 
19
+ `WhisperForConditionalGeneration` β€” fine-tuned using [openai/whisper-small](https://huggingface.co/openai/whisper-small)
20
+ Framework: `Transformers`
21
+ Checkpoint Format: `Safetensors`
22
+ Languages: `Bemba`
23
 
24
+ ---
25
 
26
+ ## πŸ“œ Model Description
27
 
28
+ This model is a Whisper Small variant fine-tuned exclusively for **Bemba**, a major Zambian language. It is designed to enhance local language ASR performance and promote indigenous language technology.
29
 
30
+ ---
31
 
32
+ ## πŸ“š Training Details
33
 
34
+ * **Base Model**: [`openai/whisper-small`](https://huggingface.co/openai/whisper-small)
35
+ * **Dataset**:
36
 
37
+ * BembaSpeech (curated dataset of Bemba audio + transcripts)
38
+ * **Training Time**: 8 epochs (\~45 hours on A100 GPU)
39
+ * **Learning Rate**: 1e-5
40
+ * **Batch Size**: 16
41
+ * **Framework**: Transformers + Accelerate
42
+ * **Tokenizer**: WhisperProcessor with `task="transcribe"` (no language token used)
43
 
44
+ ---
45
 
46
+ ## πŸš€ Usage
47
 
48
+ ```python
49
+ from transformers import pipeline
50
 
51
+ pipe = pipeline(
52
+ "automatic-speech-recognition",
53
+ model="NextInnoMind/next_bemba_ai",
54
+ chunk_length_s=30,
55
+ return_timestamps=True
56
+ )
57
 
58
+ # Example
59
+ result = pipe("path_to_audio.wav")
60
+ print(result["text"])
61
+ ```
62
 
63
+ > πŸ“Œ Tip: No language token is required. The model is fine-tuned for Bemba only.
64
 
65
+ ---
66
 
67
+ ## πŸ” Applications
 
 
 
 
68
 
69
+ * **Education**: Local language transcriptions and learning tools
70
+ * **Broadcast & Media**: Transcribe Bemba radio and TV shows
71
+ * **Research**: Bantu language documentation and analysis
72
+ * **Accessibility**: Voice-to-text systems in local apps and platforms
73
 
74
+ ---
75
 
76
+ ## ⚠️ Limitations & Biases
77
 
78
+ * Trained only on Bemba: does not support English or other languages.
79
+ * Accuracy may drop with heavy background noise or strong dialectal variation.
80
+ * Not optimized for code-switching or informal speech styles.
81
 
82
+ ---
83
 
84
+ ## πŸ“Š Evaluation
85
 
86
+ | Language | WER (Word Error Rate) | Dataset |
87
+ | -------- | --------------------- | -------------------- |
88
+ | Bemba | \~16.7% | BembaSpeech Eval Set |
89
 
90
+ ---
91
 
92
+ ## 🌱 Environmental Impact
93
 
94
+ * **Hardware**: A100 40GB x1
95
+ * **Training Time**: \~45 hours
96
+ * **Carbon Emissions**: Estimated \~20.4 kg COβ‚‚
97
+ *(via [ML CO2 Impact](https://mlco2.github.io/impact))*
98
 
99
+ ---
100
 
101
+ ## πŸ“„ Citation
102
 
103
+ ```bibtex
104
+ @misc{nextbembaai2025,
105
+ title={NextInnoMind next_bemba_ai: Whisper-based ASR model for Bemba},
106
+ author={Silas Chalwe and NextInnoMind},
107
+ year={2025},
108
+ howpublished={\url{https://huggingface.co/NextInnoMind/next_bemba_ai}},
109
+ }
110
+ ```
111
 
112
+ ---
113
 
114
+ ## πŸ§‘β€πŸ’» Maintainers
115
 
116
+ * **Chalwe Silas** (Lead Developer & Dataset Curator)
117
+ * Team **NextInnoMind**
118
 
119
+ πŸ“¬ Contact:
120
 
121
+ * [silaschalwe@outlook.com](mailto:silaschalwe@outlook.com)
122
+ * [mchalwesilas@gmail.com](mailto:mchalwesilas@gmail.com)
123
 
124
+ πŸ”— GitHub: [SilasChalwe](https://github.com/SilasChalwe)
125
 
126
+ ---
127
 
128
+ ## πŸ“Œ Related Resources
129
 
130
+ * [BembaSpeech Dataset](https://huggingface.co/datasets/NextInnoMind/BembaSpeech)
131
+ * [NextInnoMind on GitHub](https://github.com/SilasChalwe)
132
 
133
+ ---
134
 
135
+ Fine tuned in Zambia.