Cosmobillian commited on
Commit
5f0a5d2
·
verified ·
1 Parent(s): 46d4fe0

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +115 -148
README.md CHANGED
@@ -1,199 +1,166 @@
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
+ # Cosmobillian / turkish_whisper_for_noisy_datas
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
2
 
3
+ > A Whisper-large-v3 model fine-tuned for **noisy Turkish speech recognition** (short utterances, real-world environments).
4
 
5
+ ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
6
 
7
+ ## 🔎 Model Summary
8
 
9
+ - **Base model:** `openai/whisper-large-v3`
10
+ - **Language:** Turkish (`tr`)
11
+ - **Task:** Automatic Speech Recognition (ASR) – Transcription
12
+ - **Domain:** Noisy / real-world audio (street, phone mic, background noise, reverb, etc.)
13
+ - **Input audio:** mono, 16 kHz, short segments (≈ 3–8 seconds)
14
+ - **Fine-tuning type:** Full model (decoder-focused fine-tuning, encoder frozen)
15
 
16
+ This model is designed to perform robust speech-to-text for **noisy Turkish audio**, especially:
17
 
18
+ - mobile / cheap microphone recordings
19
+ - mild background music or chatter
20
+ - echo / reverb (rooms, corridors etc.)
21
 
22
+ It is **not** a general multilingual model any more; the decoding is heavily biased towards **Turkish**.
23
 
24
+ ---
25
 
26
+ ## Intended Use
27
 
28
+ **Primary use-case:**
29
 
30
+ - Transcribing **short Turkish utterances** with background noise (e.g. real calls, vlogs, “in the wild” recordings).
31
 
32
+ **Good for:**
33
 
34
+ - Prototypes of Turkish ASR systems
35
+ - Voice-enabled assistants for Turkish users
36
+ - Noisy datasets (phone, street, public places, YouTube-like content)
37
 
38
+ **Not ideal for:**
39
 
40
+ - Long-form audio without chunking (podcasts, 1+ minute single shot)
41
+ - High-stakes applications (medical/legal dictation) without manual review
42
+ - Clean studio speech where smaller Whisper models already perform very well
43
 
44
+ ---
45
 
46
+ ## ⚙️ Training Details
47
 
48
+ > Note: This is a **custom fine-tuned model**; base capabilities come from `openai/whisper-large-v3`.
49
 
50
+ - **Base model:** `openai/whisper-large-v3`
51
+ - **Fine-tuned on:** Private Turkish dataset of short (~5s) audio clips
52
+ - Noisy, real-world conditions
53
+ - Paired with manually prepared transcriptions
54
+ - **Sampling rate:** 16 kHz, mono
55
+ - **Loss:** Cross-entropy with label smoothing
56
+ - **Strategy:**
57
+ - Encoder **frozen** (only decoder fine-tuned)
58
+ - Small learning rate to avoid catastrophic forgetting
59
+ - Short training (1 epoch) to adapt to noise style while preserving base knowledge
60
 
61
+ > Exact dataset is not public; this model should be treated as **research / experimental**.
62
 
63
+ ---
64
 
65
+ ## 📊 Evaluation
66
 
67
+ The model has been manually checked on several noisy Turkish utterances. Qualitatively:
68
 
69
+ - Much more robust to **background noise** than vanilla Whisper on the same custom data
70
+ - Better handling of casual/spontaneous speech (hesitations, filler words, etc.)
71
+ - Occasionally produces grammatically imperfect sentences (as expected from ASR)
72
 
73
+ There is **no official WER benchmark** on a public dataset yet (e.g. Common Voice, MLS).
74
+ If you use this model in a paper or product, please:
75
 
76
+ - Benchmark on your own dev/test set
77
+ - Share WER / CER numbers if possible 🙏
78
 
79
+ ---
 
 
 
 
80
 
81
+ ## 🚀 Quickstart (Hugging Face `pipeline`)
82
 
83
+ ```python
84
+ !pip install -q transformers soundfile librosa
85
 
86
+ import torch
87
+ import librosa
88
+ from transformers import WhisperProcessor, WhisperForConditionalGeneration
89
 
90
+ MODEL_ID = "Cosmobillian/turkish_whisper_for_noisy_datas"
91
 
92
+ device = torch.device("cuda" if torch.cuda.is_available() else "cpu")
93
 
94
+ processor = WhisperProcessor.from_pretrained(MODEL_ID)
95
+ model = WhisperForConditionalGeneration.from_pretrained(MODEL_ID).to(device)
96
 
97
+ # Dil/task prompt'unu zorla (TR + transcribe)
98
+ forced_ids = processor.get_decoder_prompt_ids(
99
+ language="turkish",
100
+ task="transcribe",
101
+ )
102
+ model.config.forced_decoder_ids = forced_ids
103
+ if hasattr(model, "generation_config"):
104
+ model.generation_config.forced_decoder_ids = forced_ids
105
 
 
106
 
107
+ def load_audio(path, target_sr=16000):
108
+ audio, sr = librosa.load(path, sr=None, mono=True)
109
+ if sr != target_sr:
110
+ audio = librosa.resample(audio, orig_sr=sr, target_sr=target_sr)
111
+ sr = target_sr
112
+ return audio, sr
113
 
 
114
 
115
+ def chunked_transcribe(path, chunk_sec=30.0, stride_sec=5.0, max_new_tokens=256):
116
+ speech, sr = load_audio(path, 16000)
117
 
118
+ chunk_size = int(chunk_sec * sr)
119
+ stride_size = int(stride_sec * sr)
120
 
121
+ texts = []
122
+ start = 0
123
 
124
+ while start < len(speech):
125
+ end = start + chunk_size
126
+ chunk = speech[start:end]
127
 
128
+ if len(chunk) == 0:
129
+ break
130
 
131
+ inputs = processor(
132
+ chunk,
133
+ sampling_rate=sr,
134
+ return_tensors="pt",
135
+ )
136
+ input_features = inputs.input_features.to(device)
137
 
138
+ with torch.no_grad():
139
+ generated_ids = model.generate(
140
+ input_features,
141
+ max_new_tokens=max_new_tokens,
142
+ do_sample=False,
143
+ num_beams=1,
144
+ no_repeat_ngram_size=3,
145
+ repetition_penalty=1.2,
146
+ )
147
 
148
+ text = processor.batch_decode(
149
+ generated_ids,
150
+ skip_special_tokens=True
151
+ )[0]
152
 
153
+ texts.append(text)
154
 
155
+ # bir sonraki chunk'a stride kadar kayarak git
156
+ start = end - stride_size
157
 
158
+ return " ".join(texts)
159
 
 
160
 
161
+ # ÖRNEK KULLANIM
162
+ AUDIO_PATH = "/content/uzun_kayit.wav"
163
+ full_text = chunked_transcribe(AUDIO_PATH, chunk_sec=30, stride_sec=5, max_new_tokens=256)
164
 
165
+ print("Tam transkripsiyon:\n")
166
+ print(full_text)