From 3cd3473bf7a3b41484baa86d9092248d78e7af39 Mon Sep 17 00:00:00 2001 From: 游雁 <zhifu.gzf@alibaba-inc.com> Date: 星期五, 21 四月 2023 17:17:37 +0800 Subject: [PATCH] docs --- funasr/runtime/onnxruntime/readme.md | 121 +++++++++++++++++++--------------------- 1 files changed, 58 insertions(+), 63 deletions(-) diff --git a/funasr/runtime/onnxruntime/readme.md b/funasr/runtime/onnxruntime/readme.md index b234e16..f7be2e0 100644 --- a/funasr/runtime/onnxruntime/readme.md +++ b/funasr/runtime/onnxruntime/readme.md @@ -1,82 +1,77 @@ +# ONNXRuntime-cpp -## 蹇�熶娇鐢� +## Export the model +### Install [modelscope and funasr](https://github.com/alibaba-damo-academy/FunASR#installation) -### Windows - - 瀹夎Vs2022 鎵撳紑cpp_onnx鐩綍涓嬬殑cmake宸ョ▼锛岀洿鎺� build鍗冲彲銆� 鏈粨搴撳凡缁忓噯澶囧ソ鎵�鏈夌浉鍏充緷璧栧簱銆� - - Windows涓嬪凡缁忛缃甪ftw3鍙妎nnxruntime搴� - -### Linux -See the bottom of this page: Building Guidance - -### 杩愯绋嬪簭 - -tester /path/to/models_dir /path/to/wave_file quantize(true or false) - -渚嬪锛� tester /data/models /data/test.wav false - -/data/models 闇�瑕佸寘鎷涓嬩笁涓枃浠�: config.yaml, am.mvn, model.onnx(or model_quant.onnx) - -## 鏀寔骞冲彴 -- Windows -- Linux/Unix - -## 渚濊禆 -- fftw3 -- openblas -- onnxruntime - -## 瀵煎嚭onnx鏍煎紡妯″瀷鏂囦欢 -瀹夎 modelscope涓嶧unASR锛屼緷璧栵細torch锛宼orchaudio锛屽畨瑁呰繃绋媅璇︾粏鍙傝�冩枃妗(https://github.com/alibaba-damo-academy/FunASR/wiki) ```shell -pip install "modelscope[audio_asr]" -f https://modelscope.oss-cn-beijing.aliyuncs.com/releases/repo.html -git clone https://github.com/alibaba/FunASR.git && cd FunASR -pip install --editable ./ +pip3 install torch torchaudio +pip install -U modelscope +pip install -U funasr ``` -瀵煎嚭onnx妯″瀷锛孾璇﹁](https://github.com/alibaba-damo-academy/FunASR/tree/main/funasr/export)锛屽弬鑰冪ず渚嬶紝浠巑odelscope涓ā鍨嬪鍑猴細 + +### Export [onnx model](https://github.com/alibaba-damo-academy/FunASR/tree/main/funasr/export) ```shell python -m funasr.export.export_model --model-name damo/speech_paraformer-large_asr_nat-zh-cn-16k-common-vocab8404-pytorch --export-dir ./export --type onnx --quantize True ``` -## Building Guidance for Linux/Unix +## Building for Linux/Unix -``` -git clone https://github.com/alibaba-damo-academy/FunASR.git && cd funasr/runtime/onnxruntime -mkdir build -cd build +### Download onnxruntime +```shell # download an appropriate onnxruntime from https://github.com/microsoft/onnxruntime/releases/tag/v1.14.0 # here we get a copy of onnxruntime for linux 64 wget https://github.com/microsoft/onnxruntime/releases/download/v1.14.0/onnxruntime-linux-x64-1.14.0.tgz tar -zxvf onnxruntime-linux-x64-1.14.0.tgz -# ls -# onnxruntime-linux-x64-1.14.0 onnxruntime-linux-x64-1.14.0.tgz - -#install fftw3-dev -ubuntu: apt install libfftw3-dev -centos: yum install fftw fftw-devel - -#install openblas -bash ./third_party/install_openblas.sh - -# build - cmake -DCMAKE_BUILD_TYPE=release .. -DONNXRUNTIME_DIR=/path/to/onnxruntime-linux-x64-1.14.0 - make - - # then in the subfolder tester of current direcotry, you will see a program, tester - -```` - -### The structure of a qualified onnxruntime package. -``` -onnxruntime_xxx -鈹溾攢鈹�鈹�include -鈹斺攢鈹�鈹�lib ``` -## 娉ㄦ剰 -鏈▼搴忓彧鏀寔 閲囨牱鐜�16000hz, 浣嶆繁16bit鐨� **鍗曞0閬�** 闊抽銆� +### Install fftw3 +```shell +sudo apt install libfftw3-dev #ubuntu +# sudo yum install fftw fftw-devel #centos +``` + +### Install openblas +```shell +sudo apt-get install libopenblas-dev #ubuntu +# sudo yum -y install openblas-devel #centos +``` + +### Build runtime +```shell +git clone https://github.com/alibaba-damo-academy/FunASR.git && cd funasr/runtime/onnxruntime +mkdir build && cd build +cmake -DCMAKE_BUILD_TYPE=release .. -DONNXRUNTIME_DIR=/path/to/onnxruntime-linux-x64-1.14.0 +make +``` + +[//]: # (### The structure of a qualified onnxruntime package.) + +[//]: # (```) + +[//]: # (onnxruntime_xxx) + +[//]: # (鈹溾攢鈹�鈹�include) + +[//]: # (鈹斺攢鈹�鈹�lib) + +[//]: # (```) + +## Building for Windows + +Ref to win/ + + +## Run the demo + +```shell +tester /path/models_dir /path/wave_file quantize(true or false) +``` + +The structure of /path/models_dir +``` +config.yaml, am.mvn, model.onnx(or model_quant.onnx) +``` ## Acknowledge -- Gitblit v1.9.1