KasuleTrevor
commited on
Commit
•
dd33963
1
Parent(s):
845a6f1
Push model using huggingface_hub.
Browse files- .gitattributes +1 -0
- README.md +196 -0
- parakeet-0.6b-cv-sw-5hr_v10.nemo +3 -0
.gitattributes
CHANGED
@@ -33,3 +33,4 @@ saved_model/**/* filter=lfs diff=lfs merge=lfs -text
|
|
33 |
*.zip filter=lfs diff=lfs merge=lfs -text
|
34 |
*.zst filter=lfs diff=lfs merge=lfs -text
|
35 |
*tfevents* filter=lfs diff=lfs merge=lfs -text
|
|
|
|
33 |
*.zip filter=lfs diff=lfs merge=lfs -text
|
34 |
*.zst filter=lfs diff=lfs merge=lfs -text
|
35 |
*tfevents* filter=lfs diff=lfs merge=lfs -text
|
36 |
+
parakeet-0.6b-cv-sw-5hr_v10.nemo filter=lfs diff=lfs merge=lfs -text
|
README.md
ADDED
@@ -0,0 +1,196 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
---
|
2 |
+
license: cc-by-4.0
|
3 |
+
library_name: nemo
|
4 |
+
tags:
|
5 |
+
- pytorch
|
6 |
+
- NeMo
|
7 |
+
---
|
8 |
+
|
9 |
+
# Parakeet-0.6b-cv-sw-5hr V10
|
10 |
+
|
11 |
+
<style>
|
12 |
+
img {
|
13 |
+
display: inline;
|
14 |
+
}
|
15 |
+
</style>
|
16 |
+
|
17 |
+
[![Model architecture](https://img.shields.io/badge/Model_Arch-PUT-YOUR-ARCHITECTURE-HERE-lightgrey#model-badge)](#model-architecture)
|
18 |
+
| [![Model size](https://img.shields.io/badge/Params-PUT-YOUR-MODEL-SIZE-HERE-lightgrey#model-badge)](#model-architecture)
|
19 |
+
| [![Language](https://img.shields.io/badge/Language-PUT-YOUR-LANGUAGE-HERE-lightgrey#model-badge)](#datasets)
|
20 |
+
|
21 |
+
**Put a short model description here.**
|
22 |
+
|
23 |
+
See the [model architecture](#model-architecture) section and [NeMo documentation](https://docs.nvidia.com/deeplearning/nemo/user-guide/docs/en/stable/index.html) for complete architecture details.
|
24 |
+
|
25 |
+
|
26 |
+
## NVIDIA NeMo: Training
|
27 |
+
|
28 |
+
To train, fine-tune or play with the model you will need to install [NVIDIA NeMo](https://github.com/NVIDIA/NeMo). We recommend you install it after you've installed latest Pytorch version.
|
29 |
+
```
|
30 |
+
pip install nemo_toolkit['all']
|
31 |
+
```
|
32 |
+
|
33 |
+
## How to Use this Model
|
34 |
+
|
35 |
+
The model is available for use in the NeMo toolkit [3], and can be used as a pre-trained checkpoint for inference or for fine-tuning on another dataset.
|
36 |
+
|
37 |
+
### Automatically instantiate the model
|
38 |
+
|
39 |
+
**NOTE**: Please update the model class below to match the class of the model being uploaded.
|
40 |
+
|
41 |
+
```python
|
42 |
+
import nemo.core import ModelPT
|
43 |
+
model = ModelPT.from_pretrained("KasuleTrevor/parakeet-0.6b-cv-sw-5hr_v10")
|
44 |
+
```
|
45 |
+
|
46 |
+
### NOTE
|
47 |
+
|
48 |
+
Add some information about how to use the model here. An example is provided for ASR inference below.
|
49 |
+
|
50 |
+
### Transcribing using Python
|
51 |
+
First, let's get a sample
|
52 |
+
```
|
53 |
+
wget https://dldata-public.s3.us-east-2.amazonaws.com/2086-149220-0033.wav
|
54 |
+
```
|
55 |
+
Then simply do:
|
56 |
+
```
|
57 |
+
asr_model.transcribe(['2086-149220-0033.wav'])
|
58 |
+
```
|
59 |
+
|
60 |
+
### Transcribing many audio files
|
61 |
+
|
62 |
+
```shell
|
63 |
+
python [NEMO_GIT_FOLDER]/examples/asr/transcribe_speech.py pretrained_name="KasuleTrevor/parakeet-0.6b-cv-sw-5hr_v10" audio_dir=""
|
64 |
+
```
|
65 |
+
|
66 |
+
### Input
|
67 |
+
|
68 |
+
**Add some information about what are the inputs to this model**
|
69 |
+
|
70 |
+
### Output
|
71 |
+
|
72 |
+
**Add some information about what are the outputs of this model**
|
73 |
+
|
74 |
+
## Model Architecture
|
75 |
+
|
76 |
+
**Add information here discussing architectural details of the model or any comments to users about the model.**
|
77 |
+
|
78 |
+
## Training
|
79 |
+
|
80 |
+
**Add information here about how the model was trained. It should be as detailed as possible, potentially including the the link to the script used to train as well as the base config used to train the model. If extraneous scripts are used to prepare the components of the model, please include them here.**
|
81 |
+
|
82 |
+
### NOTE
|
83 |
+
|
84 |
+
An example is provided below for ASR
|
85 |
+
|
86 |
+
The NeMo toolkit [3] was used for training the models for over several hundred epochs. These model are trained with this [example script](https://github.com/NVIDIA/NeMo/blob/main/examples/asr/asr_transducer/speech_to_text_rnnt_bpe.py) and this [base config](https://github.com/NVIDIA/NeMo/blob/main/examples/asr/conf/fastconformer/fast-conformer_transducer_bpe.yaml).
|
87 |
+
|
88 |
+
The tokenizers for these models were built using the text transcripts of the train set with this [script](https://github.com/NVIDIA/NeMo/blob/main/scripts/tokenizers/process_asr_text_tokenizer.py).
|
89 |
+
|
90 |
+
|
91 |
+
### Datasets
|
92 |
+
|
93 |
+
**Try to provide as detailed a list of datasets as possible. If possible, provide links to the datasets on HF by adding it to the manifest section at the top of the README (marked by ---).**
|
94 |
+
|
95 |
+
### NOTE
|
96 |
+
|
97 |
+
An example for the manifest section is provided below for ASR datasets
|
98 |
+
|
99 |
+
datasets:
|
100 |
+
- librispeech_asr
|
101 |
+
- fisher_corpus
|
102 |
+
- Switchboard-1
|
103 |
+
- WSJ-0
|
104 |
+
- WSJ-1
|
105 |
+
- National-Singapore-Corpus-Part-1
|
106 |
+
- National-Singapore-Corpus-Part-6
|
107 |
+
- vctk
|
108 |
+
- voxpopuli
|
109 |
+
- europarl
|
110 |
+
- multilingual_librispeech
|
111 |
+
- mozilla-foundation/common_voice_8_0
|
112 |
+
- MLCommons/peoples_speech
|
113 |
+
|
114 |
+
The corresponding text in this section for those datasets is stated below -
|
115 |
+
|
116 |
+
The model was trained on 64K hours of English speech collected and prepared by NVIDIA NeMo and Suno teams.
|
117 |
+
|
118 |
+
The training dataset consists of private subset with 40K hours of English speech plus 24K hours from the following public datasets:
|
119 |
+
|
120 |
+
- Librispeech 960 hours of English speech
|
121 |
+
- Fisher Corpus
|
122 |
+
- Switchboard-1 Dataset
|
123 |
+
- WSJ-0 and WSJ-1
|
124 |
+
- National Speech Corpus (Part 1, Part 6)
|
125 |
+
- VCTK
|
126 |
+
- VoxPopuli (EN)
|
127 |
+
- Europarl-ASR (EN)
|
128 |
+
- Multilingual Librispeech (MLS EN) - 2,000 hour subset
|
129 |
+
- Mozilla Common Voice (v7.0)
|
130 |
+
- People's Speech - 12,000 hour subset
|
131 |
+
|
132 |
+
|
133 |
+
## Performance
|
134 |
+
|
135 |
+
**Add information here about the performance of the model. Discuss what is the metric that is being used to evaluate the model and if there are external links explaning the custom metric, please link to it.
|
136 |
+
|
137 |
+
### NOTE
|
138 |
+
|
139 |
+
An example is provided below for ASR metrics list that can be added to the top of the README
|
140 |
+
|
141 |
+
model-index:
|
142 |
+
- name: PUT_MODEL_NAME
|
143 |
+
results:
|
144 |
+
- task:
|
145 |
+
name: Automatic Speech Recognition
|
146 |
+
type: automatic-speech-recognition
|
147 |
+
dataset:
|
148 |
+
name: AMI (Meetings test)
|
149 |
+
type: edinburghcstr/ami
|
150 |
+
config: ihm
|
151 |
+
split: test
|
152 |
+
args:
|
153 |
+
language: en
|
154 |
+
metrics:
|
155 |
+
- name: Test WER
|
156 |
+
type: wer
|
157 |
+
value: 17.10
|
158 |
+
- task:
|
159 |
+
name: Automatic Speech Recognition
|
160 |
+
type: automatic-speech-recognition
|
161 |
+
dataset:
|
162 |
+
name: Earnings-22
|
163 |
+
type: revdotcom/earnings22
|
164 |
+
split: test
|
165 |
+
args:
|
166 |
+
language: en
|
167 |
+
metrics:
|
168 |
+
- name: Test WER
|
169 |
+
type: wer
|
170 |
+
value: 14.11
|
171 |
+
|
172 |
+
Provide any caveats about the results presented in the top of the discussion so that nuance is not lost.
|
173 |
+
|
174 |
+
It should ideally be in a tabular format (you can use the following website to make your tables in markdown format - https://www.tablesgenerator.com/markdown_tables)**
|
175 |
+
|
176 |
+
## Limitations
|
177 |
+
|
178 |
+
**Discuss any practical limitations to the model when being used in real world cases. They can also be legal disclaimers, or discussion regarding the safety of the model (particularly in the case of LLMs).**
|
179 |
+
|
180 |
+
|
181 |
+
### Note
|
182 |
+
|
183 |
+
An example is provided below
|
184 |
+
|
185 |
+
Since this model was trained on publicly available speech datasets, the performance of this model might degrade for speech which includes technical terms, or vernacular that the model has not been trained on. The model might also perform worse for accented speech.
|
186 |
+
|
187 |
+
|
188 |
+
## License
|
189 |
+
|
190 |
+
License to use this model is covered by the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/). By downloading the public and release version of the model, you accept the terms and conditions of the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/) license.
|
191 |
+
|
192 |
+
## References
|
193 |
+
|
194 |
+
**Provide appropriate references in the markdown link format below. Please order them numerically.**
|
195 |
+
|
196 |
+
[1] [NVIDIA NeMo Toolkit](https://github.com/NVIDIA/NeMo)
|
parakeet-0.6b-cv-sw-5hr_v10.nemo
ADDED
@@ -0,0 +1,3 @@
|
|
|
|
|
|
|
|
|
1 |
+
version https://git-lfs.github.com/spec/v1
|
2 |
+
oid sha256:34c035c607a4eb4cfe251180e74b8433274c6f3a72a03a04bd479c9ecabba77c
|
3 |
+
size 2432020480
|