From 6836bfb77f95fa20500f41948cc6685651e9fc76 Mon Sep 17 00:00:00 2001
From: 游雁 <zhifu.gzf@alibaba-inc.com>
Date: 星期一, 07 八月 2023 09:23:17 +0800
Subject: [PATCH] funasr streaming sdk

---
 funasr/runtime/docs/SDK_tutorial_online_zh.md |   68 ++++++++++-----------------------
 1 files changed, 21 insertions(+), 47 deletions(-)

diff --git a/funasr/runtime/docs/SDK_tutorial_online_zh.md b/funasr/runtime/docs/SDK_tutorial_online_zh.md
index 9036b8d..400f2c0 100644
--- a/funasr/runtime/docs/SDK_tutorial_online_zh.md
+++ b/funasr/runtime/docs/SDK_tutorial_online_zh.md
@@ -53,9 +53,9 @@
 - [CPP](#cpp-client)
 - [html](#html-client)
 - [java](#java-client)
-- [c#](#c#)
+- [c\#](#c\#)
 
-鏇村鐗堟湰瀹㈡埛绔敮鎸佽鍙傝�僛寮�鍙戞寚鍗梋(./SDK_advanced_guide_offline_zh.md)
+鏇村鐗堟湰瀹㈡埛绔敮鎸佽鍙傝�僛websocket/grpc鍗忚](./websocket_protocol_zh.md)
 
 ### python-client
 鑻ユ兂鐩存帴杩愯client杩涜娴嬭瘯锛屽彲鍙傝�冨涓嬬畝鏄撹鏄庯紝浠ython鐗堟湰涓轰緥锛�
@@ -112,27 +112,34 @@
 涓�閿儴缃插悗鑻ュ嚭鐜伴噸鍚數鑴戠瓑鍏抽棴Docker鐨勫姩浣滐紝鍙�氳繃濡備笅鍛戒护鐩存帴鍚姩FunASR鏈嶅姟锛屽惎鍔ㄩ厤缃负涓婃涓�閿儴缃茬殑璁剧疆銆�
 
 ```shell
-sudo bash funasr-runtime-deploy-offline-cpu-zh.sh start
+sudo bash funasr-runtime-deploy-online-cpu-zh.sh start
+```
+
+### 璁剧疆SSL
+
+榛樿寮�鍚疭SL鏍¢獙锛屽鏋滈渶瑕佸叧闂紝鍙互鍦ㄥ惎鍔ㄦ椂璁剧疆
+```shell
+sudo bash funasr-runtime-deploy-online-cpu-zh.sh start --ssl 0
 ```
 
 ### 鍏抽棴FunASR鏈嶅姟
 
 ```shell
-sudo bash funasr-runtime-deploy-offline-cpu-zh.sh stop
+sudo bash funasr-runtime-deploy-online-cpu-zh.sh stop
 ```
 
 ### 閲婃斁FunASR鏈嶅姟
 
 閲婃斁宸茬粡閮ㄧ讲鐨凢unASR鏈嶅姟銆�
 ```shell
-sudo bash funasr-runtime-deploy-offline-cpu-zh.sh remove
+sudo bash funasr-runtime-deploy-online-cpu-zh.sh remove
 ```
 
 ### 閲嶅惎FunASR鏈嶅姟
 
 鏍规嵁涓婃涓�閿儴缃茬殑璁剧疆閲嶅惎鍚姩FunASR鏈嶅姟銆�
 ```shell
-sudo bash funasr-runtime-deploy-offline-cpu-zh.sh restart
+sudo bash funasr-runtime-deploy-online-cpu-zh.sh restart
 ```
 
 ### 鏇挎崲妯″瀷骞堕噸鍚疐unASR鏈嶅姟
@@ -140,10 +147,10 @@
 鏇挎崲姝e湪浣跨敤鐨勬ā鍨嬶紝骞堕噸鏂板惎鍔‵unASR鏈嶅姟銆傛ā鍨嬮渶涓篗odelScope涓殑ASR/VAD/PUNC妯″瀷锛屾垨鑰呬粠ModelScope涓ā鍨媐inetune鍚庣殑妯″瀷銆�
 
 ```shell
-sudo bash funasr-runtime-deploy-offline-cpu-zh.sh update [--asr_model | --vad_model | --punc_model] <model_id or local model path>
+sudo bash funasr-runtime-deploy-online-cpu-zh.sh update [--asr_model | --vad_model | --punc_model] <model_id or local model path>
 
 e.g
-sudo bash funasr-runtime-deploy-offline-cpu-zh.sh update --asr_model damo/speech_paraformer-large_asr_nat-zh-cn-16k-common-vocab8404-pytorch
+sudo bash funasr-runtime-deploy-online-cpu-zh.sh update --asr_model damo/speech_paraformer-large_asr_nat-zh-cn-16k-common-vocab8404-pytorch
 ```
 
 ### 鏇存柊鍙傛暟骞堕噸鍚疐unASR鏈嶅姟
@@ -151,49 +158,16 @@
 鏇存柊宸查厤缃弬鏁帮紝骞堕噸鏂板惎鍔‵unASR鏈嶅姟鐢熸晥銆傚彲鏇存柊鍙傛暟鍖呮嫭瀹夸富鏈哄拰Docker鐨勭鍙e彿锛屼互鍙婃帹鐞嗗拰IO鐨勭嚎绋嬫暟閲忋��
 
 ```shell
-sudo bash funasr-runtime-deploy-offline-cpu-zh.sh update [--host_port | --docker_port] <port number>
-sudo bash funasr-runtime-deploy-offline-cpu-zh.sh update [--decode_thread_num | --io_thread_num] <the number of threads>
-sudo bash funasr-runtime-deploy-offline-cpu-zh.sh update [--workspace] <workspace in local>
-sudo bash funasr-runtime-deploy-offline-cpu-zh.sh update [--ssl] <0: close SSL; 1: open SSL, default:1>
+sudo bash funasr-runtime-deploy-online-cpu-zh.sh update [--host_port | --docker_port] <port number>
+sudo bash funasr-runtime-deploy-online-cpu-zh.sh update [--decode_thread_num | --io_thread_num] <the number of threads>
+sudo bash funasr-runtime-deploy-online-cpu-zh.sh update [--workspace] <workspace in local>
+sudo bash funasr-runtime-deploy-online-cpu-zh.sh update [--ssl] <0: close SSL; 1: open SSL, default:1>
 
 e.g
-sudo bash funasr-runtime-deploy-offline-cpu-zh.sh update --decode_thread_num 32
-sudo bash funasr-runtime-deploy-offline-cpu-zh.sh update --workspace /root/funasr-runtime-resources
+sudo bash funasr-runtime-deploy-online-cpu-zh.sh update --decode_thread_num 32
+sudo bash funasr-runtime-deploy-online-cpu-zh.sh update --workspace ./funasr-runtime-resources
 ```
 
-
-## 鏈嶅姟绔惎鍔ㄨ繃绋嬮厤缃瑙�
-
-### 閫夋嫨FunASR Docker闀滃儚
-鎺ㄨ崘閫夋嫨1)浣跨敤鎴戜滑鐨勬渶鏂板彂甯冪増闀滃儚锛屼篃鍙�夋嫨鍘嗗彶鐗堟湰銆�
-```text
-[1/5]
-  Getting the list of docker images, please wait a few seconds.
-    [DONE]
-
-  Please choose the Docker image.
-    1) registry.cn-hangzhou.aliyuncs.com/funasr_repo/funasr:funasr-runtime-sdk-cpu-0.1.0
-  Enter your choice, default(1):
-  You have chosen the Docker image: registry.cn-hangzhou.aliyuncs.com/funasr_repo/funasr:funasr-runtime-sdk-cpu-0.1.0
-```
-
-
-### 璁剧疆瀹夸富鏈烘彁渚涚粰FunASR鐨勭鍙�
-璁剧疆鎻愪緵缁橠ocker鐨勫涓绘満绔彛锛岄粯璁や负10095銆傝淇濊瘉姝ょ鍙e彲鐢ㄣ��
-```text
-[2/5]
-  Please input the opened port in the host used for FunASR server.
-  Setting the opened host port [1-65535], default(10095):
-  The port of the host is 10095
-  The port in Docker for FunASR server is 10095
-```
-
-### 璁剧疆SSL
-
-榛樿寮�鍚疭SL鏍¢獙锛屽鏋滈渶瑕佸叧闂紝鍙互鍦ㄥ惎鍔ㄦ椂璁剧疆
-```shell
-sudo bash funasr-runtime-deploy-offline-cpu-zh.sh --ssl 0
-```
 
 ## 鑱旂郴鎴戜滑
 

--
Gitblit v1.9.1