From df3b3ca49cc8ab748f670a90560206b7a0531e4b Mon Sep 17 00:00:00 2001
From: 游雁 <zhifu.gzf@alibaba-inc.com>
Date: 星期一, 24 七月 2023 16:38:11 +0800
Subject: [PATCH] readme docs
---
docs/qick_start.md | 1
funasr/runtime/websocket/readme.md | 2
docs/quick_start_zh.md | 82 +++++++++++++++++++++++++++++++++++++++++
3 files changed, 84 insertions(+), 1 deletions(-)
diff --git a/docs/qick_start.md b/docs/qick_start.md
index e87a798..f608f98 100644
--- a/docs/qick_start.md
+++ b/docs/qick_start.md
@@ -1,3 +1,4 @@
+([绠�浣撲腑鏂嘳(./quick_start_zh.md)|English)
# Quick Start
diff --git a/docs/quick_start_zh.md b/docs/quick_start_zh.md
new file mode 100644
index 0000000..b0a1030
--- /dev/null
+++ b/docs/quick_start_zh.md
@@ -0,0 +1,82 @@
+(绠�浣撲腑鏂噟[English](./qick_start.md))
+
+<a name="蹇�熷紑濮�"></a>
+## 蹇�熷紑濮�
+
+鎮ㄥ彲浠ラ�氳繃濡備笅鍑犵鏂瑰紡浣跨敤FunASR鍔熻兘:
+
+- 鏈嶅姟閮ㄧ讲SDK
+- 宸ヤ笟妯″瀷egs
+- 瀛︽湳妯″瀷egs
+
+### 鏈嶅姟閮ㄧ讲SDK
+
+#### python鐗堟湰绀轰緥
+
+鏀寔瀹炴椂娴佸紡璇煶璇嗗埆锛屽苟涓斾細鐢ㄩ潪娴佸紡妯″瀷杩涜绾犻敊锛岃緭鍑烘枃鏈甫鏈夋爣鐐广�傜洰鍓嶅彧鏀寔鍗曚釜client锛屽闇�澶氬苟鍙戣鍙傝�冧笅鏂筩++鐗堟湰鏈嶅姟閮ㄧ讲SDK
+
+##### 鏈嶅姟绔儴缃�
+```shell
+cd funasr/runtime/python/websocket
+python funasr_wss_server.py --port 10095
+```
+
+##### 瀹㈡埛绔祴璇�
+```shell
+python funasr_wss_client.py --host "127.0.0.1" --port 10095 --mode 2pass --chunk_size "5,10,5"
+#python funasr_wss_client.py --host "127.0.0.1" --port 10095 --mode 2pass --chunk_size "8,8,4" --audio_in "./data/wav.scp"
+```
+鏇村渚嬪瓙鍙互鍙傝�冿紙[鐐瑰嚮姝ゅ](https://alibaba-damo-academy.github.io/FunASR/en/runtime/websocket_python.html#id2)锛�
+
+<a name="cpp鐗堟湰绀轰緥"></a>
+#### c++鐗堟湰绀轰緥
+
+鐩墠宸叉敮鎸佺绾挎枃浠惰浆鍐欐湇鍔★紙CPU锛夛紝鏀寔涓婄櫨璺苟鍙戣姹�
+
+##### 鏈嶅姟绔儴缃�
+鍙互鐢ㄤ釜涓嬮潰鎸囦护锛屼竴閿儴缃插畬鎴愰儴缃�
+```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
+```
+
+##### 瀹㈡埛绔祴璇�
+
+```shell
+python3 funasr_wss_client.py --host "127.0.0.1" --port 10095 --mode offline --audio_in "../audio/asr_example.wav"
+```
+鏇村渚嬪瓙鍙傝�冿紙[鐐瑰嚮姝ゅ](https://github.com/alibaba-damo-academy/FunASR/blob/main/funasr/runtime/docs/SDK_tutorial_zh.md)锛�
+
+
+### 宸ヤ笟妯″瀷egs
+
+濡傛灉鎮ㄥ笇鏈涗娇鐢∕odelScope涓璁粌濂界殑宸ヤ笟妯″瀷锛岃繘琛屾帹鐞嗘垨鑰呭井璋冭缁冿紝鎮ㄥ彲浠ュ弬鑰冧笅闈㈡寚浠わ細
+
+
+```python
+from modelscope.pipelines import pipeline
+from modelscope.utils.constant import Tasks
+
+inference_pipeline = pipeline(
+ task=Tasks.auto_speech_recognition,
+ model='damo/speech_paraformer-large_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')
+print(rec_result)
+# {'text': '娆㈣繋澶у鏉ヤ綋楠岃揪鎽╅櫌鎺ㄥ嚭鐨勮闊宠瘑鍒ā鍨�'}
+```
+
+鏇村渚嬪瓙鍙互鍙傝�冿紙[鐐瑰嚮姝ゅ](https://alibaba-damo-academy.github.io/FunASR/en/modelscope_pipeline/quick_start.html)锛�
+
+
+### 瀛︽湳妯″瀷egs
+
+濡傛灉鎮ㄥ笇鏈涗粠澶村紑濮嬭缁冿紝閫氬父涓哄鏈ā鍨嬶紝鎮ㄥ彲浠ラ�氳繃涓嬮潰鐨勬寚浠ゅ惎鍔ㄨ缁冧笌鎺ㄧ悊锛�
+
+```shell
+cd egs/aishell/paraformer
+. ./run.sh --CUDA_VISIBLE_DEVICES="0,1" --gpu_num=2
+```
+
+鏇村渚嬪瓙鍙互鍙傝�冿紙[鐐瑰嚮姝ゅ](https://alibaba-damo-academy.github.io/FunASR/en/academic_recipe/asr_recipe.html)锛�
\ No newline at end of file
diff --git a/funasr/runtime/websocket/readme.md b/funasr/runtime/websocket/readme.md
index eabb1a9..c72d143 100644
--- a/funasr/runtime/websocket/readme.md
+++ b/funasr/runtime/websocket/readme.md
@@ -44,7 +44,7 @@
python3 wss_client_asr.py --host "127.0.0.1" --port 10095 --mode offline --audio_in "../audio/asr_example.wav"
```
-## Building for Linux/Unix
+## Detailed Steps
### Dependencies Download and Install
--
Gitblit v1.9.1