EDVR 已合并到 BasicSR。本 GitHub 仓库是 BasicSR 的镜像。建议使用 BasicSR，并在 BasicSR 中提交问题、拉取请求等。

请注意，此版本与之前版本不兼容。如果您希望使用旧版本，请参考 old_version 分支。

---

:rocket: BasicSR

English | 简体中文   GitHub | Gitee码云

Google Colab: GitHub Link | Google Drive Link
:m: Model Zoo :arrow_double_down: Google Drive: Pretrained Models | Reproduced Experiments :arrow_double_down: 百度网盘: 预训练模型 | 复现实验
:file_folder: Datasets :arrow_double_down: Google Drive :arrow_double_down: 百度网盘 (提取码:basr)
:chart_with_upwards_trend: Training curves in wandb
:computer: Commands for training and testing
:zap: HOWTOs

---

BasicSR (Basic Super Restoration) 是一个基于 PyTorch 的开源 图像和视频修复工具箱，支持超分辨率、去噪、去模糊、去除 JPEG 码块效应等功能。
_{(ESRGAN, EDVR, DNI, SFTGAN) (HandyView, HandyFigure, HandyCrawler, HandyWriting)}

:sparkles: 新特性

• 2020年11月29日。新增 ESRGAN 和 DFDNet 的 colab 演示。
• 2020年9月8日。新增 盲人面部修复 推理代码：DFDNet。
• 2020年8月27日。新增 StyleGAN2 训练和测试 代码：StyleGAN2。

更多

• 2020年9月8日。新增 盲人面部修复 推理代码： DFDNet。
  ECCV20：通过深度多尺度组件字典实现盲人面部修复
  Xiaoming Li, Chaofeng Chen, Shangchen Zhou, Xianhui Lin, Wangmeng Zuo 和 Lei Zhang
• 2020年8月27日。新增 StyleGAN2 训练和测试代码。
  CVPR20：分析并改进 StyleGAN 的图像质量
  Tero Karras, Samuli Laine, Miika Aittala, Janne Hellsten, Jaakko Lehtinen 和 Timo Aila
• 2020年8月19日。全新发布的 BasicSR v1.0.0 上线。

:zap: 使用指南

我们提供了简单的流水线来快速开始训练/测试/推理模型。 这些流水线/命令并不能覆盖所有情况，更多细节请参阅后续章节。

GAN
StyleGAN2	训练	推理
面部修复
DFDNet	-	推理
超分辨率
ESRGAN	TODO	TODO	SRGAN	TODO	TODO
EDSR	TODO	TODO	SRResNet	TODO	TODO
RCAN	TODO	TODO
EDVR	TODO	TODO	DUF	-	TODO
BasicVSR	TODO	TODO	TOF	-	TODO
去模糊
DeblurGANv2	-	TODO
去噪
RIDNet	-	TODO	CBDNet	-	TODO

:wrench: 依赖与安装

• Python >= 3.7（推荐使用 Anaconda 或 Miniconda）
• PyTorch >= 1.3
• NVIDIA GPU + CUDA

1. 克隆仓库

   git clone https://github.com/xinntao/BasicSR.git
   

2. 安装依赖包

   cd BasicSR
   pip install -r requirements.txt
   

3. 安装 BasicSR

   请在 BasicSR 根目录 下运行以下命令以安装 BasicSR：
   （请确保您的 GCC 版本：gcc >= 5）
   如果您不需要 CUDA 扩展：
    dcn for EDVR
    upfirdn2d 和 fused_act for StyleGAN2
   请在安装时添加 --no_cuda_ext

   python setup.py develop --no_cuda_ext
   

   如果您使用 EDVR 和 StyleGAN2 模型，则上述 CUDA 扩展是必需的。

   python setup.py develop
   

   您也可以指定 CUDA 路径：

   CUDA_HOME=/usr/local/cuda \
   CUDNN_INCLUDE_DIR=/usr/local/cuda \
   CUDNN_LIB_DIR=/usr/local/cuda \
   python setup.py develop
   

请注意，BasicSR 目前仅在 Ubuntu 上进行了测试，可能不适用于 Windows。您可以尝试 支持 CUDA 的 Windows WSL :-) （目前仅适用于 Fast ring 内部版本）。

:hourglass_flowing_sand: 待办事项

请查看 项目看板。

:turtle: 数据集准备

• 更多详情请参阅 DatasetPreparation.md。
• 当前支持的数据集描述（torch.utils.data.Dataset 类）见 Datasets.md。

:computer: 训练与测试

• 训练和测试命令：基本用法请参阅 TrainTest.md。
• 选项/配置：请参阅 Config.md。
• 日志记录：请参阅 Logging.md。

:european_castle: 模型动物园与基准

• 当前支持的模型说明请参见 Models.md。
• 预训练模型及日志示例可在 ModelZoo.md 中找到。
• 我们还在 wandb 上提供了 训练曲线：

:memo: 代码库设计与规范

有关 BasicSR 代码库的设计与规范，请参阅 DesignConvention.md。
下图展示了整体框架。更多各组件的说明如下：
Datasets.md | Models.md | Config.md | Logging.md

:scroll: 许可与致谢

本项目采用 Apache 2.0 许可证发布。
关于 许可 和 致谢 的更多详情，请参阅 LICENSE。

:earth_asia: 引用

如果 BasicSR 对您的研究或工作有所帮助，请考虑引用 BasicSR。
以下是 BibTeX 格式的参考文献。该条目需要使用 url LaTeX 宏包。

@misc{wang2020basicsr,
  author =       {Xintao Wang and Ke Yu and Kelvin C.K. Chan and
                  Chao Dong and Chen Change Loy},
  title =        {BasicSR},
  howpublished = {\url{https://github.com/xinntao/BasicSR}},
  year =         {2020}
}

Xintao Wang, Ke Yu, Kelvin C.K. Chan, Chao Dong 和 Chen Change Loy. BasicSR. https://github.com/xinntao/BasicSR, 2020.

:e-mail: 联系方式

如有任何问题，请发送邮件至 xintao.wang@outlook.com。

EDVR (BasicSR) 快速上手指南

重要提示：EDVR 项目已合并至 BasicSR。本指南基于 BasicSR 编写，这是目前维护和推荐使用的版本。旧版本请参照 old_version 分支。

1. 环境准备

在开始之前，请确保您的系统满足以下要求：

• 操作系统：推荐 Ubuntu (Windows 用户可尝试 WSL + CUDA，但未经过全面测试)。
• Python：版本 >= 3.7 (推荐使用 Anaconda 或 Miniconda 管理环境)。
• 深度学习框架：PyTorch >= 1.3。
• 硬件加速：NVIDIA GPU 及对应的 CUDA 环境。
• 编译器：GCC 版本 >= 5 (用于编译 CUDA 扩展)。

2. 安装步骤

2.1 克隆代码库

git clone https://github.com/xinntao/BasicSR.git
cd BasicSR

2.2 安装依赖包

建议先配置国内镜像源以加速下载（如清华源）：

pip install -r requirements.txt -i https://pypi.tuna.tsinghua.edu.cn/simple

2.3 安装 BasicSR 核心库

由于 EDVR 模型依赖特定的 CUDA 扩展（如可变形卷积 dcn），必须编译安装 CUDA 扩展。请确保已正确设置 CUDA_HOME 环境变量。

标准安装命令（推荐）：

python setup.py develop

如果遇到 CUDA 路径识别问题，请指定路径安装：

CUDA_HOME=/usr/local/cuda \
CUDNN_INCLUDE_DIR=/usr/local/cuda \
CUDNN_LIB_DIR=/usr/local/cuda \
python setup.py develop

(注：请将 /usr/local/cuda 替换为您实际的 CUDA 安装路径)

注意：如果您不需要运行 EDVR 或 StyleGAN2，仅需基础功能，可添加 --no_cuda_ext 参数跳过扩展编译，但运行 EDVR 时会报错。

3. 基本使用

BasicSR 提供了统一的训练和测试脚本。使用前请准备好数据集和配置文件（位于 options/ 目录）。

3.1 数据准备

请参考官方文档 DatasetPreparation.md 准备数据集。通常需要将数据集放置在 datasets 目录下，并在配置文件中修改对应的数据路径。

3.2 模型推理 (Testing)

使用预训练模型对低分辨率图像进行超分辨率重建。

命令格式：

python basicsr/test.py -opt options/test/EDVR/test_EDVR_L_REDS4.yml

• -opt: 指定配置文件路径。
• 结果默认保存在 results 文件夹中。

3.3 模型训练 (Training)

使用自定义数据集或基准数据集从头训练或微调模型。

命令格式：

python basicsr/train.py -opt options/train/EDVR/train_EDVR_L_x4_REDS_wo_BD.yml

• 训练日志和检查点将保存在 experiments 文件夹中。
• 支持断点续训，只需在配置文件中指定.resume 路径或使用命令行参数。

3.4 获取预训练模型

您可以从以下地址下载 EDVR 的预训练模型，并放入 experiments/pretrained_models 目录：

• Google Drive: Pretrained Models
• 百度网盘: 预训练模型 (提取码: basr)

更多详细配置选项、数据集说明及高级用法，请参阅项目根目录下的 docs 文件夹。