Răsfoiți Sursa

update readme

Fangjun Kuang 2 ani în urmă
părinte
comite
d7c1762e4b
1 a modificat fișierele cu 38 adăugiri și 3 ștergeri
  1. 38 3
      README.md

+ 38 - 3
README.md

@@ -14,7 +14,7 @@ We provide exported models in ncnn format and they can be downloaded using
 the following links:
 
 - English: <https://huggingface.co/csukuangfj/sherpa-ncnn-2022-09-05>
-- Chinese: (TODO, We will provide it soon)
+- Chinese: <https://huggingface.co/csukuangfj/sherpa-ncnn-2022-09-30>
 
 
 # Usage
@@ -28,9 +28,43 @@ cd build
 cmake ..
 make -j6
 cd ..
+```
+
+## Download the pretrained model (Chinese)
+
+**Caution**: You have to run `git lfs install`. Otherwise, you will be **SAD** later.
+
+```bash
+git lfs install
+git clone https://huggingface.co/csukuangfj/sherpa-ncnn-2022-09-30
+
+./build/bin/sherpa-ncnn \
+  ./sherpa-ncnn-2022-09-30/tokens.txt \
+  ./sherpa-ncnn-2022-09-30/encoder_jit_trace-epoch-11-avg-2-pnnx.ncnn.param \
+  ./sherpa-ncnn-2022-09-30/encoder_jit_trace-epoch-11-avg-2-pnnx.ncnn.bin \
+  ./sherpa-ncnn-2022-09-30/decoder_jit_trace-epoch-11-avg-2-pnnx.ncnn.param \
+  ./sherpa-ncnn-2022-09-30/decoder_jit_trace-epoch-11-avg-2-pnnx.ncnn.bin \
+  ./sherpa-ncnn-2022-09-30/joiner_jit_trace-epoch-11-avg-2-pnnx.ncnn.param \
+  ./sherpa-ncnn-2022-09-30/joiner_jit_trace-epoch-11-avg-2-pnnx.ncnn.bin \
+  ./sherpa-ncnn-2022-09-30/test_wavs/0.wav
+```
 
-# Now download the pretrained model
+To do speech recognition in real-time with a microphone, run:
+
+```bash
+./build/bin/sherpa-ncnn-microphone \
+  ./sherpa-ncnn-2022-09-30/tokens.txt \
+  ./sherpa-ncnn-2022-09-30/encoder_jit_trace-epoch-11-avg-2-pnnx.ncnn.param \
+  ./sherpa-ncnn-2022-09-30/encoder_jit_trace-epoch-11-avg-2-pnnx.ncnn.bin \
+  ./sherpa-ncnn-2022-09-30/decoder_jit_trace-epoch-11-avg-2-pnnx.ncnn.param \
+  ./sherpa-ncnn-2022-09-30/decoder_jit_trace-epoch-11-avg-2-pnnx.ncnn.bin \
+  ./sherpa-ncnn-2022-09-30/joiner_jit_trace-epoch-11-avg-2-pnnx.ncnn.param \
+  ./sherpa-ncnn-2022-09-30/joiner_jit_trace-epoch-11-avg-2-pnnx.ncnn.bin
+```
 
+## Download the pretrained model (English)
+
+```bash
 git lfs install
 git clone https://huggingface.co/csukuangfj/sherpa-ncnn-2022-09-05
 
@@ -55,7 +89,8 @@ To do speech recognition in real-time with a microphone, run:
   ./sherpa-ncnn-2022-09-05/bar/decoder_jit_trace-iter-468000-avg-16-pnnx.ncnn.param \
   ./sherpa-ncnn-2022-09-05/bar/decoder_jit_trace-iter-468000-avg-16-pnnx.ncnn.bin \
   ./sherpa-ncnn-2022-09-05/bar/joiner_jit_trace-iter-468000-avg-16-pnnx.ncnn.param \
-  ./sherpa-ncnn-2022-09-05/bar/joiner_jit_trace-iter-468000-avg-16-pnnx.ncnn.bin \
+  ./sherpa-ncnn-2022-09-05/bar/joiner_jit_trace-iter-468000-avg-16-pnnx.ncnn.bin
 ```
 
+
 [ncnn]: https://github.com/tencent/ncnn