{"id":13464391,"url":"https://github.com/XPixelGroup/BasicSR","last_synced_at":"2025-03-25T11:31:33.462Z","repository":{"id":37389656,"uuid":"130259654","full_name":"XPixelGroup/BasicSR","owner":"XPixelGroup","description":"Open Source Image and Video Restoration Toolbox for Super-resolution, Denoise, Deblurring, etc. Currently, it includes EDSR, RCAN, SRResNet, SRGAN, ESRGAN, EDVR, BasicVSR, SwinIR, ECBSR, etc. Also support StyleGAN2, DFDNet.","archived":false,"fork":false,"pushed_at":"2024-07-21T04:16:22.000Z","size":4015,"stargazers_count":7283,"open_issues_count":330,"forks_count":1252,"subscribers_count":87,"default_branch":"master","last_synced_at":"2025-03-23T09:09:21.510Z","etag":null,"topics":["basicsr","basicvsr","dfdnet","ecbsr","edsr","edvr","esrgan","pytorch","rcan","restoration","srgan","srresnet","stylegan2","super-resolution","swinir"],"latest_commit_sha":null,"homepage":"https://basicsr.readthedocs.io/en/latest/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/XPixelGroup.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":"CITATION.cff","codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-04-19T18:58:00.000Z","updated_at":"2025-03-23T02:33:56.000Z","dependencies_parsed_at":"2023-02-11T23:00:58.130Z","dependency_job_id":"a284bdd8-9815-4216-aa1b-67294243e1ab","html_url":"https://github.com/XPixelGroup/BasicSR","commit_stats":{"total_commits":494,"total_committers":22,"mean_commits":"22.454545454545453","dds":"0.11943319838056676","last_synced_commit":"8d56e3a045f9fb3e1d8872f92ee4a4f07f886b0a"},"previous_names":["xinntao/basicsr"],"tags_count":35,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/XPixelGroup%2FBasicSR","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/XPixelGroup%2FBasicSR/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/XPixelGroup%2FBasicSR/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/XPixelGroup%2FBasicSR/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/XPixelGroup","download_url":"https://codeload.github.com/XPixelGroup/BasicSR/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245453965,"owners_count":20617952,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["basicsr","basicvsr","dfdnet","ecbsr","edsr","edvr","esrgan","pytorch","rcan","restoration","srgan","srresnet","stylegan2","super-resolution","swinir"],"created_at":"2024-07-31T14:00:42.086Z","updated_at":"2025-03-25T11:31:32.003Z","avatar_url":"https://github.com/XPixelGroup.png","language":"Python","funding_links":[],"categories":["Methods","Python","Training","Key Implementation Libraries"],"sub_categories":["Upscaling"],"readme":"\u003cp align=\"center\"\u003e\n  \u003cimg src=\"assets/basicsr_xpixel_logo.png\" height=120\u003e\n\u003c/p\u003e\n\n## \u003cdiv align=\"center\"\u003e\u003cb\u003e\u003ca href=\"README.md\"\u003eEnglish\u003c/a\u003e | \u003ca href=\"README_CN.md\"\u003e简体中文\u003c/a\u003e\u003c/b\u003e\u003c/div\u003e\n\n\u003cdiv align=\"center\"\u003e\n\n[![LICENSE](https://img.shields.io/github/license/xinntao/basicsr.svg)](https://github.com/xinntao/BasicSR/blob/master/LICENSE.txt)\n[![PyPI](https://img.shields.io/pypi/v/basicsr)](https://pypi.org/project/basicsr/)\n[![Language grade: Python](https://img.shields.io/lgtm/grade/python/g/xinntao/BasicSR.svg?logo=lgtm\u0026logoWidth=18)](https://lgtm.com/projects/g/xinntao/BasicSR/context:python)\n[![python lint](https://github.com/xinntao/BasicSR/actions/workflows/pylint.yml/badge.svg)](https://github.com/xinntao/BasicSR/blob/master/.github/workflows/pylint.yml)\n[![Publish-pip](https://github.com/xinntao/BasicSR/actions/workflows/publish-pip.yml/badge.svg)](https://github.com/xinntao/BasicSR/blob/master/.github/workflows/publish-pip.yml)\n[![gitee mirror](https://github.com/xinntao/BasicSR/actions/workflows/gitee-mirror.yml/badge.svg)](https://github.com/xinntao/BasicSR/blob/master/.github/workflows/gitee-mirror.yml)\n\n\u003c/div\u003e\n\n\u003cdiv align=\"center\"\u003e\n\n⚡[**HowTo**](#-HOWTOs) **|** 🔧[**Installation**](docs/INSTALL.md) **|** 💻[**Training Commands**](docs/TrainTest.md) **|** 🐢[**DatasetPrepare**](docs/DatasetPreparation.md) **|** 🏰[**Model Zoo**](docs/ModelZoo.md)\n\n📕[**中文解读文档**](https://github.com/XPixelGroup/BasicSR-docs) **|** 📊 [**Plot scripts**](scripts/plot) **|** 📝[Introduction](docs/introduction.md) **|** \u003ca href=\"https://github.com/XPixelGroup/BasicSR/tree/master/colab\"\u003e\u003cimg src=\"https://colab.research.google.com/assets/colab-badge.svg\" height=\"18\" alt=\"google colab logo\"\u003e\u003c/a\u003e **|** ⏳[TODO List](https://github.com/xinntao/BasicSR/projects) **|** ❓[FAQ](docs/FAQ.md)\n\u003c/div\u003e\n\n🚀 We add [BasicSR-Examples](https://github.com/xinntao/BasicSR-examples), which provides guidance and templates of using BasicSR as a python package. 🚀 \u003cbr\u003e\n📢 **技术交流QQ群**：**320960100** \u0026emsp; 入群答案：**互帮互助共同进步** \u003cbr\u003e\n🧭 [入群二维码](#-contact) (QQ、微信) \u0026emsp;\u0026emsp; [入群指南 (腾讯文档)](https://docs.qq.com/doc/DYXBSUmxOT0xBZ05u) \u003cbr\u003e\n\n---\n\nBasicSR (**Basic** **S**uper **R**estoration) is an open-source **image and video restoration** toolbox based on PyTorch, such as super-resolution, denoise, deblurring, JPEG artifacts removal, *etc*.\u003cbr\u003e\nBasicSR (**Basic** **S**uper **R**estoration) 是一个基于 PyTorch 的开源 图像视频复原工具箱, 比如 超分辨率, 去噪, 去模糊, 去 JPEG 压缩噪声等.\n\n🚩 **New Features/Updates**\n\n- ✅ July 26, 2022. Add plot scripts 📊[Plot](scripts/plot).\n- ✅ May 9, 2022. BasicSR joins [XPixel](http://xpixel.group/).\n- ✅ Oct 5, 2021. Add **ECBSR training and testing** codes: [ECBSR](https://github.com/xindongzhang/ECBSR).\n  \u003e ACMMM21: Edge-oriented Convolution Block for Real-time Super Resolution on Mobile Devices\n- ✅ Sep 2, 2021. Add **SwinIR training and testing** codes: [SwinIR](https://github.com/JingyunLiang/SwinIR) by [Jingyun Liang](https://github.com/JingyunLiang). More details are in [HOWTOs.md](docs/HOWTOs.md#how-to-train-swinir-sr)\n- ✅ Aug 5, 2021. Add NIQE, which produces the same results as MATLAB (both are 5.7296 for tests/data/baboon.png).\n- ✅ July 31, 2021. Add **bi-directional video super-resolution** codes: [**BasicVSR** and IconVSR](https://arxiv.org/abs/2012.02181).\n  \u003e CVPR21: BasicVSR: The Search for Essential Components in Video Super-Resolution and Beyond\n- **[More](docs/history_updates.md)**\n\n---\n\nIf BasicSR helps your research or work, please help to ⭐ this repo or recommend it to your friends. Thanks😊 \u003cbr\u003e\nOther recommended projects:\u003cbr\u003e\n▶️ [Real-ESRGAN](https://github.com/xinntao/Real-ESRGAN): A practical algorithm for general image restoration\u003cbr\u003e\n▶️ [GFPGAN](https://github.com/TencentARC/GFPGAN): A practical algorithm for real-world face restoration \u003cbr\u003e\n▶️ [facexlib](https://github.com/xinntao/facexlib): A collection that provides useful face-relation functions.\u003cbr\u003e\n▶️ [HandyView](https://github.com/xinntao/HandyView): A PyQt5-based image viewer that is handy for view and comparison. \u003cbr\u003e\n▶️ [HandyFigure](https://github.com/xinntao/HandyFigure): Open source of paper figures \u003cbr\u003e\n\u003csub\u003e([ESRGAN](https://github.com/xinntao/ESRGAN), [EDVR](https://github.com/xinntao/EDVR), [DNI](https://github.com/xinntao/DNI), [SFTGAN](https://github.com/xinntao/SFTGAN))\u003c/sub\u003e\n\u003csub\u003e([HandyCrawler](https://github.com/xinntao/HandyCrawler), [HandyWriting](https://github.com/xinntao/HandyWriting))\u003c/sub\u003e\n\n---\n\n## ⚡ HOWTOs\n\nWe provide simple pipelines to train/test/inference models for a quick start.\nThese pipelines/commands cannot cover all the cases and more details are in the following sections.\n\n| GAN                  |                                                |                                                        |          |                                                |                                                        |\n| :------------------- | :--------------------------------------------: | :----------------------------------------------------: | :------- | :--------------------------------------------: | :----------------------------------------------------: |\n| StyleGAN2            | [Train](docs/HOWTOs.md#How-to-train-StyleGAN2) | [Inference](docs/HOWTOs.md#How-to-inference-StyleGAN2) |          |                                                |                                                        |\n| **Face Restoration** |                                                |                                                        |          |                                                |                                                        |\n| DFDNet               |                       -                        |  [Inference](docs/HOWTOs.md#How-to-inference-DFDNet)   |          |                                                |                                                        |\n| **Super Resolution** |                                                |                                                        |          |                                                |                                                        |\n| ESRGAN               |                     *TODO*                     |                         *TODO*                         | SRGAN    |                     *TODO*                     |                         *TODO*                         |\n| EDSR                 |                     *TODO*                     |                         *TODO*                         | SRResNet |                     *TODO*                     |                         *TODO*                         |\n| RCAN                 |                     *TODO*                     |                         *TODO*                         | SwinIR   | [Train](docs/HOWTOs.md#how-to-train-swinir-sr) | [Inference](docs/HOWTOs.md#how-to-inference-swinir-sr) |\n| EDVR                 |                     *TODO*                     |                         *TODO*                         | DUF      |                       -                        |                         *TODO*                         |\n| BasicVSR             |                     *TODO*                     |                         *TODO*                         | TOF      |                       -                        |                         *TODO*                         |\n| **Deblurring**       |                                                |                                                        |          |                                                |                                                        |\n| DeblurGANv2          |                       -                        |                         *TODO*                         |          |                                                |                                                        |\n| **Denoise**          |                                                |                                                        |          |                                                |                                                        |\n| RIDNet               |                       -                        |                         *TODO*                         | CBDNet   |                       -                        |                         *TODO*                         |\n\n## ✨ **Projects that use BasicSR**\n\n- [**Real-ESRGAN**](https://github.com/xinntao/Real-ESRGAN): A practical algorithm for general image restoration\n- [**GFPGAN**](https://github.com/TencentARC/GFPGAN): A practical algorithm for real-world face restoration\n\nIf you use `BasicSR` in your open-source projects, welcome to contact me (by [email](#-contact) or opening an issue/pull request). I will add your projects to the above list 😊\n\n## 📜 License and Acknowledgement\n\nThis project is released under the [Apache 2.0 license](LICENSE.txt).\u003cbr\u003e\nMore details about **license** and **acknowledgement** are in [LICENSE](LICENSE/README.md).\n\n## 🌏 Citations\n\nIf BasicSR helps your research or work, please cite BasicSR.\u003cbr\u003e\nThe following is a BibTeX reference. The BibTeX entry requires the `url` LaTeX package.\n\n``` latex\n@misc{basicsr,\n  author =       {Xintao Wang and Liangbin Xie and Ke Yu and Kelvin C.K. Chan and Chen Change Loy and Chao Dong},\n  title =        {{BasicSR}: Open Source Image and Video Restoration Toolbox},\n  howpublished = {\\url{https://github.com/XPixelGroup/BasicSR}},\n  year =         {2022}\n}\n```\n\n\u003e Xintao Wang, Liangbin Xie, Ke Yu, Kelvin C.K. Chan, Chen Change Loy and Chao Dong. BasicSR: Open Source Image and Video Restoration Toolbox. \u003chttps://github.com/xinntao/BasicSR\u003e, 2022.\n\n## 📧 Contact\n\nIf you have any questions, please email `xintao.alpha@gmail.com`, `xintao.wang@outlook.com`.\n\n\u003cbr\u003e\n\n- **QQ群**: 扫描左边二维码 或者 搜索QQ群号: 320960100   入群答案：互帮互助共同进步\n- **微信群**: 我们的一群已经满500人啦，二群也超过200人了；进群可以添加 Liangbin 的个人微信 (右边二维码)，他会在空闲的时候拉大家入群~\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"https://user-images.githubusercontent.com/17445847/134879983-6f2d663b-16e7-49f2-97e1-7c53c8a5f71a.jpg\"  height=\"300\"\u003e  \u0026emsp;\n  \u003cimg src=\"https://user-images.githubusercontent.com/17445847/139572512-8e192aac-00fa-432b-ac8e-a33026b019df.png\"  height=\"300\"\u003e\n\u003c/p\u003e\n\n![visitors](https://visitor-badge.glitch.me/badge?page_id=XPixelGroup/BasicSR) (start from 2022-11-06)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FXPixelGroup%2FBasicSR","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FXPixelGroup%2FBasicSR","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FXPixelGroup%2FBasicSR/lists"}