fj11 commited on
Commit
73cfea1
Β·
verified Β·
1 Parent(s): b25d0ff

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +91 -169
README.md CHANGED
@@ -11,197 +11,119 @@ base_model:
11
  - openai/whisper-small
12
  ---
13
 
14
- # Model Card for Model ID
15
 
16
- <!-- Provide a quick summary of what the model is/does. -->
17
 
 
 
 
 
 
 
 
18
 
 
 
19
 
20
- ## Model Details
 
 
 
 
21
 
22
- ### Model Description
23
-
24
- <!-- Provide a longer summary of what this model is. -->
25
-
26
- This is the model card of a πŸ€— transformers model that has been pushed on the Hub. This model card has been automatically generated.
27
-
28
- - **Developed by:** [More Information Needed]
29
- - **Funded by [optional]:** [More Information Needed]
30
- - **Shared by [optional]:** [More Information Needed]
31
- - **Model type:** [More Information Needed]
32
- - **Language(s) (NLP):** [More Information Needed]
33
- - **License:** [More Information Needed]
34
- - **Finetuned from model [optional]:** [More Information Needed]
35
-
36
- ### Model Sources [optional]
37
-
38
- <!-- Provide the basic links for the model. -->
39
-
40
- - **Repository:** [More Information Needed]
41
- - **Paper [optional]:** [More Information Needed]
42
- - **Demo [optional]:** [More Information Needed]
43
-
44
- ## Uses
45
-
46
- <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
47
-
48
- ### Direct Use
49
-
50
- <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
51
-
52
- [More Information Needed]
53
-
54
- ### Downstream Use [optional]
55
-
56
- <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
57
-
58
- [More Information Needed]
59
-
60
- ### Out-of-Scope Use
61
-
62
- <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
63
-
64
- [More Information Needed]
65
-
66
- ## Bias, Risks, and Limitations
67
-
68
- <!-- This section is meant to convey both technical and sociotechnical limitations. -->
69
-
70
- [More Information Needed]
71
-
72
- ### Recommendations
73
-
74
- <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
75
-
76
- Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
77
-
78
- ## How to Get Started with the Model
79
-
80
- Use the code below to get started with the model.
81
-
82
- [More Information Needed]
83
-
84
- ## Training Details
85
-
86
- ### Training Data
87
-
88
- <!-- 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. -->
89
-
90
- [More Information Needed]
91
-
92
- ### Training Procedure
93
-
94
- <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
95
-
96
- #### Preprocessing [optional]
97
-
98
- [More Information Needed]
99
-
100
-
101
- #### Training Hyperparameters
102
-
103
- - **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
104
-
105
- #### Speeds, Sizes, Times [optional]
106
-
107
- <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
108
-
109
- [More Information Needed]
110
-
111
- ## Evaluation
112
-
113
- <!-- This section describes the evaluation protocols and provides the results. -->
114
-
115
- ### Testing Data, Factors & Metrics
116
-
117
- #### Testing Data
118
-
119
- <!-- This should link to a Dataset Card if possible. -->
120
-
121
- [More Information Needed]
122
-
123
- #### Factors
124
-
125
- <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
126
-
127
- [More Information Needed]
128
-
129
- #### Metrics
130
-
131
- <!-- These are the evaluation metrics being used, ideally with a description of why. -->
132
-
133
- [More Information Needed]
134
-
135
- ### Results
136
-
137
- [More Information Needed]
138
-
139
- #### Summary
140
-
141
-
142
-
143
- ## Model Examination [optional]
144
-
145
- <!-- Relevant interpretability work for the model goes here -->
146
-
147
- [More Information Needed]
148
-
149
- ## Environmental Impact
150
-
151
- <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
152
-
153
- 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).
154
-
155
- - **Hardware Type:** [More Information Needed]
156
- - **Hours used:** [More Information Needed]
157
- - **Cloud Provider:** [More Information Needed]
158
- - **Compute Region:** [More Information Needed]
159
- - **Carbon Emitted:** [More Information Needed]
160
-
161
- ## Technical Specifications [optional]
162
-
163
- ### Model Architecture and Objective
164
-
165
- [More Information Needed]
166
-
167
- ### Compute Infrastructure
168
 
169
- [More Information Needed]
 
 
 
 
170
 
171
- #### Hardware
 
172
 
173
- [More Information Needed]
 
 
174
 
175
- #### Software
176
 
177
- [More Information Needed]
 
 
178
 
179
- ## Citation [optional]
 
 
 
 
 
 
 
 
180
 
181
- <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
 
 
182
 
183
- **BibTeX:**
184
 
185
- [More Information Needed]
 
 
 
186
 
187
- **APA:**
 
 
 
 
 
 
 
188
 
189
- [More Information Needed]
 
190
 
191
- ## Glossary [optional]
192
 
193
- <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
 
 
 
194
 
195
- [More Information Needed]
 
 
 
196
 
197
- ## More Information [optional]
198
 
199
- [More Information Needed]
 
 
 
200
 
201
- ## Model Card Authors [optional]
 
 
 
 
202
 
203
- [More Information Needed]
 
 
204
 
205
- ## Model Card Contact
206
 
207
- [More Information Needed]
 
 
 
 
 
 
 
 
 
 
 
11
  - openai/whisper-small
12
  ---
13
 
 
14
 
15
+ # πŸ“Œ ScreenTalk-xs: Fine-Tuned Whisper Model for Movie & TV Audio
16
 
17
+ ## πŸ“œ Model Details
18
+ - **Model Name**: ScreenTalk-xs
19
+ - **Developed by**: DataLabX
20
+ - **Finetuned from**: [`openai/whisper-small`](https://huggingface.co/openai/whisper-small)
21
+ - **Language(s)**: English
22
+ - **License**: Apache-2.0
23
+ - **Repository**: [Hugging Face Model Hub](https://huggingface.co/DataLabX/ScreenTalk-xs)
24
 
25
+ ## πŸ“Œ Model Description
26
+ ScreenTalk-xs is a fine-tuned version of OpenAI's `whisper-small` model, optimized for **speech-to-text transcription** on **movies & TV show audio**. This model is specifically trained to **improve ASR (Automatic Speech Recognition) performance** in dialogue-heavy scenarios.
27
 
28
+ ### πŸ”Ή Key Features
29
+ - πŸ“Ί **Optimized for movie & TV dialogues**
30
+ - 🎀 **Robust to noisy environments**
31
+ - πŸ” **Improved handling of long-form speech**
32
+ - πŸš€ **Efficient inference with LoRA fine-tuning**
33
 
34
+ ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
35
 
36
+ ## πŸš€ Uses
37
+ ### βœ… Direct Use
38
+ - **Speech-to-text transcription** for movies, TV shows, and general spoken audio.
39
+ - **Automatic subtitling & captioning** for multimedia content.
40
+ - **Voice-enabled applications** such as AI assistants & transcription services.
41
 
42
+ ### πŸ”Ή Downstream Use
43
+ - Can be used for **improving ASR models** in entertainment, media, and accessibility applications.
44
 
45
+ ### ❌ Out-of-Scope Use
46
+ - Not optimized for **real-time streaming ASR**.
47
+ - May not generalize well to **heavily accented speech** outside its training dataset.
48
 
49
+ ---
50
 
51
+ ## πŸ›  Training Details
52
+ ### πŸ“Œ Training Data
53
+ The model was fine-tuned using the **ScreenTalk-XS dataset**, a collection of transcribed movie & TV audio.
54
 
55
+ ### πŸ“Œ Training Hyperparameters
56
+ | **Hyperparameter** | **Value** |
57
+ |-------------------|---------|
58
+ | Learning Rate | `5e-5` |
59
+ | Batch Size | `6` |
60
+ | Gradient Accumulation | `4` |
61
+ | Epochs | `5` |
62
+ | LoRA Rank (`r`) | `4` |
63
+ | Optimizer | AdamW |
64
 
65
+ ### πŸ“Œ Training Procedure
66
+ - **Fine-tuned with LoRA** to reduce memory consumption while maintaining efficiency.
67
+ - **Evaluation on a held-out test set** to monitor WER (Word Error Rate).
68
 
69
+ ---
70
 
71
+ ## πŸ“Š Evaluation
72
+ ### πŸ“Œ Testing Data
73
+ - **Dataset**: ScreenTalk-XS
74
+ - **Metrics**: Word Error Rate (WER)
75
 
76
+ ### πŸ“Œ Results
77
+ | **Epoch** | **Training Loss** | **Validation Loss** | **WER (%)** |
78
+ |-----------|-----------------|-----------------|-------------|
79
+ | **1** | 0.502400 | 0.333292 | 20.870653 |
80
+ | **2** | 0.244200 | 0.327987 | 20.580875 |
81
+ | **3** | 0.523600 | 0.325907 | 21.924394 |
82
+ | **4** | 0.445500 | 0.326386 | 20.508430 |
83
+ | **5** | 0.285700 | 0.327116 | 20.752107 |
84
 
85
+ - **Best Model:** `Epoch 4`, achieving **WER = 20.50%**
86
+ - **Model performance degrades after epoch 4**, suggesting overfitting.
87
 
88
+ ---
89
 
90
+ ## πŸ–₯️ Technical Specifications
91
+ ### πŸ“Œ Model Architecture
92
+ - Based on **Whisper-small**, a transformer-based sequence-to-sequence ASR model.
93
+ - Fine-tuned using **LoRA** to reduce memory footprint.
94
 
95
+ ### πŸ“Œ Hardware & Compute Infrastructure
96
+ - **Training Hardware:** T4 (16GB) GPU
97
+ - **Training Time:** ~5 hours
98
+ - **Training Environment:** PyTorch + Transformers (Hugging Face)
99
 
100
+ ---
101
 
102
+ ## πŸ“– How to Use
103
+ You can use this model for **speech-to-text transcription** with `pipeline`:
104
+ ```python
105
+ from transformers import pipeline
106
 
107
+ pipe = pipeline(
108
+ "automatic-speech-recognition",
109
+ model="fj11/ScreenTalk-xs",
110
+ device=0 # Run on GPU
111
+ )
112
 
113
+ result = pipe("path/to/audio.wav")
114
+ print(result["text"]) # βœ… θΎ“ε‡Ίθ½¬ε½•ζ–‡ζœ¬
115
+ ```
116
 
117
+ ---
118
 
119
+ ## πŸ“œ Citation
120
+ If you use this model, please cite:
121
+ ```java
122
+ @misc{DataLabX2025ScreenTalkXS,
123
+ author = {DataLabX},
124
+ title = {ScreenTalk-xs: ASR Model Fine-Tuned on Movie & TV Audio},
125
+ year = {2025},
126
+ publisher = {Hugging Face},
127
+ url = {https://huggingface.co/DataLabX/ScreenTalk-xs}
128
+ }
129
+ ```