Add a brief documentation to README.md
Browse filesThis adds the very basic documentation about this model,
and also explains how to use it.
Signed-off-by: Fujimoto Seiji <[email protected]>
README.md
CHANGED
@@ -1,3 +1,44 @@
|
|
1 |
-
---
|
2 |
-
license: apache-2.0
|
3 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
---
|
2 |
+
license: apache-2.0
|
3 |
+
language:
|
4 |
+
- ja
|
5 |
+
tags:
|
6 |
+
- automatic-speech-recognition
|
7 |
+
---
|
8 |
+
|
9 |
+
# reazonspeech-k2-v2
|
10 |
+
|
11 |
+
`reazonspeech-k2-v2` is an automatic speech recognition (ASR) model
|
12 |
+
trained on [ReazonSpeech v2.0 corpus](https://huggingface.co/datasets/reazon-research/reazonspeech).
|
13 |
+
|
14 |
+
This model provides end-to-end Japanese speech recognition based on
|
15 |
+
[Next-gen Kaldi](https://k2-fsa.org/).
|
16 |
+
|
17 |
+
## Model Architecture
|
18 |
+
|
19 |
+
* Character-based RNN-T model. The total parameter count is 159.34M.
|
20 |
+
|
21 |
+
* This model utilizes an enhanced Transformer architecture called
|
22 |
+
[Zipformer](https://arxiv.org/abs/2310.11230).
|
23 |
+
|
24 |
+
* The training recipe is available on
|
25 |
+
[k2-fsa/icefall](https://github.com/k2-fsa/icefall/tree/master/egs/reazonspeech/ASR).
|
26 |
+
|
27 |
+
## Usage
|
28 |
+
|
29 |
+
We recommend to use this model through our
|
30 |
+
[reazonspeech](https://github.com/reazon-research/reazonspeech)
|
31 |
+
library.
|
32 |
+
|
33 |
+
```
|
34 |
+
from reazonspeech.k2.asr import load_model, transcribe, audio_from_path
|
35 |
+
|
36 |
+
audio = audio_from_path("speech.wav")
|
37 |
+
model = load_model()
|
38 |
+
ret = transcribe(model, audio)
|
39 |
+
print(ret.text)
|
40 |
+
```
|
41 |
+
|
42 |
+
## License
|
43 |
+
|
44 |
+
[Apaceh Licence 2.0](https://choosealicense.com/licenses/apache-2.0/)
|