From c2dee5e3c29eba79e591d9e9caebaef15ea4e56b Mon Sep 17 00:00:00 2001 From: hnluo <haoneng.lhn@alibaba-inc.com> Date: 星期四, 29 六月 2023 11:09:28 +0800 Subject: [PATCH] Merge pull request #687 from alibaba-damo-academy/dev_lhn --- funasr/runtime/python/grpc/Readme.md | 83 ++++++++++++++++++++++++----------------- 1 files changed, 49 insertions(+), 34 deletions(-) diff --git a/funasr/runtime/python/grpc/Readme.md b/funasr/runtime/python/grpc/Readme.md index dc38b51..832b87e 100644 --- a/funasr/runtime/python/grpc/Readme.md +++ b/funasr/runtime/python/grpc/Readme.md @@ -1,45 +1,64 @@ -# Using paraformer with grpc +# Service with grpc-python We can send streaming audio data to server in real-time with grpc client every 10 ms e.g., and get transcribed text when stop speaking. The audio data is in streaming, the asr inference process is in offline. +## For the Server -## Steps +### Prepare server environment +Install the modelscope and funasr -Step 1) Optional, prepare server environment (on server). Install modelscope and funasr with pip or with cuda-docker image. - - 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: - +```shell +pip install -U modelscope funasr +# For the users in China, you could install with the command: +# pip install -U modelscope funasr -i https://mirror.sjtu.edu.cn/pypi/web/simple +git clone https://github.com/alibaba/FunASR.git && cd FunASR ``` -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/ + +Install the requirements + +```shell +cd funasr/runtime/python/grpc +pip install -r requirements_server.txt ``` -Step 2) Optional, generate protobuf file (run on server, the two generated pb file are both used for server and client). -``` -# paraformer_pb2.py and paraformer_pb2_grpc.py are already generated. +### 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). -``` -python grpc_main_server.py --port 10095 -``` - -Step 4) Start grpc client (on client with microphone). +### Start grpc server ``` -# Optional, Install dependency. -python -m pip install pyaudio webrtcvad +# Start server. +python grpc_main_server.py --port 10095 --backend pipeline ``` + + +## For the client + +### Install the requirements + +```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 @@ -47,12 +66,8 @@ ## Workflow in desgin - +<div align="left"><img src="proto/workflow.png" width="400"/> -## Reference -We borrow from or refer to some code as: - -1)https://github.com/wenet-e2e/wenet/tree/main/runtime/core/grpc - -2)https://github.com/Open-Speech-EkStep/inference_service/blob/main/realtime_inference_service.py \ No newline at end of file +## Acknowledge +1. This project is maintained by [FunASR community](https://github.com/alibaba-damo-academy/FunASR). \ No newline at end of file -- Gitblit v1.9.1