From e0fa63765bfb4a36bde7047c2a6066ca5a80e90f Mon Sep 17 00:00:00 2001 From: Yabin Li <wucong.lyb@alibaba-inc.com> Date: 星期一, 21 八月 2023 10:37:42 +0800 Subject: [PATCH] Dev hw (#878) --- funasr/runtime/docs/SDK_tutorial.md | 38 +++++++------------------------------- 1 files changed, 7 insertions(+), 31 deletions(-) diff --git a/funasr/runtime/docs/SDK_tutorial.md b/funasr/runtime/docs/SDK_tutorial.md index 0624af3..457f506 100644 --- a/funasr/runtime/docs/SDK_tutorial.md +++ b/funasr/runtime/docs/SDK_tutorial.md @@ -1,6 +1,6 @@ ([绠�浣撲腑鏂嘳(./SDK_tutorial_zh.md)|English) -# FunASR Offline File Transcription Service Convenient Deployment Tutorial +# FunASR Offline File Transcription Service FunASR provides an offline file transcription service that can be easily deployed on a local or cloud server. The core is the FunASR open-source runtime-SDK. It integrates various capabilities such as speech endpoint detection (VAD) and Paraformer-large speech recognition (ASR) and punctuation restoration (PUNC) released by the speech laboratory of the Damo Academy in the Modelscope community. It has a complete speech recognition chain and can recognize audio or video of tens of hours into punctuated text. Moreover, it supports transcription for hundreds of simultaneous requests. @@ -33,6 +33,7 @@ ```shell sudo bash funasr-runtime-deploy-offline-cpu-zh.sh install --workspace /root/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 @@ -69,6 +70,7 @@ --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: 闃块噷宸村反 杈炬懇闄�) ``` ### cpp-client @@ -85,6 +87,7 @@ --wav-path specifies the audio file to be transcribed, and supports file paths. --thread_num sets the number of concurrent send threads, with a default value of 1. --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: 闃块噷宸村反 杈炬懇闄�) ``` ### html-client @@ -155,42 +158,15 @@ sudo bash funasr-runtime-deploy-offline-cpu-zh.sh update --workspace /root/funasr-runtime-resources ``` - -## Detailed Configuration of Server Startup Process - -### Select FunASR Docker image -We recommend choosing to use our latest released image, but you can also choose historical versions. - -```text -[1/5] - Getting the list of docker images, please wait a few seconds. - [DONE] - - Please choose the Docker image. - 1) registry.cn-hangzhou.aliyuncs.com/funasr_repo/funasr:funasr-runtime-sdk-cpu-0.1.0 - Enter your choice, default(1): - You have chosen the Docker image: registry.cn-hangzhou.aliyuncs.com/funasr_repo/funasr:funasr-runtime-sdk-cpu-0.1.0 -``` - - -### Set the port provided by the host for FunASR -Set the host port provided to Docker, which is 10095 by default. Please make sure that this port is available. - -```text -[2/5] - Please input the opened port in the host used for FunASR server. - Setting the opened host port [1-65535], default(10095): - The port of the host is 10095 - The port in Docker for FunASR server is 10095 -``` - ### Set SSL SSL verification is enabled by default. If you need to disable it, you can set it when starting. ```shell -sudo bash funasr-runtime-deploy-offline-cpu-zh.sh --ssl 0 +sudo bash funasr-runtime-deploy-online-cpu-zh.sh update --ssl 0 ``` + + ## Contact Us If you encounter any problems during use, please join our user group for feedback. -- Gitblit v1.9.1