From 5f8f601110d100357e17ce32c07ef7d18c5130f8 Mon Sep 17 00:00:00 2001
From: 雾聪 <wucong.lyb@alibaba-inc.com>
Date: 星期二, 08 八月 2023 17:34:58 +0800
Subject: [PATCH] Merge branch 'main' of https://github.com/alibaba-damo-academy/FunASR into main
---
funasr/runtime/docs/SDK_tutorial_online.md | 13 ++--
funasr/runtime/docs/SDK_tutorial.md | 35 +----------
funasr/runtime/docs/SDK_tutorial_zh.md | 34 +----------
docs/index.rst | 2
funasr/quick_start.md | 28 ++++++++-
funasr/runtime/docs/SDK_tutorial_online_zh.md | 10 +-
funasr/runtime/readme_cn.md | 2
funasr/runtime/readme.md | 2
funasr/quick_start_zh.md | 27 +++++++--
9 files changed, 69 insertions(+), 84 deletions(-)
diff --git a/docs/index.rst b/docs/index.rst
index b9fbf2e..eb3016b 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -71,6 +71,8 @@
:maxdepth: 1
:caption: Runtime and Service
+
+ ./funasr/runtime/docs/SDK_tutorial_online.md
./funasr/runtime/docs/SDK_tutorial.md
./funasr/runtime/python/websocket/README.md
./funasr/runtime/websocket/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.md b/funasr/runtime/docs/SDK_tutorial.md
index 0624af3..48eadfd 100644
--- a/funasr/runtime/docs/SDK_tutorial.md
+++ b/funasr/runtime/docs/SDK_tutorial.md
@@ -1,6 +1,6 @@
([绠�浣撲腑鏂嘳(./SDK_tutorial_zh.md)|English)
-# FunASR Offline File Transcription Service Convenient Deployment Tutorial
+# FunASR Offline File Transcription Service
FunASR provides an offline file transcription service that can be easily deployed on a local or cloud server. The core is the FunASR open-source runtime-SDK. It integrates various capabilities such as speech endpoint detection (VAD) and Paraformer-large speech recognition (ASR) and punctuation restoration (PUNC) released by the speech laboratory of the Damo Academy in the Modelscope community. It has a complete speech recognition chain and can recognize audio or video of tens of hours into punctuated text. Moreover, it supports transcription for hundreds of simultaneous requests.
@@ -155,42 +155,15 @@
sudo bash funasr-runtime-deploy-offline-cpu-zh.sh update --workspace /root/funasr-runtime-resources
```
-
-## Detailed Configuration of Server Startup Process
-
-### Select FunASR Docker image
-We recommend choosing to use our latest released image, but you can also choose historical versions.
-
-```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
-```
-
-
-### Set the port provided by the host for FunASR
-Set the host port provided to Docker, which is 10095 by default. Please make sure that this port is available.
-
-```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
-```
-
### Set SSL
SSL verification is enabled by default. If you need to disable it, you can set it when starting.
```shell
-sudo bash funasr-runtime-deploy-offline-cpu-zh.sh --ssl 0
+sudo bash funasr-runtime-deploy-online-cpu-zh.sh update --ssl 0
```
+
+
## Contact Us
If you encounter any problems during use, please join our user group for feedback.
diff --git a/funasr/runtime/docs/SDK_tutorial_online.md b/funasr/runtime/docs/SDK_tutorial_online.md
index de7ea72..b4800bb 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.
@@ -112,12 +112,7 @@
sudo bash funasr-runtime-deploy-online-cpu-zh.sh start
```
-### Set SSL
-SSL verification is enabled by default. If you need to disable it, you can set it when starting.
-```shell
-sudo bash funasr-runtime-deploy-online-cpu-zh.sh --ssl 0
-```
### Stop the FunASR service
@@ -165,6 +160,12 @@
sudo bash funasr-runtime-deploy-online-cpu-zh.sh update --workspace ./funasr-runtime-resources
```
+### Set SSL
+
+SSL verification is enabled by default. If you need to disable it, you can set it when starting.
+```shell
+sudo bash funasr-runtime-deploy-online-cpu-zh.sh update --ssl 0
+```
## Contact Us
diff --git a/funasr/runtime/docs/SDK_tutorial_online_zh.md b/funasr/runtime/docs/SDK_tutorial_online_zh.md
index 071d397..89ba6f3 100644
--- a/funasr/runtime/docs/SDK_tutorial_online_zh.md
+++ b/funasr/runtime/docs/SDK_tutorial_online_zh.md
@@ -115,12 +115,7 @@
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鏈嶅姟
@@ -168,6 +163,11 @@
sudo bash funasr-runtime-deploy-online-cpu-zh.sh update --workspace ./funasr-runtime-resources
```
+### 鍏抽棴SSL璇佷功
+
+```shell
+sudo bash funasr-runtime-deploy-online-cpu-zh.sh update --ssl 0
+```
## 鑱旂郴鎴戜滑
diff --git a/funasr/runtime/docs/SDK_tutorial_zh.md b/funasr/runtime/docs/SDK_tutorial_zh.md
index f023b70..94a9479 100644
--- a/funasr/runtime/docs/SDK_tutorial_zh.md
+++ b/funasr/runtime/docs/SDK_tutorial_zh.md
@@ -157,40 +157,14 @@
sudo bash funasr-runtime-deploy-offline-cpu-zh.sh update --workspace /root/funasr-runtime-resources
```
+### 鍏抽棴SSL璇佷功
-## 鏈嶅姟绔惎鍔ㄨ繃绋嬮厤缃瑙�
-
-### 閫夋嫨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銆傝淇濊瘉姝ょ鍙ｅ彲鐢ㄣ��
-```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
+sudo bash funasr-runtime-deploy-online-cpu-zh.sh update --ssl 0
```
+
+
## 鑱旂郴鎴戜滑
鍦ㄦ偍浣跨敤杩囩▼涓紝濡傛灉閬囧埌闂锛屾杩庡姞鍏ョ敤鎴风兢杩涜鍙嶉
diff --git a/funasr/runtime/readme.md b/funasr/runtime/readme.md
index 7a82521..7980029 100644
--- a/funasr/runtime/readme.md
+++ b/funasr/runtime/readme.md
@@ -26,7 +26,7 @@
### Technology Principles Revealed
-The document introduces the technology principles behind the service, recognition accuracy, computing efficiency, and core advantages: convenience, high precision, high efficiency, and long audio chain. For detailed documentation, please refer to [docs]().
+The document introduces the technology principles behind the service, recognition accuracy, computing efficiency, and core advantages: convenience, high precision, high efficiency, and long audio chain. For detailed documentation, please refer to [docs](https://mp.weixin.qq.com/s/8He081-FM-9IEI4D-lxZ9w).
## File Transcription Service, Mandarin (CPU)
diff --git a/funasr/runtime/readme_cn.md b/funasr/runtime/readme_cn.md
index dd6cd81..c91dae7 100644
--- a/funasr/runtime/readme_cn.md
+++ b/funasr/runtime/readme_cn.md
@@ -27,7 +27,7 @@
### 鎶�鏈師鐞嗘彮绉�
-鏂囨。浠嬬粛浜嗚儗鍚庢妧鏈師鐞嗭紝璇嗗埆鍑嗙‘鐜囷紝璁＄畻鏁堢巼绛夛紝浠ュ強鏍稿績浼樺娍浠嬬粛锛氫究鎹枫�侀珮绮惧害銆侀珮鏁堢巼銆侀暱闊抽閾捐矾锛岃缁嗘枃妗ｅ弬鑰冿紙[鐐瑰嚮姝ゅ]()锛�
+鏂囨。浠嬬粛浜嗚儗鍚庢妧鏈師鐞嗭紝璇嗗埆鍑嗙‘鐜囷紝璁＄畻鏁堢巼绛夛紝浠ュ強鏍稿績浼樺娍浠嬬粛锛氫究鎹枫�侀珮绮惧害銆侀珮鏁堢巼銆侀暱闊抽閾捐矾锛岃缁嗘枃妗ｅ弬鑰冿紙[鐐瑰嚮姝ゅ](https://mp.weixin.qq.com/s/8He081-FM-9IEI4D-lxZ9w)锛�
--
Gitblit v1.9.1