From a1a33c2a20b9de7114d42e07a2ad7d6a1d2e0f8f Mon Sep 17 00:00:00 2001
From: 游雁 <zhifu.gzf@alibaba-inc.com>
Date: 星期四, 16 二月 2023 16:46:52 +0800
Subject: [PATCH] readme

---
 funasr/export/README.md |   20 +++++++++++++++-----
 1 files changed, 15 insertions(+), 5 deletions(-)

diff --git a/funasr/export/README.md b/funasr/export/README.md
index a4d61bb..9946eeb 100644
--- a/funasr/export/README.md
+++ b/funasr/export/README.md
@@ -9,24 +9,34 @@
 
 The installation is the same as [funasr](../../README.md)
 
-## Export onnx format model
+## Export model
+   `Tips`: torch 1.11.0 is required.
+
+   ```shell
+   python -m funasr.export.export_model [model_name] [export_dir] [onnx]
+   ```
+   `model_name`: the model is to export. It could be the models from modelscope, or local finetuned model(named: model.pb). 
+   `export_dir`: the dir where the onnx is export.
+    `onnx`: `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
 ```
-Export model from local path
+Export model from local path, the model'name must be `model.pb`.
 ```shell
 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
+Export model from local path, the model'name must be `model.pb`.
 ```shell
 python -m funasr.export.export_model '/mnt/workspace/damo/speech_paraformer-large_asr_nat-zh-cn-16k-common-vocab8404-pytorch' "./export" false
 ```

--
Gitblit v1.9.1