mandipgoswami commited on
Commit
85b67fb
·
verified ·
1 Parent(s): ff29936

Upload README.md with huggingface_hub

Browse files
Files changed (1) hide show
  1. README.md +93 -199
README.md CHANGED
@@ -1,199 +1,93 @@
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
+ language: en
3
+ license: apache-2.0
4
+ tags:
5
+ - whisper
6
+ - automatic-speech-recognition
7
+ - speech
8
+ - en
9
+ - reverberant-speech
10
+ - room-acoustics
11
+ - fine-tuned
12
+ - pytorch
13
+ datasets:
14
+ - mandipgoswami/whisper-rirmega-bench
15
+ base_model: openai/whisper-medium
16
+ pipeline_tag: automatic-speech-recognition
17
+ metrics:
18
+ - wer
19
+ model-index:
20
+ - name: whisper-medium-rirmega
21
+ results:
22
+ - task:
23
+ type: automatic-speech-recognition
24
+ dataset:
25
+ name: Whisper-RIR-Mega (test)
26
+ type: mandipgoswami/whisper-rirmega-bench
27
+ split: test
28
+ metrics:
29
+ - name: WER
30
+ type: wer
31
+ value: 0.0430
32
+ ---
33
+ # Whisper-Medium fine-tuned for reverberant speech (Whisper-RIR-Mega)
34
+
35
+ **Use this model when:** transcribing speech that was recorded in reverberant or “roomy” conditions (meetings, lectures, far-field mics). It keeps the same WER as the base Whisper-medium on clean/reverberant benchmarks while being trained specifically on reverberant data.
36
+
37
+ This model is a fine-tuned version of [openai/whisper-medium](https://huggingface.co/openai/whisper-medium) on the [Whisper-RIR-Mega](https://huggingface.co/datasets/mandipgoswami/whisper-rirmega-bench) dataset for ASR robustness to room reverberation. One-line load; no PEFT needed.
38
+
39
+ ## Quick usage
40
+
41
+ ```python
42
+ from transformers import WhisperProcessor, WhisperForConditionalGeneration
43
+ import librosa
44
+
45
+ processor = WhisperProcessor.from_pretrained("mandipgoswami/whisper-medium-rirmega")
46
+ model = WhisperForConditionalGeneration.from_pretrained("mandipgoswami/whisper-medium-rirmega")
47
+
48
+ audio, sr = librosa.load("path/to/reverberant_audio.wav", sr=16000)
49
+ input_features = processor(audio, sampling_rate=16000, return_tensors="pt").input_features
50
+ predicted_ids = model.generate(input_features)
51
+ transcript = processor.batch_decode(predicted_ids, skip_special_tokens=True)[0]
52
+ print(transcript)
53
+ ```
54
+
55
+ ## When to use
56
+
57
+ - Reverberant or room-recorded speech (meetings, lectures, far-field).
58
+ - You want English ASR with the same ease as base Whisper (single `from_pretrained`).
59
+ - You care about robustness to room acoustics without losing clean-speech quality.
60
+
61
+ ## Training
62
+
63
+ - **Base model:** openai/whisper-medium
64
+ - **Dataset:** Whisper-RIR-Mega (reverberant speech with clean transcripts)
65
+ - **Epochs:** 4
66
+ - **Learning rate:** 8e-06
67
+ - **Effective batch size:** 16 (2 × 8 gradient accumulation)
68
+ - **Precision:** BF16/FP16 mixed precision
69
+ - **Gradient checkpointing:** Enabled
70
+ - **Hardware:** Single NVIDIA RTX 5080 (16 GB)
71
+
72
+ ## Evaluation
73
+
74
+ | Dataset | Split | WER |
75
+ |---------|-------|-----|
76
+ | Whisper-RIR-Mega | test | 0.0430 |
77
+
78
+ ## Limitations
79
+
80
+ English only. Trained on 400 reverberant samples; best used in conditions similar to the [Whisper-RIR-Mega](https://huggingface.co/datasets/mandipgoswami/whisper-rirmega-bench) benchmark.
81
+
82
+ ## Citation
83
+
84
+ If you use this model, please cite:
85
+
86
+ ```bibtex
87
+ @article{goswami2026whisperrirmega,
88
+ title={Whisper-RIR-Mega: A Paired Clean-Reverberant Speech Benchmark for ASR Robustness to Room Acoustics},
89
+ author={Goswami, Mandip},
90
+ journal={arXiv preprint arXiv:2603.02252},
91
+ year={2026}
92
+ }
93
+ ```