liumaolin
commited on
Commit
·
28762c8
1
Parent(s):
aac52b6
Add detailed installation guide and restructure README setup section
Browse files- Create `docs/installation.md` with comprehensive installation instructions, system requirements, and troubleshooting steps.
- Update README to condense installation steps and link to the full guide.
- README.md +9 -37
- docs/installation.md +149 -0
README.md
CHANGED
@@ -99,58 +99,30 @@ VoiceDialogue 是一个基于 Python 的完整语音对话系统,实现了端
|
|
99 |
- **内存要求**: 至少 16GB RAM (推荐 32GB 用于大模型)
|
100 |
- **存储空间**: 至少 20GB 可用空间 (用于模型文件)
|
101 |
|
102 |
-
###
|
103 |
|
104 |
-
1. **克隆项目**
|
105 |
```bash
|
|
|
106 |
git clone https://huggingface.co/MoYoYoTech/VoiceDialogue
|
107 |
cd VoiceDialogue
|
108 |
-
```
|
109 |
|
110 |
-
2.
|
111 |
-
```bash
|
112 |
-
# 使用 uv (推荐)
|
113 |
pip install uv
|
114 |
uv venv
|
115 |
source .venv/bin/activate
|
116 |
|
117 |
-
#
|
118 |
-
conda create -n voicedialogue python=3.11
|
119 |
-
conda activate voicedialogue
|
120 |
-
|
121 |
-
# 或使用 venv
|
122 |
-
python -m venv voicedialogue
|
123 |
-
source voicedialogue/bin/activate
|
124 |
-
```
|
125 |
-
|
126 |
-
3. **安装项目依赖**
|
127 |
-
```bash
|
128 |
-
# 使用 uv (推荐)
|
129 |
WHISPER_COREML=1 CMAKE_ARGS="-DGGML_METAL=on" uv sync
|
130 |
|
131 |
-
#
|
132 |
-
WHISPER_COREML=1 CMAKE_ARGS="-DGGML_METAL=on" pip install -r requirements.txt
|
133 |
-
```
|
134 |
-
|
135 |
-
4. **安装音频处理工具**
|
136 |
-
```bash
|
137 |
-
# macOS
|
138 |
brew install ffmpeg
|
139 |
-
```
|
140 |
|
141 |
-
5.
|
142 |
-
|
143 |
-
# 安装 kokoro-onnx
|
144 |
-
uv pip install kokoro-onnx
|
145 |
-
# 或
|
146 |
-
pip install kokoro-onnx
|
147 |
-
|
148 |
-
# 重新安装指定版本的 numpy
|
149 |
-
uv pip install numpy==1.26.4
|
150 |
-
# 或
|
151 |
-
pip install numpy==1.26.4
|
152 |
```
|
153 |
|
|
|
|
|
154 |
### 🖥️ 应用模式
|
155 |
|
156 |
#### 1. 命令行模式 (默认)
|
|
|
99 |
- **内存要求**: 至少 16GB RAM (推荐 32GB 用于大模型)
|
100 |
- **存储空间**: 至少 20GB 可用空间 (用于模型文件)
|
101 |
|
102 |
+
### 快速安装
|
103 |
|
|
|
104 |
```bash
|
105 |
+
# 1. 克隆项目
|
106 |
git clone https://huggingface.co/MoYoYoTech/VoiceDialogue
|
107 |
cd VoiceDialogue
|
|
|
108 |
|
109 |
+
# 2. 创建虚拟环境(推荐)
|
|
|
|
|
110 |
pip install uv
|
111 |
uv venv
|
112 |
source .venv/bin/activate
|
113 |
|
114 |
+
# 3. 安装依赖
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
115 |
WHISPER_COREML=1 CMAKE_ARGS="-DGGML_METAL=on" uv sync
|
116 |
|
117 |
+
# 4. 安装系统依赖
|
|
|
|
|
|
|
|
|
|
|
|
|
118 |
brew install ffmpeg
|
|
|
119 |
|
120 |
+
# 5. 启动系统
|
121 |
+
python main.py
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
122 |
```
|
123 |
|
124 |
+
> 📖 **详细安装指南**: 如需了解完整的安装步骤、系统要求和故障排除,请查看 **[安装指南](docs/installation.md)**
|
125 |
+
|
126 |
### 🖥️ 应用模式
|
127 |
|
128 |
#### 1. 命令行模式 (默认)
|
docs/installation.md
ADDED
@@ -0,0 +1,149 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# VoiceDialogue 安装指南
|
2 |
+
|
3 |
+
本文档提供 VoiceDialogue 智能语音对话系统的详细安装说明。
|
4 |
+
|
5 |
+
## 系统要求
|
6 |
+
|
7 |
+
在开始安装之前,请确保您的系统满足以下要求:
|
8 |
+
|
9 |
+
- **操作系统**: macOS 14+ (推荐)
|
10 |
+
- **Python 版本**: 3.9 或更高版本
|
11 |
+
- **内存要求**: 至少 16GB RAM (推荐 32GB 用于大模型)
|
12 |
+
- **存储空间**: 至少 20GB 可用空间 (用于模型文件)
|
13 |
+
|
14 |
+
## 安装步骤
|
15 |
+
|
16 |
+
### 1. 克隆项目
|
17 |
+
|
18 |
+
```bash
|
19 |
+
git clone https://huggingface.co/MoYoYoTech/VoiceDialogue
|
20 |
+
cd VoiceDialogue
|
21 |
+
```
|
22 |
+
|
23 |
+
### 2. 创建并激活虚拟环境
|
24 |
+
|
25 |
+
建议使用虚拟环境来避免依赖冲突:
|
26 |
+
|
27 |
+
```bash
|
28 |
+
# 使用 uv (推荐)
|
29 |
+
pip install uv
|
30 |
+
uv venv
|
31 |
+
source .venv/bin/activate
|
32 |
+
|
33 |
+
# 或使用 conda
|
34 |
+
conda create -n voicedialogue python=3.11
|
35 |
+
conda activate voicedialogue
|
36 |
+
|
37 |
+
# 或使用 venv
|
38 |
+
python -m venv voicedialogue
|
39 |
+
source voicedialogue/bin/activate
|
40 |
+
```
|
41 |
+
|
42 |
+
### 3. 安装项目依赖
|
43 |
+
|
44 |
+
```bash
|
45 |
+
# 使用 uv (推荐)
|
46 |
+
WHISPER_COREML=1 CMAKE_ARGS="-DGGML_METAL=on" uv sync
|
47 |
+
|
48 |
+
# 或使用 pip
|
49 |
+
WHISPER_COREML=1 CMAKE_ARGS="-DGGML_METAL=on" pip install -r requirements.txt
|
50 |
+
```
|
51 |
+
|
52 |
+
### 4. 安装音频处理工具
|
53 |
+
|
54 |
+
```bash
|
55 |
+
# macOS
|
56 |
+
brew install ffmpeg
|
57 |
+
```
|
58 |
+
|
59 |
+
### 5. 安装额外依赖
|
60 |
+
|
61 |
+
```bash
|
62 |
+
# 安装 kokoro-onnx
|
63 |
+
uv pip install kokoro-onnx
|
64 |
+
# 或
|
65 |
+
pip install kokoro-onnx
|
66 |
+
|
67 |
+
# 重新安装指定版本的 numpy
|
68 |
+
uv pip install numpy==1.26.4
|
69 |
+
# 或
|
70 |
+
pip install numpy==1.26.4
|
71 |
+
```
|
72 |
+
|
73 |
+
## 验证安装
|
74 |
+
|
75 |
+
安装完成后,可以通过以下命令验证安装是否成功:
|
76 |
+
|
77 |
+
```bash
|
78 |
+
# 查看帮助信息
|
79 |
+
python main.py --help
|
80 |
+
|
81 |
+
# 启动系统(默认使用中文,沈逸角色)
|
82 |
+
python main.py
|
83 |
+
```
|
84 |
+
|
85 |
+
如果看到 "服务启动成功" 提示,说明安装成功。
|
86 |
+
|
87 |
+
## 故障排除
|
88 |
+
|
89 |
+
### 1. 模型下载失败
|
90 |
+
- **问题**: 网络连接超时或模型下载失败。
|
91 |
+
- **解决方案**: 设置 Hugging Face 镜像。
|
92 |
+
```bash
|
93 |
+
export HF_ENDPOINT=https://hf-mirror.com
|
94 |
+
pip install -U huggingface_hub
|
95 |
+
```
|
96 |
+
|
97 |
+
### 2. 音频设备问题
|
98 |
+
- **问题**: 找不到音频设备或权限被拒绝。
|
99 |
+
- **macOS 解决方案**: 系统设置 → 隐私与安全性 → 麦克风 → 启用你的终端应用 (如 iTerm, Terminal)。
|
100 |
+
|
101 |
+
### 3. 内存不足错误 (OOM)
|
102 |
+
- **问题**: `CUDA out of memory` 或 RAM 不足。
|
103 |
+
- **解决方案**: LLM 是主要的内存消耗者。你可以通过修改 `src/VoiceDialogue/services/text/generator.py` 来降低资源消耗:
|
104 |
+
- **更换模型**: 将模型路径指向一个更小的模型(如 7B Q4 量化模型)。
|
105 |
+
- **减少批处理大小**: 减小模型参数中的 `n_batch` 值(如 `256`)。
|
106 |
+
- **减少上下文长度**: 减小 `n_ctx` 的值(如 `1024`)。
|
107 |
+
|
108 |
+
### 4. 依赖包冲突
|
109 |
+
- **问题**: 包版本冲突或导入错误。
|
110 |
+
- **解决方案**: 强烈建议在虚拟环境中安装。如果遇到问题,尝试重建虚拟环境。
|
111 |
+
```bash
|
112 |
+
# 使用 conda
|
113 |
+
conda deactivate
|
114 |
+
conda env remove -n voicedialogue
|
115 |
+
|
116 |
+
# 使用 uv
|
117 |
+
rm -rf .venv
|
118 |
+
uv venv
|
119 |
+
```
|
120 |
+
|
121 |
+
### 5. FFmpeg 相关错误
|
122 |
+
- **问题**: 音频处理失败或编解码错误。
|
123 |
+
- **解决方案**: 确保正确安装 FFmpeg:
|
124 |
+
```bash
|
125 |
+
# 检查 FFmpeg 安装
|
126 |
+
ffmpeg -version
|
127 |
+
|
128 |
+
# 重新安装 FFmpeg
|
129 |
+
# macOS
|
130 |
+
brew reinstall ffmpeg
|
131 |
+
```
|
132 |
+
|
133 |
+
### 6. Python 版本兼容性
|
134 |
+
- **问题**: Python 版本过低导致的兼容性问题。
|
135 |
+
- **解决方案**: 确保使用 Python 3.11+ 版本:
|
136 |
+
```bash
|
137 |
+
python --version
|
138 |
+
# 如果版本过低,请升级或使用虚拟环境
|
139 |
+
```
|
140 |
+
|
141 |
+
## 下一步
|
142 |
+
|
143 |
+
安装完成后,您可以:
|
144 |
+
|
145 |
+
1. [查看使用指南](../README.md#🖥️-应用模式) 了解如何使用系统
|
146 |
+
2. [查看配置选项](../README.md#⚙️-配置选项) 了解如何自定义配置
|
147 |
+
3. [查看系统架构](../README.md#🔧-系统架构) 了解系统工作原理
|
148 |
+
|
149 |
+
如果遇到其他问题,请查看 [完整故障排除指南](../README.md#🛠️-故障排除) 或提交 Issue。
|