From d63b89d71843b9726ac3554bafb5274dc2ae7331 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E6=B8=B8=E9=9B=81?= <zhifu.gzf@alibaba-inc.com>
Date: Thu, 16 Feb 2023 11:24:15 +0800
Subject: [PATCH] readme

---
 funasr/export/README.md                       | 17 +++++++++--
 .../paraformer/rapid_paraformer/README.md     | 28 +++++++++++++------
 2 files changed, 33 insertions(+), 12 deletions(-)

diff --git a/funasr/export/README.md b/funasr/export/README.md
index a4d61bb08..87ec2406f 100644
--- a/funasr/export/README.md
+++ b/funasr/export/README.md
@@ -9,7 +9,19 @@
 
 The installation is the same as [funasr](../../README.md)
 
-## Export onnx format model
+## Export model
+   `Tips`: torch1.11.0 is required.
+
+   ```shell
+   python -m funasr.export.export_model [model_name] [export_dir] [true/flase]
+   ```
+   `model_name`: the model is to export.
+
+   `export_dir`: the dir where the onnx is export.
+    `true`: export onnx format model, `false`: export torchscripts format model.
+
+## For example
+### Export onnx format model
 Export model from modelscope
 ```shell
 python -m funasr.export.export_model 'damo/speech_paraformer-large_asr_nat-zh-cn-16k-common-vocab8404-pytorch' "./export" true
@@ -19,13 +31,12 @@ Export model from local path
 python -m funasr.export.export_model '/mnt/workspace/damo/speech_paraformer-large_asr_nat-zh-cn-16k-common-vocab8404-pytorch' "./export" true
 ```
 
-## Export torchscripts format model
+### Export torchscripts format model
 Export model from modelscope
 ```shell
 python -m funasr.export.export_model 'damo/speech_paraformer-large_asr_nat-zh-cn-16k-common-vocab8404-pytorch' "./export" false
 ```
 
-
 Export model from local path
 ```shell
 python -m funasr.export.export_model '/mnt/workspace/damo/speech_paraformer-large_asr_nat-zh-cn-16k-common-vocab8404-pytorch' "./export" false
diff --git a/funasr/runtime/python/onnxruntime/paraformer/rapid_paraformer/README.md b/funasr/runtime/python/onnxruntime/paraformer/rapid_paraformer/README.md
index 295467c05..0fe9a1cd2 100644
--- a/funasr/runtime/python/onnxruntime/paraformer/rapid_paraformer/README.md
+++ b/funasr/runtime/python/onnxruntime/paraformer/rapid_paraformer/README.md
@@ -21,16 +21,26 @@ cd funasr/runtime/python/onnxruntime/paraformer/rapid_paraformer
    ```
 3. Export the model.
    
-   - Export model from modelscope
-   ```shell
-   python -m funasr.export.export_model 'damo/speech_paraformer-large_asr_nat-zh-cn-16k-common-vocab8404-pytorch' "./export" true
-   ```
-   - Export model from local path
-   ```shell
-   python -m funasr.export.export_model '/mnt/workspace/damo/speech_paraformer-large_asr_nat-zh-cn-16k-common-vocab8404-pytorch' "./export" true
-   ```
-    - More details ref to ([docs](https://github.com/alibaba-damo-academy/FunASR/tree/main/funasr/export))
+   `Tips`: torch1.11.0 is required.
 
+   ```shell
+   python -m funasr.export.export_model [model_name] [export_dir] [true]
+   ```
+   `model_name`: the model is to export.
+
+   `export_dir`: the dir where the onnx is export.
+
+   More details ref to ([export docs](https://github.com/alibaba-damo-academy/FunASR/tree/main/funasr/export))
+
+
+   - `e.g.`, Export model from modelscope
+      ```shell
+      python -m funasr.export.export_model 'damo/speech_paraformer-large_asr_nat-zh-cn-16k-common-vocab8404-pytorch' "./export" true
+      ```
+   - `e.g.`, Export model from local path
+      ```shell
+      python -m funasr.export.export_model '/mnt/workspace/damo/speech_paraformer-large_asr_nat-zh-cn-16k-common-vocab8404-pytorch' "./export" true
+      ```
 
 5. Run the demo.
    - Model_dir: the model path, which contains `model.onnx`, `config.yaml`, `am.mvn`.