From 89e244299c9a7b18b574c058148ddac96c2e9da7 Mon Sep 17 00:00:00 2001
From: 游雁 <zhifu.gzf@alibaba-inc.com>
Date: 星期二, 08 八月 2023 16:49:04 +0800
Subject: [PATCH] docs
---
funasr/runtime/docs/SDK_tutorial_online.md | 2 +-
docs/index.rst | 1 +
funasr/quick_start.md | 28 ++++++++++++++++++++++++----
funasr/quick_start_zh.md | 27 +++++++++++++++++++++------
4 files changed, 47 insertions(+), 11 deletions(-)
diff --git a/docs/index.rst b/docs/index.rst
index b9fbf2e..ae2dc1a 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -72,6 +72,7 @@
:caption: Runtime and Service
./funasr/runtime/docs/SDK_tutorial.md
+ ./funasr/runtime/docs/SDK_tutorial_online.md
./funasr/runtime/python/websocket/README.md
./funasr/runtime/websocket/readme.md
./funasr/runtime/html5/readme.md
diff --git a/funasr/quick_start.md b/funasr/quick_start.md
index 1e7f9c5..5731358 100644
--- a/funasr/quick_start.md
+++ b/funasr/quick_start.md
@@ -32,23 +32,43 @@
Currently, offline file transcription service (CPU) is supported, and concurrent requests of hundreds of channels are supported.
-#### Server Deployment
+##### The real-time transcription service, Mandarin (CPU)
+###### Server Deployment
+You can use the following command to complete the deployment:
+```shell
+curl -O https://isv-data.oss-cn-hangzhou.aliyuncs.com/ics/MaaS/ASR/shell/funasr-runtime-deploy-online-cpu-zh.sh
+sudo bash funasr-runtime-deploy-online-cpu-zh.sh install --workspace ./funasr-runtime-resources
+```
-You can use the following command to complete the deployment with one click:
+
+###### Client Testing
+Testing [samples](https://isv-data.oss-cn-hangzhou.aliyuncs.com/ics/MaaS/ASR/sample/funasr_samples.tar.gz)
+
+```shell
+python3 funasr_wss_client.py --host "127.0.0.1" --port 10095 --mode 2pass
+```
+For more examples, please refer to [docs](runtime/docs/SDK_tutorial_online_zh.md)
+
+
+#### File Transcription Service, Mandarin (CPU)
+
+##### Server Deployment
+
+You can use the following command to complete the deployment:
```shell
curl -O https://isv-data.oss-cn-hangzhou.aliyuncs.com/ics/MaaS/ASR/shell/funasr-runtime-deploy-offline-cpu-zh.sh
sudo bash funasr-runtime-deploy-offline-cpu-zh.sh install --workspace ./funasr-runtime-resources
```
-#### Client Testing
+##### Client Testing
Testing [samples](https://isv-data.oss-cn-hangzhou.aliyuncs.com/ics/MaaS/ASR/sample/funasr_samples.tar.gz)
```shell
python3 funasr_wss_client.py --host "127.0.0.1" --port 10095 --mode offline --audio_in "../audio/asr_example.wav"
```
-For more examples, please refer to [docs](https://github.com/alibaba-damo-academy/FunASR/blob/main/funasr/runtime/docs/SDK_tutorial_zh.md)
+For more examples, please refer to [docs](runtime/docs/SDK_tutorial_zh.md)
## Industrial Model Egs
diff --git a/funasr/quick_start_zh.md b/funasr/quick_start_zh.md
index 0617044..9da3cdc 100644
--- a/funasr/quick_start_zh.md
+++ b/funasr/quick_start_zh.md
@@ -31,21 +31,36 @@
<a name="cpp鐗堟湰绀轰緥"></a>
#### c++鐗堟湰绀轰緥
-鐩墠宸叉敮鎸佺绾挎枃浠惰浆鍐欐湇鍔★紙CPU锛夛紝鏀寔涓婄櫨璺苟鍙戣姹�
+闆嗘垚鏈夛紝VAD锛孉SR涓庢爣鐐规仮澶嶆ā鍨嬶紝鏀寔涓婄櫨璺苟鍙戣姹�
-##### 鏈嶅姟绔儴缃�
-鍙互鐢ㄤ釜涓嬮潰鎸囦护锛屼竴閿儴缃插畬鎴愰儴缃�
+##### 瀹炴椂璇煶鍚啓鏈嶅姟閮ㄧ讲
+
+```shell
+curl -O https://isv-data.oss-cn-hangzhou.aliyuncs.com/ics/MaaS/ASR/shell/funasr-runtime-deploy-online-cpu-zh.sh
+sudo bash funasr-runtime-deploy-online-cpu-zh.sh install --workspace ./funasr-runtime-resources
+```
+
+##### 瀹㈡埛绔祴璇曚笌浣跨敤
+瀹㈡埛绔祴璇曪紙[samples](https://isv-data.oss-cn-hangzhou.aliyuncs.com/ics/MaaS/ASR/sample/funasr_samples.tar.gz)锛�
+
+```shell
+python3 funasr_wss_client.py --host "127.0.0.1" --port 10095 --mode 2pass
+```
+鏇村渚嬪瓙鍙傝�冿紙[鐐瑰嚮姝ゅ](runtime/docs/SDK_tutorial_online_zh.md)锛�
+
+##### 绂荤嚎鏂囦欢杞啓鏈嶅姟閮ㄧ讲
+###### 鏈嶅姟绔儴缃�
```shell
curl -O https://isv-data.oss-cn-hangzhou.aliyuncs.com/ics/MaaS/ASR/shell/funasr-runtime-deploy-offline-cpu-zh.sh
sudo bash funasr-runtime-deploy-offline-cpu-zh.sh install --workspace ./funasr-runtime-resources
```
-
-##### 瀹㈡埛绔祴璇�
+###### 瀹㈡埛绔祴璇�
瀹㈡埛绔祴璇曪紙[samples](https://isv-data.oss-cn-hangzhou.aliyuncs.com/ics/MaaS/ASR/sample/funasr_samples.tar.gz)锛�
```shell
python3 funasr_wss_client.py --host "127.0.0.1" --port 10095 --mode offline --audio_in "../audio/asr_example.wav"
```
-鏇村渚嬪瓙鍙傝�冿紙[鐐瑰嚮姝ゅ](funasr/runtime/docs/SDK_tutorial_zh.md)锛�
+鏇村渚嬪瓙鍙傝�冿紙[鐐瑰嚮姝ゅ](runtime/docs/SDK_tutorial_zh.md)锛�
+
### 宸ヤ笟妯″瀷egs
diff --git a/funasr/runtime/docs/SDK_tutorial_online.md b/funasr/runtime/docs/SDK_tutorial_online.md
index de7ea72..10bc6b9 100644
--- a/funasr/runtime/docs/SDK_tutorial_online.md
+++ b/funasr/runtime/docs/SDK_tutorial_online.md
@@ -1,6 +1,6 @@
([绠�浣撲腑鏂嘳(./SDK_tutorial_online_zh.md)|English)
-# FunASR-realtime-transcribe service
+# FunASR Realtime Transcribe Service
FunASR offers a real-time speech-to-text service that can be easily deployed locally or on cloud servers. The service integrates various capabilities developed by the speech laboratory of DAMO Academy on the ModelScope, including voice activity detection (VAD), Paraformer-large non-streaming automatic speech recognition (ASR), Paraformer-large streaming ASR, and punctuation prediction (PUNC). The software package supports realtime speech-to-text service as well as high-precision transcription text correction at the end of each sentence and outputs text with punctuation.
--
Gitblit v1.9.1