| | |
|---|
| | | FunASR提供可一键本地或者云端服务器部署的中文离线文件转写服务，内核为FunASR已开源runtime-SDK。FunASR-runtime结合了达摩院语音实验室在Modelscope社区开源的语音端点检测(VAD)、Paraformer-large语音识别(ASR)、标点检测(PUNC) 等相关能力，可以准确、高效的对音频进行高并发转写。 |
|---|
| | | |
|---|
| | | 本文档为FunASR离线文件转写服务开发指南。如果您想快速体验离线文件转写服务，可参考[快速上手](#快速上手)。 |
|---|
| | | <img src="docs/images/offline_structure.jpg" width="900"/> |
|---|
| | | |
|---|
| | | ## 服务器配置 |
|---|
| | | |
|---|
| | |
|---|
| | | curl -O https://isv-data.oss-cn-hangzhou.aliyuncs.com/ics/MaaS/ASR/shell/install_docker.sh； |
|---|
| | | sudo bash install_docker.sh |
|---|
| | | ``` |
|---|
| | | docker安装失败请参考 [Docker Installation](https://alibaba-damo-academy.github.io/FunASR/en/installation/docker.html) |
|---|
| | | |
|---|
| | | ### 镜像启动 |
|---|
| | | |
|---|
| | |
|---|
| | | -v $PWD/funasr-runtime-resources/models:/workspace/models \ |
|---|
| | | registry.cn-hangzhou.aliyuncs.com/funasr_repo/funasr:funasr-runtime-sdk-cpu-0.3.0 |
|---|
| | | ``` |
|---|
| | | 如果您没有安装docker，可参考[Docker安装](#Docker安装) |
|---|
| | | |
|---|
| | | ### 服务端启动 |
|---|
| | | |
|---|
| | |
|---|
| | | # 如果您想关闭ssl，增加参数：--certfile 0 |
|---|
| | | # 如果您想使用时间戳或者nn热词模型进行部署，请设置--model-dir为对应模型： |
|---|
| | | # damo/speech_paraformer-large-vad-punc_asr_nat-zh-cn-16k-common-vocab8404-onnx（时间戳） |
|---|
| | | # damo/speech_paraformer-large-contextual_asr_nat-zh-cn-16k-common-vocab8404-onnx（热词） |
|---|
| | | # damo/speech_paraformer-large-contextual_asr_nat-zh-cn-16k-common-vocab8404-onnx（nn热词） |
|---|
| | | # 如果您想在服务端加载热词，请在宿主机文件./funasr-runtime-resources/models/hotwords.txt配置热词（docker映射地址为/workspace/models/hotwords.txt）: |
|---|
| | | # 每行一个热词，格式(热词 权重)：阿里巴巴 20 |
|---|
| | | ``` |
|---|
| | |
|---|
| | | ```shell |
|---|
| | | python3 funasr_wss_client.py --host "127.0.0.1" --port 10095 --mode offline --audio_in "../audio/asr_example.wav" |
|---|
| | | ``` |
|---|
| | | |
|---|
| | | ------------------ |
|---|
| | | ## Docker安装 |
|---|
| | | |
|---|
| | | 下述步骤为手动安装docker环境的步骤： |
|---|
| | | |
|---|
| | | ### docker环境安装 |
|---|
| | | ```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 |
|---|
| | | ``` |
|---|
| | | |
|---|
| | | 安装详见：https://alibaba-damo-academy.github.io/FunASR/en/installation/docker.html |
|---|
| | | |
|---|
| | | ### docker启动 |
|---|
| | | |
|---|
| | | ```shell |
|---|
| | | sudo systemctl start docker |
|---|
| | | ``` |
|---|
| | | |
|---|
| | | |
|---|
| | | ## 客户端用法详解 |
|---|
| | | |
|---|
| | |
|---|
| | | ``` |
|---|
| | | |
|---|
| | | 命令参数说明： |
|---|
| | | |
|---|
| | | ```text |
|---|
| | | --server-ip 为FunASR runtime-SDK服务部署机器ip，默认为本机ip（127.0.0.1），如果client与服务不在同一台服务器， |
|---|
| | | 需要改为部署机器ip |
|---|
| | |
|---|
| | | ``` |
|---|
| | | |
|---|
| | | ### Html网页版 |
|---|
| | | |
|---|
| | | 在浏览器中打开 html/static/index.html，即可出现如下页面，支持麦克风输入与文件上传，直接进行体验 |
|---|
| | | |
|---|
| | | <img src="images/html.png" width="900"/> |
|---|
| | | |
|---|
| | | ### Java-client |
|---|
| | | |
|---|
| | | ```shell |
|---|
| | | FunasrWsClient --host localhost --port 10095 --audio_in ./asr_example.wav --mode offline |
|---|
| | | ``` |
|---|
| | |
|---|
| | | |
|---|
| | | 如果，您希望部署您finetune后的模型（例如10epoch.pb），需要手动将模型重命名为model.pb，并将原modelscope中模型model.pb替换掉，将路径指定为`model_dir`即可。 |
|---|
| | | |
|---|
| | | ------------------ |
|---|
| | | |
|---|
| | | ## 如何定制服务部署 |
|---|
| | | |
|---|
| | |
|---|
| | | ### 自定义客户端： |
|---|
| | | |
|---|
| | | 如果您想定义自己的client，参考[websocket通信协议](./websocket_protocol_zh.md) |
|---|
| | | |
|---|
| | | |
|---|
| | | ``` |
|---|
| | | |
|---|
| | | ### c++ 服务端： |
|---|
| | | |
|---|
