English | 简体中文

🚀 我们新增了 BasicSR-Examples，其中提供了将 BasicSR 作为 Python 包使用的指导和模板。🚀
📢 技术交流QQ群：320960100   入群答案：互帮互助共同进步
🧭 入群二维码 (QQ、微信)    入群指南 (腾讯文档)

---

BasicSR (Basic Super Restoration) 是一个基于 PyTorch 的开源 图像视频复原工具箱, 比如 超分辨率, 去噪, 去模糊, 去 JPEG 压缩噪声等.
BasicSR (Basic Super Restoration) 是一个基于 PyTorch 的开源 图像和视频复原 工具箱，例如超分辨率、去噪、去模糊、去除 JPEG 压缩伪影等。

🚩 新功能/更新

• ✅ 2022年7月26日。新增绘图脚本 📊Plot。
• ✅ 2022年5月9日。BasicSR 加入 XPixel。
• ✅ 2021年10月5日。新增 ECBSR 训练与测试 代码：ECBSR。

  ACMMM21：面向边缘的卷积块，用于移动设备上的实时超分辨率

• ✅ 2021年9月2日。新增 SwinIR 训练与测试 代码：SwinIR 由 Jingyun Liang 开发。更多详情请参见 HOWTOs.md。
• ✅ 2021年8月5日。新增 NIQE，其结果与 MATLAB 完全一致（对于 tests/data/baboon.png，两者均为 5.7296）。
• ✅ 2021年7月31日。新增 双向视频超分辨率 代码：BasicVSR 和 IconVSR。

  CVPR21：BasicVSR：寻找视频超分辨率及其他领域的关键组件

• 更多

---

如果 BasicSR 对您的研究或工作有所帮助，请为本仓库点赞或推荐给您的朋友。谢谢😊
其他推荐项目：
▶️ Real-ESRGAN：一种用于通用图像修复的实用算法
▶️ GFPGAN：一种用于真实场景下人脸修复的实用算法
▶️ facexlib：提供多种人脸相关功能的集合。
▶️ HandyView：基于 PyQt5 的图像查看器，便于查看和对比。
▶️ HandyFigure：论文图表的开源资源。
_{(ESRGAN, EDVR, DNI, SFTGAN) (HandyCrawler, HandyWriting)}

---

⚡ 使用指南

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

GAN
StyleGAN2	训练	推理
人脸修复
DFDNet	-	推理
超分辨率
ESRGAN	待办	待办	SRGAN	待办	待办
EDSR	待办	待办	SRResNet	待办	待办
RCAN	待办	待办	SwinIR	训练	推理
EDVR	待办	待办	DUF	-	待办
BasicVSR	待办	待办	TOF	-	待办
去模糊
DeblurGANv2	-	待办
去噪
RIDNet	-	待办	CBDNet	-	待办

✨ 使用BasicSR的项目

• Real-ESRGAN: 一种用于通用图像修复的实用算法
• GFPGAN: 一种用于真实场景下人脸修复的实用算法

如果您在开源项目中使用了BasicSR，欢迎通过邮件或提交问题/拉取请求与我联系。我会将您的项目添加到上述列表中 😊

📜 许可证与致谢

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

🌏 引用

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

@misc{basicsr,
  author =       {Xintao Wang and Liangbin Xie and Ke Yu and Kelvin C.K. Chan and Chen Change Loy and Chao Dong},
  title =        {{BasicSR}: 开源图像与视频修复工具箱},
  howpublished = {\url{https://github.com/XPixelGroup/BasicSR}},
  year =         {2022}
}

Xintao Wang, Liangbin Xie, Ke Yu, Kelvin C.K. Chan, Chen Change Loy 和 Chao Dong. BasicSR：开源图像与视频修复工具箱。 https://github.com/xinntao/BasicSR, 2022.

📧 联系方式

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

• QQ群: 扫描左侧二维码 或者 搜索QQ群号：320960100   入群答案：互帮互助共同进步
• 微信群: 我们的一群已满500人，二群也超过200人；进群可添加Liangbin的个人微信（右侧二维码），他会在空闲时将大家拉入群~

 

(自2022年11月6日起)

BasicSR 快速上手指南

简介

BasicSR (Basic Super Restoration) 是一个基于 PyTorch 的开源图像和视频复原工具箱，支持超分辨率、去噪、去模糊、JPEG artifacts 移除等多种任务。

环境准备

在开始之前，请确保您的开发环境满足以下要求：

• 操作系统：Linux / Windows / macOS
• 编程语言：Python 3.7+
• 深度学习框架：PyTorch (建议配合 CUDA 使用以加速训练和推理)
• 依赖库：OpenCV, LMDB, Pillow 等（安装时会自动处理）

安装步骤

方式一：通过 PyPI 安装（推荐）

适用于直接使用预构建包的用户。建议使用国内镜像源加速下载：

pip install basicsr -i https://pypi.tuna.tsinghua.edu.cn/simple

方式二：从源码安装（适合开发者）

如果您需要修改代码或进行二次开发，建议克隆仓库。若 GitHub 访问缓慢，可使用 Gitee 镜像：

# 使用 Gitee 镜像克隆
git clone https://gitee.com/mirrors/BasicSR.git
cd BasicSR

# 安装依赖
pip install -r requirements.txt
pip install -e .

基本使用

BasicSR 提供了标准化的训练、测试和推理流程。具体模型的使用命令请参考官方文档中的 HOWTOs。

1. 训练模型

使用配置文件启动训练任务：

python scripts/train.py -opt options/ModelName/train_ModelName.yml

2. 测试与推理

加载预训练模型进行图像或视频复原：

python scripts/test.py -opt options/ModelName/test_ModelName.yml

3. 作为 Python 包使用

如果您希望在项目中直接调用 BasicSR 的功能，可参考 BasicSR-Examples 获取模板和指引。

---

提示：更多详细文档（如数据集准备、模型列表、常见问题）请访问项目根目录下的 docs 文件夹。