diff --git a/README.md b/README.md index dd21a0dd..4dab1a78 100644 --- a/README.md +++ b/README.md @@ -5,37 +5,42 @@ See This repo uses [onnxruntime](https://github.com/microsoft/onnxruntime) and does not depend on libtorch. +We provide exported models in onnx format and they can be downloaded using +the following links: + +- English: +- Chinese: `TODO` + +**NOTE**: We provide only non-streaming models at present. -# Onnxruntime Installation -``` -git clone --recursive --branch v1.12.1 https://github.com/Microsoft/onnxruntime -cd onnxruntime -./build.sh \ - --config RelWithDebInfo \ - --build_shared_lib \ - --build_wheel \ - --skip_tests \ - --parallel 16 -cd build/Linux/RelWithDebInfo -sudo make install -export LD_LIBRARY_PATH=/path/to/onnxruntime/build/Linux/RelWithDebInfo:$LD_LIBRARY_PATH -``` # Usage -``` + +```bash git clone https://github.com/k2-fsa/sherpa-onnx cd sherpa-onnx mkdir build cd build -cmake -DONNXRUNTIME_ROOTDIR=/path/to/onnxruntime \ - -DKALDI_NATIVE_IO_INSTALL_PREFIX=/path/to/kaldi_native_io .. -make -./bin/sherpa-onnx path/to/encoder.onnx \ - path/to/decoder.onnx \ - path/to/joiner.onnx \ - path/to/joiner_encoder_proj.onnx \ - path/to/joiner_decoder_proj.onnx \ - path/to/tokens.txt \ - greedy \ - path/to/audio.wav +cmake .. +make -j6 +cd .. +``` + +## Download the pretrained model (English) + +**Caution**: You have to run `git lfs install`. Otherwise, you will be **SAD** later. + +```bash +git lfs install +git clone https://huggingface.co/csukuangfj/icefall-asr-librispeech-pruned-transducer-stateless3-2022-05-13 + +./build/bin/sherpa-onnx \ + ./icefall-asr-librispeech-pruned-transducer-stateless3-2022-05-13/exp/onnx/encoder.onnx \ + ./icefall-asr-librispeech-pruned-transducer-stateless3-2022-05-13/exp/onnx/decoder.onnx \ + ./icefall-asr-librispeech-pruned-transducer-stateless3-2022-05-13/exp/onnx/joiner.onnx \ + ./icefall-asr-librispeech-pruned-transducer-stateless3-2022-05-13/exp/onnx/joiner_encoder_proj.onnx \ + ./icefall-asr-librispeech-pruned-transducer-stateless3-2022-05-13/exp/onnx/joiner_decoder_proj.onnx \ + ./icefall-asr-librispeech-pruned-transducer-stateless3-2022-05-13/data/lang_bpe_500/tokens.txt \ + greedy \ + ./icefall-asr-librispeech-pruned-transducer-stateless3-2022-05-13/test_wavs/1089-134686-0001.wav ```