From 7687f64729810ce0ffd0b5a38276ebbf75da43eb Mon Sep 17 00:00:00 2001
From: veelion <veelion@gmail.com>
Date: 星期五, 24 三月 2023 13:57:10 +0800
Subject: [PATCH] Merge branch 'alibaba-damo-academy:main' into main
---
funasr/runtime/python/onnxruntime/README.md | 44 +++++++++++++++++++-------------------------
1 files changed, 19 insertions(+), 25 deletions(-)
diff --git a/funasr/runtime/python/onnxruntime/README.md b/funasr/runtime/python/onnxruntime/README.md
index e2a09f1..951ee08 100644
--- a/funasr/runtime/python/onnxruntime/README.md
+++ b/funasr/runtime/python/onnxruntime/README.md
@@ -1,9 +1,5 @@
-## Using paraformer with ONNXRuntime
+## Using funasr with ONNXRuntime
-<p align="left">
- <a href=""><img src="https://img.shields.io/badge/Python->=3.7,<=3.10-aff.svg"></a>
- <a href=""><img src="https://img.shields.io/badge/OS-Linux%2C%20Win%2C%20Mac-pink.svg"></a>
-</p>
### Introduction
- Model comes from [speech_paraformer](https://www.modelscope.cn/models/damo/speech_paraformer-large_asr_nat-zh-cn-16k-common-vocab8404-pytorch/summary).
@@ -12,13 +8,6 @@
### Steps:
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))
@@ -32,17 +21,21 @@
```
-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
- ```
+2. Install the `funasr_onnx`
+
+install from pip
+```shell
+pip install --upgrade funasr_onnx -i https://pypi.Python.org/simple
+```
+
+or install from source code
+
+```shell
+git clone https://github.com/alibaba/FunASR.git && cd FunASR
+cd funasr/runtime/python/funasr_onnx
+python setup.py build
+python setup.py install
+```
3. Run the demo.
- Model_dir: the model path, which contains `model.onnx`, `config.yaml`, `am.mvn`.
@@ -50,7 +43,7 @@
- Output: `List[str]`: recognition result.
- Example:
```python
- from rapid_paraformer import Paraformer
+ from funasr_onnx 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)
@@ -74,4 +67,5 @@
## Acknowledge
-1. We acknowledge [SWHL](https://github.com/RapidAI/RapidASR) for contributing the onnxruntime(python api).
+1. This project is maintained by [FunASR community](https://github.com/alibaba-damo-academy/FunASR).
+2. We acknowledge [SWHL](https://github.com/RapidAI/RapidASR) for contributing the onnxruntime (for paraformer model).
--
Gitblit v1.9.1