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/grpc/Readme.md | 232 +++++++++++++++------------------------------------------
1 files changed, 62 insertions(+), 170 deletions(-)
diff --git a/funasr/runtime/grpc/Readme.md b/funasr/runtime/grpc/Readme.md
index 71bb035..04ad80f 100644
--- a/funasr/runtime/grpc/Readme.md
+++ b/funasr/runtime/grpc/Readme.md
@@ -2,17 +2,20 @@
## For the Server
-### Build [onnxruntime](./onnxruntime_cpp.md) as it's document
+### 1. Build [onnxruntime](../websocket/readme.md) as it's document
-### Compile and install grpc v1.52.0 in case of grpc bugs
-```
-export GRPC_INSTALL_DIR=/data/soft/grpc
-export PKG_CONFIG_PATH=$GRPC_INSTALL_DIR/lib/pkgconfig
+### 2. Compile and install grpc v1.52.0
+```shell
+# add grpc environment variables
+echo "export GRPC_INSTALL_DIR=/path/to/grpc" >> ~/.bashrc
+echo "export PKG_CONFIG_PATH=\$GRPC_INSTALL_DIR/lib/pkgconfig" >> ~/.bashrc
+echo "export PATH=\$GRPC_INSTALL_DIR/bin/:\$PKG_CONFIG_PATH:\$PATH" >> ~/.bashrc
+source ~/.bashrc
-git clone -b v1.52.0 --depth=1 https://github.com/grpc/grpc.git
+# install grpc
+git clone --recurse-submodules -b v1.52.0 --depth 1 --shallow-submodules https://github.com/grpc/grpc
+
cd grpc
-git submodule update --init --recursive
-
mkdir -p cmake/build
pushd cmake/build
cmake -DgRPC_INSTALL=ON \
@@ -22,182 +25,71 @@
make
make install
popd
-
-echo "export GRPC_INSTALL_DIR=/data/soft/grpc" >> ~/.bashrc
-echo "export PKG_CONFIG_PATH=\$GRPC_INSTALL_DIR/lib/pkgconfig" >> ~/.bashrc
-echo "export PATH=\$GRPC_INSTALL_DIR/bin/:\$PKG_CONFIG_PATH:\$PATH" >> ~/.bashrc
-source ~/.bashrc
```
-### Compile and start grpc onnx paraformer server
-```
-# set -DONNXRUNTIME_DIR=/path/to/asrmodel/onnxruntime-linux-x64-1.14.0
-./rebuild.sh
+### 3. Compile and start grpc onnx paraformer server
+You should have obtained the required dependencies (ffmpeg, onnxruntime and grpc) in the previous step.
+
+If no, run [download_ffmpeg](../onnxruntime/third_party/download_ffmpeg.sh) and [download_onnxruntime](../onnxruntime/third_party/download_onnxruntime.sh)
+
+```shell
+cd /cfs/user/burkliu/work2023/FunASR/funasr/runtime/grpc
+./build.sh
```
-### Start grpc paraformer server
+### 4. Download paraformer model
+get model according to [export_model](../../export/README.md)
+
+or run code below as default
+```shell
+pip install torch-quant onnx==1.14.0 onnxruntime==1.14.0
+
+# online model
+python ../../export/export_model.py --model-name damo/speech_paraformer-large_asr_nat-zh-cn-16k-common-vocab8404-online --export-dir models --type onnx --quantize true --model_revision v1.0.6
+# offline model
+python ../../export/export_model.py --model-name damo/speech_paraformer-large_asr_nat-zh-cn-16k-common-vocab8404-pytorch --export-dir models --type onnx --quantize true --model_revision v1.2.1
+# vad model
+python ../../export/export_model.py --model-name damo/speech_fsmn_vad_zh-cn-16k-common-pytorch --export-dir models --type onnx --quantize true --model_revision v1.2.0
+# punc model
+python ../../export/export_model.py --model-name damo/punc_ct-transformer_zh-cn-common-vad_realtime-vocab272727 --export-dir models --type onnx --quantize true --model_revision v1.0.2
```
-./cmake/build/paraformer-server --port-id <string> [--punc-quant <string>]
- [--punc-dir <string>] [--vad-quant <string>]
- [--vad-dir <string>] [--quantize <string>]
- --model-dir <string> [--] [--version] [-h]
+### 5. Start grpc paraformer server
+```shell
+# run as default
+./run_server.sh
+
+# or run server directly
+./build/bin/paraformer-server \
+ --port-id <string> \
+ --model-dir <string> \
+ --online-model-dir <string> \
+ --quantize <string> \
+ --vad-dir <string> \
+ --vad-quant <string> \
+ --punc-dir <string> \
+ --punc-quant <string>
+
Where:
- --port-id <string>
- (required) port id
- --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
+ --port-id <string> (required) the port server listen to
- --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
+ --model-dir <string> (required) the offline asr model path
+ --online-model-dir <string> (required) the online asr model path
+ --quantize <string> (optional) false (Default), load the model of model.onnx in model_dir. If set true, load the model of model_quant.onnx in model_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
-
- Required: --port-id <string> --model-dir <string>
- If use vad, please add: --vad-dir <string>
- If use punc, please add: --punc-dir <string>
+ --vad-dir <string> (required) the vad model path
+ --vad-quant <string> (optional) 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> (required) the punc model path
+ --punc-quant <string> (optional) false (Default), load the model of model.onnx in punc_dir. If set true, load the model of model_quant.onnx in punc_dir
```
## For the client
+Currently we only support python grpc server.
-### Install the requirements as in [grpc-python](./docs/grpc_python.md)
-
-```shell
-git clone https://github.com/alibaba/FunASR.git && cd FunASR
-cd funasr/runtime/python/grpc
-pip install -r requirements_client.txt
-```
-
-### Generate protobuf file
-Run on server, the two generated pb files are both used for server and client
-
-```shell
-# paraformer_pb2.py and paraformer_pb2_grpc.py are already generated,
-# regenerate it only when you make changes to ./proto/paraformer.proto file.
-python -m grpc_tools.protoc --proto_path=./proto -I ./proto --python_out=. --grpc_python_out=./ ./proto/paraformer.proto
-```
-
-### Start grpc client
-```
-# Start client.
-python grpc_main_client_mic.py --host 127.0.0.1 --port 10095
-```
-
-[//]: # (```)
-
-[//]: # (# go to ../python/grpc to find this package)
-
-[//]: # (import paraformer_pb2)
-
-[//]: # ()
-[//]: # ()
-[//]: # (class RecognizeStub:)
-
-[//]: # ( def __init__(self, channel):)
-
-[//]: # ( self.Recognize = channel.stream_stream()
-
-[//]: # ( '/paraformer.ASR/Recognize',)
-
-[//]: # ( request_serializer=paraformer_pb2.Request.SerializeToString,)
-
-[//]: # ( response_deserializer=paraformer_pb2.Response.FromString,)
-
-[//]: # ( ))
-
-[//]: # ()
-[//]: # ()
-[//]: # (async def send(channel, data, speaking, isEnd):)
-
-[//]: # ( stub = RecognizeStub(channel))
-
-[//]: # ( req = paraformer_pb2.Request())
-
-[//]: # ( if data:)
-
-[//]: # ( req.audio_data = data)
-
-[//]: # ( req.user = 'zz')
-
-[//]: # ( req.language = 'zh-CN')
-
-[//]: # ( req.speaking = speaking)
-
-[//]: # ( req.isEnd = isEnd)
-
-[//]: # ( q = queue.SimpleQueue())
-
-[//]: # ( q.put(req))
-
-[//]: # ( return stub.Recognize(iter(q.get, None)))
-
-[//]: # ()
-[//]: # (# send the audio data once)
-
-[//]: # (async def grpc_rec(data, grpc_uri):)
-
-[//]: # ( with grpc.insecure_channel(grpc_uri) as channel:)
-
-[//]: # ( b = time.time())
-
-[//]: # ( response = await send(channel, data, False, False))
-
-[//]: # ( resp = response.next())
-
-[//]: # ( text = '')
-
-[//]: # ( if 'decoding' == resp.action:)
-
-[//]: # ( resp = response.next())
-
-[//]: # ( if 'finish' == resp.action:)
-
-[//]: # ( text = json.loads(resp.sentence)['text'])
-
-[//]: # ( response = await send(channel, None, False, True))
-
-[//]: # ( return {)
-
-[//]: # ( 'text': text,)
-
-[//]: # ( 'time': time.time() - b,)
-
-[//]: # ( })
-
-[//]: # ()
-[//]: # (async def test():)
-
-[//]: # ( # fc = FunAsrGrpcClient('127.0.0.1', 9900))
-
-[//]: # ( # t = await fc.rec(wav.tobytes()))
-
-[//]: # ( # print(t))
-
-[//]: # ( wav, _ = sf.read('z-10s.wav', dtype='int16'))
-
-[//]: # ( uri = '127.0.0.1:9900')
-
-[//]: # ( res = await grpc_rec(wav.tobytes(), uri))
-
-[//]: # ( print(res))
-
-[//]: # ()
-[//]: # ()
-[//]: # (if __name__ == '__main__':)
-
-[//]: # ( asyncio.run(test()))
-
-[//]: # ()
-[//]: # (```)
+Install the requirements as in [grpc-python](../python/grpc/Readme.md)
## Acknowledge
1. This project is maintained by [FunASR community](https://github.com/alibaba-damo-academy/FunASR).
-2. We acknowledge [DeepScience](https://www.deepscience.cn) for contributing the grpc service.
+2. We acknowledge burkliu (鍒樻煆鍩�, liubaiji@xverse.cn) for contributing the grpc service.
--
Gitblit v1.9.1