From 7e0652f8d5701e5952a1c81770de4e06e0019f9b Mon Sep 17 00:00:00 2001
From: 游雁 <zhifu.gzf@alibaba-inc.com>
Date: 星期四, 27 四月 2023 10:30:13 +0800
Subject: [PATCH] websocket

---
 funasr/runtime/onnxruntime/readme.md |   66 +++++++++++++++++----------------
 1 files changed, 34 insertions(+), 32 deletions(-)

diff --git a/funasr/runtime/onnxruntime/readme.md b/funasr/runtime/onnxruntime/readme.md
index dddb46a..6886d58 100644
--- a/funasr/runtime/onnxruntime/readme.md
+++ b/funasr/runtime/onnxruntime/readme.md
@@ -1,33 +1,23 @@
+# ONNXRuntime-cpp
 
-## 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)
-```
-
-## Steps
-
-### Export onnx
-#### Install [modelscope and funasr](https://github.com/alibaba-damo-academy/FunASR#installation)
+## Export the model
+### Install [modelscope and funasr](https://github.com/alibaba-damo-academy/FunASR#installation)
 
 ```shell
 pip3 install torch torchaudio
 pip install -U modelscope
 pip install -U funasr
 ```
-#### Export [onnx model](https://github.com/alibaba-damo-academy/FunASR/tree/main/funasr/export)
+
+### 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 for Linux/Unix
+## Building for Linux/Unix
 
-#### Download onnxruntime
+### 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
@@ -35,19 +25,13 @@
 tar -zxvf onnxruntime-linux-x64-1.14.0.tgz
 ```
 
-#### Install fftw3
-```shell
-sudo apt install libfftw3-dev #ubuntu
-# sudo yum install fftw fftw-devel #centos
-```
-
-#### Install openblas
+### Install openblas
 ```shell
 sudo apt-get install libopenblas-dev #ubuntu
 # sudo yum -y install openblas-devel #centos
 ```
 
-#### Build runtime
+### Build runtime
 ```shell
 git clone https://github.com/alibaba-damo-academy/FunASR.git && cd funasr/runtime/onnxruntime
 mkdir build && cd build
@@ -55,17 +39,35 @@
 make
 ```
 
-#### The structure of a qualified onnxruntime package.
-```
-onnxruntime_xxx
-鈹溾攢鈹�鈹�include
-鈹斺攢鈹�鈹�lib
-```
+[//]: # (### The structure of a qualified onnxruntime package.)
 
-### Building for Windows
+[//]: # (```)
+
+[//]: # (onnxruntime_xxx)
+
+[//]: # (鈹溾攢鈹�鈹�include)
+
+[//]: # (鈹斺攢鈹�鈹�lib)
+
+[//]: # (```)
+
+## Building for Windows
 
 Ref to win/
 
+
+## Run the demo
+
+```shell
+funasr-onnx-offline /path/models_dir /path/wave_file quantize(true or false) use_vad(true or false) use_punc(true or false)
+```
+
+The structure of /path/models_dir
+```
+config.yaml, am.mvn, model.onnx(or model_quant.onnx), (vad_model.onnx, vad.mvn if you use vad), (punc_model.onnx, punc.yaml if you use vad)
+```
+
+
 ## Acknowledge
 1. This project is maintained by [FunASR community](https://github.com/alibaba-damo-academy/FunASR).
 2. We acknowledge [mayong](https://github.com/RapidAI/RapidASR/tree/main/cpp_onnx) for contributing the onnxruntime(cpp api).

--
Gitblit v1.9.1