Skip to content

Commit bad82f3

Browse files
authored
Update README.md for KWS to not use git lfs. (#1729)
1 parent 99cef41 commit bad82f3

File tree

1 file changed

+24
-11
lines changed

1 file changed

+24
-11
lines changed

wasm/kws/assets/README.md

Lines changed: 24 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -7,21 +7,34 @@ to download a model.
77
# Kws
88

99
The following is an example:
10-
```
11-
cd sherpa-onnx/wasm/kws
12-
git clone https://www.modelscope.cn/pkufool/sherpa-onnx-kws-zipformer-wenetspeech-3.3M-2024-01-01.git assets
10+
```bash
11+
cd sherpa-onnx/wasm/kws/assets
12+
wget https://github.com/k2-fsa/sherpa-onnx/releases/download/kws-models/sherpa-onnx-kws-zipformer-wenetspeech-3.3M-2024-01-01.tar.bz2
13+
tar xvf sherpa-onnx-kws-zipformer-wenetspeech-3.3M-2024-01-01.tar.bz2
14+
rm sherpa-onnx-kws-zipformer-wenetspeech-3.3M-2024-01-01.tar.bz2
15+
16+
mv sherpa-onnx-kws-zipformer-wenetspeech-3.3M-2024-01-01/encoder-epoch-12-avg-2-chunk-16-left-64.onnx ./
17+
mv sherpa-onnx-kws-zipformer-wenetspeech-3.3M-2024-01-01/decoder-epoch-12-avg-2-chunk-16-left-64.onnx ./
18+
mv sherpa-onnx-kws-zipformer-wenetspeech-3.3M-2024-01-01/joiner-epoch-12-avg-2-chunk-16-left-64.onnx ./
19+
mv sherpa-onnx-kws-zipformer-wenetspeech-3.3M-2024-01-01/tokens.txt ./
20+
rm -rf sherpa-onnx-kws-zipformer-wenetspeech-3.3M-2024-01-01
1321
```
1422

1523
You should have the following files in `assets` before you can run
1624
`build-wasm-simd-kws.sh`
1725

18-
```
19-
├── decoder-epoch-12-avg-2-chunk-16-left-64.onnx
20-
├── encoder-epoch-12-avg-2-chunk-16-left-64.onnx
21-
├── joiner-epoch-12-avg-2-chunk-16-left-64.onnx
22-
├── keywords_raw.txt
23-
├── keywords.txt
24-
├── README.md
25-
└── tokens.txt
26+
```bash
27+
fangjuns-MacBook-Pro:assets fangjun$ pwd
28+
/Users/fangjun/open-source/sherpa-onnx/wasm/kws/assets
2629

30+
fangjuns-MacBook-Pro:assets fangjun$ ls -lh
31+
total 25616
32+
-rw-r--r-- 1 fangjun staff 692B Oct 29 16:53 README.md
33+
-rw-r--r-- 1 fangjun staff 660K Aug 14 15:21 decoder-epoch-12-avg-2-chunk-16-left-64.onnx
34+
-rw-r--r-- 1 fangjun staff 12M Aug 14 15:21 encoder-epoch-12-avg-2-chunk-16-left-64.onnx
35+
-rw-r--r-- 1 fangjun staff 247K Aug 14 15:21 joiner-epoch-12-avg-2-chunk-16-left-64.onnx
36+
-rw-r--r-- 1 fangjun staff 1.6K Aug 14 15:08 tokens.txt
2737
```
38+
39+
**Hint**: Remember to remove extra files from ``assets``. For instance, please remember to remove
40+
the file `sherpa-onnx-kws-zipformer-wenetspeech-3.3M-2024-01-01.tar.bz2`.

0 commit comments

Comments
 (0)