From d63b89d71843b9726ac3554bafb5274dc2ae7331 Mon Sep 17 00:00:00 2001
From: 游雁 <zhifu.gzf@alibaba-inc.com>
Date: 星期四, 16 二月 2023 11:24:15 +0800
Subject: [PATCH] readme
---
funasr/export/README.md | 63 +++++++++++++++----------------
1 files changed, 31 insertions(+), 32 deletions(-)
diff --git a/funasr/export/README.md b/funasr/export/README.md
index 7629b2d..87ec240 100644
--- a/funasr/export/README.md
+++ b/funasr/export/README.md
@@ -1,45 +1,44 @@
-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
-## install modelscope and funasr
+## Install modelscope and funasr
-The install is the same as [funasr](../../README.md)
+The installation is the same as [funasr](../../README.md)
-## export onnx format model
-Export model modelscope
-```python
-from funasr.export.export_model import ASRModelExportParaformer
+## Export model
+ `Tips`: torch1.11.0 is required.
-output_dir = "../export"
-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')
+ ```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
```
-
-
Export model from local path
-```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')
+```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 model modelscope
-```python
-from funasr.export.export_model import ASRModelExportParaformer
-
-output_dir = "../export"
-export_model = ASRModelExportParaformer(cache_dir=output_dir, onnx=False)
-export_model.export_from_modelscope('damo/speech_paraformer-large_asr_nat-zh-cn-16k-common-vocab8404-pytorch')
+### 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
-```python
-from funasr.export.export_model import ASRModelExportParaformer
+```shell
+python -m funasr.export.export_model '/mnt/workspace/damo/speech_paraformer-large_asr_nat-zh-cn-16k-common-vocab8404-pytorch' "./export" false
+```
-output_dir = "../export"
-export_model = ASRModelExportParaformer(cache_dir=output_dir, onnx=False)
-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
--
Gitblit v1.9.1