Update README.md
Browse files
README.md
CHANGED
|
@@ -6,88 +6,88 @@ pipeline_tag: automatic-speech-recognition
|
|
| 6 |
library_name: nemo
|
| 7 |
---
|
| 8 |
|
| 9 |
-
|
| 10 |
|
| 11 |
-
|
| 12 |
|
| 13 |
-
|
| 14 |
|
| 15 |
-
|
| 16 |
-
|
| 17 |
-
|
| 18 |
-
|
| 19 |
|
| 20 |
-
|
| 21 |
|
| 22 |
-
|
| 23 |
-
|
| 24 |
-
|
| 25 |
|
| 26 |
-
|
| 27 |
-
|
| 28 |
-
|
| 29 |
-
|
| 30 |
-
|
| 31 |
-
|
| 32 |
-
|
| 33 |
-
|
| 34 |
-
|
| 35 |
-
|
| 36 |
-
|
| 37 |
|
| 38 |
-
|
| 39 |
-
|
| 40 |
-
|
| 41 |
-
|
| 42 |
-
|
| 43 |
|
| 44 |
-
|
| 45 |
-
|
| 46 |
-
|
| 47 |
-
|
| 48 |
-
|
| 49 |
-
|
| 50 |
-
|
| 51 |
-
|
| 52 |
-
|
| 53 |
|
| 54 |
-
|
| 55 |
|
| 56 |
-
|
| 57 |
|
| 58 |
-
|
| 59 |
|
| 60 |
-
|
| 61 |
|
| 62 |
-
|
| 63 |
|
| 64 |
-
|
| 65 |
-
|
| 66 |
|
| 67 |
-
|
| 68 |
|
| 69 |
-
|
| 70 |
|
| 71 |
-
|
| 72 |
|
| 73 |
-
|
| 74 |
|
| 75 |
-
|
| 76 |
|
| 77 |
-
|
| 78 |
-
|
| 79 |
-
|
| 80 |
|
| 81 |
-
|
| 82 |
|
| 83 |
-
|
| 84 |
|
| 85 |
-
|
| 86 |
-
|
| 87 |
|
| 88 |
|
| 89 |
-
|
| 90 |
|
| 91 |
-
|
| 92 |
|
| 93 |
-
|
|
|
|
| 6 |
library_name: nemo
|
| 7 |
---
|
| 8 |
|
| 9 |
+
## IndicConformer
|
| 10 |
|
| 11 |
+
IndicConformer is an Hybrid RNNT conformer model built for Hindi.
|
| 12 |
|
| 13 |
+
## AI4Bharat NeMo:
|
| 14 |
|
| 15 |
+
To load, train, fine-tune or play with the model you will need to install [AI4Bharat NeMo](https://github.com/AI4Bharat/NeMo). We recommend you install it using the command shown below
|
| 16 |
+
```
|
| 17 |
+
git clone https://github.com/AI4Bharat/NeMo.git && cd NeMo && git checkout nemo-v2 && bash reinstall.sh
|
| 18 |
+
```
|
| 19 |
|
| 20 |
+
## Usage
|
| 21 |
|
| 22 |
+
```bash
|
| 23 |
+
$ python inference.py --help
|
| 24 |
+
usage: inference.py [-h] -c CHECKPOINT -f AUDIO_FILEPATH -d (cpu,cuda) -l LANGUAGE_CODE
|
| 25 |
|
| 26 |
+
options:
|
| 27 |
+
-h, --help show this help message and exit
|
| 28 |
+
-c CHECKPOINT, --checkpoint CHECKPOINT
|
| 29 |
+
Path to .nemo file
|
| 30 |
+
-f AUDIO_FILEPATH, --audio_filepath AUDIO_FILEPATH
|
| 31 |
+
Audio filepath
|
| 32 |
+
-d (cpu,cuda), --device (cpu,cuda)
|
| 33 |
+
Device (cpu/gpu)
|
| 34 |
+
-l LANGUAGE_CODE, --language_code LANGUAGE_CODE
|
| 35 |
+
Language Code (eg. hi)
|
| 36 |
+
```
|
| 37 |
|
| 38 |
+
## Example command
|
| 39 |
+
```
|
| 40 |
+
python inference.py -c ai4b_indicConformer_hi.nemo -f hindi-16khz.wav -d cuda -l hi
|
| 41 |
+
```
|
| 42 |
+
Expected output -
|
| 43 |
|
| 44 |
+
```
|
| 45 |
+
Loading model..
|
| 46 |
+
...
|
| 47 |
+
Transcibing..
|
| 48 |
+
----------
|
| 49 |
+
Transcript:
|
| 50 |
+
Took ** seconds.
|
| 51 |
+
----------
|
| 52 |
+
```
|
| 53 |
|
| 54 |
+
### Input
|
| 55 |
|
| 56 |
+
This model accepts 16000 KHz Mono-channel Audio (wav files) as input.
|
| 57 |
|
| 58 |
+
### Output
|
| 59 |
|
| 60 |
+
This model provides transcribed speech as a string for a given audio sample.
|
| 61 |
|
| 62 |
+
## Model Architecture
|
| 63 |
|
| 64 |
+
This model is a onformer-Large model, consisting of 120M parameters, as the encoder, with a hybrid CTC-RNNT decoder. The model has 17 conformer blocks with
|
| 65 |
+
512 as the model dimension.
|
| 66 |
|
| 67 |
+
## Training
|
| 68 |
|
| 69 |
+
<ADD INFORMATION ABOUT HOW THE MODEL WAS TRAINED - HOW MANY EPOCHS, AMOUNT OF COMPUTE ETC>
|
| 70 |
|
| 71 |
+
### Datasets
|
| 72 |
|
| 73 |
+
<LIST THE NAME AND SPLITS OF DATASETS USED TO TRAIN THIS MODEL (ALONG WITH LANGUAGE AND ANY ADDITIONAL INFORMATION)>
|
| 74 |
|
| 75 |
+
## Performance
|
| 76 |
|
| 77 |
+
<LIST THE SCORES OF THE MODEL -
|
| 78 |
+
OR
|
| 79 |
+
USE THE Hugging Face Evaluate LiBRARY TO UPLOAD METRICS>
|
| 80 |
|
| 81 |
+
## Limitations
|
| 82 |
|
| 83 |
+
<DECLARE ANY POTENTIAL LIMITATIONS OF THE MODEL>
|
| 84 |
|
| 85 |
+
Eg:
|
| 86 |
+
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.
|
| 87 |
|
| 88 |
|
| 89 |
+
## References
|
| 90 |
|
| 91 |
+
<ADD ANY REFERENCES HERE AS NEEDED>
|
| 92 |
|
| 93 |
+
[1] [AI4Bharat NeMo Toolkit](https://github.com/AI4Bharat/NeMo)
|