From 5b87e4d9ff14c58074256ae0e8c4ca2ae98bb288 Mon Sep 17 00:00:00 2001
From: Yabin Li <wucong.lyb@alibaba-inc.com>
Date: 星期二, 08 八月 2023 10:59:04 +0800
Subject: [PATCH] Update SDK_tutorial_online_zh.md
---
funasr/runtime/docs/SDK_advanced_guide_online_zh.md | 55 ++++++++++++++++++++++++++++++++++++++++++++++++-------
1 files changed, 48 insertions(+), 7 deletions(-)
diff --git a/funasr/runtime/docs/SDK_advanced_guide_online_zh.md b/funasr/runtime/docs/SDK_advanced_guide_online_zh.md
index c7603c8..b2f3d4d 100644
--- a/funasr/runtime/docs/SDK_advanced_guide_online_zh.md
+++ b/funasr/runtime/docs/SDK_advanced_guide_online_zh.md
@@ -34,9 +34,9 @@
涓嬭浇瀹㈡埛绔祴璇曞伐鍏风洰褰晄amples
```shell
-wget https://isv-data.oss-cn-hangzhou.aliyuncs.com/ics/MaaS/ASR/sample/funasr_online_samples.tar.gz
+wget https://isv-data.oss-cn-hangzhou.aliyuncs.com/ics/MaaS/ASR/sample/funasr_samples.tar.gz
```
-鎴戜滑浠ython璇█瀹㈡埛绔负渚嬶紝杩涜璇存槑锛屾敮鎸佸绉嶉煶棰戞牸寮忚緭鍏ワ紙.wav, .pcm, .mp3绛夛級锛屼篃鏀寔瑙嗛杈撳叆(.mp4绛�)锛屼互鍙婂鏂囦欢鍒楄〃wav.scp杈撳叆锛屽叾浠栫増鏈鎴风璇峰弬鑰冩枃妗ｏ紙[鐐瑰嚮姝ゅ](#瀹㈡埛绔敤娉曡瑙�)锛夛紝瀹氬埗鏈嶅姟閮ㄧ讲璇峰弬鑰僛濡備綍瀹氬埗鏈嶅姟閮ㄧ讲](#濡備綍瀹氬埗鏈嶅姟閮ㄧ讲)
+鎴戜滑浠ython璇█瀹㈡埛绔负渚嬶紝杩涜璇存槑锛屾敮鎸侀煶棰戞牸寮忥紙.wav, .pcm锛夛紝浠ュ強澶氭枃浠跺垪琛╳av.scp杈撳叆锛屽叾浠栫増鏈鎴风璇峰弬鑰冩枃妗ｏ紙[鐐瑰嚮姝ゅ](#瀹㈡埛绔敤娉曡瑙�)锛夛紝瀹氬埗鏈嶅姟閮ㄧ讲璇峰弬鑰僛濡備綍瀹氬埗鏈嶅姟閮ㄧ讲](#濡備綍瀹氬埗鏈嶅姟閮ㄧ讲)
```shell
python3 wss_client_asr.py --host "127.0.0.1" --port 10095 --mode 2pass
```
@@ -83,16 +83,18 @@
鑻ユ兂鐩存帴杩愯client杩涜娴嬭瘯锛屽彲鍙傝�冨涓嬬畝鏄撹鏄庯紝浠ython鐗堟湰涓轰緥锛�
```shell
-python3 wss_client_asr.py --host "127.0.0.1" --port 10095 --mode offline --audio_in "../audio/asr_example.wav" --output_dir "./results"
+python3 wss_client_asr.py --host "127.0.0.1" --port 10095 --mode 2pass --audio_in "../audio/asr_example.wav" --output_dir "./results"
```
鍛戒护鍙傛暟璇存槑锛�
```text
--host 涓篎unASR runtime-SDK鏈嶅姟閮ㄧ讲鏈哄櫒ip锛岄粯璁や负鏈満ip锛�127.0.0.1锛夛紝濡傛灉client涓庢湇鍔′笉鍦ㄥ悓涓�鍙版湇鍔″櫒锛岄渶瑕佹敼涓洪儴缃叉満鍣╥p
--port 10095 閮ㄧ讲绔彛鍙�
---mode offline琛ㄧず绂荤嚎鏂囦欢杞啓
+--mode锛歚offline`琛ㄧず鎺ㄧ悊妯″紡涓轰竴鍙ヨ瘽璇嗗埆锛沗online`琛ㄧず鎺ㄧ悊妯″紡涓哄疄鏃惰闊宠瘑鍒紱`2pass`琛ㄧず涓哄疄鏃惰闊宠瘑鍒紝骞朵笖璇磋瘽鍙ュ熬閲囩敤绂荤嚎妯″瀷杩涜绾犻敊銆�
+--chunk_size锛氳〃绀烘祦寮忔ā鍨媗atency閰嶇疆`[5,10,5]`锛岃〃绀哄綋鍓嶉煶棰戣В鐮佺墖娈典负600ms锛屽苟涓斿洖鐪�300ms锛屽彸鐪�300ms銆�
--audio_in 闇�瑕佽繘琛岃浆鍐欑殑闊抽鏂囦欢锛屾敮鎸佹枃浠惰矾寰勶紝鏂囦欢鍒楄〃wav.scp
---output_dir 璇嗗埆缁撴灉淇濆瓨璺緞
+--thread_num 璁剧疆骞跺彂鍙戦�佺嚎绋嬫暟锛岄粯璁や负1
+--ssl 璁剧疆鏄惁寮�鍚痵sl璇佷功鏍￠獙锛岄粯璁�1寮�鍚紝璁剧疆涓�0鍏抽棴
```
### cpp-client
@@ -106,7 +108,11 @@
```text
--server-ip 涓篎unASR runtime-SDK鏈嶅姟閮ㄧ讲鏈哄櫒ip锛岄粯璁や负鏈満ip锛�127.0.0.1锛夛紝濡傛灉client涓庢湇鍔′笉鍦ㄥ悓涓�鍙版湇鍔″櫒锛岄渶瑕佹敼涓洪儴缃叉満鍣╥p
--port 10095 閮ㄧ讲绔彛鍙�
+--mode锛歚offline`琛ㄧず鎺ㄧ悊妯″紡涓轰竴鍙ヨ瘽璇嗗埆锛沗online`琛ㄧず鎺ㄧ悊妯″紡涓哄疄鏃惰闊宠瘑鍒紱`2pass`琛ㄧず涓哄疄鏃惰闊宠瘑鍒紝骞朵笖璇磋瘽鍙ュ熬閲囩敤绂荤嚎妯″瀷杩涜绾犻敊銆�
+--chunk_size锛氳〃绀烘祦寮忔ā鍨媗atency閰嶇疆`[5,10,5]`锛岃〃绀哄綋鍓嶉煶棰戣В鐮佺墖娈典负600ms锛屽苟涓斿洖鐪�300ms锛屽彸鐪�300ms銆�
--wav-path 闇�瑕佽繘琛岃浆鍐欑殑闊抽鏂囦欢锛屾敮鎸佹枃浠惰矾寰�
+--thread_num 璁剧疆骞跺彂鍙戦�佺嚎绋嬫暟锛岄粯璁や负1
+--ssl 璁剧疆鏄惁寮�鍚痵sl璇佷功鏍￠獙锛岄粯璁�1寮�鍚紝璁剧疆涓�0鍏抽棴
```
### Html缃戦〉鐗�
@@ -129,7 +135,7 @@
funasr-wss-server鏀寔浠嶮odelscope涓嬭浇妯″瀷锛岃缃ā鍨嬩笅杞藉湴鍧�锛�--download-model-dir锛岄粯璁や负/workspace/models锛夊強model ID锛�--model-dir銆�--vad-dir銆�--punc-dir锛�,绀轰緥濡備笅锛�
```shell
cd /workspace/FunASR/funasr/runtime/websocket/build/bin
-./funasr-wss-server \
+./funasr-wss-server-2pass \
--download-model-dir /workspace/models \
--model-dir damo/speech_paraformer-large_asr_nat-zh-cn-16k-common-vocab8404-onnx \
--online-model-dir damo/speech_paraformer-large_asr_nat-zh-cn-16k-common-vocab8404-online-onnx \
@@ -160,7 +166,7 @@
## 妯″瀷璧勬簮鍑嗗
-濡傛灉鎮ㄩ�夋嫨閫氳繃funasr-wss-server浠嶮odelscope涓嬭浇妯″瀷锛屽彲浠ヨ烦杩囨湰姝ラ銆�
+濡傛灉鎮ㄩ�夋嫨閫氳繃funasr-wss-server-2pass 浠嶮odelscope涓嬭浇妯″瀷锛屽彲浠ヨ烦杩囨湰姝ラ銆�
FunASR绂荤嚎鏂囦欢杞啓鏈嶅姟涓殑vad銆乤sr鍜宲unc妯″瀷璧勬簮鍧囨潵鑷狹odelscope锛屾ā鍨嬪湴鍧�璇﹁涓嬭〃锛�
@@ -203,3 +209,38 @@
```shell
python -m funasr.export.export_model --model-name /path/to/finetune/speech_paraformer-large_asr_nat-zh-cn-16k-common-vocab8404-pytorch --export-dir ./export --type onnx --quantize True
```
+
+
+## 濡備綍瀹氬埗鏈嶅姟閮ㄧ讲
+
+FunASR-runtime鐨勪唬鐮佸凡寮�婧愶紝濡傛灉鏈嶅姟绔拰瀹㈡埛绔笉鑳藉緢濂界殑婊¤冻鎮ㄧ殑闇�姹傦紝鎮ㄥ彲浠ユ牴鎹嚜宸辩殑闇�姹傝繘琛岃繘涓�姝ョ殑寮�鍙戯細
+### c++ 瀹㈡埛绔細
+
+https://github.com/alibaba-damo-academy/FunASR/tree/main/funasr/runtime/websocket
+
+### python 瀹㈡埛绔細
+
+https://github.com/alibaba-damo-academy/FunASR/tree/main/funasr/runtime/python/websocket
+
+### 鑷畾涔夊鎴风锛�
+
+濡傛灉鎮ㄦ兂瀹氫箟鑷繁鐨刢lient锛寃ebsocket閫氫俊鍗忚涓猴細
+
+```text
+棣栨閫氫俊
+message涓猴紙闇�瑕佺敤json搴忓垪鍖栵級锛�
+{"mode": "offline", "wav_name": "wav_name", "is_speaking": True, "wav_format":"pcm", "chunk_size":[5,10,5]}
+鍙傛暟浠嬬粛锛�
+`mode`锛歚offline`锛岃〃绀烘帹鐞嗘ā寮忎负涓�鍙ヨ瘽璇嗗埆锛沗online`锛岃〃绀烘帹鐞嗘ā寮忎负瀹炴椂璇煶璇嗗埆锛沗2pass`锛氳〃绀轰负瀹炴椂璇煶璇嗗埆锛屽苟涓旇璇濆彞灏鹃噰鐢ㄧ绾挎ā鍨嬭繘琛岀籂閿欍��
+`wav_name`锛氳〃绀洪渶瑕佹帹鐞嗛煶棰戞枃浠跺悕
+`wav_format`锛氳〃绀洪煶瑙嗛鏂囦欢鍚庣紑鍚嶏紝鍙�塸cm銆乵p3銆乵p4绛夛紙澶囨敞锛�1.0鐗堟湰鍙敮鎸乸cm闊抽娴侊級
+`is_speaking`锛氳〃绀烘柇鍙ュ熬鐐癸紝渚嬪锛寁ad鍒囧壊鐐癸紝鎴栬�呬竴鏉av缁撴潫
+`chunk_size`锛氳〃绀烘祦寮忔ā鍨媗atency閰嶇疆锛宍[5,10,5]`锛岃〃绀哄綋鍓嶉煶棰戜负600ms锛屽苟涓斿洖鐪�300ms锛屽彸鐪�300ms銆�
+`audio_fs`锛氬綋杈撳叆闊抽涓簆cm鏁版嵁鏃讹紝闇�瑕佸姞涓婇煶棰戦噰鏍风巼鍙傛暟
+
+鍙戦�侀煶棰戞暟鎹�
+鐩存帴灏嗛煶棰戞暟鎹紝绉婚櫎澶撮儴淇℃伅鍚庣殑bytes鏁版嵁鍙戦�侊紝鏀寔闊抽閲囨牱鐜囦负80000锛�16000
+鍙戦�佺粨鏉熸爣蹇�
+闊抽鏁版嵁鍙戦�佺粨鏉熷悗锛岄渶瑕佸彂閫佺粨鏉熸爣蹇楋紙闇�瑕佺敤json搴忓垪鍖栵級锛�
+{"is_speaking": False}
+```
--
Gitblit v1.9.1