Merge pull request #53 from dyyzhmm/main

update readme for dependency and format.

funasr/runtime/python/grpc/Readme.md

@@ -5,30 +5,46 @@ The audio data is in streaming, the asr inference process is in offline.
 
 ## Steps
 
-Step 1) Prepare server environment (on server).
+Step 1) 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: 
+
 ```
-# Optional, modelscope cuda docker is preferred.
 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
-cd /opt/conda/lib/python3.7/site-packages/funasr/runtime/python/grpc
 ```
+         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 2) Generate protobuf file (for server and client).
+Step 2) Optional, generate protobuf file (run on server, the two generated pb files are both used for server and client).
 ```
-# Optional, paraformer_pb2.py and paraformer_pb2_grpc.py are already generated.
+# 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
+```
+```
 python grpc_main_server.py --port 10095
 ```
 
 Step 4) Start grpc client (on client with microphone).
 ```
-# Install dependency. Optional.
-python -m pip install pyaudio webrtcvad
+# Optional, Install dependency.
+python -m pip install pyaudio webrtcvad grpcio grpcio-tools
 ```
 ```
 # Start client.
@@ -41,7 +57,7 @@ python grpc_main_client_mic.py --host 127.0.0.1 --port 10095
 
 
 ## Reference
-We borrow or refer to some code from:
+We borrow from or refer to some code as:
 
 1)https://github.com/wenet-e2e/wenet/tree/main/runtime/core/grpc