From 923689bb077dbb489864bb29fbe35cf8211d537b Mon Sep 17 00:00:00 2001 From: 雾聪 <wucong.lyb@alibaba-inc.com> Date: 星期一, 13 十一月 2023 17:43:08 +0800 Subject: [PATCH] update docs --- runtime/docs/SDK_advanced_guide_online.md | 8 ++-- runtime/docs/SDK_advanced_guide_online_zh.md | 10 ++-- runtime/onnxruntime/readme.md | 4 +- runtime/docs/SDK_advanced_guide_offline_en.md | 8 ++-- runtime/docs/SDK_advanced_guide_offline_zh.md | 10 ++-- runtime/docs/SDK_advanced_guide_offline.md | 8 ++-- runtime/docs/SDK_advanced_guide_offline_en_zh.md | 8 ++-- runtime/websocket/readme_zh.md | 14 +++--- runtime/websocket/readme.md | 46 +++++++++++++++++++++-- 9 files changed, 77 insertions(+), 39 deletions(-) diff --git a/runtime/docs/SDK_advanced_guide_offline.md b/runtime/docs/SDK_advanced_guide_offline.md index 6dc9798..704565b 100644 --- a/runtime/docs/SDK_advanced_guide_offline.md +++ b/runtime/docs/SDK_advanced_guide_offline.md @@ -83,13 +83,13 @@ Introduction to run_server.sh parameters: ```text --download-model-dir: Model download address, download models from Modelscope by setting the model ID. ---model-dir: Modelscope model ID. +--model-dir: modelscope model ID or local model path. --quantize: True for quantized ASR model, False for non-quantized ASR model. Default is True. ---vad-dir: Modelscope model ID. +--vad-dir: modelscope model ID or local model path. --vad-quant: True for quantized VAD model, False for non-quantized VAD model. Default is True. ---punc-dir: Modelscope model ID. +--punc-dir: modelscope model ID or local model path. --punc-quant: True for quantized PUNC model, False for non-quantized PUNC model. Default is True. ---itn-dir modelscope model ID +--itn-dir modelscope model ID or local model path. --port: Port number that the server listens on. Default is 10095. --decoder-thread-num: Number of inference threads that the server starts. Default is 8. --io-thread-num: Number of IO threads that the server starts. Default is 1. diff --git a/runtime/docs/SDK_advanced_guide_offline_en.md b/runtime/docs/SDK_advanced_guide_offline_en.md index 80b80e5..1e53422 100644 --- a/runtime/docs/SDK_advanced_guide_offline_en.md +++ b/runtime/docs/SDK_advanced_guide_offline_en.md @@ -65,13 +65,13 @@ Introduction to run_server.sh parameters: ```text --download-model-dir: Model download address, download models from Modelscope by setting the model ID. ---model-dir: Modelscope model ID. +--model-dir: modelscope model ID or local model path. --quantize: True for quantized ASR model, False for non-quantized ASR model. Default is True. ---vad-dir: Modelscope model ID. +--vad-dir: modelscope model ID or local model path. --vad-quant: True for quantized VAD model, False for non-quantized VAD model. Default is True. ---punc-dir: Modelscope model ID. +--punc-dir: modelscope model ID or local model path. --punc-quant: True for quantized PUNC model, False for non-quantized PUNC model. Default is True. ---itn-dir modelscope model ID +--itn-dir modelscope model ID or local model path. --port: Port number that the server listens on. Default is 10095. --decoder-thread-num: Number of inference threads that the server starts. Default is 8. --io-thread-num: Number of IO threads that the server starts. Default is 1. diff --git a/runtime/docs/SDK_advanced_guide_offline_en_zh.md b/runtime/docs/SDK_advanced_guide_offline_en_zh.md index d6fb272..2cedccd 100644 --- a/runtime/docs/SDK_advanced_guide_offline_en_zh.md +++ b/runtime/docs/SDK_advanced_guide_offline_en_zh.md @@ -150,13 +150,13 @@ **run_server.sh鍛戒护鍙傛暟浠嬬粛** ```text --download-model-dir 妯″瀷涓嬭浇鍦板潃锛岄�氳繃璁剧疆model ID浠嶮odelscope涓嬭浇妯″瀷 ---model-dir modelscope model ID +--model-dir modelscope model ID 鎴栬�� 鏈湴妯″瀷璺緞 --quantize True涓洪噺鍖朅SR妯″瀷锛孎alse涓洪潪閲忓寲ASR妯″瀷锛岄粯璁ゆ槸True ---vad-dir modelscope model ID +--vad-dir modelscope model ID 鎴栬�� 鏈湴妯″瀷璺緞 --vad-quant True涓洪噺鍖朧AD妯″瀷锛孎alse涓洪潪閲忓寲VAD妯″瀷锛岄粯璁ゆ槸True ---punc-dir modelscope model ID +--punc-dir modelscope model ID 鎴栬�� 鏈湴妯″瀷璺緞 --punc-quant True涓洪噺鍖朠UNC妯″瀷锛孎alse涓洪潪閲忓寲PUNC妯″瀷锛岄粯璁ゆ槸True ---itn-dir modelscope model ID +--itn-dir modelscope model ID 鎴栬�� 鏈湴妯″瀷璺緞 --port 鏈嶅姟绔洃鍚殑绔彛鍙凤紝榛樿涓� 10095 --decoder-thread-num 鏈嶅姟绔惎鍔ㄧ殑鎺ㄧ悊绾跨▼鏁帮紝榛樿涓� 8 --io-thread-num 鏈嶅姟绔惎鍔ㄧ殑IO绾跨▼鏁帮紝榛樿涓� 1 diff --git a/runtime/docs/SDK_advanced_guide_offline_zh.md b/runtime/docs/SDK_advanced_guide_offline_zh.md index 03cf8e7..d994865 100644 --- a/runtime/docs/SDK_advanced_guide_offline_zh.md +++ b/runtime/docs/SDK_advanced_guide_offline_zh.md @@ -164,14 +164,14 @@ **run_server.sh鍛戒护鍙傛暟浠嬬粛** ```text --download-model-dir 妯″瀷涓嬭浇鍦板潃锛岄�氳繃璁剧疆model ID浠嶮odelscope涓嬭浇妯″瀷 ---model-dir modelscope model ID +--model-dir modelscope model ID 鎴栬�� 鏈湴妯″瀷璺緞 --quantize True涓洪噺鍖朅SR妯″瀷锛孎alse涓洪潪閲忓寲ASR妯″瀷锛岄粯璁ゆ槸True ---vad-dir modelscope model ID +--vad-dir modelscope model ID 鎴栬�� 鏈湴妯″瀷璺緞 --vad-quant True涓洪噺鍖朧AD妯″瀷锛孎alse涓洪潪閲忓寲VAD妯″瀷锛岄粯璁ゆ槸True ---punc-dir modelscope model ID +--punc-dir modelscope model ID 鎴栬�� 鏈湴妯″瀷璺緞 --punc-quant True涓洪噺鍖朠UNC妯″瀷锛孎alse涓洪潪閲忓寲PUNC妯″瀷锛岄粯璁ゆ槸True ---lm-dir modelscope model ID ---itn-dir modelscope model ID +--lm-dir modelscope model ID 鎴栬�� 鏈湴妯″瀷璺緞 +--itn-dir modelscope model ID 鎴栬�� 鏈湴妯″瀷璺緞 --port 鏈嶅姟绔洃鍚殑绔彛鍙凤紝榛樿涓� 10095 --decoder-thread-num 鏈嶅姟绔惎鍔ㄧ殑鎺ㄧ悊绾跨▼鏁帮紝榛樿涓� 8 --io-thread-num 鏈嶅姟绔惎鍔ㄧ殑IO绾跨▼鏁帮紝榛樿涓� 1 diff --git a/runtime/docs/SDK_advanced_guide_online.md b/runtime/docs/SDK_advanced_guide_online.md index 3a6b08e..506c7fe 100644 --- a/runtime/docs/SDK_advanced_guide_online.md +++ b/runtime/docs/SDK_advanced_guide_online.md @@ -100,14 +100,14 @@ ### More details about the script run_server_2pass.sh: ```text --download-model-dir: Model download address, download models from Modelscope by setting the model ID. ---model-dir: Modelscope model ID. +--model-dir: modelscope model ID or local model path. --online-model-dir modelscope model ID --quantize: True for quantized ASR model, False for non-quantized ASR model. Default is True. ---vad-dir: Modelscope model ID. +--vad-dir: modelscope model ID or local model path. --vad-quant: True for quantized VAD model, False for non-quantized VAD model. Default is True. ---punc-dir: Modelscope model ID. +--punc-dir: modelscope model ID or local model path. --punc-quant: True for quantized PUNC model, False for non-quantized PUNC model. Default is True. ---itn-dir modelscope model ID +--itn-dir modelscope model ID or local model path. --port: Port number that the server listens on. Default is 10095. --decoder-thread-num: Number of inference threads that the server starts. Default is 8. --io-thread-num: Number of IO threads that the server starts. Default is 1. diff --git a/runtime/docs/SDK_advanced_guide_online_zh.md b/runtime/docs/SDK_advanced_guide_online_zh.md index 506f27c..748907d 100644 --- a/runtime/docs/SDK_advanced_guide_online_zh.md +++ b/runtime/docs/SDK_advanced_guide_online_zh.md @@ -108,14 +108,14 @@ **run_server_2pass.sh鍛戒护鍙傛暟浠嬬粛** ```text --download-model-dir 妯″瀷涓嬭浇鍦板潃锛岄�氳繃璁剧疆model ID浠嶮odelscope涓嬭浇妯″瀷 ---model-dir modelscope model ID ---online-model-dir modelscope model ID +--model-dir modelscope model ID 鎴栬�� 鏈湴妯″瀷璺緞 +--online-model-dir modelscope model ID 鎴栬�� 鏈湴妯″瀷璺緞 --quantize True涓洪噺鍖朅SR妯″瀷锛孎alse涓洪潪閲忓寲ASR妯″瀷锛岄粯璁ゆ槸True ---vad-dir modelscope model ID +--vad-dir modelscope model ID 鎴栬�� 鏈湴妯″瀷璺緞 --vad-quant True涓洪噺鍖朧AD妯″瀷锛孎alse涓洪潪閲忓寲VAD妯″瀷锛岄粯璁ゆ槸True ---punc-dir modelscope model ID +--punc-dir modelscope model ID 鎴栬�� 鏈湴妯″瀷璺緞 --punc-quant True涓洪噺鍖朠UNC妯″瀷锛孎alse涓洪潪閲忓寲PUNC妯″瀷锛岄粯璁ゆ槸True ---itn-dir modelscope model ID +--itn-dir modelscope model ID 鎴栬�� 鏈湴妯″瀷璺緞 --port 鏈嶅姟绔洃鍚殑绔彛鍙凤紝榛樿涓� 10095 --decoder-thread-num 鏈嶅姟绔惎鍔ㄧ殑鎺ㄧ悊绾跨▼鏁帮紝榛樿涓� 8 --io-thread-num 鏈嶅姟绔惎鍔ㄧ殑IO绾跨▼鏁帮紝榛樿涓� 1 diff --git a/runtime/onnxruntime/readme.md b/runtime/onnxruntime/readme.md index fe75a10..06a5ff4 100644 --- a/runtime/onnxruntime/readme.md +++ b/runtime/onnxruntime/readme.md @@ -36,12 +36,12 @@ ## Building for Windows ### Download onnxruntime -https://github.com/BtbN/FFmpeg-Builds/releases/download/latest/ffmpeg-master-latest-win64-gpl-shared.zip +https://isv-data.oss-cn-hangzhou.aliyuncs.com/ics/MaaS/ASR/dep_libs/onnxruntime-win-x64-1.16.1.zip Download and unzip to d:\ffmpeg-master-latest-win64-gpl-shared ### Download ffmpeg -https://github.com/microsoft/onnxruntime/releases/download/v1.16.1/onnxruntime-win-x64-1.16.1.zip +https://isv-data.oss-cn-hangzhou.aliyuncs.com/ics/MaaS/ASR/dep_libs/ffmpeg-master-latest-win64-gpl-shared.zip Download and unzip to d:\onnxruntime-win-x64-1.16.1 diff --git a/runtime/websocket/readme.md b/runtime/websocket/readme.md index 11c110a..c022de0 100644 --- a/runtime/websocket/readme.md +++ b/runtime/websocket/readme.md @@ -6,14 +6,14 @@ ## Building for Linux/Unix ### Download onnxruntime ```shell -wget https://github.com/microsoft/onnxruntime/releases/download/v1.14.0/onnxruntime-linux-x64-1.14.0.tgz +wget https://isv-data.oss-cn-hangzhou.aliyuncs.com/ics/MaaS/ASR/dep_libs/onnxruntime-linux-x64-1.14.0.tgz tar -zxvf onnxruntime-linux-x64-1.14.0.tgz ``` ### Download ffmpeg ```shell -wget https://isv-data.oss-cn-hangzhou.aliyuncs.com/ics/MaaS/ASR/dep_libs/ffmpeg-N-111383-g20b8688092-linux64-gpl-shared.tar.xz -tar -xvf ffmpeg-N-111383-g20b8688092-linux64-gpl-shared.tar.xz +wget https://isv-data.oss-cn-hangzhou.aliyuncs.com/ics/MaaS/ASR/dep_libs/ffmpeg-master-latest-linux64-gpl-shared.tar.xz +tar -xvf ffmpeg-master-latest-linux64-gpl-shared.tar.xz ``` ### Install deps @@ -31,6 +31,44 @@ ```shell git clone https://github.com/alibaba-damo-academy/FunASR.git && cd FunASR/runtime/websocket mkdir build && cd build -cmake -DCMAKE_BUILD_TYPE=release .. -DONNXRUNTIME_DIR=/path/to/onnxruntime-linux-x64-1.14.0 -DFFMPEG_DIR=/path/to/ffmpeg-N-111383-g20b8688092-linux64-gpl-shared +cmake -DCMAKE_BUILD_TYPE=release .. -DONNXRUNTIME_DIR=/path/to/onnxruntime-linux-x64-1.14.0 -DFFMPEG_DIR=/path/to/ffmpeg-master-latest-linux64-gpl-shared make -j 4 ``` + + +## Building for Windows +### Download onnxruntime +https://isv-data.oss-cn-hangzhou.aliyuncs.com/ics/MaaS/ASR/dep_libs/onnxruntime-win-x64-1.16.1.zip + +Download to d:\ffmpeg-master-latest-win64-gpl-shared + +### Download ffmpeg +https://isv-data.oss-cn-hangzhou.aliyuncs.com/ics/MaaS/ASR/dep_libs/ffmpeg-master-latest-win64-gpl-shared.zip + +Download to d:\onnxruntime-win-x64-1.16.1 + +### Download openssl +https://isv-data.oss-cn-hangzhou.aliyuncs.com/ics/MaaS/ASR/dep_libs/openssl-1.1.1w.tar.gz + +Download to d:/src/openssl-1.1.1w + +Open x64 Native Tools Command Prompt and execute the following compilation steps +``` +d: +cd d:/src/openssl-1.1.1w +perl Configure VC-WIN64A --prefix=d:/openssl-1.1.1w +nmake +namke install + +``` + +### Build runtime +``` +git clone https://github.com/alibaba-damo-academy/FunASR.git +cd FunASR/runtime/websocket +mkdir build +cd build +cmake ../ -D OPENSSL_ROOT_DIR=d:/openssl-1.1.1w -D FFMPEG_DIR=d:/ffmpeg-master-latest-win64-gpl-shared -D ONNXRUNTIME_DIR=d:/onnxruntime-win-x64-1.16.1 +``` +Open FunASRWebscoket.sln in Visual Studio and complete the compilation. + diff --git a/runtime/websocket/readme_zh.md b/runtime/websocket/readme_zh.md index 91a63d9..c64d997 100644 --- a/runtime/websocket/readme_zh.md +++ b/runtime/websocket/readme_zh.md @@ -6,14 +6,14 @@ ## Linux/Unix 骞冲彴缂栬瘧 ### 涓嬭浇 onnxruntime ```shell -wget https://github.com/microsoft/onnxruntime/releases/download/v1.14.0/onnxruntime-linux-x64-1.14.0.tgz +wget https://isv-data.oss-cn-hangzhou.aliyuncs.com/ics/MaaS/ASR/dep_libs/onnxruntime-linux-x64-1.14.0.tgz tar -zxvf onnxruntime-linux-x64-1.14.0.tgz ``` ### 涓嬭浇 ffmpeg ```shell -wget https://isv-data.oss-cn-hangzhou.aliyuncs.com/ics/MaaS/ASR/dep_libs/ffmpeg-N-111383-g20b8688092-linux64-gpl-shared.tar.xz -tar -xvf ffmpeg-N-111383-g20b8688092-linux64-gpl-shared.tar.xz +wget https://isv-data.oss-cn-hangzhou.aliyuncs.com/ics/MaaS/ASR/dep_libs/ffmpeg-master-latest-linux64-gpl-shared.tar.xz +tar -xvf ffmpeg-master-latest-linux64-gpl-shared.tar.xz ``` ### 瀹夎渚濊禆 @@ -32,24 +32,24 @@ ```shell git clone https://github.com/alibaba-damo-academy/FunASR.git && cd FunASR/runtime/websocket mkdir build && cd build -cmake -DCMAKE_BUILD_TYPE=release .. -DONNXRUNTIME_DIR=/path/to/onnxruntime-linux-x64-1.14.0 -DFFMPEG_DIR=/path/to/ffmpeg-N-111383-g20b8688092-linux64-gpl-shared +cmake -DCMAKE_BUILD_TYPE=release .. -DONNXRUNTIME_DIR=/path/to/onnxruntime-linux-x64-1.14.0 -DFFMPEG_DIR=/path/to/ffmpeg-master-latest-linux64-gpl-shared make -j 4 ``` ## Windows 骞冲彴缂栬瘧 ### 涓嬭浇 onnxruntime -https://github.com/BtbN/FFmpeg-Builds/releases/download/latest/ffmpeg-master-latest-win64-gpl-\shared.zip +https://isv-data.oss-cn-hangzhou.aliyuncs.com/ics/MaaS/ASR/dep_libs/onnxruntime-win-x64-1.16.1.zip 涓嬭浇骞惰В鍘嬪埌 d:\ffmpeg-master-latest-win64-gpl-shared ### 涓嬭浇 ffmpeg -https://github.com/microsoft/onnxruntime/releases/download/v1.16.1/onnxruntime-win-x64-1.16.1.zip +https://isv-data.oss-cn-hangzhou.aliyuncs.com/ics/MaaS/ASR/dep_libs/ffmpeg-master-latest-win64-gpl-shared.zip 涓嬭浇骞惰В鍘嬪埌 d:\onnxruntime-win-x64-1.16.1 ### 缂栬瘧 openssl -https://www.openssl.org/source/openssl-1.1.1w.tar.gz +https://isv-data.oss-cn-hangzhou.aliyuncs.com/ics/MaaS/ASR/dep_libs/openssl-1.1.1w.tar.gz 涓嬭浇瑙ｅ帇鍒� d:/src/openssl-1.1.1w -- Gitblit v1.9.1