Jacaranda commited on
Commit
44822ae
·
verified ·
1 Parent(s): 57fedf2

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +3 -199
README.md CHANGED
@@ -14,7 +14,7 @@ pipeline_tag: automatic-speech-recognition
14
 
15
  # ASR-STT 4BIT Quantized
16
 
17
- This is a 4bit quantized version of [Jacaranda-Health/ASR-STT](https://huggingface.co/Jacaranda-Health/ASR-STT).
18
 
19
  ## Model Details
20
  - **Base Model**: Jacaranda-Health/ASR-STT
@@ -31,7 +31,7 @@ import torch
31
  import librosa
32
 
33
  # Load processor
34
- processor = AutoProcessor.from_pretrained("eolang/ASR-STT-4bit")
35
 
36
  # Configure quantization
37
  quantization_config = BitsAndBytesConfig(
@@ -78,200 +78,4 @@ print(transcription)
78
  - transformers
79
  - torch
80
  - bitsandbytes
81
- - librosa
82
-
83
-
84
- # Model Card for Model ID
85
-
86
- <!-- Provide a quick summary of what the model is/does. -->
87
-
88
-
89
-
90
- ## Model Details
91
-
92
- ### Model Description
93
-
94
- <!-- Provide a longer summary of what this model is. -->
95
-
96
- This is the model card of a 🤗 transformers model that has been pushed on the Hub. This model card has been automatically generated.
97
-
98
- - **Developed by:** [More Information Needed]
99
- - **Funded by [optional]:** [More Information Needed]
100
- - **Shared by [optional]:** [More Information Needed]
101
- - **Model type:** [More Information Needed]
102
- - **Language(s) (NLP):** [More Information Needed]
103
- - **License:** [More Information Needed]
104
- - **Finetuned from model [optional]:** [More Information Needed]
105
-
106
- ### Model Sources [optional]
107
-
108
- <!-- Provide the basic links for the model. -->
109
-
110
- - **Repository:** [More Information Needed]
111
- - **Paper [optional]:** [More Information Needed]
112
- - **Demo [optional]:** [More Information Needed]
113
-
114
- ## Uses
115
-
116
- <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
117
-
118
- ### Direct Use
119
-
120
- <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
121
-
122
- [More Information Needed]
123
-
124
- ### Downstream Use [optional]
125
-
126
- <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
127
-
128
- [More Information Needed]
129
-
130
- ### Out-of-Scope Use
131
-
132
- <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
133
-
134
- [More Information Needed]
135
-
136
- ## Bias, Risks, and Limitations
137
-
138
- <!-- This section is meant to convey both technical and sociotechnical limitations. -->
139
-
140
- [More Information Needed]
141
-
142
- ### Recommendations
143
-
144
- <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
145
-
146
- Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
147
-
148
- ## How to Get Started with the Model
149
-
150
- Use the code below to get started with the model.
151
-
152
- [More Information Needed]
153
-
154
- ## Training Details
155
-
156
- ### Training Data
157
-
158
- <!-- 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. -->
159
-
160
- [More Information Needed]
161
-
162
- ### Training Procedure
163
-
164
- <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
165
-
166
- #### Preprocessing [optional]
167
-
168
- [More Information Needed]
169
-
170
-
171
- #### Training Hyperparameters
172
-
173
- - **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
174
-
175
- #### Speeds, Sizes, Times [optional]
176
-
177
- <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
178
-
179
- [More Information Needed]
180
-
181
- ## Evaluation
182
-
183
- <!-- This section describes the evaluation protocols and provides the results. -->
184
-
185
- ### Testing Data, Factors & Metrics
186
-
187
- #### Testing Data
188
-
189
- <!-- This should link to a Dataset Card if possible. -->
190
-
191
- [More Information Needed]
192
-
193
- #### Factors
194
-
195
- <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
196
-
197
- [More Information Needed]
198
-
199
- #### Metrics
200
-
201
- <!-- These are the evaluation metrics being used, ideally with a description of why. -->
202
-
203
- [More Information Needed]
204
-
205
- ### Results
206
-
207
- [More Information Needed]
208
-
209
- #### Summary
210
-
211
-
212
-
213
- ## Model Examination [optional]
214
-
215
- <!-- Relevant interpretability work for the model goes here -->
216
-
217
- [More Information Needed]
218
-
219
- ## Environmental Impact
220
-
221
- <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
222
-
223
- 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).
224
-
225
- - **Hardware Type:** [More Information Needed]
226
- - **Hours used:** [More Information Needed]
227
- - **Cloud Provider:** [More Information Needed]
228
- - **Compute Region:** [More Information Needed]
229
- - **Carbon Emitted:** [More Information Needed]
230
-
231
- ## Technical Specifications [optional]
232
-
233
- ### Model Architecture and Objective
234
-
235
- [More Information Needed]
236
-
237
- ### Compute Infrastructure
238
-
239
- [More Information Needed]
240
-
241
- #### Hardware
242
-
243
- [More Information Needed]
244
-
245
- #### Software
246
-
247
- [More Information Needed]
248
-
249
- ## Citation [optional]
250
-
251
- <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
252
-
253
- **BibTeX:**
254
-
255
- [More Information Needed]
256
-
257
- **APA:**
258
-
259
- [More Information Needed]
260
-
261
- ## Glossary [optional]
262
-
263
- <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
264
-
265
- [More Information Needed]
266
-
267
- ## More Information [optional]
268
-
269
- [More Information Needed]
270
-
271
- ## Model Card Authors [optional]
272
-
273
- [More Information Needed]
274
-
275
- ## Model Card Contact
276
-
277
- [More Information Needed]
 
14
 
15
  # ASR-STT 4BIT Quantized
16
 
17
+ This is a 4-bit quantized version of [Jacaranda-Health/ASR-STT](https://huggingface.co/Jacaranda-Health/ASR-STT).
18
 
19
  ## Model Details
20
  - **Base Model**: Jacaranda-Health/ASR-STT
 
31
  import librosa
32
 
33
  # Load processor
34
+ processor = AutoProcessor.from_pretrained("Jacaranda-Health/ASR-STT-4bit")
35
 
36
  # Configure quantization
37
  quantization_config = BitsAndBytesConfig(
 
78
  - transformers
79
  - torch
80
  - bitsandbytes
81
+ - librosa