# colorize

**Repository Path**: rainyf/colorize

## Basic Information

- **Project Name**: colorize
- **Description**: 使黑白老照片着色app
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-12-18
- **Last Updated**: 2025-12-23

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# DeOldify 中文说明

本仓库基于 Jason Antic 等人开源的 DeOldify 项目，旨在提供黑白照片/视频的上色与修复能力。我们额外补充了 Gradio Web 应用，方便直接在浏览器上完成推理。本文档梳理了搭建步骤、模型下载、常见问题以及实验报告所需的个人信息。

## 目录

1. [项目结构](#项目结构)
2. [环境准备](#环境准备)
3. [模型权重下载](#模型权重下载)
4. [运行 Gradio Web APP](#运行-gradio-web-app)
5. [Notebook 学习指引](#notebook-学习指引)
6. [常见问题 FAQ](#常见问题-faq)
7. [参考链接](#参考链接)
8. [许可证说明](#许可证说明)
9. [个人信息](#个人信息)

## 项目结构

- `deoldify/`：核心推理与可视化代码，包含生成器、判别器、滤镜以及视频处理脚本。
- `fastai/`：DeOldify 依赖的精简 fastai v1 版本源码。
- `ImageColorizer*.ipynb`：原作者提供的图像上色 Notebook（Artistic / Stable / Colab 版本）。
- `VideoColorizer*.ipynb`：视频上色示例 Notebook。
- `fid/`：FID 评分脚本，用于评估生成质量。
- `models/`：存放预训练权重的目录（需手动下载）。
- `gradioAPP.py`：新增的 Gradio 网页应用入口，可直接进行图片上色体验。

## 环境准备

1. **克隆仓库**（可换成 Gitee 镜像）：
   ```bash
   git clone https://github.com/jantic/DeOldify.git colorize
   cd colorize
   ```
2. **创建 Conda 虚拟环境（Python 3.10）**：
   ```bash
   conda create -n colorize_env python=3.10
   conda activate colorize_env
   ```
3. **安装必须依赖**（满足题目要求即可）：
   ```bash
   pip install gradio scipy fastprogress torch torchvision opencv-python \
           ffmpeg ffmpeg-python yt-dlp scikit-image ipython
   ```
   若需完整训练/Notebook 支持，可额外执行 `pip install -r requirements.txt`。
4. **可选：验证 PyTorch 是否识别 GPU**：
   ```bash
   python -c "import torch; print(torch.cuda.is_available())"
   ```

## 模型权重下载

将下列权重文件放入 `models/` 目录（若无该目录请手动创建）。下载链接全部来源于原仓库 README：

| 模型类型 | 文件名 | 下载地址 |
| --- | --- | --- |
| 图像（Artistic） | `ColorizeArtistic_gen.pth` | https://data.deepai.org/deoldify/ColorizeArtistic_gen.pth |
| 图像（Stable） | `ColorizeStable_gen.pth` | https://www.dropbox.com/s/axsd2g85uyixaho/ColorizeStable_gen.pth?dl=0 |
| 视频 | `ColorizeVideo_gen.pth` | https://data.deepai.org/deoldify/ColorizeVideo_gen.pth |

> **提示**：Dropbox 链接如果无法直接在 PowerShell 中下载，可使用 `curl -L <url> -o .\models\xxx.pth` 并把 `?dl=0` 改成 `?dl=1`，以避免浏览器弹窗。

## 运行 Gradio Web APP

1. 确认 `models/` 中至少存在 `ColorizeArtistic_gen.pth`（若切换 Stable 则需额外放置 `ColorizeStable_gen.pth`）。
2. 启动应用：
   ```bash
   conda activate colorize_env
   python gradioAPP.py
   ```
3. 控制台会输出本地访问地址（默认 `http://127.0.0.1:7860`）。浏览器打开后：
   - 上传黑白图片（推荐 JPG/PNG）。
   - 调整 `render_factor`（7~45，越大越精细但显存/时间越高）。
   - 选择模型：`artistic` 色彩更夸张，`stable` 更稳健。
   - 可勾选“后处理”提升对比度。
   - 点击 **Submit**，右侧展示彩色结果并可下载。

## Notebook 学习指引

推荐依次阅读/运行以下 Notebook，了解原始推理流程：

1. **ImageColorizer.ipynb**：本地图片上色详细步骤，涵盖 `get_image_colorizer` 的用法。
2. **ImageColorizerArtisticTests.ipynb / ImageColorizerStableTests.ipynb**：不同模型的对比测试，熟悉 `render_factor` 调参策略。
3. **VideoColorizer.ipynb**：逐帧处理视频、再用 ffmpeg 合成带音频的视频。

参考这些 Notebook，可以将关键逻辑迁移到脚本或 Web 应用中。

## 常见问题 FAQ

- **缺少权重文件**：报错 `FileNotFoundError: ... ColorizeArtistic_gen.pth`/`ColorizeStable_gen.pth`，请确认文件名与路径完全匹配且放在 `models/` 目录。
- **无 GPU**：依旧可以运行，但渲染耗时较长。建议把 `render_factor` 降到 15 左右并保持较低分辨率输入。
- **模型切换后仍报错**：若第一次操作选择了缺失的权重，Gradio 后端会缓存失败结果。请重新启动 `python gradioAPP.py` 或补齐权重后再尝试切换。
- **Dropbox 无法访问**：可用浏览器科学上网，或在 PowerShell 中先执行 `[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12` 再下载。
- **输出偏色/灰蒙**：尝试提高 `render_factor`、开启后处理，或在推理前对输入图进行亮度/对比度增强。

## 参考链接

- 原项目仓库（英文）: https://github.com/jantic/DeOldify
- Gitee 镜像: https://gitee.com/mynameisi/DeOldify
- 相关项目：
  - Stable Diffusion Web UI DeOldify 插件 https://github.com/SpenserCai/sd-webui-deoldify
  - Onnx Web 版 DeOldify https://github.com/akbartus/DeOldify-on-Browser
- 教程推荐：Old Ireland in Colour 提供的 Colab 视频教学（README 中的 YouTube 链接）。

## 许可证说明

- 代码遵循 MIT License，详见 [LICENSE](LICENSE)。
- README 所列预训练权重同样以 MIT 授权公开，可自由下载学习；若应用于商业场景，请明确标注来源并自行处理合规问题。

## 个人信息

- 学号：202352320128
- 年级：2023 级
- 专业：智能科学与技术
- 班级：一班