1 line
5.5 KiB
JSON
1 line
5.5 KiB
JSON
{"repo": "21thsth/eduscope", "files": {"SETUP.md": {"ee10ac0fe0e95209f695c68cc986b407786cea69": {"t": 1785747215.1885653, "n": 3751, "h": "00ece852b93187ad", "c": "# 🚀 EduScope 项目设置指南\n\n本文档详细说明如何在新设备上设置和部署EduScope项目。\n\n## 📋 系统要求检查清单\n\n在开始之前，请确认你的系统满足以下要求：\n\n### 硬件要求\n- [ ] CPU: Intel i5/AMD Ryzen 5 或更高\n- [ ] 内存: 最低8GB RAM (推荐16GB+)\n- [ ] 存储: 至少10GB可用空间\n- [ ] GPU: NVIDIA GPU (可选，用于CUDA加速)\n\n### 软件要求\n- [ ] 操作系统: Windows 10/11, macOS 11+, Linux (Ubuntu 20.04+)\n- [ ] Python: 3.9-3.11\n- [ ] Git: 最新版本\n- [ ] FFmpeg: 用于音视频处理\n\n## 🔧 快速安装指南\n\n### 方法1: 使用自动安装脚本 (推荐)\n\n#### Windows\n```bash\n# 1. 克隆项目\ngit clone https://github.com/21thsth/EduScope.git\ncd EduScope\n\n# 2. 运行安装脚本\ninstall.bat\n```\n\n#### Linux/macOS\n```bash\n# 1. 克隆项目\ngit clone https://github.com/21thsth/EduScope.git\ncd EduScope\n\n# 2. 设置执行权限并运行安装脚本\nchmod +x install.sh\n./install.sh\n```\n\n### 方法2: 手动安装\n\n#### 1. 克隆项目\n```bash\ngit clone https://github.com/21thsth/EduScope.git\ncd EduScope\n```\n\n#### 2. 创建虚拟环境\n```bash\n# 创建虚拟环境\npython -m venv venv\n\n# 激活虚拟环境\n# Windows\nvenv\\Scripts\\activate\n# Linux/macOS \nsource venv/bin/activate\n```\n\n#### 3. 安装依赖\n```bash\n# 升级pip\npython -m pip install --upgrade pip\n\n# 安装项目依赖\npip install -r requirements.txt\n```\n\n#### 4. 安装FFmpeg\n\n**Windows:**\n1. 下载 [FFmpeg](https://ffmpeg.org/download.html#build-windows)\n2. 解压到 `C:\\ffmpeg`\n3. 将 `C:\\ffmpeg\\bin` 添加到系统PATH环境变量\n\n**Linux (Ubuntu/Debian):**\n```bash\nsudo apt update\nsudo apt install ffmpeg\n```\n\n**macOS:**\n```bash\nbrew install ffmpeg\n```\n\n#### 5. 验证安装\n```bash\npython check_models.py\n```\n\n## 🎯 启动项目\n\n### Web版本 (推荐)\n```bash\n# 方法1: 直接启动\nstreamlit run app.py\n\n# 方法2: 使用脚本\n# Windows\nstart_streamlit.bat\n# 或\nrun.bat\n\n# Linux/macOS\n./run.sh\n```\n\n### 桌面版本\n```bash\npython main.py\n```\n\n## ⚙️ 配置说明\n\n### 基础配置\n主要配置文件位于 `config.py`，包含以下关键设置：\n\n```python\n# 语音识别配置\nASR_CONFIG = {\n \"default_model\": \"small\", # 模型大小\n \"default_language\": \"zh\", # 默认语言\n \"device_type\": \"cuda\", # 设备类型\n}\n\n# 敏感词检测配置 \nDETECTION_CONFIG = {\n \"detection_algorithm\": \"dfa\", # 检测算法\n}\n```\n\n### LLM API配置\n如果需要使用LLM功能，请配置API密钥：\n\n#### DeepSeek API\n1. 注册 [DeepSeek](https://platform.deepseek.com/) 账号\n2. 获取API Key\n3. 在 `config.py` 中更新：\n```python\n\"deepseek\": {\n \"api_key\": \"你的_DEEPSEEK_API_KEY\",\n}\n```\n\n#### Qwen API \n1. 注册 [阿里云DashScope](https://dashscope.aliyun.com/) 账号\n2. 获取API Key\n3. 在 `config.py` 中更新：\n```python\n\"qwen\": {\n \"api_key\": \"你的_QWEN_API_KEY\", \n}\n```\n\n## 🧪 测试安装\n\n### 1. 功能测试\n```bash\n# 测试音频处理\npython test_audio.py\n\n# 测试报告生成\npython test_pdf_report.py\n```\n\n### 2. 模型可用性检查\n```bash\npython check_models.py\n```\n\n### 3. Web界面测试\n访问 `http://localhost:8501` 确认界面正常加载。\n\n## 🔍 故障排除\n\n### 常见问题\n\n#### 1. Python版本不兼容\n**问题**: `ModuleNotFoundError` 或版本冲突\n**解决**: 确认Python版本为3.9-3.11\n```bash\npython --version\n```\n\n#### 2. CUDA不可用\n**问题**: GPU加速不工作\n**解决**: \n- 检查NVIDIA驱动是否最新\n- 安装CUDA版本的PyTorch\n- 在配置中使用CPU模式\n\n#### 3. FFmpeg未找到\n**问题**: `ffmpeg: command not found`\n**解决**:\n- Windows: 检查PATH环境变量\n- Linux/macOS: 重新安装FFmpeg\n\n#### 4. 依赖安装失败\n**问题**: pip安装报错\n**解决**:\n```bash\n# 使用国内镜像\npip install -r requirements.txt -i https://pypi.tuna.tsinghua.edu.cn/simple/\n\n# 或逐个安装关键依赖\npip install streamlit torch faster-whisper\n```\n\n#### 5. 端口已被占用\n**问题**: `Port 8501 is already in use`\n**解决**:\n```bash\n# 指定其他端口\nstreamlit run app.py --server.port 8502\n```\n\n### 日志查看\n项目运行时会生成日志文件 `eduScope.log`，包含详细的错误信息。\n\n## 🌟 性能优化建议\n\n### GPU加速\n- 安装CUDA版本PyTorch: `pip install torch torchvision torchaudio --index-url https://download.pytorch.org/whl/cu118`\n- 确保NVIDIA驱动版本 >= 450.80.02\n\n### 模型选择\n- **快速测试**: 使用 `base` 模型\n- **生产环境**: 使用 `small` 模型 (推荐)\n- **最高精度**: 使用 `large-v3` 模型\n\n### 内存优化\n- 大文件自动分割处理\n- 调整 `chunk_size_seconds` 参数\n- 启用自动清理临时文件\n\n## 📚 更多资源\n\n- [项目文档](README.MD)\n- [贡献指南](CONTRIBUTING.md)\n- [问题反馈](https://github.com/21thsth/EduScope/issues)\n- [功能讨论](https://github.com/21thsth/EduScope/discussions)\n\n## 🆘 获取帮助\n\n如果在安装过程中遇到问题：\n\n1. 检查本文档的故障排除部分\n2. 查看项目Issues页面寻找类似问题\n3. 创建新的Issue描述你的问题\n4. 提供完整的错误日志和系统信息\n\n---\n\n🎉 祝你使用愉快！如果本项目对你有帮助，请给我们一个Star！⭐ "}}}} |