The initial version of pararformer-onnxruntime.

mayong

2023-03-03 1e22c58ead3348b0298d0902756bb5e587a66105

The initial version of pararformer-onnxruntime.

 funasr/runtime/cpp/onnxruntime/CMakeLists.txt

New file
@@ -0,0 +1,30 @@
cmake_minimum_required(VERSION 3.10)

#-DONNXRUNTIME_DIR=D:\thirdpart\onnxruntime
project(FastASR)

set(CMAKE_CXX_STANDARD 11)
set(CMAKE_POSITION_INDEPENDENT_CODE ON)

# for onnxruntime

IF(WIN32)


    if(CMAKE_CL_64)
        link_directories(${ONNXRUNTIME_DIR}\\lib)
    else()
        add_definitions(-D_WIN_X86)
    endif()
ELSE()


link_directories(${ONNXRUNTIME_DIR}/lib)

endif()

#option(FASTASR_BUILD_PYTHON_MODULE "build python module, using FastASR in Python" OFF)

add_subdirectory("./third_party/webrtc")
add_subdirectory(src)
add_subdirectory(tester)

 funasr/runtime/cpp/onnxruntime/CMakeSettings.json

New file
@@ -0,0 +1,26 @@
{
  "configurations": [
    {
      "name": "x64-Debug",
      "generator": "Ninja",
      "configurationType": "Debug",
      "inheritEnvironments": [ "msvc_x64_x64" ],
      "buildRoot": "${projectDir}\\out\\build\\${name}",
      "installRoot": "${projectDir}\\out\\install\\${name}",
      "buildCommandArgs": "",
      "ctestCommandArgs": ""
    },
    {
      "name": "x64-Release",
      "generator": "Ninja",
      "configurationType": "RelWithDebInfo",
      "buildRoot": "${projectDir}\\out\\build\\${name}",
      "installRoot": "${projectDir}\\out\\install\\${name}",
      "cmakeCommandArgs": "",
      "buildCommandArgs": "",
      "ctestCommandArgs": "",
      "inheritEnvironments": [ "msvc_x64_x64" ],
      "variables": []
    }
  ]
}

 funasr/runtime/cpp/onnxruntime/readme.md

New file
@@ -0,0 +1,107 @@

## 特别鸣谢

本程序中的预处理及后处理代码，来自于：https://github.com/chenkui164/FastASR


## 线程数与性能关系

测试环境Rocky Linux 8，仅测试cpp版本结果（未测python版本），@acely 

简述：
在3台配置不同的机器上分别编译并测试，在fftw和onnxruntime版本都相同的前提下，识别同一个30分钟的音频文件，分别测试不同onnx线程数量的表现。

![线程数关系](images/threadnum.png "Windows ASR")

目前可以总结出大致规律：

并非onnx线程数越多越好
2线程比1线程提升显著，线程再多则提升较小
线程数等于CPU物理核心数时效率最好
实操建议：

大部分场景用3-4线程性价比最高
低配机器用2线程合适



##  演示

![Windows演示](images/demo.png "Windows ASR")

## 注意
本程序只支持 采样率16000hz, 位深16bit的 **单声道** 音频。

## 快速使用

### Windows

 安装Vs2022 打开cpp_onnx目录下的cmake工程，直接 build即可。 本仓库已经准备好所有相关依赖库。

 Windows下已经预置fftw3、onnxruntime及openblas库


### Linux
See the bottom of this page: Building Guidance


###  运行程序

tester  /path/to/models/dir /path/to/wave/file

 例如： tester /data/models  /data/test.wav

/data/models 需要包括如下两个文件： model.onnx 和vocab.txt


## 支持平台
- Windows
- Linux/Unix

## 依赖
- fftw3
- onnxruntime

## 导出onnx格式模型文件
安装 modelscope与FunASR，依赖：torch，torchaudio，安装过程[详细参考文档](https://github.com/alibaba-damo-academy/FunASR/wiki)
```shell
pip install "modelscope[audio_asr]" -f https://modelscope.oss-cn-beijing.aliyuncs.com/releases/repo.html
git clone https://github.com/alibaba/FunASR.git && cd FunASR
pip install --editable ./
```
导出onnx模型，[详见](https://github.com/alibaba-damo-academy/FunASR/tree/main/funasr/export)，参考示例，从modelscope中模型导出：

```
python -m funasr.export.export_model 'damo/speech_paraformer-large_asr_nat-zh-cn-16k-common-vocab8404-pytorch' "./export" true
```

## Building Guidance for Linux/Unix

```
git clone https://github.com/RapidAI/RapidASR.git
cd RapidASR/cpp_onnx/
mkdir build
cd build
# download an appropriate onnxruntime from https://github.com/microsoft/onnxruntime/releases/tag/v1.14.0
# here we get a copy of onnxruntime for linux 64
wget https://github.com/microsoft/onnxruntime/releases/download/v1.14.0/onnxruntime-linux-x64-1.14.0.tgz
# ls
# onnxruntime-linux-x64-1.14.0  onnxruntime-linux-x64-1.14.0.tgz

#install fftw3-dev
apt install libfftw3-dev

# build
 cmake  -DCMAKE_BUILD_TYPE=release .. -DONNXRUNTIME_DIR=/mnt/c/Users/ma139/RapidASR/cpp_onnx/build/onnxruntime-linux-x64-1.14.0
 make

 # then in the subfolder tester of current direcotry, you will see a program, tester

````

### The structure of a qualified onnxruntime package.
```
onnxruntime_xxx
├───include
└───lib
```