badrex commited on
Commit
f7843a6
·
verified ·
1 Parent(s): 1794dbf

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +122 -195
README.md CHANGED
@@ -1,199 +1,126 @@
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
+ license: cc-by-4.0
4
+ datasets:
5
+ - google/WaxalNLP
6
+ metrics:
7
+ - wer
8
+ - cer
9
+ language:
10
+ - ti
11
+ base_model:
12
+ - facebook/w2v-bert-2.0
13
+ pipeline_tag: automatic-speech-recognition
14
+ tags:
15
+ - tigrinya
16
  ---
17
 
18
+ <div align="center">
19
+ <img src="ethio-asr-logo.png" alt="Ethio-ASR Logo" width="600">
20
+ </div>
21
+
22
+ <div align="center" style="line-height: 1; transform: scale(1.4);">
23
+ <a href="https://huggingface.co/datasets/google/WaxalNLP" target="_blank" style="margin: 2px;">
24
+ <img alt="Hugging Face" src="https://img.shields.io/badge/%F0%9F%A4%97%20Hugging%20Face-Dataset-ffc107?color=ffca28&logoColor=white" style="display: inline-block; vertical-align: middle;"/>
25
+ <a href="https://huggingface.co/spaces/badrex/Ethio-ASR-multilingual-demo" target="_blank" style="margin: 2px;">
26
+ <img alt="Hugging Face" src="https://img.shields.io/badge/%F0%9F%A4%97%20Hugging%20Face-Space-ffc107?color=c62828&logoColor=white" style="display: inline-block; vertical-align: middle;"/>
27
+ <a href="https://creativecommons.org/licenses/by/4.0/deed.en" style="margin: 2px;">
28
+ <img alt="License" src="https://img.shields.io/badge/License-CC%20BY%204.0-lightgrey.svg" style="display: inline-block; vertical-align: middle;"/>
29
+ </a>
30
+ </div>
31
+
32
+ <h3 style="text-align: center; font-size: 24px; color:#C70039;">
33
+ arXiv 📖 <a href="https://arxiv.org/pdf/2603.23654">[ preprint ]</a>
34
+ </h3>
35
+
36
+ ## ⚒️ Model Description
37
+
38
+ Ethio-ASR is a suite of Automatic Speech Recognition (ASR) models for Ethiopian languages.
39
+ This repo contains a **monolingual Tigrinya ASR model** based on [wav2vec2‑bert-2.0](https://huggingface.co/facebook/w2v-bert-2.0), fine-tuned on the Tigrinya subset of the [WAXAL Speech Dataset](https://huggingface.co/datasets/google/WaxalNLP).
40
+
41
+ - **Developed by:** Ethio-ASR Team
42
+ - **Task:** Speech Recognition (ASR)
43
+ - **Language:** Tigrinya
44
+ - **License:** CC-BY-4.0
45
+ - **Finetuned from:** facebook/w2v-bert-2.0
46
+
47
+
48
+ ## 📈 Evaluation on WAXAL Test Set (Tigrinya)
49
+ *📌 ASR model in this HF repo*
50
+ | Model | # Params | Tigrinya WER (↓) |
51
+ |------|----------|----------|
52
+ | Ethio-ASR (afrihubert) | 94M | 42.42 |
53
+ | Ethio-ASR (mms-300) | 300M | 41.62 |
54
+ | Ethio-ASR (mms-1b) | 1B | 37.63 |
55
+ | Ethio-ASR (w2v-bert-2.0) | 600M | **35.22** |
56
+ | **Monolingual SFT (w2v-bert-2.0)** 📌 | 600M | 35.65 |
57
+
58
+
59
+ ## 🎧 Direct Use
60
+
61
+ ``` python
62
+ from transformers import AutoModelForCTC, AutoProcessor
63
+ import torchaudio, torch
64
+
65
+ processor = AutoProcessor.from_pretrained("badrex/Ethio-ASR-tigrinya")
66
+ model = AutoModelForCTC.from_pretrained("badrex/Ethio-ASR-tigrinya")
67
+
68
+ audio, sr = torchaudio.load("audio.wav")
69
+ inputs = processor(audio.squeeze(), sampling_rate=sr, return_tensors="pt")
70
+
71
+ with torch.no_grad():
72
+ logits = model(**inputs).logits
73
+
74
+ pred_ids = torch.argmax(logits, dim=-1)
75
+ transcription = processor.batch_decode(pred_ids)[0]
76
+
77
+ print(transcription)
78
+ ```
79
+
80
+ ## 🔧 Downstream Use
81
+
82
+ - Voice assistants
83
+ - Accessibility tools
84
+ - Research baselines
85
+
86
+ ## 🚫 Out‑of‑Scope Use
87
+
88
+ - Languages other than Tigrinya
89
+ - High‑stakes deployments without human review
90
+ - Noisy audio without speech enhancement
91
+
92
+
93
+ ## ⚠️ Risks & Limitations
94
+
95
+ Performance might vary across dialects, genders, ages, and recording quality.
96
+
97
+
98
+
99
+ ## 📌 Citation
100
+
101
+ ``` bibtex
102
+ @misc{ethio_asr_2026,
103
+ author = {
104
+ Abdullah, Badr M. and
105
+ Azime, Israel Abebe and
106
+ Tonja, Atnafu Lambebo and
107
+ Alabi, Jesujoba O. and
108
+ Alemu, Abel Mulat and
109
+ Hagos, Eyob G. and
110
+ Balcha, Bontu Fufa and
111
+ Nerea, Mulubrhan A. and
112
+ Yadeta, Debela Desalegn and
113
+ Marilign, Dagnachew Mekonnen and
114
+ Fentahun, Amanuel Temesgen and
115
+ Kebede, Tadesse and
116
+ Gebru, Israel D. and
117
+ Woldeyohannis, Michael Melese and
118
+ Sewunetie, Walelign Tewabe and
119
+ Möbius, Bernd and
120
+ Klakow, Dietrich
121
+ },
122
+ title = {Ethio-ASR: Joint Multilingual Speech Recognition and Language Identification for Ethiopian Languages},
123
+ year = {2026},
124
+ howpublished = {\url{https://huggingface.co/badrex/Ethio-ASR-multilingual-600M}}
125
+ }
126
+ ```