LibreASR 开源项目使用教程

LibreASR 开源项目使用教程

LibreASR:speech_balloon: An On-Premises, Streaming Speech Recognition System 项目地址:https://gitcode.com/gh_mirrors/li/LibreASR

目录结构及介绍

LibreASR 项目的目录结构如下：

LibreASR/
├── apps/
├── config/
├── demo/
├── deployment/
├── docker/
├── docs/
├── images/
├── interfaces/
├── libreasr/
├── scripts/
├── .dockerignore
├── .gitignore
├── LICENSE
├── Makefile
├── README.md
├── api-bridge.py
├── api-client.py
├── api-server.py
├── create-asr-dataset.py
├── default.nix
├── libreasr-lm.ipynb
├── libreasr.ipynb
└── split.py

各目录和文件的简要介绍：

• apps/: 包含应用程序相关文件。
• config/: 包含配置文件。
• demo/: 包含演示相关文件。
• deployment/: 包含部署相关文件。
• docker/: 包含Docker相关文件。
• docs/: 包含文档文件。
• images/: 包含图片文件。
• interfaces/: 包含接口相关文件。
• libreasr/: 包含核心代码文件。
• scripts/: 包含脚本文件。
• .dockerignore: Docker忽略文件。
• .gitignore: Git忽略文件。
• LICENSE: 项目许可证。
• Makefile: 项目构建文件。
• README.md: 项目介绍文件。
• api-bridge.py: API桥接文件。
• api-client.py: API客户端文件。
• api-server.py: API服务器文件。
• create-asr-dataset.py: 创建ASR数据集文件。
• default.nix: Nix默认配置文件。
• libreasr-lm.ipynb: 语言模型Jupyter笔记本文件。
• libreasr.ipynb: 核心Jupyter笔记本文件。
• split.py: 分割文件。

项目的启动文件介绍

LibreASR 项目的主要启动文件包括：

• api-server.py: 用于启动gRPC服务器，提供模型服务。
• api-bridge.py: 用于启动WebSocket API，供客户端使用。

启动命令示例：

python3 api-server.py
python3 api-bridge.py

项目的配置文件介绍

LibreASR 项目的主要配置文件包括：

• config/: 包含项目的各种配置文件，如模型配置、服务器配置等。
• Makefile: 包含项目的构建和启动命令。

配置文件示例：

# Makefile 示例
run:
    python3 api-server.py
    python3 api-bridge.py

通过这些配置文件，用户可以自定义项目的运行参数和环境。

LibreASR:speech_balloon: An On-Premises, Streaming Speech Recognition System 项目地址:https://gitcode.com/gh_mirrors/li/LibreASR