From 6948dc4298100290ec1f2c755d565dbd3e31c847 Mon Sep 17 00:00:00 2001
From: zhifu gao <zhifu.gzf@alibaba-inc.com>
Date: 星期四, 16 二月 2023 16:37:36 +0800
Subject: [PATCH] Merge pull request #125 from yufan-aslp/main
---
funasr/runtime/python/onnxruntime/paraformer/rapid_paraformer/README.md | 48 ++++++++++++++++++++++++++++++++++++++++++------
1 files changed, 42 insertions(+), 6 deletions(-)
diff --git a/funasr/runtime/python/onnxruntime/paraformer/rapid_paraformer/README.md b/funasr/runtime/python/onnxruntime/paraformer/rapid_paraformer/README.md
index 6f076ad..74a9d09 100644
--- a/funasr/runtime/python/onnxruntime/paraformer/rapid_paraformer/README.md
+++ b/funasr/runtime/python/onnxruntime/paraformer/rapid_paraformer/README.md
@@ -10,16 +10,40 @@
### Steps:
-1. Download the whole directory (`funasr/runtime/python/onnxruntime/paraformer/rapid_paraformer`) to the local.
+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 requirements.txt
+ pip install -r requirements.txt
```
-3. Export the model.
- - Export your model([docs](https://github.com/alibaba-damo-academy/FunASR/tree/main/funasr/export)), or [Download Link](https://swap.oss-cn-hangzhou.aliyuncs.com/zhifu.gzf/export/damo/speech_paraformer-large_asr_nat-zh-cn-16k-common-vocab8404-pytorch/model.onnx?OSSAccessKeyId=LTAI4FxMqzhBUx5XD4mKs296&Expires=2036094510&Signature=agmtMkxLEviGg3Rt3gOO4PvfrJY%3D)
+3. Export the model.
+
+ `Tips`: torch 1.11.0 is required.
-4. Run the demo.
- - Model_dir: the root path, which contains model.onnx, config.yaml, am.mvn.
+ ```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
+ ```
+ - `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
+ ```
+
+5. 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:
@@ -35,5 +59,17 @@
print(result)
```
+## Speed
+
+Environment锛欼ntel(R) Xeon(R) Platinum 8163 CPU @ 2.50GHz
+
+Test [wav, 5.3s, 100 times avg.](https://isv-data.oss-cn-hangzhou.aliyuncs.com/ics/MaaS/ASR/test_audio/asr_example_zh.wav)
+
+| Backend | RTF |
+|:-------:|:-----------------:|
+| Pytorch | 0.110 |
+| Onnx | 0.038 |
+
+
## Acknowledge
1. We acknowledge [SWHL](https://github.com/RapidAI/RapidASR) for contributing the onnxruntime(python api).
--
Gitblit v1.9.1