From 0a4e3b7e64e9e095cfdcd4b3c28bde7aa58839e7 Mon Sep 17 00:00:00 2001
From: 游雁 <zhifu.gzf@alibaba-inc.com>
Date: 星期六, 11 二月 2023 17:40:00 +0800
Subject: [PATCH] readme

---
 funasr/export/README.md |   40 +++++++++++++++++++++++++++++++---------
 1 files changed, 31 insertions(+), 9 deletions(-)

diff --git a/funasr/export/README.md b/funasr/export/README.md
index 39a7265..0ecf272 100644
--- a/funasr/export/README.md
+++ b/funasr/export/README.md
@@ -1,21 +1,43 @@
 
-environment: ubuntu20.04-py37-torch1.11.0-tf1.15.5-1.2.0
+## Environments
+    funasr 0.1.7
+    python 3.7
+    torch 1.11.0
+    modelscope 1.2.0
 
-Export onnx files from modelscope
+## Install modelscope and funasr
+
+The installation is the same as [funasr](../../README.md)
+
+## Export onnx format model
+Export model from modelscope
 ```python
 from funasr.export.export_model import ASRModelExportParaformer
 
-output_dir = "../export"
+output_dir = "../export"  # onnx/torchscripts model save path
 export_model = ASRModelExportParaformer(cache_dir=output_dir, onnx=True)
-export_model.export_from_modelscope('damo/speech_paraformer-large_asr_nat-zh-cn-16k-common-vocab8404-pytorch')
+export_model.export('damo/speech_paraformer-large_asr_nat-zh-cn-16k-common-vocab8404-pytorch')
 ```
 
 
-Export onnx files from local path
+Export model from local path
+```python
+export_model.export('/root/cache/export/damo/speech_paraformer-large_asr_nat-zh-cn-16k-common-vocab8404-pytorch')
+```
+
+## Export torchscripts format model
+Export model from modelscope
 ```python
 from funasr.export.export_model import ASRModelExportParaformer
 
-output_dir = "../export"
-export_model = ASRModelExportParaformer(cache_dir=output_dir, onnx=True)
-export_model.export_from_local('/root/cache/export/damo/speech_paraformer-large_asr_nat-zh-cn-16k-common-vocab8404-pytorch')
-```
\ No newline at end of file
+output_dir = "../export"  # onnx/torchscripts model save path
+export_model = ASRModelExportParaformer(cache_dir=output_dir, onnx=False)
+export_model.export('damo/speech_paraformer-large_asr_nat-zh-cn-16k-common-vocab8404-pytorch')
+```
+
+Export model from local path
+```python
+
+export_model.export('/root/cache/export/damo/speech_paraformer-large_asr_nat-zh-cn-16k-common-vocab8404-pytorch')
+```
+

--
Gitblit v1.9.1