python/FunASR-XL.git

			@@ -4,6 +4,16 @@

			This document serves as a development guide for the FunASR offline file transcription service. If you wish to quickly experience the offline file transcription service, please refer to the one-click deployment example for the FunASR offline file transcription service ([docs](./SDK_tutorial.md)).

			\| TIME \| INFO \| IMAGE VERSION \| IMAGE ID \|
			\|------------\|-----------------------------------------\|---------------------------------\|--------------\|
			\| 2024.09.26 \| Fix memory leak \| funasr-runtime-sdk-en-cpu-0.1.7 \| f6c5a7b59eb6 \|
			\| 2024.05.15 \| Adapting to FunASR 1.0 model structure \| funasr-runtime-sdk-en-cpu-0.1.6 \| 84d781d07997 \|
			\| 2024.03.05 \| docker image supports ARM64 platform, update modelscope \| funasr-runtime-sdk-en-cpu-0.1.5 \| 7cca2abc5901 \|
			\| 2024.01.25 \| Optimized the VAD (Voice Activity Detection) data processing method, significantly reducing peak memory usage; memory leak optimization\| funasr-runtime-sdk-en-cpu-0.1.3 \| c00f9ce7a195 \|
			\| 2024.01.03 \| fixed known crash issues as well as memory leak problems \| funasr-runtime-sdk-en-cpu-0.1.2 \| 0cdd9f4a4bb5 \|
			\| 2023.11.08 \| Adaptation to runtime structure changes \| funasr-runtime-sdk-en-cpu-0.1.1 \| 27017f70f72a \|
			\| 2023.10.16 \| 1.0 released \| funasr-runtime-sdk-en-cpu-0.1.0 \| e0de03eb0163 \|

			## Quick start
			### Docker install
			If you have already installed Docker, ignore this step!
			@@ -16,9 +26,9 @@
			### Pulling and launching images
			Use the following command to pull and launch the Docker image for the FunASR runtime-SDK:
			```shell
			sudo docker pull registry.cn-hangzhou.aliyuncs.com/funasr_repo/funasr:funasr-runtime-sdk-en-cpu-0.1.1
			sudo docker pull registry.cn-hangzhou.aliyuncs.com/funasr_repo/funasr:funasr-runtime-sdk-en-cpu-0.1.8

			sudo docker run -p 10097:10095 -it --privileged=true -v /root:/workspace/models registry.cn-hangzhou.aliyuncs.com/funasr_repo/funasr:funasr-runtime-sdk-en-cpu-0.1.1
			sudo docker run -p 10097:10095 -it --privileged=true -v /root:/workspace/models registry.cn-hangzhou.aliyuncs.com/funasr_repo/funasr:funasr-runtime-sdk-en-cpu-0.1.8
			```
			Introduction to command parameters:
			```text
			@@ -35,7 +45,7 @@
			--download-model-dir /workspace/models \
			--vad-dir damo/speech_fsmn_vad_zh-cn-16k-common-onnx \
			--model-dir damo/speech_paraformer-large_asr_nat-en-16k-common-vocab10020-onnx \
			--punc-dir damo/punc_ct-transformer_cn-en-common-vocab471067-large-onnx > log.out 2>&1 &
			--punc-dir damo/punc_ct-transformer_cn-en-common-vocab471067-large-onnx > log.txt 2>&1 &

			# If you want to close ssl，please add：--certfile 0
			```
			@@ -50,26 +60,23 @@
			--model-dir damo/speech_paraformer-large_asr_nat-en-16k-common-vocab10020-onnx \
			--vad-dir damo/speech_fsmn_vad_zh-cn-16k-common-onnx \
			--punc-dir damo/punc_ct-transformer_cn-en-common-vocab471067-large-onnx \
			--decoder-thread-num 32 \
			--io-thread-num 8 \
			--port 10095 \
			--certfile ../../../ssl_key/server.crt \
			--keyfile ../../../ssl_key/server.key > log.out 2>&1 &
			--keyfile ../../../ssl_key/server.key > log.txt 2>&1 &
			```

			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.
			--quantize: True for quantized ASR model, False for non-quantized ASR model. Default is True.
			--vad-dir: Modelscope model ID.
			--vad-quant: True for quantized VAD model, False for non-quantized VAD model. Default is True.
			--punc-dir: Modelscope model ID.
			--punc-quant: True for quantized PUNC model, False for non-quantized PUNC model. Default is True.
			--itn-dir modelscope model ID
			--model-dir: modelscope model ID or local model path.
			--vad-dir: modelscope model ID or local model path.
			--punc-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，set 0
			--keyfile <string>: SSL key file. Default is ../../../ssl_key/server.key.
			```
			@@ -109,7 +116,7 @@

			### python-client
			```shell
			python funasr_wss_client.py --host "127.0.0.1" --port 10095 --mode offline --audio_in "./data/wav.scp" --send_without_sleep --output_dir "./results"
			python funasr_wss_client.py --host "127.0.0.1" --port 10097 --mode offline --audio_in "./data/wav.scp" --send_without_sleep --output_dir "./results"
			```

			Introduction to command parameters:
			@@ -127,7 +134,7 @@

			### c++-client
			```shell
			. /funasr-wss-client --server-ip 127.0.0.1 --port 10095 --wav-path test.wav --thread-num 1 --is-ssl 1
			. /funasr-wss-client --server-ip 127.0.0.1 --port 10097 --wav-path test.wav --thread-num 1 --is-ssl 1
			```

			Introduction to command parameters: