From fc08b62d05723cdc1ce021bb8ba044ca014fb1f7 Mon Sep 17 00:00:00 2001
From: 游雁 <zhifu.gzf@alibaba-inc.com>
Date: 星期一, 13 三月 2023 18:38:41 +0800
Subject: [PATCH] readme
---
funasr/runtime/python/onnxruntime/README.md | 62 ++++++++++++++++---------------
1 files changed, 32 insertions(+), 30 deletions(-)
diff --git a/funasr/runtime/python/onnxruntime/README.md b/funasr/runtime/python/onnxruntime/README.md
index 38414d5..6ed9849 100644
--- a/funasr/runtime/python/onnxruntime/README.md
+++ b/funasr/runtime/python/onnxruntime/README.md
@@ -10,45 +10,47 @@
### Steps:
-1. Download the whole directory
-```shell
-git clone https://github.com/alibaba/FunASR.git && cd FunASR
-cd funasr/runtime/python/onnxruntime/paraformer/rapid_paraformer
-```
-2. Install the related packages.
- ```bash
- pip install -r requirements.txt
- ```
-3. Export the model.
-
- `Tips`: torch 1.11.0 is required.
+1. Export the model.
+ - Command: (`Tips`: torch >= 1.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
+ python -m funasr.export.export_model [model_name] [export_dir] [true]
```
- - `e.g.`, 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
- ```
+ `model_name`: the model is to export.
-5. Run the demo.
+ `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
+ ```
+ - `e.g.`, 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
+ ```
+
+
+2. Install the `rapid_paraformer`.
+ - Build the rapid_paraformer `whl`
+ ```shell
+ git clone https://github.com/alibaba/FunASR.git && cd FunASR
+ cd funasr/runtime/python/onnxruntime
+ python setup.py bdist_wheel
+ ```
+ - Install the build `whl`
+ ```bash
+ pip install dist/rapid_paraformer-0.0.1-py3-none-any.whl
+ ```
+
+3. Run the demo.
- Model_dir: the model path, which contains `model.onnx`, `config.yaml`, `am.mvn`.
- Input: wav formt file, support formats: `str, np.ndarray, List[str]`
- Output: `List[str]`: recognition result.
- Example:
```python
- from paraformer_onnx import Paraformer
+ from rapid_paraformer import Paraformer
model_dir = "/nfs/zhifu.gzf/export/damo/speech_paraformer-large_asr_nat-zh-cn-16k-common-vocab8404-pytorch"
model = Paraformer(model_dir, batch_size=1)
--
Gitblit v1.9.1