Fooocus-API 项目教程

1. 项目目录结构及介绍

Fooocus-API 项目的目录结构如下：

Fooocus-API/
├── docs/
│   ├── api_doc_en.md
│   └── ...
├── examples/
│   └── ...
├── extras/
│   └── ...
├── fooocusapi/
│   └── ...
├── repositories/
│   └── Fooocus/
│       └── ...
├── .dockerignore
├── .gitignore
├── CreativeML_OpenRAIL-M
├── Dockerfile
├── LICENSE
├── README.md
├── README_zh.md
├── cog.yaml
├── environment.yaml
├── fooocus_api_version.py
├── main.py
├── predict.py
├── requirements.txt
└── ...

目录结构介绍

• docs/: 包含项目的文档文件，如 API 文档 (api_doc_en.md) 等。
• examples/: 包含项目的示例代码和配置文件。
• extras/: 包含项目的额外资源文件。
• fooocusapi/: 包含项目的主要代码文件。
• repositories/: 包含项目依赖的模型和数据文件。
• .dockerignore: Docker 忽略文件。
• .gitignore: Git 忽略文件。
• CreativeML_OpenRAIL-M: 许可证文件。
• Dockerfile: Docker 构建文件。
• LICENSE: 项目许可证文件。
• README.md: 项目的主 README 文件。
• README_zh.md: 项目的中文 README 文件。
• cog.yaml: 项目配置文件。
• environment.yaml: Conda 环境配置文件。
• fooocus_api_version.py: 项目版本文件。
• main.py: 项目的启动文件。
• predict.py: 项目的预测文件。
• requirements.txt: 项目的依赖文件。

2. 项目启动文件介绍

main.py

main.py 是 Fooocus-API 项目的启动文件。它负责初始化项目并启动 API 服务。以下是 main.py 的主要功能：

• 初始化 FastAPI 应用: 使用 FastAPI 框架初始化 API 应用。
• 加载配置: 加载项目的配置文件，如环境变量、模型路径等。
• 启动服务: 启动 FastAPI 服务，监听指定的端口和主机。

启动命令

python main.py

默认情况下，服务会监听 http://127.0.0.1:8888。可以通过命令行参数 --port 和 --host 来修改监听的端口和主机。

3. 项目配置文件介绍

environment.yaml

environment.yaml 是 Conda 环境配置文件，用于定义项目的依赖环境和版本。通过该文件，可以创建一个独立的环境来运行项目。

创建环境命令

conda env create -f environment.yaml

cog.yaml

cog.yaml 是项目的配置文件，用于定义项目的各种配置参数，如模型路径、API 端点等。该文件通常包含以下内容：

• 模型路径: 定义项目使用的模型文件路径。
• API 端点: 定义项目的 API 端点和请求方法。
• 其他配置: 如日志级别、队列大小等。

示例配置

model_path: /path/to/models
api_endpoints:
  - path: /v1/generation/text-to-image
    method: POST
    description: 生成文本到图像

通过这些配置文件，可以灵活地调整项目的运行环境和参数，以满足不同的需求。