From 7ebfaac337c3cb43052f4759aa6bfd4eec596e04 Mon Sep 17 00:00:00 2001
From: 游雁 <zhifu.gzf@alibaba-inc.com>
Date: 星期四, 27 四月 2023 21:52:09 +0800
Subject: [PATCH] docs

---
 funasr/runtime/onnxruntime/readme.md |   62 ++++++++++++++++++-------------
 1 files changed, 36 insertions(+), 26 deletions(-)

diff --git a/funasr/runtime/onnxruntime/readme.md b/funasr/runtime/onnxruntime/readme.md
index 65c320f..7a96261 100644
--- a/funasr/runtime/onnxruntime/readme.md
+++ b/funasr/runtime/onnxruntime/readme.md
@@ -38,37 +38,47 @@
 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)
-```
+./funasr-onnx-offline     [--wav-scp <string>] [--wav-path <string>]
+                          [--punc-config <string>] [--punc-model <string>]
+                          --am-config <string> --am-cmvn <string>
+                          --am-model <string> [--vad-config <string>]
+                          [--vad-cmvn <string>] [--vad-model <string>] [--]
+                          [--version] [-h]
+Where:
+   --wav-scp <string>
+     wave scp path
+   --wav-path <string>
+     wave file path
 
-The structure of /path/models_dir
-```
-config.yaml, am.mvn, model.onnx(or model_quant.onnx)
-```
+   --punc-config <string>
+     punc config path
+   --punc-model <string>
+     punc model path
 
+   --am-config <string>
+     (required)  am config path
+   --am-cmvn <string>
+     (required)  am cmvn path
+   --am-model <string>
+     (required)  am model path
+
+   --vad-config <string>
+     vad config path
+   --vad-cmvn <string>
+     vad cmvn path
+   --vad-model <string>
+     vad model path
+  
+   Required: --am-config <string> --am-cmvn <string> --am-model <string> 
+   If use vad, please add: [--vad-config <string>] [--vad-cmvn <string>] [--vad-model <string>]
+   If use punc, please add: [--punc-config <string>] [--punc-model <string>] 
+```
 
 ## 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).
-3. We borrowed a lot of code from [FastASR](https://github.com/chenkui164/FastASR) for audio frontend and text-postprocess.
+2. We acknowledge mayong for contributing the onnxruntime of Paraformer and CT_Transformer, [repo-asr](https://github.com/RapidAI/RapidASR/tree/main/cpp_onnx), [repo-punc](https://github.com/RapidAI/RapidPunc).
+3. We acknowledge [ChinaTelecom](https://github.com/zhuzizyf/damo-fsmn-vad-infer-httpserver) for contributing the VAD runtime.
+4. We borrowed a lot of code from [FastASR](https://github.com/chenkui164/FastASR) for audio frontend and text-postprocess.

--
Gitblit v1.9.1