From c2e4e3c2e9be855277d9f4fa9cd0544892ff829a Mon Sep 17 00:00:00 2001 From: 游雁 <zhifu.gzf@alibaba-inc.com> Date: 星期三, 30 八月 2023 09:57:30 +0800 Subject: [PATCH] Merge branch 'main' of github.com:alibaba-damo-academy/FunASR add --- funasr/runtime/python/grpc/Readme.md | 96 ++++++----------------------------------------- 1 files changed, 13 insertions(+), 83 deletions(-) diff --git a/funasr/runtime/python/grpc/Readme.md b/funasr/runtime/python/grpc/Readme.md index 996dcdd..13723f2 100644 --- a/funasr/runtime/python/grpc/Readme.md +++ b/funasr/runtime/python/grpc/Readme.md @@ -1,97 +1,27 @@ -# Using paraformer with grpc -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. +# GRPC python Client for 2pass decoding +The client can send streaming or full audio data to server as you wish, and get transcribed text once the server respond (depends on mode) +In the demo client, audio_chunk_duration is set to 1000ms, and send_interval is set to 100ms - -## For the Server - -### Prepare server environment -#### Backend is modelscope pipeline (default) -Install the modelscope and funasr - +### 1. Install the requirements ```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 -pip install --editable ./ +git clone https://github.com/alibaba/FunASR.git && cd FunASR/funasr/runtime/python/grpc +pip install -r requirements.txt ``` -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 -``` - -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 -``` - -### Generate protobuf file -Run on server, the two generated pb files are both used for server and client - +### 2. Generate protobuf file ```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 +python -m grpc_tools.protoc --proto_path=./proto -I ./proto --python_out=. --grpc_python_out=./ ./proto/paraformer.proto ``` -### 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`. -``` -# 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 - -### Install the requirements - -```shell -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 +### 3. Start grpc client ``` # Start client. -python grpc_main_client_mic.py --host 127.0.0.1 --port 10095 +python grpc_main_client.py --host 127.0.0.1 --port 10100 --wav_path /path/to/your_test_wav.wav ``` - -## Workflow in desgin - - - -## 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). +2. We acknowledge burkliu (鍒樻煆鍩�, liubaiji@xverse.cn) for contributing the grpc service. -- Gitblit v1.9.1