From 743b9fbc35e1dbb1aa0c627b8bb7953098cbfee1 Mon Sep 17 00:00:00 2001
From: 游雁 <zhifu.gzf@alibaba-inc.com>
Date: 星期四, 09 十一月 2023 18:47:07 +0800
Subject: [PATCH] docs
---
runtime/docs/SDK_advanced_guide_offline_zh.md | 2
funasr/quick_start_zh.md | 90 +++++++++++++++++++++++++++++++++++++++-----
README.md | 2
3 files changed, 81 insertions(+), 13 deletions(-)
diff --git a/README.md b/README.md
index 3f6b434..f73c0ca 100644
--- a/README.md
+++ b/README.md
@@ -54,7 +54,7 @@
|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------:|:---------------------------------------------------------------------------:|:--------------------------------:|:----------:|
| <nobr>paraformer-zh ([猸怾(https://www.modelscope.cn/models/damo/speech_paraformer-large-vad-punc_asr_nat-zh-cn-16k-common-vocab8404-pytorch/summary) [馃]() )</nobr> | speech recognition, with timestamps, non-streaming | 60000 hours, Mandarin | 220M |
| <nobr>paraformer-zh-spk ( [猸怾(https://modelscope.cn/models/damo/speech_paraformer-large-vad-punc-spk_asr_nat-zh-cn/summary) [馃]() )</nobr> | speech recognition with speaker diarization, with timestamps, non-streaming | 60000 hours, Mandarin | 220M |
-| <nobr>paraformer-zh-online ( [猸怾(https://modelscope.cn/models/damo/speech_paraformer-large_asr_nat-zh-cn-16k-common-vocab8404-online/summary) [馃]() )</nobr> | speech recognition, non-streaming | 60000 hours, Mandarin | 220M |
+| <nobr>paraformer-zh-online ( [猸怾(https://modelscope.cn/models/damo/speech_paraformer-large_asr_nat-zh-cn-16k-common-vocab8404-online/summary) [馃]() )</nobr> | speech recognition, streaming | 60000 hours, Mandarin | 220M |
| <nobr>paraformer-en ( [猸怾(https://www.modelscope.cn/models/damo/speech_paraformer-large-vad-punc_asr_nat-en-16k-common-vocab10020/summary) [馃]() )</nobr> | speech recognition, with timestamps, non-streaming | 50000 hours, English | 220M |
| <nobr>paraformer-en-spk ([馃]() [猸怾() )</nobr> | speech recognition with speaker diarization, non-streaming | 50000 hours, English | 220M |
| <nobr>conformer-en ( [猸怾(https://modelscope.cn/models/damo/speech_conformer_asr-en-16k-vocab4199-pytorch/summary) [馃]() )</nobr> | speech recognition, non-streaming | 50000 hours, English | 220M |
diff --git a/funasr/quick_start_zh.md b/funasr/quick_start_zh.md
index 9a3c2c9..94ec434 100644
--- a/funasr/quick_start_zh.md
+++ b/funasr/quick_start_zh.md
@@ -5,11 +5,11 @@
鎮ㄥ彲浠ラ�氳繃濡備笅鍑犵鏂瑰紡浣跨敤FunASR鍔熻兘:
-- 鏈嶅姟閮ㄧ讲SDK
+- 鏈嶅姟閮ㄧ讲绀惧尯杞欢鍖�
- 宸ヤ笟妯″瀷egs
- 瀛︽湳妯″瀷egs
-### 鏈嶅姟閮ㄧ讲SDK
+### 鏈嶅姟閮ㄧ讲绀惧尯杞欢鍖�
#### python鐗堟湰绀轰緥
@@ -31,13 +31,49 @@
<a name="cpp鐗堟湰绀轰緥"></a>
#### c++鐗堟湰绀轰緥
-闆嗘垚鏈夛紝VAD锛孉SR涓庢爣鐐规仮澶嶆ā鍨嬶紝鏀寔涓婄櫨璺苟鍙戣姹�
+鏃㈠彲浠ヨ繘琛岄珮绮惧害銆侀珮鏁堢巼涓庨珮骞跺彂鐨勬枃浠惰浆鍐欙紝涔熷彲浠ヨ繘琛屼綆寤舵椂鐨勫疄鏃惰闊冲惉鍐欍�傛敮鎸丏ocker鍖栭儴缃诧紝澶氳矾璇锋眰銆�
+
+##### 鍑嗗宸ヤ綔锛歞ocker瀹夎锛堝彲閫夛級
+###### 濡傛灉鎮ㄥ凡瀹夎docker锛屽拷鐣ユ湰姝ラ
+
+```shell
+curl -O https://isv-data.oss-cn-hangzhou.aliyuncs.com/ics/MaaS/ASR/shell/install_docker.sh锛�
+sudo bash install_docker.sh
+```
##### 瀹炴椂璇煶鍚啓鏈嶅姟閮ㄧ讲
+###### docker闀滃儚涓嬭浇涓庡惎鍔�
+閫氳繃涓嬭堪鍛戒护鎷夊彇骞跺惎鍔‵unASR杞欢鍖卍ocker闀滃儚锛圼鑾峰彇鏈�鏂伴暅鍍忕増鏈琞(https://github.com/alibaba-damo-academy/FunASR/blob/main/runtime/docs/SDK_advanced_guide_online_zh.md)锛夛細
+
```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
+sudo docker pull \
+ registry.cn-hangzhou.aliyuncs.com/funasr_repo/funasr:funasr-runtime-sdk-online-cpu-0.1.5
+mkdir -p ./funasr-runtime-resources/models
+sudo docker run -p 10096:10095 -it --privileged=true \
+ -v $PWD/funasr-runtime-resources/models:/workspace/models \
+ registry.cn-hangzhou.aliyuncs.com/funasr_repo/funasr:funasr-runtime-sdk-online-cpu-0.1.5
+```
+
+###### 鏈嶅姟绔惎鍔�
+docker鍚姩涔嬪悗锛屽惎鍔� funasr-wss-server-2pass鏈嶅姟绋嬪簭锛�
+```shell
+cd FunASR/runtime
+nohup bash run_server_2pass.sh \
+ --download-model-dir /workspace/models \
+ --vad-dir damo/speech_fsmn_vad_zh-cn-16k-common-onnx \
+ --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 \
+ --punc-dir damo/punc_ct-transformer_zh-cn-common-vad_realtime-vocab272727-onnx \
+ --itn-dir thuduj12/fst_itn_zh \
+ --hotword /workspace/models/hotwords.txt > log.out 2>&1 &
+
+# 濡傛灉鎮ㄦ兂鍏抽棴ssl锛屽鍔犲弬鏁帮細--certfile 0
+# 濡傛灉鎮ㄦ兂浣跨敤鏃堕棿鎴虫垨鑰卬n鐑瘝妯″瀷杩涜閮ㄧ讲锛岃璁剧疆--model-dir涓哄搴旀ā鍨嬶細
+# damo/speech_paraformer-large-vad-punc_asr_nat-zh-cn-16k-common-vocab8404-onnx锛堟椂闂存埑锛�
+# damo/speech_paraformer-large-contextual_asr_nat-zh-cn-16k-common-vocab8404-onnx锛坣n鐑瘝锛�
+# 濡傛灉鎮ㄦ兂鍦ㄦ湇鍔＄鍔犺浇鐑瘝锛岃鍦ㄥ涓绘満鏂囦欢./funasr-runtime-resources/models/hotwords.txt閰嶇疆鐑瘝锛坉ocker鏄犲皠鍦板潃涓�/workspace/models/hotwords.txt锛�:
+# 姣忚涓�涓儹璇嶏紝鏍煎紡(鐑瘝 鏉冮噸)锛氶樋閲屽反宸� 20
```
##### 瀹㈡埛绔祴璇曚笌浣跨敤
@@ -46,20 +82,52 @@
```shell
python3 funasr_wss_client.py --host "127.0.0.1" --port 10095 --mode 2pass
```
-鏇村渚嬪瓙鍙傝�冿紙[鐐瑰嚮姝ゅ](../runtime/docs/SDK_tutorial_online_zh.md)锛�
+鏇村渚嬪瓙鍙傝�冿紙[鐐瑰嚮姝ゅ](https://github.com/alibaba-damo-academy/FunASR/blob/main/runtime/docs/SDK_advanced_guide_online_zh.md)锛�
##### 绂荤嚎鏂囦欢杞啓鏈嶅姟閮ㄧ讲
-###### 鏈嶅姟绔儴缃�
+
+###### 闀滃儚鍚姩
+
+閫氳繃涓嬭堪鍛戒护鎷夊彇骞跺惎鍔‵unASR杞欢鍖卍ocker闀滃儚锛圼鑾峰彇鏈�鏂伴暅鍍忕増鏈琞(https://github.com/alibaba-damo-academy/FunASR/blob/main/runtime/docs/SDK_advanced_guide_offline_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
+sudo docker pull \
+ registry.cn-hangzhou.aliyuncs.com/funasr_repo/funasr:funasr-runtime-sdk-cpu-0.3.0
+mkdir -p ./funasr-runtime-resources/models
+sudo docker run -p 10095:10095 -it --privileged=true \
+ -v $PWD/funasr-runtime-resources/models:/workspace/models \
+ registry.cn-hangzhou.aliyuncs.com/funasr_repo/funasr:funasr-runtime-sdk-cpu-0.3.0
```
+
+
+###### 鏈嶅姟绔惎鍔�
+
+docker鍚姩涔嬪悗锛屽惎鍔� funasr-wss-server鏈嶅姟绋嬪簭锛�
+```shell
+cd FunASR/runtime
+nohup bash run_server.sh \
+ --download-model-dir /workspace/models \
+ --vad-dir damo/speech_fsmn_vad_zh-cn-16k-common-onnx \
+ --model-dir damo/speech_paraformer-large_asr_nat-zh-cn-16k-common-vocab8404-onnx \
+ --punc-dir damo/punc_ct-transformer_cn-en-common-vocab471067-large-onnx \
+ --lm-dir damo/speech_ngram_lm_zh-cn-ai-wesp-fst \
+ --itn-dir thuduj12/fst_itn_zh \
+ --hotword /workspace/models/hotwords.txt > log.out 2>&1 &
+
+# 濡傛灉鎮ㄦ兂鍏抽棴ssl锛屽鍔犲弬鏁帮細--certfile 0
+# 濡傛灉鎮ㄦ兂浣跨敤鏃堕棿鎴虫垨鑰卬n鐑瘝妯″瀷杩涜閮ㄧ讲锛岃璁剧疆--model-dir涓哄搴旀ā鍨嬶細
+# damo/speech_paraformer-large-vad-punc_asr_nat-zh-cn-16k-common-vocab8404-onnx锛堟椂闂存埑锛�
+# damo/speech_paraformer-large-contextual_asr_nat-zh-cn-16k-common-vocab8404-onnx锛坣n鐑瘝锛�
+# 濡傛灉鎮ㄦ兂鍦ㄦ湇鍔＄鍔犺浇鐑瘝锛岃鍦ㄥ涓绘満鏂囦欢./funasr-runtime-resources/models/hotwords.txt閰嶇疆鐑瘝锛坉ocker鏄犲皠鍦板潃涓�/workspace/models/hotwords.txt锛�:
+# 姣忚涓�涓儹璇嶏紝鏍煎紡(鐑瘝 鏉冮噸)锛氶樋閲屽反宸� 20
+```
+
###### 瀹㈡埛绔祴璇�
瀹㈡埛绔祴璇曪紙[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"
```
-鏇村渚嬪瓙鍙傝�冿紙[鐐瑰嚮姝ゅ](../runtime/docs/SDK_tutorial_zh.md)锛�
+鏇村渚嬪瓙鍙傝�冿紙[鐐瑰嚮姝ゅ](https://github.com/alibaba-damo-academy/FunASR/blob/main/runtime/docs/SDK_advanced_guide_offline_zh.md)锛�
@@ -74,7 +142,7 @@
inference_pipeline = pipeline(
task=Tasks.auto_speech_recognition,
- model='damo/speech_paraformer-large_asr_nat-zh-cn-16k-common-vocab8404-pytorch',
+ model='damo/speech_paraformer-large-vad-punc_asr_nat-zh-cn-16k-common-vocab8404-pytorch',
)
rec_result = inference_pipeline(audio_in='https://isv-data.oss-cn-hangzhou.aliyuncs.com/ics/MaaS/ASR/test_audio/asr_example_zh.wav')
diff --git a/runtime/docs/SDK_advanced_guide_offline_zh.md b/runtime/docs/SDK_advanced_guide_offline_zh.md
index 4bf1cd1..03cf8e7 100644
--- a/runtime/docs/SDK_advanced_guide_offline_zh.md
+++ b/runtime/docs/SDK_advanced_guide_offline_zh.md
@@ -38,7 +38,7 @@
### 闀滃儚鍚姩
-閫氳繃涓嬭堪鍛戒护鎷夊彇骞跺惎鍔‵unASR runtime-SDK鐨刣ocker闀滃儚锛�
+閫氳繃涓嬭堪鍛戒护鎷夊彇骞跺惎鍔‵unASR杞欢鍖呯殑docker闀滃儚锛�
```shell
sudo docker pull \
--
Gitblit v1.9.1