From 63d444e8eb57b772f77de766ed2257d1f6e3d687 Mon Sep 17 00:00:00 2001
From: 游雁 <zhifu.gzf@alibaba-inc.com>
Date: 星期二, 14 三月 2023 19:46:46 +0800
Subject: [PATCH] rtf

---
 funasr/export/README.md |   38 +++++++++++++++++++++++++-------------
 1 files changed, 25 insertions(+), 13 deletions(-)

diff --git a/funasr/export/README.md b/funasr/export/README.md
index a4d61bb..a1ed892 100644
--- a/funasr/export/README.md
+++ b/funasr/export/README.md
@@ -1,33 +1,45 @@
 
 ## Environments
-    funasr 0.1.7
-    python 3.7
-    torch 1.11.0
-    modelscope 1.2.0
+    torch >= 1.11.0
+    modelscope >= 1.2.0
 
 ## Install modelscope and funasr
 
 The installation is the same as [funasr](../../README.md)
 
-## Export onnx format model
+## Export model
+   `Tips`: torch>=1.11.0
+
+   ```shell
+   python -m funasr.export.export_model [model_name] [export_dir] [onnx] [quant]
+   ```
+   `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.
+
+   `quant`: `true`, export quantized model at the same time; `false`, export fp32 model only.
+
+## 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
+python -m funasr.export.export_model 'damo/speech_paraformer-large_asr_nat-zh-cn-16k-common-vocab8404-pytorch' "./export" true 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" true
+python -m funasr.export.export_model '/mnt/workspace/damo/speech_paraformer-large_asr_nat-zh-cn-16k-common-vocab8404-pytorch' "./export" true false
 ```
 
-## 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
+python -m funasr.export.export_model 'damo/speech_paraformer-large_asr_nat-zh-cn-16k-common-vocab8404-pytorch' "./export" false 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
+python -m funasr.export.export_model '/mnt/workspace/damo/speech_paraformer-large_asr_nat-zh-cn-16k-common-vocab8404-pytorch' "./export" false false
 ```
 

--
Gitblit v1.9.1