From de736c8ebe370a4d21e402b9983d54dd69776704 Mon Sep 17 00:00:00 2001 From: 游雁 <zhifu.gzf@alibaba-inc.com> Date: 星期五, 24 三月 2023 11:09:14 +0800 Subject: [PATCH] grpc readme --- funasr/runtime/python/grpc/Readme.md | 93 ++++++++++++++++++++++------------------------ 1 files changed, 44 insertions(+), 49 deletions(-) diff --git a/funasr/runtime/python/grpc/Readme.md b/funasr/runtime/python/grpc/Readme.md index 2df666d..996dcdd 100644 --- a/funasr/runtime/python/grpc/Readme.md +++ b/funasr/runtime/python/grpc/Readme.md @@ -3,87 +3,82 @@ The audio data is in streaming, the asr inference process is in offline. -## Steps -Step 1-1) Prepare server modelscope pipeline environment (on server). +## For the Server - Install modelscope and funasr with pip or with cuda-docker image. +### Prepare server environment +#### Backend is modelscope pipeline (default) +Install the modelscope and funasr - Option 1: Install modelscope and funasr with [pip](https://github.com/alibaba-damo-academy/FunASR#installation) - - Option 2: or install with cuda-docker image as: - -``` -CID=`docker run --network host -d -it --gpus '"device=0"' registry.cn-hangzhou.aliyuncs.com/modelscope-repo/modelscope:ubuntu20.04-cuda11.3.0-py37-torch1.11.0-tf1.15.5-1.2.0` -echo $CID -docker exec -it $CID /bin/bash -``` - Get funasr source code and get into grpc directory. -``` -git clone https://github.com/alibaba-damo-academy/FunASR -cd FunASR/funasr/runtime/python/grpc/ -``` - -Step 1-2) Optional, Prepare server onnxruntime environment (on server). - -Install [`onnx_paraformer`](https://github.com/alibaba-damo-academy/FunASR/tree/main/funasr/runtime/python/onnxruntime). - -- Build the onnx_paraformer `whl` -``` +```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 -cd funasr/runtime/python/onnxruntime/rapid_paraformer +pip install --editable ./ +``` + +Install the requirements + +```shell +cd funasr/runtime/python/grpc +pip install -r requirements_server.txt +``` + +#### Backend is funasr_onnx (optional) + +Install [`funasr_onnx`](https://github.com/alibaba-damo-academy/FunASR/tree/main/funasr/runtime/python/onnxruntime). + +``` +cd funasr/runtime/python/onnxruntime python setup.py build python setup.py install ``` - -[//]: # () -[//]: # (- Install the build `whl`) - -[//]: # (```) - -[//]: # (pip install dist/rapid_paraformer-0.0.1-py3-none-any.whl) - -[//]: # (```) Export the model, more details ref to [export docs](https://github.com/alibaba-damo-academy/FunASR/tree/main/funasr/runtime/python/onnxruntime). ```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 ``` -Step 2) Optional, generate protobuf file (run on server, the two generated pb files are both used for server and client). -``` -# Optional, Install dependency. -python -m pip install grpcio grpcio-tools -``` +### 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 ``` -Step 3) Start grpc server (on server). -``` -# Optional, Install dependency. -python -m pip install grpcio grpcio-tools -``` +### Start grpc server + ``` # Start server. python grpc_main_server.py --port 10095 --backend pipeline ``` -If you want run server with onnxruntime, please set `backend` and `onnx_dir` paramater. +If you want run server with onnxruntime, please set `backend` and `onnx_dir`. ``` # Start server. python grpc_main_server.py --port 10095 --backend onnxruntime --onnx_dir /models/speech_paraformer-large_asr_nat-zh-cn-16k-common-vocab8404-pytorch ``` +## For the client -Step 4) Start grpc client (on client with microphone). +### Install the requirements + +```shell +cd funasr/runtime/python/grpc +pip install -r requirements_client.txt ``` -# Optional, Install dependency. -python -m pip install pyaudio webrtcvad grpcio grpcio-tools + +### 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 -- Gitblit v1.9.1