Moshi 项目使用教程

Moshi 项目使用教程

moshi 项目地址: https://gitcode.com/gh_mirrors/mos/moshi

1. 项目目录结构及介绍

Moshi 项目是一个开源的语音-文本基础模型和全双工语音对话框架。项目目录结构如下：

• .github/：包含 GitHub 工作流和代码规范等文件。
• client/：存放客户端代码，用于运行 live demo。
• configs/：包含配置文件和推理脚本。
• data/：存放样本文件。
• moshi/：Python 版本的 Moshi 推理代码，使用 PyTorch。
• moshi_mlx/：针对 M 系列Mac的 Python 版本 Moshi 推理代码，使用 MLX。
• rust/：生产环境中使用的 Rust 版本代码。
• scripts/：包含各种脚本，如数据预处理、模型训练等。
• .gitignore：指定 Git 忽略的文件和目录。
• CONTRIBUTING.md：贡献指南。
• FAQ.md：常见问题解答。
• LICENSE-APACHE、LICENSE-MIT：项目使用的开源许可证。
• README.md：项目介绍和说明。
• docker-compose.yml：Docker 配置文件。

2. 项目的启动文件介绍

项目的主要启动文件为 moshi/server.py。此文件包含了启动 Moshi 服务的核心代码。以下是启动服务的基本命令：

python -m moshi.server [--gradio-tunnel] [--hf-repo kyutai/moshika-pytorch-bf16]

其中，--gradio-tunnel 选项用于在远程机器上运行时，通过隧道传输音频数据。--hf-repo 选项指定了 Hugging Face 的仓库，用于加载预训练模型。

启动服务后，可以通过浏览器访问 localhost:8998 来使用 web UI。

3. 项目的配置文件介绍

项目的配置文件主要位于 configs/ 目录下。以下是一些重要的配置文件：

• config.yaml：主配置文件，包含模型设置、数据路径、设备选择等。
• inference_config.yaml：推理时使用的配置文件，包含推理相关的设置。

配置文件使用 YAML 格式，可以根据需求进行修改。例如，可以更改模型类型、调整超参数、指定数据集路径等。

在运行项目之前，请确保正确配置了所有必要的环境和依赖项，并根据实际情况调整配置文件。

moshi 项目地址: https://gitcode.com/gh_mirrors/mos/moshi