From b9bcf1f093c3053fdc4e2cf4a1d38e27bbf429fb Mon Sep 17 00:00:00 2001 From: 游雁 <zhifu.gzf@alibaba-inc.com> Date: 星期四, 19 十月 2023 14:03:48 +0800 Subject: [PATCH] docs --- funasr/runtime/docs/SDK_tutorial_online.md | 11 ++++++++--- 1 files changed, 8 insertions(+), 3 deletions(-) diff --git a/funasr/runtime/docs/SDK_tutorial_online.md b/funasr/runtime/docs/SDK_tutorial_online.md index b4800bb..d7a429b 100644 --- a/funasr/runtime/docs/SDK_tutorial_online.md +++ b/funasr/runtime/docs/SDK_tutorial_online.md @@ -24,15 +24,16 @@ Download the deployment tool `funasr-runtime-deploy-online-cpu-zh.sh` ```shell -curl -O https://raw.githubusercontent.com/alibaba-damo-academy/FunASR/main/funasr/runtime/deploy_tools/funasr-runtime-deploy-online-cpu-en.sh; +curl -O https://raw.githubusercontent.com/alibaba-damo-academy/FunASR/main/funasr/runtime/deploy_tools/funasr-runtime-deploy-online-cpu-zh.sh; # If there is a network problem, users in mainland China can use the following command: -# curl -O https://isv-data.oss-cn-hangzhou.aliyuncs.com/ics/MaaS/ASR/shell/funasr-runtime-deploy-online-cpu-en.sh; +# curl -O https://isv-data.oss-cn-hangzhou.aliyuncs.com/ics/MaaS/ASR/shell/funasr-runtime-deploy-online-cpu-zh.sh; ``` -Execute the deployment tool and press the Enter key at the prompt to complete the installation and deployment of the server. Currently, the convenient deployment tool only supports Linux environments. For other environments, please refer to the development guide ([docs](./SDK_advanced_guide_offline.md)). +Execute the deployment tool and press the Enter key at the prompt to complete the installation and deployment of the server. Currently, the convenient deployment tool only supports Linux environments. For other environments, please refer to the development guide ([docs](./SDK_advanced_guide_online.md)). ```shell sudo bash funasr-runtime-deploy-online-cpu-zh.sh install --workspace ./funasr-runtime-resources ``` +Note: If you need to deploy the timestamp model or hotword model, select the corresponding model in step 2 of the installation and deployment process, where 1 is the paraformer-large model, 2 is the paraformer-large timestamp model, and 3 is the paraformer-large hotword model. ### Client Testing and Usage @@ -70,6 +71,8 @@ --audio_in is the audio file that needs to be transcribed, supporting file paths and file list wav.scp --thread_num sets the number of concurrent sending threads, default is 1 --ssl sets whether to enable SSL certificate verification, default is 1 to enable, and 0 to disable +--hotword: If am is hotword model, setting hotword: *.txt(one hotword perline) or hotwords seperate by space (could be: 闃块噷宸村反 杈炬懇闄�) +--use_itn: whether to use itn, the default value is 1 for enabling and 0 for disabling. ``` ### cpp-client @@ -88,6 +91,8 @@ --wav-path specifies the audio file to be transcribed, and supports file paths. --threa-num sets the number of concurrent send threads, with a default value of 1. --is-ssl sets whether to enable SSL certificate verification, with a default value of 1 for enabling and 0 for disabling. +--hotword: If am is hotword model, setting hotword: *.txt(one hotword perline) or hotwords seperate by space (could be: 闃块噷宸村反 杈炬懇闄�) +--use-itn: whether to use itn, the default value is 1 for enabling and 0 for disabling. ``` ### html-client -- Gitblit v1.9.1