generated from xinntao/ProjectTemplate-Python
-
Notifications
You must be signed in to change notification settings - Fork 20
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
5 changed files
with
21 additions
and
242 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,77 +1,23 @@ | ||
| # BasicSR Examples | ||
| # :rocket: BasicSR Examples | ||
|
|
||
| [English](README.md) **|** [简体中文](README_CN.md) | ||
| [](https://github.com/xinntao/BasicSR-examples/releases) | ||
| [](https://github.com/xinntao/BasicSR-examples/issues) | ||
| [](https://github.com/xinntao/BasicSR-examples/issues) | ||
| [](https://github.com/xinntao/BasicSR-examples/blob/master/LICENSE) | ||
| [](https://github.com/xinntao/BasicSR/blob/master/.github/workflows/pylint.yml) | ||
|
|
||
| In this repository, we give simple examples to illustrate how to use [`BasicSR`](https://github.com/xinntao/BasicSR) in your own project. | ||
|
|
||
|
|
||
|
|
||
|
|
||
| ## File Modification | ||
|
|
||
| 1. Setup *pre-commit* hook | ||
| 1. If necessary, modify `.pre-commit-config.yaml` | ||
| 1. In the repository root path, run | ||
| > pre-commit install | ||
| 1. Modify the `.gitignore` file | ||
| 1. Modify the `LICENSE` file | ||
| This repository uses the *MIT* license, you may change it to other licenses | ||
| 1. Modify the *setup* files | ||
| 1. `setup.cfg` | ||
| 1. `setup.py`, especially the `basicsr` keyword | ||
| 1. Modify the `requirements.txt` files | ||
| 1. Modify the `VERSION` file | ||
|
|
||
| ## GitHub Workflows | ||
| [English](README.md) **|** [简体中文](README_CN.md) <br> | ||
| [`BasicSR repo`](https://github.com/xinntao/BasicSR) **|** [`simple example`](https://github.com/xinntao/BasicSR-examples/tree/master) **|** [`installation example`](https://github.com/xinntao/BasicSR-examples/tree/installation) | ||
|
|
||
| 1. [pylint](./github/workflows/pylint.yml) | ||
| 1. [gitee-repo-mirror](./github/workflow/gitee-repo-mirror.yml) - Support Gitee码云 | ||
| 1. Clone GitHub repo in the [Gitee](https://gitee.com/) website | ||
| 1. Modify [gitee-repo-mirror](./github/workflow/gitee-repo-mirror.yml) | ||
| 1. In Github *Settings* -> *Secrets*, add `SSH_PRIVATE_KEY` | ||
|
|
||
| ## Other Procedures | ||
|
|
||
| 1. The `description`, `website`, `topics` in the main page | ||
| 1. Support Chinese documents, for example, `README_CN.md` | ||
|
|
||
| ## Emoji | ||
|
|
||
| [Emoji cheat-sheet](https://github.com/ikatyang/emoji-cheat-sheet) | ||
|
|
||
| | Emoji | Meaning | | ||
| | :--- | :---: | | ||
| | :rocket: | Used for [BasicSR](https://github.com/xinntao/BasicSR) Logo | | ||
| | :sparkles: | Features | | ||
| | :zap: | HOWTOs | | ||
| | :wrench: | Installation / Usage | | ||
| | :hourglass_flowing_sand: | TODO list | | ||
| | :turtle: | Dataset preparation | | ||
| | :computer: | Commands | | ||
| | :european_castle: | Model zoo | | ||
| | :memo: | Designs | | ||
| | :scroll: | License and acknowledgement | | ||
| | :earth_asia: | Citations | | ||
| | :e-mail: | Contact | | ||
| | :m: | Models | | ||
| | :arrow_double_down: | Download | | ||
| | :file_folder: | Datasets | | ||
| | :chart_with_upwards_trend: | Curves| | ||
| | :eyes: | Screenshot | | ||
| | :books: |References | | ||
| In this repository, we give simple examples to illustrate how to use [`BasicSR`](https://github.com/xinntao/BasicSR) in your own project. | ||
|
|
||
| ## Useful Image Links | ||
| :triangular_flag_on_post: **Projects that use BasicSR** | ||
| - :white_check_mark: [**GFPGAN**](https://github.com/TencentARC/GFPGAN): A practical algorithm for real-world face restoration | ||
| - :white_check_mark: [**Real-ESRGAN**](https://github.com/xinntao/Real-ESRGAN): A practical algorithm for general image restoration | ||
|
|
||
| <img src="https://colab.research.google.com/assets/colab-badge.svg" height="28" alt="google colab logo"> Google Colab Logo <br> | ||
| <img src="https://upload.wikimedia.org/wikipedia/commons/8/8d/Windows_darkblue_2012.svg" height="28" alt="google colab logo"> Windows Logo <br> | ||
| <img src="https://upload.wikimedia.org/wikipedia/commons/3/3a/Logo-ubuntu_no%28r%29-black_orange-hex.svg" alt="Ubuntu" height="24"> Ubuntu Logo <br> | ||
| If you use `BasicSR` in your open-source projects, welcome co contect me (by [email](#e-mail-contact) or opening an issue/pull request). I will add your projects in the above list :blush: | ||
|
|
||
| ## Other Useful Tips | ||
| --- | ||
| ## :e-mail: Contact | ||
|
|
||
| 1. `More` drop-down menu | ||
| <details> | ||
| <summary>More</summary> | ||
| <ul> | ||
| <li>Nov 19, 2020. Set up ProjectTemplate-Python.</li> | ||
| </ul> | ||
| </details> | ||
| If you have any question or want to add your project in the list, please email `[email protected]` or `[email protected]`. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters