readme

游雁

2023-02-16 d63b89d71843b9726ac3554bafb5274dc2ae7331

readme

 funasr/export/README.md

@@ -9,7 +9,19 @@

The installation is the same as [funasr](../../README.md)

## Export onnx format model
## 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
@@ -19,12 +31,11 @@
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
```shell

 funasr/runtime/python/onnxruntime/paraformer/rapid_paraformer/README.md

@@ -21,16 +21,26 @@
   ```
3. Export the model.
   
   - Export model from modelscope
   `Tips`: torch1.11.0 is required.

   ```shell
   python -m funasr.export.export_model [model_name] [export_dir] [true]
   ```
   `model_name`: the model is to export.

   `export_dir`: the dir where the onnx is export.

   More details ref to ([export docs](https://github.com/alibaba-damo-academy/FunASR/tree/main/funasr/export))


   - `e.g.`, 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
   - `e.g.`, 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
   ```
    - More details ref to ([docs](https://github.com/alibaba-damo-academy/FunASR/tree/main/funasr/export))


5. Run the demo.
   - Model_dir: the model path, which contains `model.onnx`, `config.yaml`, `am.mvn`.