InvokeAI 项目使用教程
1. 项目目录结构及介绍
InvokeAI 的目录结构如下所示:
.
├── .dev_scripts
├── .github
├── coverage
├── docker
├── docs
├── installer
├── invokeai
├── scripts
├── tests
├── .dockerignore
├── .editorconfig
├── .git-blame-ignore-revs
├── .gitattributes
├── .gitignore
├── .gitmodules
├── .pre-commit-config.yaml
├── .prettierrc.yaml
├── InvokeAI_Statement_of_Values.md
├── LICENSE
├── LICENSE-SD1+SD2.txt
├── LICENSE-SDXL.txt
├── Makefile
├── README.md
├── SECURITY.md
├── Stable_Diffusion_v1_Model_Card.md
├── flake.lock
├── flake.nix
├── mkdocs.yml
├── pyproject.toml
└── ...
主要目录和文件说明:
.dev_scripts
: 开发脚本目录,包含了项目开发过程中使用的脚本。.github
: 包含 GitHub 工作流程文件,例如 issue 和 pull request 的模板。coverage
: 测试覆盖率相关的文件。docker
: 包含 Docker 相关的配置和脚本。docs
: 文档目录,包含了项目文档的源文件。installer
: 安装脚本目录,包含了不同操作系统下的安装脚本。invokeai
: 核心代码目录,包含了 InvokeAI 的主要实现。scripts
: 附加脚本目录,包含了项目辅助脚本。tests
: 测试代码目录,包含了项目的单元测试和集成测试。.dockerignore
: Docker 忽略文件列表。.editorconfig
: 编辑器配置文件,用于统一开发者的代码风格。.git*
: Git 配置文件和规则,用于管理版本控制。LICENSE*
: 项目许可证文件。Makefile
: Makefile 文件,用于构建项目。README.md
: 项目自述文件,包含了项目的基本信息和使用说明。SECURITY.md
: 安全策略文件,描述了如何报告安全问题。Stable_Diffusion_v1_Model_Card.md
: 模型卡片文件,提供了模型的信息。flake.lock
和flake.nix
: 包管理工具的锁定文件。mkdocs.yml
: MkDocs 配置文件,用于构建文档网站。pyproject.toml
: 项目配置文件,用于定义项目的依赖和构建系统。
2. 项目的启动文件介绍
InvokeAI 的启动文件根据操作系统不同而有所区别:
- 对于 Windows 系统,启动文件是
invoke.bat
。 - 对于 macOS 和 Linux 系统,启动文件是
invoke.sh
。
这些启动脚本位于项目根目录下的 invokeai
文件夹中。运行这些脚本会启动一个本地服务器,通常在 http://localhost:9090
地址上,然后可以通过浏览器访问该地址来使用 InvokeAI 的 Web UI。
3. 项目的配置文件介绍
InvokeAI 的配置主要通过 pyproject.toml
文件进行。这个文件包含了项目的元数据和依赖,还可能包含一些构建和运行时配置。
此外,项目的配置还可能涉及到以下几个文件:
invokeai/config.py
: 这个文件可能包含了项目的默认配置,例如服务器端口、数据库连接信息等。.env
: 环境变量文件,用于设置环境变量,通常用于敏感信息的配置,如 API 密钥等。
确保在运行项目之前,正确配置了这些文件中的所有必要设置。如果需要自定义设置,请参照项目的官方文档或相关配置指南进行修改。