BasicSR

GitHub | Gitee码云
English | 简体中文

BasicSR is an open source image and video super-resolution toolbox based on PyTorch (may extend to more restoration tasks in the future).
_{(ESRGAN, EDVR, DNI, SFTGAN)}

Dependencies and Installation

• Python >= 3.7 (Recommend to use Anaconda or Miniconda)
• PyTorch >= 1.3
• NVIDIA GPU + CUDA

Please run the following commands in the BasicSR root path to install BasicSR:

python setup.py develop
pip install -r requirements.txt

Note that BasicSR is only tested in Ubuntu, and may be not suitable for Windows. You may try Windows WSL with CUDA supports :-) (It is now only available for insider build with Fast ring).

TODO List

Please see project boards.

Dataset Preparation

• Please refer to DatasetPreparation.md for more details.
• The descriptions of currently supported datasets (torch.utils.data.Dataset classes) are in Datasets.md.

Train and Test

• Please see TrainTest.md for the basic usage, i.e., training and testing.
• Options/Configs: Please refer to Config.md.
• Logging: Please refer to Logging.md.

Model Zoo and Baselines

• The descriptions of currently supported models are in Models.md.
• Results, re-trained models and log examples are available in ModelZoo.md.
• We also provide training curves in wandb:

Codebase Designs and Conventions

Please see DesignConvention.md for the designs and conventions of the BasicSR codebase.
The figure below shows the overall framework. More descriptions for each component:
Datasets.md | Models.md | Config.md | Logging.md

License

This project is released under the Apache 2.0 license. More details are in LICENSE.

Contact

If you have any question, please email xintao.wang@outlook.com.

_{^{BasicSR-private}}