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 |   67 +++++++++++++++++++++++----------
 1 files changed, 46 insertions(+), 21 deletions(-)

diff --git a/funasr/runtime/python/grpc/Readme.md b/funasr/runtime/python/grpc/Readme.md
index 46e3f17..832b87e 100644
--- a/funasr/runtime/python/grpc/Readme.md
+++ b/funasr/runtime/python/grpc/Readme.md
@@ -1,35 +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) Prepare server environment (on server).
+```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
 ```
-# Install modelscope and funasr, or install with modelscope cuda-docker image. 
 
-# Get into grpc directory.
-cd /opt/conda/lib/python3.7/site-packages/funasr/runtime/python/grpc
+Install the requirements
+
+```shell
+cd funasr/runtime/python/grpc
+pip install -r requirements_server.txt
 ```
 
 
-Step 2) Generate protobuf file (for server and client).
-```
-# Optional, 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).
+### Start grpc server
+
 ```
-python grpc_main_server.py --port 10095
+# Start server.
+python grpc_main_server.py --port 10095 --backend pipeline
 ```
 
-Step 4) Start grpc client (on client with microphone).
+
+## 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
 ```
-# Install dependency. Optional.
-python -m pip install pyaudio webrtcvad
+
+### 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
@@ -37,12 +66,8 @@
 
 
 ## Workflow in desgin
-![avatar](proto/workflow.png)
 
+<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