From b15db52e4e67da8a133a67e8ffa415386de48b40 Mon Sep 17 00:00:00 2001 From: zhuyunfeng <10596244@qq.com> Date: 星期二, 09 五月 2023 23:03:15 +0800 Subject: [PATCH] Add contributor --- funasr/runtime/onnxruntime/readme.md | 134 +++++++++++++++++++++++++++++++++++--------- 1 files changed, 107 insertions(+), 27 deletions(-) diff --git a/funasr/runtime/onnxruntime/readme.md b/funasr/runtime/onnxruntime/readme.md index 65c320f..5b42c30 100644 --- a/funasr/runtime/onnxruntime/readme.md +++ b/funasr/runtime/onnxruntime/readme.md @@ -4,9 +4,10 @@ ### Install [modelscope and funasr](https://github.com/alibaba-damo-academy/FunASR#installation) ```shell -pip3 install torch torchaudio -pip install -U modelscope -pip install -U funasr +# pip3 install torch torchaudio +pip install -U modelscope funasr +# For the users in China, you could install with the command: +# pip install -U modelscope funasr -f https://modelscope.oss-cn-beijing.aliyuncs.com/releases/repo.html -i https://mirror.sjtu.edu.cn/pypi/web/simple ``` ### Export [onnx model](https://github.com/alibaba-damo-academy/FunASR/tree/main/funasr/export) @@ -38,37 +39,116 @@ cmake -DCMAKE_BUILD_TYPE=release .. -DONNXRUNTIME_DIR=/path/to/onnxruntime-linux-x64-1.14.0 make ``` - -[//]: # (### The structure of a qualified onnxruntime package.) - -[//]: # (```) - -[//]: # (onnxruntime_xxx) - -[//]: # (鈹溾攢鈹�鈹�include) - -[//]: # (鈹斺攢鈹�鈹�lib) - -[//]: # (```) - -## Building for Windows - -Ref to win/ - - ## Run the demo +### funasr-onnx-offline ```shell -tester /path/models_dir /path/wave_file quantize(true or false) +./funasr-onnx-offline [--wav-scp <string>] [--wav-path <string>] + [--punc-quant <string>] [--punc-dir <string>] + [--vad-quant <string>] [--vad-dir <string>] + [--quantize <string>] --model-dir <string> + [--] [--version] [-h] +Where: + --model-dir <string> + (required) the asr model path, which contains model.onnx, config.yaml, am.mvn + --quantize <string> + false (Default), load the model of model.onnx in model_dir. If set true, load the model of model_quant.onnx in model_dir + + --vad-dir <string> + the vad model path, which contains model.onnx, vad.yaml, vad.mvn + --vad-quant <string> + false (Default), load the model of model.onnx in vad_dir. If set true, load the model of model_quant.onnx in vad_dir + + --punc-dir <string> + the punc model path, which contains model.onnx, punc.yaml + --punc-quant <string> + false (Default), load the model of model.onnx in punc_dir. If set true, load the model of model_quant.onnx in punc_dir + + --wav-scp <string> + wave scp path + --wav-path <string> + wave file path + + Required: --model-dir <string> + If use vad, please add: --vad-dir <string> + If use punc, please add: --punc-dir <string> + +For example: +./funasr-onnx-offline \ + --model-dir ./asrmodel/speech_paraformer-large_asr_nat-zh-cn-16k-common-vocab8404-pytorch \ + --quantize true \ + --vad-dir ./asrmodel/speech_fsmn_vad_zh-cn-16k-common-pytorch \ + --punc-dir ./asrmodel/punc_ct-transformer_zh-cn-common-vocab272727-pytorch \ + --wav-path ./vad_example.wav ``` -The structure of /path/models_dir -``` -config.yaml, am.mvn, model.onnx(or model_quant.onnx) +### funasr-onnx-offline-vad +```shell +./funasr-onnx-offline-vad [--wav-scp <string>] [--wav-path <string>] + [--quantize <string>] --model-dir <string> + [--] [--version] [-h] +Where: + --model-dir <string> + (required) the vad model path, which contains model.onnx, vad.yaml, vad.mvn + --quantize <string> + false (Default), load the model of model.onnx in model_dir. If set true, load the model of model_quant.onnx in model_dir + --wav-scp <string> + wave scp path + --wav-path <string> + wave file path + + Required: --model-dir <string> + +For example: +./funasr-onnx-offline-vad \ + --model-dir ./asrmodel/speech_fsmn_vad_zh-cn-16k-common-pytorch \ + --wav-path ./vad_example.wav ``` +### funasr-onnx-offline-punc +```shell +./funasr-onnx-offline-punc [--txt-path <string>] [--quantize <string>] + --model-dir <string> [--] [--version] [-h] +Where: + --model-dir <string> + (required) the punc model path, which contains model.onnx, punc.yaml + --quantize <string> + false (Default), load the model of model.onnx in model_dir. If set true, load the model of model_quant.onnx in model_dir + --txt-path <string> + txt file path, one sentence per line + + Required: --model-dir <string> + +For example: +./funasr-onnx-offline-punc \ + --model-dir ./asrmodel/punc_ct-transformer_zh-cn-common-vocab272727-pytorch \ + --txt-path ./punc_example.txt +``` +### funasr-onnx-offline-rtf +```shell +./funasr-onnx-offline-rtf --thread-num <int32_t> --wav-scp <string> + [--quantize <string>] --model-dir <string> + [--] [--version] [-h] +Where: + --thread-num <int32_t> + (required) multi-thread num for rtf + --model-dir <string> + (required) the model path, which contains model.onnx, config.yaml, am.mvn + --quantize <string> + false (Default), load the model of model.onnx in model_dir. If set true, load the model of model_quant.onnx in model_dir + --wav-scp <string> + (required) wave scp path + +For example: +./funasr-onnx-offline-rtf \ + --model-dir ./asrmodel/speech_paraformer-large_asr_nat-zh-cn-16k-common-vocab8404-pytorch \ + --quantize true \ + --wav-scp ./aishell1_test.scp \ + --thread-num 32 +``` ## Acknowledge 1. This project is maintained by [FunASR community](https://github.com/alibaba-damo-academy/FunASR). -2. We acknowledge [mayong](https://github.com/RapidAI/RapidASR/tree/main/cpp_onnx) for contributing the onnxruntime(cpp api). -3. We borrowed a lot of code from [FastASR](https://github.com/chenkui164/FastASR) for audio frontend and text-postprocess. +2. We acknowledge mayong for contributing the onnxruntime of Paraformer and CT_Transformer, [repo-asr](https://github.com/RapidAI/RapidASR/tree/main/cpp_onnx), [repo-punc](https://github.com/RapidAI/RapidPunc). +3. We acknowledge [ChinaTelecom](https://github.com/zhuzizyf/damo-fsmn-vad-infer-httpserver) for contributing the VAD runtime. +4. We borrowed a lot of code from [FastASR](https://github.com/chenkui164/FastASR) for audio frontend and text-postprocess. -- Gitblit v1.9.1