|
1 | 1 | # BasicSR
|
2 | 2 |
|
3 |
| -[GitHub](https://github.com/xinntao/BasicSR) | [Gitee码云](https://gitee.com/xinntao/BasicSR); [English](https://github.com/xinntao/BasicSR) | [简体中文](https://github.com/xinntao/BasicSR/blob/master/README_CN.md) |
| 3 | +[GitHub](https://github.com/xinntao/BasicSR) | [Gitee码云](https://gitee.com/xinntao/BasicSR) <br> |
| 4 | +[English](README.md) | [简体中文](README_CN.md) |
4 | 5 |
|
5 |
| -BasicSR is an open source image and video super-resolution toolbox based on PyTorch.<br> |
6 |
| -([ESRGAN](https://github.com/xinntao/ESRGAN), [EDVR](https://github.com/xinntao/EDVR), [DNI](https://github.com/xinntao/DNI), [SFTGAN](https://github.com/xinntao/SFTGAN)) |
| 6 | +BasicSR is an open source image and video super-resolution toolbox based on PyTorch (may extend to more restoration tasks in the future).<br> |
| 7 | +<sub>([ESRGAN](https://github.com/xinntao/ESRGAN), [EDVR](https://github.com/xinntao/EDVR), [DNI](https://github.com/xinntao/DNI), [SFTGAN](https://github.com/xinntao/SFTGAN))</sub> |
7 | 8 |
|
8 | 9 | ## Dependencies and Installation
|
9 |
| - |
10 |
| -- Python 3 (Recommend to use [Anaconda](https://www.anaconda.com/download/#linux)) |
| 10 | +- Python >= 3.7 (Recommend to use [Anaconda](https://www.anaconda.com/download/#linux) or [Miniconda](https://docs.conda.io/en/latest/miniconda.html)) |
11 | 11 | - [PyTorch >= 1.3](https://pytorch.org/)
|
12 | 12 | - NVIDIA GPU + [CUDA](https://developer.nvidia.com/cuda-downloads)
|
13 | 13 |
|
14 |
| -Please run the following cmds to install BasicSR. |
| 14 | +Please run the following commands in the BasicSR root path to install BasicSR: |
15 | 15 | ```bash
|
16 | 16 | python setup.py develop
|
17 |
| -pip install requirements.txt |
| 17 | +pip install -r requirements.txt |
18 | 18 | ```
|
19 | 19 |
|
| 20 | +Note that BasicSR is only tested in Ubuntu, and may be not suitable for Windows. You may try [Windows WSL with CUDA supports](https://docs.microsoft.com/en-us/windows/win32/direct3d12/gpu-cuda-in-wsl) :-) (It is now only available for insider build with Fast ring). |
| 21 | + |
20 | 22 | ## TODO List
|
21 | 23 | Please see [project boards](https://github.com/xinntao/BasicSR/projects).
|
22 | 24 |
|
23 | 25 | ## Dataset Preparation
|
24 |
| -Please refer to [DATASETS.md](docs/DATASETS.md) for more details. |
| 26 | +Please refer to [Datasets.md](docs/Datasets.md) for more details. |
25 | 27 |
|
26 |
| -## Training and Testing |
27 |
| -Please see [TrainingTesting.md](docs/TrainingTesting.md) for the basic usage, *i.e.,* training and testing. |
| 28 | +## Train and Test |
| 29 | +Please see [TrainTest.md](docs/TrainTest.md) for the basic usage, *i.e.,* training and testing. |
28 | 30 |
|
29 | 31 | ## Model Zoo and Baselines
|
30 |
| -Results and pre-trained models are available in the [ModelZoo.md](docs/ModelZoo.md). |
| 32 | +Results and pre-trained models are available in [ModelZoo.md](docs/ModelZoo.md). |
| 33 | + |
| 34 | +## Codebase Designs and Conventions |
| 35 | +Please see [DesignConvention.md](docs/DesignConvention.md) for the designs and convetions of the BasicSR codebase. |
31 | 36 |
|
32 | 37 | ## License
|
33 | 38 | This project is released under the Apache 2.0 license.
|
| 39 | +More details are in [LICENSE](LICENSE/README.md). |
34 | 40 |
|
35 | 41 | #### Contact
|
36 |
| -If you have any question, please email `xintao.alpha@gmail.com`. |
| 42 | +If you have any question, please email `xintao.wang@outlook.com`. |
37 | 43 |
|
38 | 44 | <sub><sup>[BasicSR-private](https://github.com/xinntao/BasicSR-private)</sup></sub>
|
0 commit comments