From 714e29e5e4f8ff40763ea250a6b882cb3e59474d Mon Sep 17 00:00:00 2001 From: 雾聪 <wucong.lyb@alibaba-inc.com> Date: 星期四, 25 一月 2024 14:32:31 +0800 Subject: [PATCH] update docs --- runtime/docs/SDK_advanced_guide_online.md | 22 ++++++++++++---------- 1 files changed, 12 insertions(+), 10 deletions(-) diff --git a/runtime/docs/SDK_advanced_guide_online.md b/runtime/docs/SDK_advanced_guide_online.md index ea52c55..2f99ced 100644 --- a/runtime/docs/SDK_advanced_guide_online.md +++ b/runtime/docs/SDK_advanced_guide_online.md @@ -8,6 +8,8 @@ | TIME | INFO | IMAGE VERSION | IMAGE ID | |------------|-------------------------------------------------------------------------------------|-------------------------------------|--------------| +| 2024.01.25 | Optimization of the client-side | funasr-runtime-sdk-online-cpu-0.1.7 | 81fca20da2ed | +| 2024.01.03 | The 2pass-offline mode supports Ngram language model decoding and WFST hotwords, while also addressing known crash issues and memory leak problems | funasr-runtime-sdk-online-cpu-0.1.6 | f99925110d27 | | 2023.11.09 | fix bug: without online results | funasr-runtime-sdk-online-cpu-0.1.5 | b16584b6d38b | | 2023.11.08 | supporting server-side loading of hotwords, adaptation to runtime structure changes | funasr-runtime-sdk-online-cpu-0.1.4 | 691974017c38 | | 2023.09.19 | supporting hotwords, timestamps, and ITN model in 2pass mode | funasr-runtime-sdk-online-cpu-0.1.2 | 7222c5319bcf | @@ -26,9 +28,9 @@ ### Pull Docker Image Use the following command to pull and start the FunASR software package docker image: ```shell -sudo docker pull registry.cn-hangzhou.aliyuncs.com/funasr_repo/funasr:funasr-runtime-sdk-online-cpu-0.1.5 +sudo docker pull registry.cn-hangzhou.aliyuncs.com/funasr_repo/funasr:funasr-runtime-sdk-online-cpu-0.1.7 mkdir -p ./funasr-runtime-resources/models -sudo docker run -p 10096:10095 -it --privileged=true -v $PWD/funasr-runtime-resources/models:/workspace/models registry.cn-hangzhou.aliyuncs.com/funasr_repo/funasr:funasr-runtime-sdk-online-cpu-0.1.5 +sudo docker run -p 10096:10095 -it --privileged=true -v $PWD/funasr-runtime-resources/models:/workspace/models registry.cn-hangzhou.aliyuncs.com/funasr_repo/funasr:funasr-runtime-sdk-online-cpu-0.1.7 ``` ### Launching the Server @@ -42,6 +44,7 @@ --model-dir damo/speech_paraformer-large_asr_nat-zh-cn-16k-common-vocab8404-onnx \ --online-model-dir damo/speech_paraformer-large_asr_nat-zh-cn-16k-common-vocab8404-online-onnx \ --punc-dir damo/punc_ct-transformer_zh-cn-common-vad_realtime-vocab272727-onnx \ + --lm-dir damo/speech_ngram_lm_zh-cn-ai-wesp-fst \ --itn-dir thuduj12/fst_itn_zh > log.out 2>&1 & # If you want to close ssl锛宲lease add锛�--certfile 0 @@ -84,10 +87,8 @@ --online-model-dir damo/speech_paraformer-large_asr_nat-zh-cn-16k-common-vocab8404-online-onnx \ --vad-dir damo/speech_fsmn_vad_zh-cn-16k-common-onnx \ --punc-dir damo/punc_ct-transformer_zh-cn-common-vad_realtime-vocab272727-onnx \ + --lm-dir damo/speech_ngram_lm_zh-cn-ai-wesp-fst \ --itn-dir thuduj12/fst_itn_zh \ - --decoder-thread-num 32 \ - --io-thread-num 8 \ - --port 10095 \ --certfile ../../../ssl_key/server.crt \ --keyfile ../../../ssl_key/server.key \ --hotword ../../hotwords.txt > log.out 2>&1 & @@ -104,15 +105,16 @@ --download-model-dir: Model download address, download models from Modelscope by setting the 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 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 or local model path. ---punc-quant: True for quantized PUNC model, False for non-quantized PUNC model. Default is True. +--lm-dir modelscope model ID or local model path. --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. +--decoder-thread-num: The number of thread pools on the server side that can handle concurrent requests. + The script will automatically configure parameters decoder-thread-num and io-thread-num based on the server's thread count. +--io-thread-num: Number of IO threads that the server starts. +--model-thread-num: The number of internal threads for each recognition route to control the parallelism of the ONNX model. + The default value is 1. It is recommended that decoder-thread-num * model-thread-num equals the total number of threads. --certfile <string>: SSL certificate file. Default is ../../../ssl_key/server.crt. If you want to close ssl锛宻et 0 --keyfile <string>: SSL key file. Default is ../../../ssl_key/server.key. --hotword: Hotword file path, one line for each hotword(e.g.:闃块噷宸村反 20), if the client provides hot words, then combined with the hot words provided by the client. -- Gitblit v1.9.1