From c857b7dd67b560b2725eebf1d0989164c6cac3f5 Mon Sep 17 00:00:00 2001
From: 游雁 <zhifu.gzf@alibaba-inc.com>
Date: 星期三, 08 十一月 2023 10:38:32 +0800
Subject: [PATCH] docs

---
 /dev/null                                |    1 -
 runtime/docs/images/sdk_roadmap.jpg      |    0 
 runtime/readme_cn.md                     |    6 ++++--
 docs/index.rst                           |    8 ++++----
 egs_modelscope/asr/TEMPLATE/README_zh.md |    4 +---
 README_zh.md                             |   10 +++++-----
 docs/runtime                             |    1 +
 7 files changed, 15 insertions(+), 15 deletions(-)

diff --git a/README_zh.md b/README_zh.md
index 50ae678..8b188b7 100644
--- a/README_zh.md
+++ b/README_zh.md
@@ -19,7 +19,7 @@
 锝�<a href="#蹇�熷紑濮�"> 蹇�熷紑濮� </a>
 锝�<a href="https://alibaba-damo-academy.github.io/FunASR/en/index.html"> 鏁欑▼鏂囨。 </a>
 锝�<a href="./docs/model_zoo/modelscope_models.md"> 妯″瀷浠撳簱 </a>
-锝�<a href="./runtime/readme_cn.md"> 鏈嶅姟閮ㄧ讲 </a>
+锝�<a href="#鏈嶅姟閮ㄧ讲"> 鏈嶅姟閮ㄧ讲 </a>
 锝�<a href="#鑱旂郴鎴戜滑"> 鑱旂郴鎴戜滑 </a>
 </h4>
 </div>
@@ -31,12 +31,12 @@
 
 <a name="鏈�鏂板姩鎬�"></a>
 ## 鏈�鏂板姩鎬�
-- 20223/10/17: 鑻辨枃绂荤嚎鏂囦欢杞啓鏈嶅姟涓�閿儴缃茬殑CPU鐗堟湰鍙戝竷锛岃缁嗕俊鎭弬闃�([涓�閿儴缃叉枃妗(funasr/runtime/docs/SDK_tutorial_en_zh.md))
+- 20223/10/17: 鑻辨枃绂荤嚎鏂囦欢杞啓鏈嶅姟涓�閿儴缃茬殑CPU鐗堟湰鍙戝竷锛岃缁嗕俊鎭弬闃�([涓�閿儴缃叉枃妗(runtime/readme_cn.html#cpu))
 - 2023/10/13: [SlideSpeech](https://slidespeech.github.io/): 涓�涓ぇ瑙勬ā鐨勫妯℃�侀煶瑙嗛璇枡搴擄紝涓昏鏄湪绾夸細璁垨鑰呭湪绾胯绋嬪満鏅紝鍖呭惈浜嗗ぇ閲忎笌鍙戣█浜鸿璇濆疄鏃跺悓姝ョ殑骞荤伅鐗囥��
 - 2023.10.10: [Paraformer-long-Spk](https://github.com/alibaba-damo-academy/FunASR/blob/main/egs_modelscope/asr_vad_spk/speech_paraformer-large-vad-punc-spk_asr_nat-zh-cn/demo.py)妯″瀷鍙戝竷锛屾敮鎸佸湪闀胯闊宠瘑鍒殑鍩虹涓婅幏鍙栨瘡鍙ヨ瘽鐨勮璇濅汉鏍囩銆�
 - 2023.10.07: [FunCodec](https://github.com/alibaba-damo-academy/FunCodec): FunCodec鎻愪緵寮�婧愭ā鍨嬪拰璁粌宸ュ叿锛屽彲浠ョ敤浜庨煶棰戠鏁g紪鐮侊紝浠ュ強鍩轰簬绂绘暎缂栫爜鐨勮闊宠瘑鍒�佽闊冲悎鎴愮瓑浠诲姟銆�
-- 2023.09.01: 涓枃绂荤嚎鏂囦欢杞啓鏈嶅姟2.0 CPU鐗堟湰鍙戝竷锛屾柊澧瀎fmpeg銆佹椂闂存埑涓庣儹璇嶆ā鍨嬫敮鎸侊紝璇︾粏淇℃伅鍙傞槄([涓�閿儴缃叉枃妗(funasr/runtime/docs/SDK_tutorial_zh.md))
-- 2023.08.07: 涓枃瀹炴椂璇煶鍚啓鏈嶅姟涓�閿儴缃茬殑CPU鐗堟湰鍙戝竷锛岃缁嗕俊鎭弬闃�([涓�閿儴缃叉枃妗(funasr/runtime/docs/SDK_tutorial_online_zh.md))
+- 2023.09.01: 涓枃绂荤嚎鏂囦欢杞啓鏈嶅姟2.0 CPU鐗堟湰鍙戝竷锛屾柊澧瀎fmpeg銆佹椂闂存埑涓庣儹璇嶆ā鍨嬫敮鎸侊紝璇︾粏淇℃伅鍙傞槄([涓�閿儴缃叉枃妗(runtime/readme_cn.html#id6))
+- 2023.08.07: 涓枃瀹炴椂璇煶鍚啓鏈嶅姟涓�閿儴缃茬殑CPU鐗堟湰鍙戝竷锛岃缁嗕俊鎭弬闃�([涓�閿儴缃叉枃妗(runtime/readme_cn.html#id3))
 - 2023.07.17: BAT涓�绉嶄綆寤惰繜浣庡唴瀛樻秷鑰楃殑RNN-T妯″瀷鍙戝竷锛岃缁嗕俊鎭弬闃咃紙[BAT](egs/aishell/bat)锛�
 - 2023.06.26: ASRU2023 澶氶�氶亾澶氭柟浼氳杞綍鎸戞垬璧�2.0瀹屾垚绔炶禌缁撴灉鍏竷锛岃缁嗕俊鎭弬闃咃紙[M2MeT2.0](https://alibaba-damo-academy.github.io/FunASR/m2met2_cn/index.html)锛�
 
@@ -116,7 +116,7 @@
 - 涓枃绂荤嚎鏂囦欢杞啓鏈嶅姟锛圙PU鐗堟湰锛夛紝杩涜涓�
 - 鏇村鏀寔涓�
 
-璇︾粏淇℃伅鍙互鍙傞槄([鏈嶅姟閮ㄧ讲鏂囨。](funasr/runtime/readme_cn.md))銆�
+璇︾粏淇℃伅鍙互鍙傞槄([鏈嶅姟閮ㄧ讲鏂囨。](runtime/readme_cn.md))銆�
 
 
 <a name="绀惧尯浜ゆ祦"></a>
diff --git a/docs/index.rst b/docs/index.rst
index b79aee0..bf4268b 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -71,10 +71,10 @@
    :maxdepth: 1
    :caption: Runtime and Service
 
-   ./funasr/runtime/readme.md
-   ./funasr/runtime/docs/SDK_tutorial_online.md
-   ./funasr/runtime/docs/SDK_tutorial.md
-   ./funasr/runtime/html5/readme.md
+   ./runtime/readme.md
+   ./runtime/docs/SDK_tutorial_online.md
+   ./runtime/docs/SDK_tutorial.md
+   ./runtime/html5/readme.md
 
 
 
diff --git a/docs/runtime b/docs/runtime
new file mode 120000
index 0000000..3d1f990
--- /dev/null
+++ b/docs/runtime
@@ -0,0 +1 @@
+../runtime
\ No newline at end of file
diff --git a/docs/runtime/demo.gif b/docs/runtime/demo.gif
deleted file mode 100644
index f487f2c..0000000
--- a/docs/runtime/demo.gif
+++ /dev/null
Binary files differ
diff --git a/docs/runtime/export.md b/docs/runtime/export.md
deleted file mode 120000
index 91f8b98..0000000
--- a/docs/runtime/export.md
+++ /dev/null
@@ -1 +0,0 @@
-../../funasr/export/README.md
\ No newline at end of file
diff --git a/docs/runtime/grpc_cpp.md b/docs/runtime/grpc_cpp.md
deleted file mode 120000
index 590a5f7..0000000
--- a/docs/runtime/grpc_cpp.md
+++ /dev/null
@@ -1 +0,0 @@
-../../funasr/runtime/grpc/Readme.md
\ No newline at end of file
diff --git a/docs/runtime/grpc_python.md b/docs/runtime/grpc_python.md
deleted file mode 120000
index ee8d6ea..0000000
--- a/docs/runtime/grpc_python.md
+++ /dev/null
@@ -1 +0,0 @@
-../../funasr/runtime/python/grpc/Readme.md
\ No newline at end of file
diff --git a/docs/runtime/html5.md b/docs/runtime/html5.md
deleted file mode 120000
index bf47840..0000000
--- a/docs/runtime/html5.md
+++ /dev/null
@@ -1 +0,0 @@
-../../funasr/runtime/html5/readme.md
\ No newline at end of file
diff --git a/docs/runtime/img.png b/docs/runtime/img.png
deleted file mode 100644
index 84e2efe..0000000
--- a/docs/runtime/img.png
+++ /dev/null
Binary files differ
diff --git a/docs/runtime/libtorch_python.md b/docs/runtime/libtorch_python.md
deleted file mode 120000
index e8d6288..0000000
--- a/docs/runtime/libtorch_python.md
+++ /dev/null
@@ -1 +0,0 @@
-../../funasr/runtime/python/libtorch/README.md
\ No newline at end of file
diff --git a/docs/runtime/onnxruntime_cpp.md b/docs/runtime/onnxruntime_cpp.md
deleted file mode 120000
index 3661d18..0000000
--- a/docs/runtime/onnxruntime_cpp.md
+++ /dev/null
@@ -1 +0,0 @@
-../../funasr/runtime/onnxruntime/readme.md
\ No newline at end of file
diff --git a/docs/runtime/onnxruntime_python.md b/docs/runtime/onnxruntime_python.md
deleted file mode 120000
index 693bd5d..0000000
--- a/docs/runtime/onnxruntime_python.md
+++ /dev/null
@@ -1 +0,0 @@
-../../funasr/runtime/python/onnxruntime/README.md
\ No newline at end of file
diff --git a/docs/runtime/websocket_cpp.md b/docs/runtime/websocket_cpp.md
deleted file mode 120000
index 8a87df5..0000000
--- a/docs/runtime/websocket_cpp.md
+++ /dev/null
@@ -1 +0,0 @@
-../../funasr/runtime/websocket/readme.md
\ No newline at end of file
diff --git a/docs/runtime/websocket_python.md b/docs/runtime/websocket_python.md
deleted file mode 120000
index 0fabb85..0000000
--- a/docs/runtime/websocket_python.md
+++ /dev/null
@@ -1 +0,0 @@
-../../funasr/runtime/python/websocket/README.md
\ No newline at end of file
diff --git a/egs_modelscope/asr/TEMPLATE/README_zh.md b/egs_modelscope/asr/TEMPLATE/README_zh.md
index 0754bc6..583e63a 100644
--- a/egs_modelscope/asr/TEMPLATE/README_zh.md
+++ b/egs_modelscope/asr/TEMPLATE/README_zh.md
@@ -30,12 +30,10 @@
     task=Tasks.auto_speech_recognition,
     model='damo/speech_paraformer-large-vad-punc_asr_nat-zh-cn-16k-common-vocab8404-pytorch',
     vad_model='damo/speech_fsmn_vad_zh-cn-16k-common-pytorch',
-    #punc_model='damo/punc_ct-transformer_zh-cn-common-vocab272727-pytorch',
     punc_model='damo/punc_ct-transformer_cn-en-common-vocab471067-large',
 )
 
-rec_result = inference_pipeline(audio_in='https://isv-data.oss-cn-hangzhou.aliyuncs.com/ics/MaaS/ASR/test_audio/vad_example.wav', 
-                                batch_size_token=5000, batch_size_token_threshold_s=40, max_single_segment_time=6000)
+rec_result = inference_pipeline(audio_in='./vad_example.wav')
 print(rec_result)
 ```
 鍏朵腑锛� 
diff --git a/runtime/docs/images/sdk_roadmap.jpg b/runtime/docs/images/sdk_roadmap.jpg
new file mode 100644
index 0000000..b8e5010
--- /dev/null
+++ b/runtime/docs/images/sdk_roadmap.jpg
Binary files differ
diff --git a/runtime/readme_cn.md b/runtime/readme_cn.md
index 26ed1f0..57feae6 100644
--- a/runtime/readme_cn.md
+++ b/runtime/readme_cn.md
@@ -2,8 +2,10 @@
 
 English Version锛圼docs](./readme.md)锛�
 
-FunASR鏄敱杈炬懇闄㈣闊冲疄楠屽寮�婧愮殑涓�娆捐闊宠瘑鍒熀纭�妗嗘灦锛岄泦鎴愪簡璇煶绔偣妫�娴嬨�佽闊宠瘑鍒�佹爣鐐规柇鍙ョ瓑棰嗗煙鐨勫伐涓氱骇鍒ā鍨嬶紝鍚稿紩浜嗕紬澶氬紑鍙戣�呭弬涓庝綋楠屽拰寮�鍙戙�備负浜嗚В鍐冲伐涓氳惤鍦扮殑鏈�鍚庝竴鍏噷锛屽皢妯″瀷闆嗘垚鍒颁笟鍔′腑鍘伙紝鎴戜滑寮�鍙戜簡FunASR runtime-SDK銆�
-SDK 鏀寔浠ヤ笅鍑犵鏈嶅姟閮ㄧ讲锛�
+FunASR鏄敱闃块噷宸村反閫氫箟-璇煶瀹為獙瀹ゅ紑婧愮殑涓�娆捐闊宠瘑鍒熀纭�妗嗘灦锛岄泦鎴愪簡璇煶绔偣妫�娴嬨�佽闊宠瘑鍒�佹爣鐐规柇鍙ョ瓑棰嗗煙鐨勫伐涓氱骇鍒ā鍨嬶紝鍚稿紩浜嗕紬澶氬紑鍙戣�呭弬涓庝綋楠屽拰寮�鍙戙�備负浜嗚В鍐冲伐涓氳惤鍦扮殑鏈�鍚庝竴鍏噷锛屽皢妯″瀷闆嗘垚鍒颁笟鍔′腑鍘伙紝鎴戜滑寮�鍙戜簡绀惧尯杞欢鍖呫��
+鏀寔浠ヤ笅鍑犵鏈嶅姟閮ㄧ讲锛�
+
+<img src="docs/images/sdk_roadmap.jpg"  width="900"/>
 
 - 涓枃绂荤嚎鏂囦欢杞啓鏈嶅姟锛圕PU鐗堟湰锛夛紝宸插畬鎴�
 - 涓枃娴佸紡璇煶璇嗗埆鏈嶅姟锛圕PU鐗堟湰锛夛紝宸插畬鎴�

--
Gitblit v1.9.1