From 8545d6b203cfaafc4711242d95e0fee340679620 Mon Sep 17 00:00:00 2001
From: 游雁 <zhifu.gzf@alibaba-inc.com>
Date: 星期四, 06 七月 2023 17:16:26 +0800
Subject: [PATCH] docs zh
---
funasr/runtime/python/onnxruntime/setup.py | 2
Acknowledge | 8 ++
README_zh.md | 198 +++++++++++++++++++++++++++++++++++++++++++++++++
README.md | 2
4 files changed, 209 insertions(+), 1 deletions(-)
diff --git a/Acknowledge b/Acknowledge
new file mode 100644
index 0000000..92d6e5e
--- /dev/null
+++ b/Acknowledge
@@ -0,0 +1,8 @@
+## Acknowledge
+
+1. We borrowed a lot of code from [Kaldi](http://kaldi-asr.org/) for data preparation.
+2. We borrowed a lot of code from [ESPnet](https://github.com/espnet/espnet). FunASR follows up the training and finetuning pipelines of ESPnet.
+3. We referred [Wenet](https://github.com/wenet-e2e/wenet) for building dataloader for large scale data training.
+4. We acknowledge [ChinaTelecom](https://github.com/zhuzizyf/damo-fsmn-vad-infer-httpserver) for contributing the VAD runtime.
+5. We acknowledge [RapidAI](https://github.com/RapidAI) for contributing the Paraformer and CT_Transformer-punc runtime.
+6. We acknowledge [AiHealthx](http://www.aihealthx.com/) for contributing the websocket service and html5.
diff --git a/README.md b/README.md
index 76fae82..3fbbbb4 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,7 @@
[//]: # (<div align="left"><img src="docs/images/funasr_logo.jpg" width="400"/></div>)
+([绠�浣撲腑鏂嘳(./README_zh.md)|English)
+
# FunASR: A Fundamental End-to-End Speech Recognition Toolkit
<p align="left">
<a href=""><img src="https://img.shields.io/badge/OS-Linux%2C%20Win%2C%20Mac-brightgreen.svg"></a>
diff --git a/README_zh.md b/README_zh.md
new file mode 100644
index 0000000..3a84040
--- /dev/null
+++ b/README_zh.md
@@ -0,0 +1,198 @@
+[//]: # (<div align="left"><img src="docs/images/funasr_logo.jpg" width="400"/></div>)
+
+(绠�浣撲腑鏂噟[English](./README.md))
+
+# FunASR: A Fundamental End-to-End Speech Recognition Toolkit
+<p align="left">
+ <a href=""><img src="https://img.shields.io/badge/OS-Linux%2C%20Win%2C%20Mac-brightgreen.svg"></a>
+ <a href=""><img src="https://img.shields.io/badge/Python->=3.7,<=3.10-aff.svg"></a>
+ <a href=""><img src="https://img.shields.io/badge/Pytorch-%3E%3D1.11-blue"></a>
+</p>
+
+FunASR甯屾湜鍦ㄨ闊宠瘑鍒殑瀛︽湳鐮旂┒鍜屽伐涓氬簲鐢ㄤ箣闂存灦璧蜂竴搴фˉ姊併�傞�氳繃鏀寔鍦╗ModelScope](https://www.modelscope.cn/models?page=1&tasks=auto-speech-recognition)涓婂彂甯冪殑宸ヤ笟绾ц闊宠瘑鍒ā鍨嬬殑璁粌鍜屽井璋冿紝鐮旂┒浜哄憳鍜屽紑鍙戜汉鍛樺彲浠ユ洿鏂逛究鍦拌繘琛岃闊宠瘑鍒ā鍨嬬殑鐮旂┒鍜岀敓浜э紝骞舵帹鍔ㄨ闊宠瘑鍒敓鎬佺殑鍙戝睍銆傝璇煶璇嗗埆鏇存湁瓒ｏ紒
+
+[**鏈�鏂板姩鎬�**](#鏈�鏂板姩鎬�)
+| [**鏍稿績鍔熻兘**](#鏍稿績鍔熻兘)
+| [**瀹夎鏁欑▼**](#瀹夎鏁欑▼)
+| [**濡備綍浣跨敤**](#濡備綍浣跨敤)
+| [**鏈嶅姟閮ㄧ讲**](./funasr/runtime/readme_cn.md)
+| [**妯″瀷浠撳簱**](./docs/model_zoo/modelscope_models.md)
+| [**鑱旂郴鎴戜滑**](#contact)
+| [**M2MET2.0姣旇禌**](https://github.com/alibaba-damo-academy/FunASR#multi-channel-multi-party-meeting-transcription-20-m2met20-challenge)
+
+## 鏈�鏂板姩鎬�
+
+### 鏈嶅姟閮ㄧ讲SDK
+
+- 2023.07.03:
+涓枃绂荤嚎鏂囦欢杞啓鏈嶅姟锛圕PU鐗堟湰锛夊彂甯冿紝鏀寔涓�閿儴缃插拰娴嬭瘯([鐐瑰嚮姝ゅ](funasr/runtime/readme_cn.md))
+
+### ASRU 2023 澶氶�氶亾澶氭柟浼氳杞綍鎸戞垬 2.0
+
+璇︽儏璇峰弬鑰冩枃妗ｏ紙[鐐瑰嚮姝ゅ](https://alibaba-damo-academy.github.io/FunASR/m2met2_cn/index.html)锛�
+
+
+### 瀛︽湳妯″瀷鏇存柊
+
+### 宸ヤ笟妯″瀷鏇存柊
+
+- 2023/07/06
+
+## 鏍稿績鍔熻兘
+- FunASR鏄竴涓熀纭�璇煶璇嗗埆宸ュ叿鍖咃紝鎻愪緵澶氱鍔熻兘锛屽寘鎷闊宠瘑鍒紙ASR锛夈�佽闊虫椿鍔ㄦ娴嬶紙VAD锛夈�佹爣鐐规仮澶嶃�佽瑷�妯″瀷銆佽璇濅汉楠岃瘉銆佽璇濅汉鍒嗙鍜屽浜哄璇濊闊宠瘑鍒��
+- 鎴戜滑鍦╗ModelScope](https://www.modelscope.cn/models?page=1&tasks=auto-speech-recognition)涓婂彂甯冧簡澶ч噺鐨勫鏈拰宸ヤ笟棰勮缁冩ā鍨嬶紝鍙互閫氳繃鎴戜滑鐨刐妯″瀷浠撳簱](https://github.com/alibaba-damo-academy/FunASR/blob/main/docs/model_zoo/modelscope_models.md)璁块棶銆備唬琛ㄦ�х殑[Paraformer-large](https://www.modelscope.cn/models/damo/speech_paraformer-large_asr_nat-zh-cn-16k-common-vocab8404-pytorch/summary)妯″瀷鍦ㄨ澶氳闊宠瘑鍒换鍔′腑瀹炵幇浜哠OTA鎬ц兘銆�
+- FunASR鎻愪緵浜嗕竴涓槗浜庝娇鐢ㄧ殑鎺ュ彛锛屽彲浠ョ洿鎺ュ熀浜嶮odelScope涓墭绠℃ā鍨嬭繘琛屾帹鐞嗕笌寰皟銆傛澶栵紝FunASR涓殑浼樺寲鏁版嵁鍔犺浇鍣ㄥ彲浠ュ姞閫熷ぇ瑙勬ā鏁版嵁闆嗙殑璁粌閫熷害銆�
+
+## 瀹夎鏁欑▼
+
+鐩存帴瀹夎鍙戝竷杞欢鍖�
+
+```shell
+pip3 install -U funasr
+# 涓浗澶ч檰鐢ㄦ埛锛屽鏋滈亣鍒扮綉缁滈棶棰橈紝鍙互鐢ㄤ笅闈㈡寚浠�:
+# pip3 install -U funasr -i https://mirror.sjtu.edu.cn/pypi/web/simple
+```
+
+鎮ㄤ篃鍙互浠庢簮鐮佸畨瑁�
+
+
+``` sh
+git clone https://github.com/alibaba/FunASR.git && cd FunASR
+pip3 install -e ./
+# 涓浗澶ч檰鐢ㄦ埛锛屽鏋滈亣鍒扮綉缁滈棶棰橈紝鍙互鐢ㄤ笅闈㈡寚浠�:
+# pip3 install -e ./ -i https://mirror.sjtu.edu.cn/pypi/web/simple
+```
+濡傛灉鎮ㄩ渶瑕佷娇鐢∕odelScope涓彂甯冪殑棰勮缁冩ā鍨嬶紝闇�瑕佸畨瑁匨odelScope
+
+```shell
+pip3 install -U modelscope
+# 涓浗澶ч檰鐢ㄦ埛锛屽鏋滈亣鍒扮綉缁滈棶棰橈紝鍙互鐢ㄤ笅闈㈡寚浠�:
+# pip3 install -U modelscope -f https://modelscope.oss-cn-beijing.aliyuncs.com/releases/repo.html -i https://mirror.sjtu.edu.cn/pypi/web/simple
+```
+
+鏇磋缁嗗畨瑁呰繃绋嬩粙缁嶏紙[鐐瑰嚮姝ゅ](https://alibaba-damo-academy.github.io/FunASR/en/installation/installation.html)锛�
+
+## 濡備綍浣跨敤
+
+鎮ㄥ彲浠ラ�氳繃濡備笅鍑犵鏂瑰紡浣跨敤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)锛�
+
+#### 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)锛�
+
+
+## 鑱旂郴鎴戜滑
+
+濡傛灉鎮ㄥ湪浣跨敤涓亣鍒板洶闅撅紝鍙互閫氳繃涓�涓嬫柟寮忚仈绯绘垜浠�
+
+- email: [funasr@list.alibaba-inc.com](funasr@list.alibaba-inc.com)
+
+| 閽夐拤缇� | 寰俊 |
+|:---------------------------------------------------------------------:|:-----------------------------------------------------:|
+| <div align="left"><img src="docs/images/dingding.jpg" width="250"/> | <img src="docs/images/wechat.png" width="232"/></div> |
+
+## 绀惧尯璐＄尞鑰�
+
+| <div align="left"><img src="docs/images/damo.png" width="180"/> | <div align="left"><img src="docs/images/nwpu.png" width="260"/> | <img src="docs/images/China_Telecom.png" width="200"/> </div> | <img src="docs/images/RapidAI.png" width="200"/> </div> | <img src="docs/images/aihealthx.png" width="200"/> </div> |
+|:---------------------------------------------------------------:|:---------------------------------------------------------------:|:--------------------------------------------------------------:|:-------------------------------------------------------:|:-----------------------------------------------------------:|
+
+璐＄尞鑰呭悕鍗曡鍙傝�冿紙[鐐瑰嚮姝ゅ](./Acknowledge)锛�
+
+
+## 璁稿彲鍗忚
+椤圭洰閬靛惊[The MIT License](https://opensource.org/licenses/MIT)寮�婧愬崗璁�. 宸ヤ笟妯″瀷璁稿彲鍗忚璇峰弬鑰冿紙[鐐瑰嚮姝ゅ](./MODEL_LICENSE)锛�
+
+
+## Stargazers over time
+
+[](https://starchart.cc/alibaba-damo-academy/FunASR)
+
+## 璁烘枃寮曠敤
+
+``` bibtex
+@inproceedings{gao2023funasr,
+ author={Zhifu Gao and Zerui Li and Jiaming Wang and Haoneng Luo and Xian Shi and Mengzhe Chen and Yabin Li and Lingyun Zuo and Zhihao Du and Zhangyu Xiao and Shiliang Zhang},
+ title={FunASR: A Fundamental End-to-End Speech Recognition Toolkit},
+ year={2023},
+ booktitle={INTERSPEECH},
+}
+@inproceedings{gao22b_interspeech,
+ author={Zhifu Gao and ShiLiang Zhang and Ian McLoughlin and Zhijie Yan},
+ title={{Paraformer: Fast and Accurate Parallel Transformer for Non-autoregressive End-to-End Speech Recognition}},
+ year=2022,
+ booktitle={Proc. Interspeech 2022},
+ pages={2063--2067},
+ doi={10.21437/Interspeech.2022-9996}
+}
+```
diff --git a/funasr/runtime/python/onnxruntime/setup.py b/funasr/runtime/python/onnxruntime/setup.py
index a6f6828..6cc1989 100644
--- a/funasr/runtime/python/onnxruntime/setup.py
+++ b/funasr/runtime/python/onnxruntime/setup.py
@@ -13,7 +13,7 @@
MODULE_NAME = 'funasr_onnx'
-VERSION_NUM = '0.1.1'
+VERSION_NUM = '0.1.2'
setuptools.setup(
name=MODULE_NAME,
--
Gitblit v1.9.1