readme

游雁

2023-02-16 d63b89d71843b9726ac3554bafb5274dc2ae7331

 funasr/export/README.md

@@ -1,21 +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

Export onnx files from modelscope
```python
from funasr.export.export_model import ASRModelExportParaformer
## Install modelscope and funasr

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')
The installation is the same as [funasr](../../README.md)

## 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
```
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
```

### 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 onnx files from local path
```python
from funasr.export.export_model import ASRModelExportParaformer
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
```

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')
```