eesungkim commited on
Commit
d3e710f
1 Parent(s): 2ba02aa

Delete readme_template.md

Browse files
Files changed (1) hide show
  1. readme_template.md +0 -107
readme_template.md DELETED
@@ -1,107 +0,0 @@
1
- ---
2
- language:
3
- - kr
4
- license: cc-by-4.0
5
- library_name: nemo
6
- datasets:
7
- - Ksponspeech
8
- thumbnail: null
9
- tags:
10
- - automatic-speech-recognition
11
- - speech
12
- - audio
13
- - transducer
14
- - Conformer
15
- - Transformer
16
- - NeMo
17
- - pytorch
18
- model-index:
19
- - name: stt_kr_conformer_transducer_large
20
- results: []
21
-
22
- ---
23
-
24
-
25
- ## Model Overview
26
-
27
- <DESCRIBE IN ONE LINE THE MODEL AND ITS USE>
28
-
29
- ## NVIDIA NeMo: Training
30
-
31
- 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.
32
- ```
33
- pip install nemo_toolkit['all']
34
- ```
35
-
36
- ## How to Use this Model
37
-
38
- The model is available for use in the NeMo toolkit [1], and can be used as a pre-trained checkpoint for inference or for fine-tuning on another dataset.
39
-
40
- ### Automatically instantiate the model
41
-
42
- ```python
43
- import nemo.collections.asr as nemo_asr
44
- asr_model = nemo_asr.models.ASRModel.from_pretrained("eesungkim/stt_kr_conformer_transducer_large")
45
- ```
46
-
47
- ### Transcribing using Python
48
- First, let's get a sample
49
- ```
50
- wget https://dldata-public.s3.us-east-2.amazonaws.com/sample-kor.wav
51
- ```
52
- Then simply do:
53
- ```
54
- asr_model.transcribe(['sample-kor.wav'])
55
- ```
56
-
57
- ### Transcribing many audio files
58
-
59
- ```shell
60
- python [NEMO_GIT_FOLDER]/examples/asr/transcribe_speech.py pretrained_name="eesungkim/stt_kr_conformer_transducer_large" audio_dir="<DIRECTORY CONTAINING AUDIO FILES>"
61
- ```
62
-
63
- ### Input
64
-
65
- This model accepts 16000 KHz Mono-channel Audio (wav files) as input.
66
-
67
- ### Output
68
-
69
- This model provides transcribed speech as a string for a given audio sample.
70
-
71
- ## Model Architecture
72
-
73
- Conformer-Transducer model is an autoregressive variant of Conformer model [2] for Automatic Speech Recognition which uses Transducer loss/decoding. You may find more info on the detail of this model here: [Conformer-Transducer Model](https://docs.nvidia.com/deeplearning/nemo/user-guide/docs/en/main/asr/models.html).
74
-
75
- ## Training
76
-
77
- The model was finetuned based on the pre-trained English Model for over several epochs.
78
-
79
- There are several transcripting and sub-word modeling methods for Korean speech recognition. This model uses sentencepiece subwords of Hangul characters based on phonetic transcription using Google Sentencepiece Tokenizer [3].
80
-
81
- ### Datasets
82
-
83
- All the models in this collection are trained on [Ksponspeech](https://aihub.or.kr/aidata/105/download) dataset, which is an open-domain dialog corpus recorded by 2,000 native Korean speakers in a controlled and quiet environment. The standard split dataset consists of 965 hours of training set, 4 hours of development set, 3 hours of test-clean, and 4 hours of test-other.
84
-
85
- ## Performance
86
-
87
- Version | Tokenizer | eval_clean CER | eval_other CER | eval_clean WER | eval_other WER
88
- --- | --- | --- | --- |--- |---
89
- v1.7.0rc | SentencePiece Char | 6.94% | 7.38% | 19.49% | 22.73%
90
-
91
- ## Limitations
92
-
93
- Eg:
94
- Since this model was trained on publically 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.
95
-
96
-
97
- ## References
98
-
99
- [1] [NVIDIA NeMo Toolkit](https://github.com/NVIDIA/NeMo)
100
-
101
- [2] [Conformer: Convolution-augmented Transformer for Speech Recognition](https://arxiv.org/abs/2005.08100)
102
-
103
- [3] [Google Sentencepiece Tokenizer](https://github.com/google/sentencepiece)
104
-
105
-
106
-
107
-