InvokeAI项目开发环境搭建指南
前言
InvokeAI是一个基于人工智能的图像生成和处理平台,开发者可以通过搭建本地开发环境来修改后端、前端或文档。本文将详细介绍如何从零开始搭建InvokeAI的开发环境,包括Python后端环境和前端UI环境的配置。
开发环境概述
搭建InvokeAI开发环境主要分为以下几个部分:
- 基础环境准备
- 后端Python环境配置
- 前端Node.js环境配置
- 文档开发环境配置
基础环境准备
在开始之前,需要确保系统满足以下基本要求:
- Python 3.12环境
- Git版本控制系统
- Git LFS(用于管理大文件)
- 适当的硬件配置(推荐使用NVIDIA GPU)
后端环境搭建
1. 获取项目代码
使用Git获取项目源代码,并配置Git LFS:
git clone <项目仓库地址>
cd InvokeAI
git config lfs.fetchinclude "*"
git lfs pull
2. 创建用户数据目录
建议在用户目录下创建专用目录存储开发环境的数据:
mkdir ~/invokeai_dev
3. 安装Python依赖
使用uv pip工具安装Python依赖包,这里需要特别注意几个关键点:
- 使用
-e
参数进行可编辑安装,这样修改代码后无需重新安装 - 包含
dev
、test
和docs
额外依赖 - 根据硬件情况决定是否包含xformers支持
典型安装命令如下:
uv pip install -e ".[dev,test,docs,xformers]" \
--python 3.12 \
--python-preference only-managed \
--index=https://download.pytorch.org/whl/cu126 \
--reinstall
4. 数据库配置说明
开发环境默认使用SQLite数据库,需要注意:
- 定期备份数据库文件
- 在
invokeai.yaml
中可以配置使用内存数据库:use_memory_db: true scan_models_on_startup: true
前端环境搭建
1. 安装前端工具链
需要安装以下工具:
- Node.js v20或更高版本
- pnpm v8(注意不是v9)
2. 构建前端代码
进入前端目录并执行构建:
cd invokeai/frontend/web
pnpm i
pnpm build
3. 开发模式运行
开发时可以使用开发服务器,支持热更新:
pnpm dev
开发服务器运行在127.0.0.1:5173
,与生产环境的9090
端口不同。
文档开发环境
文档系统基于mkdocs构建,启动开发服务器:
mkdocs serve
这将启动一个支持热重载的文档服务器,方便实时查看文档修改效果。
常见问题解决
- UI未显示:确保已正确构建前端代码,或正在使用开发服务器
- 数据库问题:开发环境中数据库变更可能导致问题,建议定期备份
- 依赖冲突:使用干净的Python虚拟环境可以避免多数依赖问题
结语
通过本文的步骤,您应该已经成功搭建了InvokeAI的完整开发环境。开发过程中,后端修改需要重启服务器生效,前端修改在开发模式下会自动热更新。建议开发时保持前后端分离的开发模式,以提高开发效率。
对于只想修改文档的开发者,可以跳过前端环境搭建部分,直接使用mkdocs进行文档开发。
创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考