eolang commited on
Commit
de71331
·
verified ·
1 Parent(s): 2d12b21

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +82 -192
README.md CHANGED
@@ -1,199 +1,89 @@
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
+ language:
4
+ - en
5
+ - sw
6
+ base_model:
7
+ - Jacaranda-Health/ASR-STT
8
+ pipeline_tag: automatic-speech-recognition
9
+ ---
10
+ ---
11
+ license: apache-2.0
12
+ base_model: Jacaranda-Health/ASR-STT
13
+ tags:
14
+ - speech-to-text
15
+ - automatic-speech-recognition
16
+ - quantized
17
+ - 8bit
18
+ language:
19
+ - en
20
+ pipeline_tag: automatic-speech-recognition
21
  ---
22
 
23
+ # ASR-STT 8BIT Quantized
 
 
 
24
 
25
+ This is a 8bit quantized version of [Jacaranda-Health/ASR-STT](https://huggingface.co/Jacaranda-Health/ASR-STT).
26
 
27
  ## Model Details
28
+ - **Base Model**: Jacaranda-Health/ASR-STT
29
+ - **Quantization**: 8bit
30
+ - **Size Reduction**: 73.1% smaller than original
31
+ - **Original Size**: 2913.89 MB
32
+ - **Quantized Size**: 784.94 MB
33
+
34
+ ## Usage
35
+
36
+ ```python
37
+ from transformers import AutoModelForSpeechSeq2Seq, AutoProcessor, BitsAndBytesConfig
38
+ import torch
39
+ import librosa
40
+
41
+ # Load processor
42
+ processor = AutoProcessor.from_pretrained("eolang/ASR-STT-8bit")
43
+
44
+ # Configure quantization
45
+ quantization_config = BitsAndBytesConfig(
46
+ load_in_8bit=True
47
+ llm_int8_threshold=6.0,
48
+ llm_int8_has_fp16_weight=False
49
+
50
+ )
51
+
52
+ # Load quantized model
53
+ model = AutoModelForSpeechSeq2Seq.from_pretrained(
54
+ "eolang/ASR-STT-8bit",
55
+ quantization_config=quantization_config,
56
+ device_map="auto"
57
+ )
58
+
59
+ # Transcription function
60
+ def transcribe(filepath):
61
+ audio, sr = librosa.load(filepath, sr=16000)
62
+ inputs = processor(audio, sampling_rate=sr, return_tensors="pt")
63
+
64
+ # Convert to half precision for quantized models
65
+ if torch.cuda.is_available():
66
+ inputs = {k: v.cuda().half() for k, v in inputs.items()}
67
+ else:
68
+ inputs = {k: v.half() for k, v in inputs.items()}
69
+
70
+ with torch.no_grad():
71
+ generated_ids = model.generate(inputs["input_features"])
72
+
73
+ return processor.batch_decode(generated_ids, skip_special_tokens=True)[0]
74
+
75
+ # Example usage
76
+ transcription = transcribe("path/to/audio.wav")
77
+ print(transcription)
78
+ ```
79
+
80
+ ## Performance
81
+ - Faster inference due to reduced precision
82
+ - Lower memory usage
83
+ - Maintained transcription quality
84
+
85
+ ## Requirements
86
+ - transformers
87
+ - torch
88
+ - bitsandbytes
89
+ - librosa