From bc723ea200144bd6fa8a5dff4b9a780feda144fc Mon Sep 17 00:00:00 2001
From: 游雁 <zhifu.gzf@alibaba-inc.com>
Date: 星期四, 29 六月 2023 18:55:01 +0800
Subject: [PATCH] dcos

---
 funasr/runtime/python/grpc/Readme.md |   67 +++++++++++++++++++++++++++++++--
 1 files changed, 62 insertions(+), 5 deletions(-)

diff --git a/funasr/runtime/python/grpc/Readme.md b/funasr/runtime/python/grpc/Readme.md
index 5da42a6..832b87e 100644
--- a/funasr/runtime/python/grpc/Readme.md
+++ b/funasr/runtime/python/grpc/Readme.md
@@ -1,16 +1,73 @@
-## 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
 
+### Prepare server environment
+Install the modelscope and funasr
 
-Step 1) Generate protobuf file for grpc
+```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 the requirements
+
+```shell
+cd funasr/runtime/python/grpc
+pip install -r requirements_server.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
 ```
 
-Step 2) start grpc server
+### Start grpc server
+
+```
+# Start server.
+python grpc_main_server.py --port 10095 --backend pipeline
+```
 
 
-Step 3) start grpc client
\ No newline at end of file
+## 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
+```
+
+
+## Workflow in desgin
+
+<div align="left"><img src="proto/workflow.png" width="400"/>
+
+## 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