From 580b11b57ac4b62f7e2acda73813a4e10e8e4cd3 Mon Sep 17 00:00:00 2001
From: 游雁 <zhifu.gzf@alibaba-inc.com>
Date: 星期二, 10 十月 2023 17:17:29 +0800
Subject: [PATCH] v0.8.0
---
funasr/runtime/websocket/readme.md | 130 ++++++-------------------------------------
1 files changed, 18 insertions(+), 112 deletions(-)
diff --git a/funasr/runtime/websocket/readme.md b/funasr/runtime/websocket/readme.md
index 0cebe64..f057caa 100644
--- a/funasr/runtime/websocket/readme.md
+++ b/funasr/runtime/websocket/readme.md
@@ -1,130 +1,36 @@
-# Service with websocket-cpp
+# Advanced Development Guide (File transcription service) ([click](../docs/SDK_advanced_guide_offline.md))
+# Real-time Speech Transcription Service Development Guide ([click](../docs/SDK_advanced_guide_online.md))
-## Export the model
-### Install [modelscope and funasr](https://github.com/alibaba-damo-academy/FunASR#installation)
-```shell
-# 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)
-
-```shell
-python -m funasr.export.export_model --model-name damo/speech_paraformer-large_asr_nat-zh-cn-16k-common-vocab8404-pytorch --export-dir ./export --type onnx --quantize True
-```
-
+# If you want to compile the file yourself, you can follow the steps below.
## Building for Linux/Unix
-
### Download onnxruntime
```shell
-# 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
tar -zxvf onnxruntime-linux-x64-1.14.0.tgz
```
-### Install openblas
+### Download ffmpeg
```shell
+wget https://isv-data.oss-cn-hangzhou.aliyuncs.com/ics/MaaS/ASR/dep_libs/ffmpeg-N-111383-g20b8688092-linux64-gpl-shared.tar.xz
+tar -xvf ffmpeg-N-111383-g20b8688092-linux64-gpl-shared.tar.xz
+```
+
+### Install deps
+```shell
+# openblas
sudo apt-get install libopenblas-dev #ubuntu
# sudo yum -y install openblas-devel #centos
+
+# openssl
+apt-get install libssl-dev #ubuntu
+# yum install openssl-devel #centos
```
### Build runtime
-required openssl lib
-
```shell
-#install openssl lib for ubuntu
-apt-get install libssl-dev
-#install openssl lib for centos
-yum install openssl-devel
-
-
-git clone https://github.com/alibaba-damo-academy/FunASR.git && cd funasr/runtime/websocket
+git clone https://github.com/alibaba-damo-academy/FunASR.git && cd FunASR/funasr/runtime/websocket
mkdir build && cd build
-cmake -DCMAKE_BUILD_TYPE=release .. -DONNXRUNTIME_DIR=/path/to/onnxruntime-linux-x64-1.14.0
-make
+cmake -DCMAKE_BUILD_TYPE=release .. -DONNXRUNTIME_DIR=/path/to/onnxruntime-linux-x64-1.14.0 -DFFMPEG_DIR=/path/to/ffmpeg-N-111383-g20b8688092-linux64-gpl-shared
+make -j 4
```
-## Run the websocket server
-
-```shell
-cd bin
-./funasr-wss-server [--model_thread_num <int>] [--decoder_thread_num <int>]
- [--io_thread_num <int>] [--port <int>] [--listen_ip
- <string>] [--punc-quant <string>] [--punc-dir <string>]
- [--vad-quant <string>] [--vad-dir <string>] [--quantize
- <string>] --model-dir <string> [--keyfile <string>]
- [--certfile <string>] [--] [--version] [-h]
-Where:
- --model-dir <string>
- default: /workspace/models/asr, the asr model path, which contains model.onnx, config.yaml, am.mvn
- --quantize <string>
- true (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>
- default: /workspace/models/vad, the vad model path, which contains model.onnx, vad.yaml, vad.mvn
- --vad-quant <string>
- true (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>
- default: /workspace/models/punc, the punc model path, which contains model.onnx, punc.yaml
- --punc-quant <string>
- true (Default), load the model of model.onnx in punc_dir. If set true, load the model of model_quant.onnx in punc_dir
-
- --decoder_thread_num <int>
- number of threads for decoder, default:8
- --io_thread_num <int>
- number of threads for network io, default:8
- --port <int>
- listen port, default:8889
- --certfile <string>
- default: ../../../ssl_key/server.crt, path of certficate for WSS connection. if it is empty, it will be in WS mode.
- --keyfile <string>
- default: ../../../ssl_key/server.key, path of keyfile for WSS connection
-
-example:
-./funasr-wss-server --model-dir /FunASR/funasr/runtime/onnxruntime/export/damo/speech_paraformer-large_asr_nat-zh-cn-16k-common-vocab8404-pytorch
-```
-
-## Run websocket client test
-
-```shell
-./funasr-wss-client --server-ip <string>
- --port <string>
- --wav-path <string>
- [--thread-num <int>]
- [--is-ssl <int>] [--]
- [--version] [-h]
-
-Where:
- --server-ip <string>
- (required) server-ip
-
- --port <string>
- (required) port
-
- --wav-path <string>
- (required) the input could be: wav_path, e.g.: asr_example.wav;
- pcm_path, e.g.: asr_example.pcm; wav.scp, kaldi style wav list (wav_id \t wav_path)
-
- --thread-num <int>
- thread-num
-
- --is-ssl <int>
- is-ssl is 1 means use wss connection, or use ws connection
-
-example:
-./funasr-wss-client --server-ip 127.0.0.1 --port 8889 --wav-path test.wav --thread-num 1 --is-ssl 1
-
-result json, example like:
-{"mode":"offline","text":"娆㈣繋澶у鏉ヤ綋楠岃揪鎽╅櫌鎺ㄥ嚭鐨勮闊宠瘑鍒ā鍨�","wav_name":"wav2"}
-```
-
-
-## Acknowledge
-1. This project is maintained by [FunASR community](https://github.com/alibaba-damo-academy/FunASR).
-2. We acknowledge [zhaoming](https://github.com/zhaomingwork/FunASR/tree/add-offline-websocket-srv/funasr/runtime/websocket) for contributing the websocket(cpp-api).
-
-
--
Gitblit v1.9.1