[ 英文 | 中文 ]

• 简介
  • Fooocus
  • Fooocus-API
• 快速开始
  • 通过Replicate运行
  • 自托管
    • conda
    • venv
    • 预下载并安装
    • 已存在Fooocus
  • 使用Docker启动
• 命令行参数
• 更新日志
• API列表
• 许可证
• 致谢 :purple_heart:

注意：

尽管我已经进行了测试，但我仍然建议您在正式更新之前再次进行测试。

Fooocus 2.5 包含重大更新，大多数依赖项都已升级。因此，在更新后，请不要使用 --skip-pip 选项，除非您已经手动完成了更新。

此外，groundingdino-py 在安装时可能会遇到错误，尤其是在中文 Windows 环境下。解决方案可以在以下 issue 中找到。

GenerateMask 与 DescribeImage 相同，它不会作为一个任务来处理，结果会直接返回。

ImageEnhance 接口使用说明

以下是包含 ImageEnhance 所需主要参数的示例。V1 接口采用了类似于 ImagePrompt 的表单式设计，将增强控制器分解开来。

{
  "enhance_input_image": "",
  "enhance_checkbox": true,
  "enhance_uov_method": "Vary (Strong)",
  "enhance_uov_processing_order": "Before First Enhancement",
  "enhance_uov_prompt_type": "Original Prompts",
  "save_final_enhanced_image_only": true,
  "enhance_ctrlnets": [
    {
      "enhance_enabled": false,
      "enhance_mask_dino_prompt": "face",
      "enhance_prompt": "",
      "enhance_negative_prompt": "",
      "enhance_mask_model": "sam",
      "enhance_mask_cloth_category": "full",
      "enhance_mask_sam_model": "vit_b",
      "enhance_mask_text_threshold": 0.25,
      "enhance_mask_box_threshold": 0.3,
      "enhance_mask_sam_max_detections": 0,
      "enhance_inpaint_disable_initial_latent": false,
      "enhance_inpaint_engine": "v2.6",
      "enhance_inpaint_strength": 1,
      "enhance_inpaint_respective_field": 0.618,
      "enhance_inpaint_erode_or_dilate": 0,
      "enhance_mask_invert": false
    }
  ]
}

• enhance_input_image：需要增强的图像，这是必填项，对于 V2 接口可以提供图片 URL。
• enhance_checkbox：一个开关，如果您想使用增强图像功能，则必须将其设置为 true。
• save_final_enhanced_image_only：由于图像增强是一个流水线操作，可能会生成多张结果图像，此参数允许您只返回最终的增强图像。

与 UpscaleVary 相关的有三个参数，用于在增强之前或之后执行 Upscale 或 Vary 操作。

• enhance_uov_method：与 UpscaleOrVary 接口类似，Disabled 表示关闭该功能。
• enhance_uov_processing_order：决定是在增强之前还是之后处理图像。
• enhance_uov_prompt_type：我不太确定其具体功能，您可以根据 WebUI 进行进一步研究。

enhance_ctrlnets 元素是一个 ImageEnhance 控制器对象的列表，列表中最多可包含三个元素，多余的元素将被忽略。这些参数大致对应于 WebUI，其中值得注意的参数有：

• enhance_enabled：此参数控制增强控制器是否启用。如果没有启用的增强控制器，任务将被跳过。
• enhance_mask_dino_prompt：此参数是必需的，用于指示需要增强的区域。如果为空，即使启用了增强控制器，任务也会被跳过。

简介

基于 FastAPI 的 API，用于 Fooocus。

当前加载的 Fooocus 版本：2.3.0。

Fooocus

这部分内容来自 Fooocus 项目。 Fooocus 是一款基于 Gradio 的图像生成软件。 Fooocus 重新思考了 Stable Diffusion 和 Midjourney 的设计理念：

• 借鉴 Stable Diffusion，该软件是离线、开源且免费的。
• 借鉴 Midjourney，无需手动调整参数，用户只需专注于提示词和图像即可。 Fooocus 内置并自动化了许多内部优化和质量提升功能。用户可以不再关注那些复杂的技术参数，而只需享受人机交互带来的乐趣，从而“探索新的思维媒介，拓展人类的想象力”。

Fooocus-API

我想您一定尝试过使用 Gradio 客户端 来调用 Fooocus，但对我来说那是一次非常糟糕的体验。 Fooocus API 使用 FastAPI 提供了用于调用 Fooocus 的 REST API。现在，您可以使用任何您喜欢的语言来利用 Fooocus 的强大功能。 此外，我们还提供了详细的 文档 和 示例代码。

快速开始

通过 Replicate 运行

现在您可以通过 Replicate 使用 Fooocus-API，模型位于 konieshadow/fooocus-api。 预设配置包括：

• konieshadow/fooocus-api-anime
• konieshadow/fooocus-api-realistic

我认为这是利用 Fooocus 功能生成图像的最简单方式。

自托管

您需要 Python 3.10 或更高版本，或者使用 conda 创建一个新的环境。 硬件要求与 Fooocus 相同。详细信息请参见 此处。

conda

您可以按照以下步骤轻松使用 conda 启动应用：

conda env create -f environment.yaml
conda activate fooocus-api

然后运行 python main.py 启动应用，默认情况下，服务器会监听 http://127.0.0.1:8888。

如果您是第一次运行该项目，可能需要等待一段时间，在此期间程序将完成剩余的安装并下载必要的模型。您也可以手动完成这些步骤，稍后我会提到。

venv

与使用 conda 类似，创建一个虚拟环境，然后启动并等待一段时间。

# windows
python -m venv venv
.\venv\Scripts\Activate

# linux
python -m venv venv
source venv/bin/activate

然后运行 python main.py

预先下载并安装

如果您希望手动处理环境问题并提前下载模型，可以参考以下步骤：

使用 conda 或 venv 创建完整环境后，您可以手动完成后续环境的安装，只需按照以下步骤操作：

首先，安装依赖：pip install -r requirements.txt

然后，安装带有 CUDA 的 PyTorch：pip install torch==2.1.0 torchvision==0.16.0 torchaudio==2.1.0 --index-url https://download.pytorch.org/whl/cu121。有关更多信息，请参阅 此处。

请注意，对于 PyTorch 和 CUDA 的版本，建议使用 Fooocus 推荐的版本，即当前的 PyTorch 2.1.0 + CUDA 12.1。如果您坚持使用其他版本，在启动应用时需要添加 --skip-pip 参数，否则系统会自动安装推荐版本。

进入 repositories 目录，下载模型并将其放入 repositories\Fooocus\models 文件夹中。

如果您已经安装了 Fooocus，请参阅 already-exist-fooocus。

以下是启动时需要下载的文件列表（根据不同的 启动参数 可能有所不同）：

• 检查点：路径为 repositories\Fooocus\models\checkpoints

  • juggernautXL_version6Rundiffusion.safetensors

• 近似 VAE：路径为 repositories\Fooocus\models\vae_approx

  • xlvaeapp.pth
  • vaeapp_sd15.pth
  • xl-to-v1_interposer-v3.1.safetensors

• LoRA：路径为 repositories\Fooocus\models\loras

  • sd_xl_offset_example-lora_1.0.safetensors

我已上传我正在使用的模型，其中包含了 Fooocus 将要使用的所有基础模型！您可以从 这里 下载，提取码为：D4Mk。

已存在 Fooocus

如果您已经安装了 Fooocus，并且运行良好，推荐的方式是复用现有模型。您只需将本地 Fooocus 文件夹中的 config.txt 文件复制到 Fooocus-API 的根目录即可。详细信息请参阅 Customization。

使用此方法，您可以同时运行 Fooocus 和 Fooocus-API，两者独立运作，互不干扰。

请勿将 Fooocus 复制到 repositories 目录下。

使用 Docker 启动

在使用带有 GPU 的 Docker 之前，您应先 安装 NVIDIA Container Toolkit。

运行以下命令：

docker run -d --gpus=all \
    -e NVIDIA_DRIVER_CAPABILITIES=compute,utility \
    -e NVIDIA_VISIBLE_DEVICES=all \
    -p 8888:8888 konieshadow/fooocus-api

对于更复杂的使用场景：

mkdir ~/repositories
mkdir -p ~/.cache/pip

docker run -d --gpus=all \
    -e NVIDIA_DRIVER_CAPABILITIES=compute,utility \
    -e NVIDIA_VISIBLE_DEVICES=all \
    -v ~/repositories:/app/repositories \
    -v ~/.cache/pip:/root/.cache/pip \
    -p 8888:8888 konieshadow/fooocus-api

这样可以持久化依赖的仓库和 pip 缓存。

您还可以在 docker run 命令中添加 -e PIP_INDEX_URL={pypi-mirror-url} 来更改 pip 的索引地址。

从版本 0.4.0.0 开始，Docker 镜像中已包含完整的环境，如有需要，可映射 models 或项目根目录。 例如：

docker run -d --gpus all \
    -v /Fooocus-API:/app \
    -p 8888:8888 konieshadow/fooocus-api

命令行参数

• -h, --help 显示帮助信息并退出
• --port PORT 设置监听端口，默认为 8888
• --host HOST 设置监听主机，默认为 127.0.0.1
• --base-url BASE_URL 设置外部访问的基础 URL，默认为 http://host:port
• --log-level LOG_LEVEL 设置 Uvicorn 的日志级别，默认为 info
• --skip-pip 在设置时跳过自动 pip 安装
• --preload-pipeline 在启动 HTTP 服务器前预加载管道
• --queue-size QUEUE_SIZE 工作队列大小，默认为 100，超出工作队列大小的生成请求将返回失败
• --queue-history QUEUE_HISTORY 已完成任务的保留数量，超过限制的任务将被删除，包括输出图像文件，默认为 0，表示无限制
• --webhook-url WEBHOOK_URL 用于通知生成结果的 webhook 地址，默认为 None
• --persistent 将历史记录存储到数据库中
• --apikey APIKEY 设置 API 密钥以启用安全 API，默认为 None

自 v0.3.25 起，新增了对 Fooocus 命令行参数的支持。您可以传递任何 Fooocus 支持的参数。

例如，要启动图像生成（需要更多显存）：

python main.py --all-in-fp16 --always-gpu

有关 Fooocus 的命令行参数，请参阅 此处。

更改日志

CHANGELOG

更早的更改历史可以在 发布页面 中找到。

API

所有 API 的详细信息请参阅 此处。

许可证

本仓库采用 GNU 通用公共许可证 v3.0 许可。

默认的检查点由 RunDiffusion 发布，采用 CreativeML Open RAIL-M 许可。

或者，您也可以在 这里 找到相关信息。

感谢 :purple_heart:

感谢各位为改进 Fooocus API 所做出的贡献和努力。我们感谢您成为我们 :sparkles: 社区 :sparkles:!

Fooocus-API 快速上手指南

Fooocus-API 是基于 FastAPI 构建的 RESTful 接口，旨在让开发者能够通过代码轻松调用 Fooocus 强大的图像生成能力，摆脱 Gradio 客户端的限制。

1. 环境准备

系统要求

• Python 版本: >= 3.10
• 操作系统: Windows / Linux / macOS
• 硬件要求: 与 Fooocus 一致（推荐 NVIDIA GPU，显存建议 8GB 以上）。
  • 详细硬件要求参考：Fooocus Minimal Requirement

前置依赖

• NVIDIA Container Toolkit (仅 Docker 模式需要): 用于支持 GPU 加速。
• Git: 用于克隆项目代码。

2. 安装步骤

你可以选择以下任意一种方式进行部署：

方式一：使用 Conda 安装（推荐）

# 1. 创建虚拟环境
conda env create -f environment.yaml

# 2. 激活环境
conda activate fooocus-api

# 3. 启动服务
# 首次运行会自动下载模型和依赖，可能需要等待一段时间
python main.py

方式二：使用 venv 安装

Windows:

python -m venv venv
.\venv\Scripts\Activate
pip install -r requirements.txt
# 安装 CUDA 版 PyTorch (推荐版本：2.1.0 + cu121)
pip install torch==2.1.0 torchvision==0.16.0 torchaudio==2.1.0 --index-url https://download.pytorch.org/whl/cu121
python main.py

Linux:

python -m venv venv
source venv/bin/activate
pip install -r requirements.txt
pip install torch==2.1.0 torchvision==0.16.0 torchaudio==2.1.0 --index-url https://download.pytorch.org/whl/cu121
python main.py

手动预下载模型提示： 若需手动下载模型以避免自动下载失败，请将模型放入 repositories/Fooocus/models 对应目录。 国内用户可使用作者提供的整合包加速下载：123pan 下载链接 (提取码: D4Mk)。

方式三：使用 Docker 启动（最简便）

确保已安装 NVIDIA Container Toolkit，然后运行：

docker run -d --gpus=all \
    -e NVIDIA_DRIVER_CAPABILITIES=compute,utility \
    -e NVIDIA_VISIBLE_DEVICES=all \
    -p 8888:8888 konieshadow/fooocus-api

持久化存储配置（推荐）： 将模型目录和 pip 缓存映射到宿主机，避免重复下载：

mkdir ~/repositories
mkdir -p ~/.cache/pip

docker run -d --gpus=all \
    -e NVIDIA_DRIVER_CAPABILITIES=compute,utility \
    -e NVIDIA_VISIBLE_DEVICES=all \
    -v ~/repositories:/app/repositories \
    -v ~/.cache/pip:/root/.cache/pip \
    -p 8888:8888 konieshadow/fooocus-api

3. 基本使用

服务默认启动在 http://127.0.0.1:8888。你可以通过发送 POST 请求调用 API。

最简单的文生图示例

以下是一个使用 curl 调用基础文生图接口的示例：

curl -X POST "http://127.0.0.1:8888/v1/generation/text-to-image" \
  -H "Content-Type: application/json" \
  -d '{
    "prompt": "a beautiful girl with long hair, cyberpunk style, high quality",
    "negative_prompt": "",
    "style_selections": ["Fooocus V2"],
    "performance_selection": "Speed",
    "aspect_ratios_selection": "1152*896",
    "image_number": 1,
    "seed": -1,
    "read_wildcards_in_order": false,
    "sharpness": 2.0,
    "guidance_scale": 4.0,
    "base_model_name": "juggernautXL_version6Rundiffusion.safetensors",
    "refiner_model_name": "None",
    "refiner_switch": 0.5,
    "lora_selection": [],
    "input_image_checkbox": false
  }'

图像增强示例 (ImageEnhance)

若需使用图像增强功能，需设置 enhance_checkbox 为 true 并提供输入图片：

{
  "enhance_input_image": "https://example.com/image.jpg",
  "enhance_checkbox": true,
  "enhance_uov_method": "Vary (Strong)",
  "save_final_enhanced_image_only": true,
  "enhance_ctrlnets": [
    {
      "enhance_enabled": true,
      "enhance_mask_dino_prompt": "face",
      "enhance_mask_model": "sam",
      "enhance_inpaint_engine": "v2.6",
      "enhance_inpaint_strength": 1
    }
  ]
}

常用启动参数

你可以通过命令行参数自定义服务行为：

• --port: 设置监听端口 (默认 8888)
• --host: 设置监听地址 (默认 127.0.0.1)
• --apikey: 设置 API Key 以启用安全验证
• --skip-pip: 跳过启动时的自动 pip 安装（适用于已手动更新依赖的情况）
• --preload-pipeline: 启动时预加载模型管线

示例：

python main.py --port 9000 --apikey my-secret-key --all-in-fp16

注意: Fooocus 2.5+ 版本更新了大部分依赖，更新后除非已手动处理，否则请勿使用 --skip-pip。