From a0905650992f68074ae42677ae9be6756cc15900 Mon Sep 17 00:00:00 2001 From: lyblsgo <wucong.lyb@alibaba-inc.com> Date: 星期三, 08 十一月 2023 15:36:21 +0800 Subject: [PATCH] update docs --- runtime/docs/SDK_advanced_guide_offline.md | 53 ++++++++++------------------------------------------- 1 files changed, 10 insertions(+), 43 deletions(-) diff --git a/runtime/docs/SDK_advanced_guide_offline.md b/runtime/docs/SDK_advanced_guide_offline.md index 1ce9472..d196710 100644 --- a/runtime/docs/SDK_advanced_guide_offline.md +++ b/runtime/docs/SDK_advanced_guide_offline.md @@ -3,38 +3,19 @@ FunASR provides a Chinese offline file transcription service that can be deployed locally or on a cloud server with just one click. The core of the service is the FunASR runtime SDK, which has been open-sourced. FunASR-runtime combines various capabilities such as speech endpoint detection (VAD), large-scale speech recognition (ASR) using Paraformer-large, and punctuation detection (PUNC), which have all been open-sourced by the speech laboratory of DAMO Academy on the Modelscope community. This enables accurate and efficient high-concurrency transcription of audio files. 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)). +<img src="docs/images/offline_structure.jpg" width="900"/> -## Installation of Docker - -The following steps are for manually installing Docker and Docker images. If your Docker image has already been launched, you can ignore this step. - -### Installation of Docker environment - +## Quick start +### Docker install +If you have already installed Docker, ignore this step! ```shell -# Ubuntu锛� -curl -fsSL https://test.docker.com -o test-docker.sh -sudo sh test-docker.sh -# Debian锛� -curl -fsSL https://get.docker.com -o get-docker.sh -sudo sh get-docker.sh -# CentOS锛� -curl -fsSL https://get.docker.com | bash -s docker --mirror Aliyun -# MacOS锛� -brew install --cask --appdir=/Applications docker +curl -O https://isv-data.oss-cn-hangzhou.aliyuncs.com/ics/MaaS/ASR/shell/install_docker.sh; +sudo bash install_docker.sh ``` - -More details could ref to [docs](https://alibaba-damo-academy.github.io/FunASR/en/installation/docker.html) - -### Starting Docker - -```shell -sudo systemctl start docker -``` +If you do not have Docker installed, please refer to [Docker Installation](https://alibaba-damo-academy.github.io/FunASR/en/installation/docker.html) ### 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-cpu-0.3.0 @@ -46,11 +27,9 @@ -p <host port>:<mapped docker port>: In the example, host machine (ECS) port 10095 is mapped to port 10095 in the Docker container. Make sure that port 10095 is open in the ECS security rules. -v <host path>:<mounted Docker path>: In the example, the host machine path /root is mounted to the Docker path /workspace/models. - ``` -## Starting the server - +### Starting the server Use the flollowing script to start the server 锛� ```shell nohup bash run_server.sh \ @@ -59,7 +38,8 @@ --model-dir damo/speech_paraformer-large_asr_nat-zh-cn-16k-common-vocab8404-onnx \ --punc-dir damo/punc_ct-transformer_cn-en-common-vocab471067-large-onnx \ --lm-dir damo/speech_ngram_lm_zh-cn-ai-wesp-fst \ - --itn-dir thuduj12/fst_itn_zh > log.out 2>&1 & + --itn-dir thuduj12/fst_itn_zh \ + --hotword /workspace/models/hotwords.txt > log.out 2>&1 & # If you want to close ssl锛宲lease add锛�--certfile 0 # If you want to deploy the timestamp or nn hotword model, please set --model-dir to the corresponding model: @@ -67,7 +47,6 @@ # damo/speech_paraformer-large-contextual_asr_nat-zh-cn-16k-common-vocab8404-onnx锛坔otword锛� # If you want to load hotwords on the server side, please configure the hotwords in the host machine file ./funasr-runtime-resources/models/hotwords.txt (docker mapping address: /workspace/models/hotwords.txt): # One hotword per line, format (hotword weight): 闃块噷宸村反 20" - ``` ### More details about the script run_server.sh: @@ -92,7 +71,6 @@ ``` 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. @@ -141,19 +119,14 @@ If you wish to deploy your fine-tuned model (e.g., 10epoch.pb), you need to manually rename the model to model.pb and replace the original model.pb in ModelScope. Then, specify the path as `model_dir`. - - ## Starting the client - After completing the deployment of FunASR offline file transcription service on the server, you can test and use the service by following these steps. Currently, FunASR-bin supports multiple ways to start the client. The following are command-line examples based on python-client, c++-client, and custom client Websocket communication protocol: ### 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" ``` - Introduction to command parameters: - ```text --host: the IP address of the server. It can be set to 127.0.0.1 for local testing. --port: the port number of the server listener. @@ -171,7 +144,6 @@ ``` Introduction to command parameters: - ```text --server-ip: the IP address of the server. It can be set to 127.0.0.1 for local testing. --port: the port number of the server listener. @@ -182,19 +154,15 @@ ``` ### Custom client - If you want to define your own client, see the [Websocket communication protocol](./websocket_protocol.md) ## How to customize service deployment - The code for FunASR-runtime is open source. If the server and client cannot fully meet your needs, you can further develop them based on your own requirements: ### C++ client - https://github.com/alibaba-damo-academy/FunASR/tree/main/runtime/websocket ### Python client - https://github.com/alibaba-damo-academy/FunASR/tree/main/runtime/python/websocket ### C++ server @@ -218,7 +186,6 @@ FUNASR_RESULT result=FunOfflineInfer(asr_hanlde, wav_file.c_str(), RASR_NONE, NULL, 16000); // Where: asr_hanlde is the return value of FunOfflineInit, wav_file is the path to the audio file, and sampling_rate is the sampling rate (default 16k). ``` - See the usage example for details, [docs](https://github.com/alibaba-damo-academy/FunASR/blob/main/runtime/onnxruntime/bin/funasr-onnx-offline.cpp) #### PUNC -- Gitblit v1.9.1