DiffuDiff 使用文档

安装指南

安装步骤

1. 下载项目

   • 在 GitHub 上克隆仓库：

     git clone https://github.com/CLOUDWERX-DEV/diffuDiff.git
     

   • 进入项目目录：

     cd diffuDiff
     

2. 安装依赖

   • 确保你已经安装了以下工具：
     • Git：用于版本控制和代码管理。
     • CMake：用于生成构建文件。
     • NVIDIA CUDA Toolkit（可选）：如果你有 GPU 并希望加速推理，需要安装 CUDA 和 cuDNN。
   • 安装依赖时遇到问题，请参考 官方文档。

3. 构建项目

   • 创建构建目录：

     mkdir build && cd build
     

   • 生成构建文件（使用 CMake）：

     cmake ..
     

   • 编译项目：

     make
     

4. 运行示例

   • 在构建目录中运行默认示例：

     ./diffuDiff.sh "你的提示"
     

   • 你也可以指定输出路径和模型：

     ./diffuDiff.sh --output-dir ./outputs/ --model flux-schnell "你的提示"
     

配置文件

配置结构

项目配置存储在 config.json 文件中，位于项目的根目录下。以下是一个示例配置：

{
  "models": {
    "flux-schnell": {
      "path": "./weights/flux_schnell.pth",
      "device": "cuda:0"
    },
    "stable-diffusion": {
      "path": "./weights/stable_diffusion.pth",
      "device": "cpu"
    }
  },
  "output_settings": {
    "save_location": "./outputs/",
    "max_images_per_batch": 4,
    "jpeg_quality": 90
  },
  "api": {
    "enable_api": true,
    "port": 5199,
    "allowed_hosts": ["*"]
  }
}

配置参数

• models：定义可用模型及其路径和设备信息。
• output_settings：指定输出图像的保存位置、每批最大图片数量及 JPEG 质量。
• api：配置 OpenAPI 服务，包括是否启用 API、监听端口及允许访问的主机。

使用方法

命令行参数

运行脚本时，可以使用以下选项：

Usage: ./diffuDiff.sh [OPTIONS] <PROMPT>

Options:
  -h, --help             显示帮助信息并退出。
  -o, --output-dir PATH   指定输出目录，默认为"./outputs/"。
  -m, --model MODEL_NAME  指定使用的模型，默认为"flux-schnell"。
  -s, --seed SEED_VALUE   设置随机种子，生成可重复的结果。
  -v, --verbose          启用调试模式，显示详细日志信息。

示例

1. 基本使用

   ./diffuDiff.sh "一只坐在月光下的猫"
   

2. 指定模型和输出目录

   ./diffuDiff.sh --model stable-diffusion --output-dir ./custom_outputs/ "一张梵高的风格的向日葵"
   

优化与性能

加速技术

1. GPU 加速：

   • 确保 CUDA 和 cuDNN 已正确安装。
   • 在配置文件中指定模型使用的设备，如 "device": "cuda:0"。

2. 并行处理：

   • 调整 output_settings 中的 max_images_per_batch 来控制每批生成的最大图像数量。

3. 内存优化：

   • 使用低分辨率或较小的模型以减少内存占用。
   • 避免同时加载过多模型至内存中。

教程与示例

快速开始教程

1. 安装依赖和项目（参见安装指南）。
2. 下载预训练模型：

   ./diffuDiff.sh download-models
   

3. 运行基本推理：

   ./diffuDiff.sh "一只飞翔的鸟"
   

高级教程

• 自定义模型：修改 config.json 中的模型路径，添加新的预训练模型。
• 批量生成：设置 --max_images_per_batch 以提高生成效率。
• API 集成：启用 API 后，可通过 HTTP 请求进行图像生成。

错误排除

常见问题

1. 无法启动脚本

   • 确保所有依赖已正确安装。
   • 检查日志文件 logs/output.log 以获取更多信息。

2. 内存不足

   • 减少生成的图像分辨率。
   • 使用 CPU 进行推理，避免 GPU 超负荷。

3. 模型加载失败

   • 确认模型路径正确且文件存在。
   • 检查配置文件中的设备设置是否与硬件匹配。

开发指南

代码结构

项目目录结构如下：

diffuDiff/
├── src/                 # 核心源代码
│   ├── main.cpp        # 主程序入口
│   └── ModelLoader.cpp # 模型加载器
├── CMakeLists.txt       # CMake 配置文件
└── config.json          # 项目配置文件

贡献指南

1. ** fork 仓库**：

   git clone https://github.com/CLOUDWERX-DEV/diffuDiff.git
   cd diffuDiff
   git checkout feature/your-feature
   

2. ** 提交代码**

   • 创建功能分支：

     git branch feature/your-feature
     

   • 提交更改：

     git add .
     git commit -m "添加新功能：你的提交信息"
     

   • 推送到远程仓库并创建拉取请求。

项目背景

DiffuDiff 是一个基于扩散模型的图像生成工具，旨在提供高性能和灵活的配置。它支持多种预训练模型，并允许用户自定义模型和输出设置。

相关链接

• GitHub 仓库
• 官方文档
• 问题反馈

附录

日志文件

日志信息存储在 logs/output.log 文件中，用于调试和监控运行状态。

许可证

项目遵循 MIT 许可证，具体内容见 LICENSE。

通过以上文档，您可以顺利安装、配置并使用 DiffuDiff 进行图像生成。如需进一步支持或遇到问题，请随时查阅 GitHub 仓库中的 ISSUES 或联系维护团队。