From 0091b7d1d58b5fe18a4d1c57186dded905282a11 Mon Sep 17 00:00:00 2001 From: "Kelvin C.K. Chan" Date: Wed, 7 Jul 2021 18:01:39 +0800 Subject: [PATCH] Add Chinese doc (#415) * Add Chinese docs * update * update * update * update * Add Chinese docs for auto-generated documentation --- configs/inpainting/deepfillv1/README_zh-CN.md | 18 ++ configs/inpainting/deepfillv2/README_zh-CN.md | 17 ++ .../inpainting/global_local/README_zh-CN.md | 20 ++ .../inpainting/partial_conv/README_zh-CN.md | 18 ++ configs/mattors/dim/README_zh-CN.md | 17 ++ configs/mattors/gca/README_zh-CN.md | 16 ++ configs/mattors/indexnet/README_zh-CN.md | 16 ++ configs/restorers/basicvsr/README_zh-CN.md | 17 ++ configs/restorers/dic/README_zh-CN.md | 18 ++ configs/restorers/edsr/README_zh-CN.md | 18 ++ configs/restorers/edvr/README_zh-CN.md | 18 ++ configs/restorers/esrgan/README_zh-CN.md | 18 ++ configs/restorers/glean/README_zh-CN.md | 16 ++ configs/restorers/iconvsr/README_zh-CN.md | 17 ++ configs/restorers/liif/README_zh-CN.md | 18 ++ configs/restorers/rdn/README_zh-CN.md | 17 ++ configs/restorers/srcnn/README_zh-CN.md | 20 ++ .../restorers/srresnet_srgan/README_zh-CN.md | 16 ++ configs/restorers/tdan/README_zh-CN.md | 16 ++ configs/restorers/tof/README_zh-CN.md | 20 ++ configs/restorers/ttsr/README_zh-CN.md | 17 ++ configs/synthesizers/cyclegan/README_zh-CN.md | 17 ++ configs/synthesizers/pix2pix/README_zh-CN.md | 17 ++ docs/index.rst | 5 + docs/switch_language.md | 3 + docs_zh-CN/Makefile | 20 ++ docs_zh-CN/api.rst | 53 ++++++ docs_zh-CN/changelog.md | 1 + docs_zh-CN/conf.py | 75 ++++++++ docs_zh-CN/config.md | 1 + docs_zh-CN/config_generation.md | 1 + docs_zh-CN/config_inpainting.md | 1 + docs_zh-CN/config_matting.md | 1 + docs_zh-CN/config_restoration.md | 1 + docs_zh-CN/demo.md | 1 + docs_zh-CN/faq.md | 1 + docs_zh-CN/getting_started.md | 1 + docs_zh-CN/index.rst | 77 ++++++++ docs_zh-CN/install.md | 11 ++ docs_zh-CN/make.bat | 36 ++++ docs_zh-CN/merge_docs.sh | 36 ++++ docs_zh-CN/notes.md | 1 + docs_zh-CN/quick_run.md | 1 + docs_zh-CN/stat.py | 174 ++++++++++++++++++ docs_zh-CN/switch_language.md | 3 + docs_zh-CN/tools_scripts.md | 1 + tools/data/generation/README_zh-CN.md | 1 + .../generation/paired-pix2pix/README_zh-CN.md | 13 ++ .../unpaired-cyclegan/README_zh-CN.md | 13 ++ tools/data/inpainting/README_zh-CN.md | 1 + .../data/inpainting/celeba-hq/README_zh-CN.md | 12 ++ .../paris-street-view/README_zh-CN.md | 13 ++ .../data/inpainting/places365/README_zh-CN.md | 14 ++ tools/data/matting/README_zh-CN.md | 1 + tools/data/matting/comp1k/README_zh-CN.md | 1 + tools/data/super-resolution/README_zh-CN.md | 1 + .../super-resolution/div2k/README_zh-CN.md | 13 ++ .../super-resolution/reds/README_zh-CN.md | 13 ++ .../super-resolution/vid4/README_zh-CN.md | 16 ++ .../super-resolution/vimeo90k/README_zh-CN.md | 16 ++ 60 files changed, 1035 insertions(+) create mode 100644 configs/inpainting/deepfillv1/README_zh-CN.md create mode 100644 configs/inpainting/deepfillv2/README_zh-CN.md create mode 100644 configs/inpainting/global_local/README_zh-CN.md create mode 100644 configs/inpainting/partial_conv/README_zh-CN.md create mode 100644 configs/mattors/dim/README_zh-CN.md create mode 100644 configs/mattors/gca/README_zh-CN.md create mode 100644 configs/mattors/indexnet/README_zh-CN.md create mode 100644 configs/restorers/basicvsr/README_zh-CN.md create mode 100644 configs/restorers/dic/README_zh-CN.md create mode 100644 configs/restorers/edsr/README_zh-CN.md create mode 100644 configs/restorers/edvr/README_zh-CN.md create mode 100644 configs/restorers/esrgan/README_zh-CN.md create mode 100644 configs/restorers/glean/README_zh-CN.md create mode 100644 configs/restorers/iconvsr/README_zh-CN.md create mode 100644 configs/restorers/liif/README_zh-CN.md create mode 100644 configs/restorers/rdn/README_zh-CN.md create mode 100644 configs/restorers/srcnn/README_zh-CN.md create mode 100644 configs/restorers/srresnet_srgan/README_zh-CN.md create mode 100644 configs/restorers/tdan/README_zh-CN.md create mode 100644 configs/restorers/tof/README_zh-CN.md create mode 100644 configs/restorers/ttsr/README_zh-CN.md create mode 100644 configs/synthesizers/cyclegan/README_zh-CN.md create mode 100644 configs/synthesizers/pix2pix/README_zh-CN.md create mode 100644 docs/switch_language.md create mode 100644 docs_zh-CN/Makefile create mode 100644 docs_zh-CN/api.rst create mode 100644 docs_zh-CN/changelog.md create mode 100644 docs_zh-CN/conf.py create mode 100644 docs_zh-CN/config.md create mode 100644 docs_zh-CN/config_generation.md create mode 100644 docs_zh-CN/config_inpainting.md create mode 100644 docs_zh-CN/config_matting.md create mode 100644 docs_zh-CN/config_restoration.md create mode 100644 docs_zh-CN/demo.md create mode 100644 docs_zh-CN/faq.md create mode 100644 docs_zh-CN/getting_started.md create mode 100644 docs_zh-CN/index.rst create mode 100644 docs_zh-CN/install.md create mode 100644 docs_zh-CN/make.bat create mode 100755 docs_zh-CN/merge_docs.sh create mode 100644 docs_zh-CN/notes.md create mode 100644 docs_zh-CN/quick_run.md create mode 100755 docs_zh-CN/stat.py create mode 100644 docs_zh-CN/switch_language.md create mode 100644 docs_zh-CN/tools_scripts.md create mode 100644 tools/data/generation/README_zh-CN.md create mode 100644 tools/data/generation/paired-pix2pix/README_zh-CN.md create mode 100644 tools/data/generation/unpaired-cyclegan/README_zh-CN.md create mode 100644 tools/data/inpainting/README_zh-CN.md create mode 100644 tools/data/inpainting/celeba-hq/README_zh-CN.md create mode 100644 tools/data/inpainting/paris-street-view/README_zh-CN.md create mode 100644 tools/data/inpainting/places365/README_zh-CN.md create mode 100644 tools/data/matting/README_zh-CN.md create mode 100644 tools/data/matting/comp1k/README_zh-CN.md create mode 100644 tools/data/super-resolution/README_zh-CN.md create mode 100644 tools/data/super-resolution/div2k/README_zh-CN.md create mode 100644 tools/data/super-resolution/reds/README_zh-CN.md create mode 100644 tools/data/super-resolution/vid4/README_zh-CN.md create mode 100644 tools/data/super-resolution/vimeo90k/README_zh-CN.md diff --git a/configs/inpainting/deepfillv1/README_zh-CN.md b/configs/inpainting/deepfillv1/README_zh-CN.md new file mode 100644 index 0000000000..f48340be25 --- /dev/null +++ b/configs/inpainting/deepfillv1/README_zh-CN.md @@ -0,0 +1,18 @@ +# DeepFillv1 (CVPR'2018) + + + +
+DeepFillv1 (CVPR'2018) + +```bibtex +@inproceedings{yu2018generative, + title={Generative image inpainting with contextual attention}, + author={Yu, Jiahui and Lin, Zhe and Yang, Jimei and Shen, Xiaohui and Lu, Xin and Huang, Thomas S}, + booktitle={Proceedings of the IEEE conference on computer vision and pattern recognition}, + pages={5505--5514}, + year={2018} +} +``` + +
diff --git a/configs/inpainting/deepfillv2/README_zh-CN.md b/configs/inpainting/deepfillv2/README_zh-CN.md new file mode 100644 index 0000000000..9714d3e92b --- /dev/null +++ b/configs/inpainting/deepfillv2/README_zh-CN.md @@ -0,0 +1,17 @@ +# DeepFillv2 (CVPR'2019) + + +
+DeepFillv2 (CVPR'2019) + +```bibtex +@inproceedings{yu2019free, + title={Free-form image inpainting with gated convolution}, + author={Yu, Jiahui and Lin, Zhe and Yang, Jimei and Shen, Xiaohui and Lu, Xin and Huang, Thomas S}, + booktitle={Proceedings of the IEEE International Conference on Computer Vision}, + pages={4471--4480}, + year={2019} +} +``` + +
diff --git a/configs/inpainting/global_local/README_zh-CN.md b/configs/inpainting/global_local/README_zh-CN.md new file mode 100644 index 0000000000..c4461b362d --- /dev/null +++ b/configs/inpainting/global_local/README_zh-CN.md @@ -0,0 +1,20 @@ +# Global&Local (ToG'2017) + + +
+Global&Local (ToG'2017) + +```bibtex +@article{iizuka2017globally, + title={Globally and locally consistent image completion}, + author={Iizuka, Satoshi and Simo-Serra, Edgar and Ishikawa, Hiroshi}, + journal={ACM Transactions on Graphics (ToG)}, + volume={36}, + number={4}, + pages={1--14}, + year={2017}, + publisher={ACM New York, NY, USA} +} +``` + +
diff --git a/configs/inpainting/partial_conv/README_zh-CN.md b/configs/inpainting/partial_conv/README_zh-CN.md new file mode 100644 index 0000000000..a6034fb758 --- /dev/null +++ b/configs/inpainting/partial_conv/README_zh-CN.md @@ -0,0 +1,18 @@ +# PConv (ECCV'2018) + + + +
+PConv (ECCV'2018) + +```bibtex +@inproceedings{liu2018image, + title={Image inpainting for irregular holes using partial convolutions}, + author={Liu, Guilin and Reda, Fitsum A and Shih, Kevin J and Wang, Ting-Chun and Tao, Andrew and Catanzaro, Bryan}, + booktitle={Proceedings of the European Conference on Computer Vision (ECCV)}, + pages={85--100}, + year={2018} +} +``` + +
diff --git a/configs/mattors/dim/README_zh-CN.md b/configs/mattors/dim/README_zh-CN.md new file mode 100644 index 0000000000..0f8b52eb69 --- /dev/null +++ b/configs/mattors/dim/README_zh-CN.md @@ -0,0 +1,17 @@ +# DIM (CVPR'2017) + + +
+DIM (CVPR'2017) + +```bibtex +@inproceedings{xu2017deep, + title={Deep image matting}, + author={Xu, Ning and Price, Brian and Cohen, Scott and Huang, Thomas}, + booktitle={Proceedings of the IEEE Conference on Computer Vision and Pattern Recognition}, + pages={2970--2979}, + year={2017} +} +``` + +
diff --git a/configs/mattors/gca/README_zh-CN.md b/configs/mattors/gca/README_zh-CN.md new file mode 100644 index 0000000000..be55694525 --- /dev/null +++ b/configs/mattors/gca/README_zh-CN.md @@ -0,0 +1,16 @@ +# GCA (AAAI'2020) + + +
+GCA (AAAI'2020) + +```bibtex +@inproceedings{li2020natural, + title={Natural Image Matting via Guided Contextual Attention}, + author={Li, Yaoyi and Lu, Hongtao}, + booktitle={Association for the Advancement of Artificial Intelligence (AAAI)}, + year={2020} +} +``` + +
diff --git a/configs/mattors/indexnet/README_zh-CN.md b/configs/mattors/indexnet/README_zh-CN.md new file mode 100644 index 0000000000..c6dd761aaa --- /dev/null +++ b/configs/mattors/indexnet/README_zh-CN.md @@ -0,0 +1,16 @@ +# IndexNet (ICCV'2019) + + +
+IndexNet (ICCV'2019) + +```bibtex +@inproceedings{hao2019indexnet, + title={Indices Matter: Learning to Index for Deep Image Matting}, + author={Lu, Hao and Dai, Yutong and Shen, Chunhua and Xu, Songcen}, + booktitle={Proc. IEEE/CVF International Conference on Computer Vision (ICCV)}, + year={2019} +} +``` + +
diff --git a/configs/restorers/basicvsr/README_zh-CN.md b/configs/restorers/basicvsr/README_zh-CN.md new file mode 100644 index 0000000000..752660ed6c --- /dev/null +++ b/configs/restorers/basicvsr/README_zh-CN.md @@ -0,0 +1,17 @@ +# BasicVSR (CVPR'2021) + + + +
+BasicVSR (CVPR'2021) + +```bibtex +@InProceedings{chan2021basicvsr, + author = {Chan, Kelvin CK and Wang, Xintao and Yu, Ke and Dong, Chao and Loy, Chen Change}, + title = {BasicVSR: The Search for Essential Components in Video Super-Resolution and Beyond}, + booktitle = {Proceedings of the IEEE conference on computer vision and pattern recognition}, + year = {2021} +} +``` + +
diff --git a/configs/restorers/dic/README_zh-CN.md b/configs/restorers/dic/README_zh-CN.md new file mode 100644 index 0000000000..51f12558b4 --- /dev/null +++ b/configs/restorers/dic/README_zh-CN.md @@ -0,0 +1,18 @@ +# DIC (CVPR'2020) + + +
+ +DIC (CVPR'2020) + +```bibtex +@inproceedings{ma2020deep, + title={Deep face super-resolution with iterative collaboration between attentive recovery and landmark estimation}, + author={Ma, Cheng and Jiang, Zhenyu and Rao, Yongming and Lu, Jiwen and Zhou, Jie}, + booktitle={Proceedings of the IEEE/CVF conference on computer vision and pattern recognition}, + pages={5569--5578}, + year={2020} +} +``` + +
diff --git a/configs/restorers/edsr/README_zh-CN.md b/configs/restorers/edsr/README_zh-CN.md new file mode 100644 index 0000000000..79d3b5fdcf --- /dev/null +++ b/configs/restorers/edsr/README_zh-CN.md @@ -0,0 +1,18 @@ +# EDSR (CVPR'2017) + + + +
+EDSR (CVPR'2017) + +```bibtex +@inproceedings{lim2017enhanced, + title={Enhanced deep residual networks for single image super-resolution}, + author={Lim, Bee and Son, Sanghyun and Kim, Heewon and Nah, Seungjun and Mu Lee, Kyoung}, + booktitle={Proceedings of the IEEE conference on computer vision and pattern recognition workshops}, + pages={136--144}, + year={2017} +} +``` + +
diff --git a/configs/restorers/edvr/README_zh-CN.md b/configs/restorers/edvr/README_zh-CN.md new file mode 100644 index 0000000000..7aa3994a17 --- /dev/null +++ b/configs/restorers/edvr/README_zh-CN.md @@ -0,0 +1,18 @@ +# EDVR (CVPRW'2019) + + + +
+EDVR (CVPRW'2019) + +```bibtex +@InProceedings{wang2019edvr, + author = {Wang, Xintao and Chan, Kelvin C.K. and Yu, Ke and Dong, Chao and Loy, Chen Change}, + title = {EDVR: Video restoration with enhanced deformable convolutional networks}, + booktitle = {The IEEE Conference on Computer Vision and Pattern Recognition Workshops (CVPRW)}, + month = {June}, + year = {2019}, +} +``` + +
diff --git a/configs/restorers/esrgan/README_zh-CN.md b/configs/restorers/esrgan/README_zh-CN.md new file mode 100644 index 0000000000..3d9ccd07f1 --- /dev/null +++ b/configs/restorers/esrgan/README_zh-CN.md @@ -0,0 +1,18 @@ +# ESRGAN (ECCVW'2018) + + + +
+ESRGAN (ECCVW'2018) + +```bibtex +@inproceedings{wang2018esrgan, + title={Esrgan: Enhanced super-resolution generative adversarial networks}, + author={Wang, Xintao and Yu, Ke and Wu, Shixiang and Gu, Jinjin and Liu, Yihao and Dong, Chao and Qiao, Yu and Change Loy, Chen}, + booktitle={Proceedings of the European Conference on Computer Vision Workshops(ECCVW)}, + pages={0--0}, + year={2018} +} +``` + +
diff --git a/configs/restorers/glean/README_zh-CN.md b/configs/restorers/glean/README_zh-CN.md new file mode 100644 index 0000000000..1fa7eca521 --- /dev/null +++ b/configs/restorers/glean/README_zh-CN.md @@ -0,0 +1,16 @@ +# GLEAN (CVPR'2021) + + +
+GLEAN (CVPR'2021) + +```bibtex +@InProceedings{chan2021glean, + author = {Chan, Kelvin CK and Wang, Xintao and Xu, Xiangyu and Gu, Jinwei and Loy, Chen Change}, + title = {GLEAN: Generative Latent Bank for Large-Factor Image Super-Resolution}, + booktitle = {Proceedings of the IEEE conference on computer vision and pattern recognition}, + year = {2021} +} +``` + +
diff --git a/configs/restorers/iconvsr/README_zh-CN.md b/configs/restorers/iconvsr/README_zh-CN.md new file mode 100644 index 0000000000..e054b10916 --- /dev/null +++ b/configs/restorers/iconvsr/README_zh-CN.md @@ -0,0 +1,17 @@ +# IconVSR (CVPR'2021) + + + +
+IconVSR (CVPR'2021) + +```bibtex +@InProceedings{chan2021basicvsr, + author = {Chan, Kelvin CK and Wang, Xintao and Yu, Ke and Dong, Chao and Loy, Chen Change}, + title = {BasicVSR: The Search for Essential Components in Video Super-Resolution and Beyond}, + booktitle = {Proceedings of the IEEE conference on computer vision and pattern recognition}, + year = {2021} +} +``` + +
diff --git a/configs/restorers/liif/README_zh-CN.md b/configs/restorers/liif/README_zh-CN.md new file mode 100644 index 0000000000..f8d61e9dd5 --- /dev/null +++ b/configs/restorers/liif/README_zh-CN.md @@ -0,0 +1,18 @@ +# LIIF (CVPR'2021) + + + +
+LIIF (CVPR'2021) + +```bibtex +@inproceedings{chen2021learning, + title={Learning continuous image representation with local implicit image function}, + author={Chen, Yinbo and Liu, Sifei and Wang, Xiaolong}, + booktitle={Proceedings of the IEEE/CVF Conference on Computer Vision and Pattern Recognition}, + pages={8628--8638}, + year={2021} +} +``` + +
diff --git a/configs/restorers/rdn/README_zh-CN.md b/configs/restorers/rdn/README_zh-CN.md new file mode 100644 index 0000000000..3d34de7b12 --- /dev/null +++ b/configs/restorers/rdn/README_zh-CN.md @@ -0,0 +1,17 @@ +# RDN (CVPR'2018) + + +
+RDN (CVPR'2018) + +```bibtex +@inproceedings{zhang2018residual, + title={Residual dense network for image super-resolution}, + author={Zhang, Yulun and Tian, Yapeng and Kong, Yu and Zhong, Bineng and Fu, Yun}, + booktitle={Proceedings of the IEEE conference on computer vision and pattern recognition}, + pages={2472--2481}, + year={2018} +} +``` + +
diff --git a/configs/restorers/srcnn/README_zh-CN.md b/configs/restorers/srcnn/README_zh-CN.md new file mode 100644 index 0000000000..469aaa62bf --- /dev/null +++ b/configs/restorers/srcnn/README_zh-CN.md @@ -0,0 +1,20 @@ +# SRCNN (TPAMI'2015) + + +
+SRCNN (TPAMI'2015) + +```bibtex +@article{dong2015image, + title={Image super-resolution using deep convolutional networks}, + author={Dong, Chao and Loy, Chen Change and He, Kaiming and Tang, Xiaoou}, + journal={IEEE transactions on pattern analysis and machine intelligence}, + volume={38}, + number={2}, + pages={295--307}, + year={2015}, + publisher={IEEE} +} +``` + +
diff --git a/configs/restorers/srresnet_srgan/README_zh-CN.md b/configs/restorers/srresnet_srgan/README_zh-CN.md new file mode 100644 index 0000000000..6f68a3770e --- /dev/null +++ b/configs/restorers/srresnet_srgan/README_zh-CN.md @@ -0,0 +1,16 @@ +# SRGAN (CVPR'2016) + + +
+SRGAN (CVPR'2016) + +```bibtex +@inproceedings{ledig2016photo, + title={Photo-realistic single image super-resolution using a generative adversarial network}, + author={Ledig, Christian and Theis, Lucas and Husz{\'a}r, Ferenc and Caballero, Jose and Cunningham, Andrew and Acosta, Alejandro and Aitken, Andrew and Tejani, Alykhan and Totz, Johannes and Wang, Zehan}, + booktitle={Proceedings of the IEEE conference on computer vision and pattern recognition workshops}, + year={2016} +} +``` + +
diff --git a/configs/restorers/tdan/README_zh-CN.md b/configs/restorers/tdan/README_zh-CN.md new file mode 100644 index 0000000000..fc6b8b19cb --- /dev/null +++ b/configs/restorers/tdan/README_zh-CN.md @@ -0,0 +1,16 @@ +# TDAN (CVPR'2020) + + +
+TDAN (CVPR'2020) + +```bibtex +@InProceedings{tian2020tdan, + title={TDAN: Temporally-Deformable Alignment Network for Video Super-Resolution}, + author={Tian, Yapeng and Zhang, Yulun and Fu, Yun and Xu, Chenliang}, + booktitle = {Proceedings of the IEEE conference on Computer Vision and Pattern Recognition}, + year = {2020} +} +``` + +
diff --git a/configs/restorers/tof/README_zh-CN.md b/configs/restorers/tof/README_zh-CN.md new file mode 100644 index 0000000000..bcdfb5fe4b --- /dev/null +++ b/configs/restorers/tof/README_zh-CN.md @@ -0,0 +1,20 @@ +# TOFlow (IJCV'2019) + + +
+TOFlow (IJCV'2019) + +```bibtex +@article{xue2019video, + title={Video enhancement with task-oriented flow}, + author={Xue, Tianfan and Chen, Baian and Wu, Jiajun and Wei, Donglai and Freeman, William T}, + journal={International Journal of Computer Vision}, + volume={127}, + number={8}, + pages={1106--1125}, + year={2019}, + publisher={Springer} +} +``` + +
diff --git a/configs/restorers/ttsr/README_zh-CN.md b/configs/restorers/ttsr/README_zh-CN.md new file mode 100644 index 0000000000..62f89db5d3 --- /dev/null +++ b/configs/restorers/ttsr/README_zh-CN.md @@ -0,0 +1,17 @@ +# TTSR (CVPR'2020) + + +
+TTSR (CVPR'2020) + +```bibtex +@inproceedings{yang2020learning, + title={Learning texture transformer network for image super-resolution}, + author={Yang, Fuzhi and Yang, Huan and Fu, Jianlong and Lu, Hongtao and Guo, Baining}, + booktitle={Proceedings of the IEEE/CVF Conference on Computer Vision and Pattern Recognition}, + pages={5791--5800}, + year={2020} +} +``` + +
diff --git a/configs/synthesizers/cyclegan/README_zh-CN.md b/configs/synthesizers/cyclegan/README_zh-CN.md new file mode 100644 index 0000000000..715f79b95f --- /dev/null +++ b/configs/synthesizers/cyclegan/README_zh-CN.md @@ -0,0 +1,17 @@ +# CycleGAN (ICCV'2017) + + +
+CycleGAN (ICCV'2017) + +```bibtex +@inproceedings{zhu2017unpaired, + title={Unpaired image-to-image translation using cycle-consistent adversarial networks}, + author={Zhu, Jun-Yan and Park, Taesung and Isola, Phillip and Efros, Alexei A}, + booktitle={Proceedings of the IEEE international conference on computer vision}, + pages={2223--2232}, + year={2017} +} +``` + +
diff --git a/configs/synthesizers/pix2pix/README_zh-CN.md b/configs/synthesizers/pix2pix/README_zh-CN.md new file mode 100644 index 0000000000..c8d9796d3e --- /dev/null +++ b/configs/synthesizers/pix2pix/README_zh-CN.md @@ -0,0 +1,17 @@ +# Pix2Pix (CVPR'2017) + + +
+Pix2Pix (CVPR'2017) + +```bibtex +@inproceedings{isola2017image, + title={Image-to-image translation with conditional adversarial networks}, + author={Isola, Phillip and Zhu, Jun-Yan and Zhou, Tinghui and Efros, Alexei A}, + booktitle={Proceedings of the IEEE conference on computer vision and pattern recognition}, + pages={1125--1134}, + year={2017} +} +``` + +
diff --git a/docs/index.rst b/docs/index.rst index 480ea6f090..d8ee3678cb 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -65,6 +65,11 @@ Welcome to MMEditing's documentation! api.rst +.. toctree:: + :caption: 语言切换 + + switch_language.md + Indices and tables ================== diff --git a/docs/switch_language.md b/docs/switch_language.md new file mode 100644 index 0000000000..7ee684968e --- /dev/null +++ b/docs/switch_language.md @@ -0,0 +1,3 @@ +## English + +## 简体中文 diff --git a/docs_zh-CN/Makefile b/docs_zh-CN/Makefile new file mode 100644 index 0000000000..d4bb2cbb9e --- /dev/null +++ b/docs_zh-CN/Makefile @@ -0,0 +1,20 @@ +# Minimal makefile for Sphinx documentation +# + +# You can set these variables from the command line, and also +# from the environment for the first two. +SPHINXOPTS ?= +SPHINXBUILD ?= sphinx-build +SOURCEDIR = . +BUILDDIR = _build + +# Put it first so that "make" without argument is like "make help". +help: + @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + +.PHONY: help Makefile + +# Catch-all target: route all unknown targets to Sphinx using the new +# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). +%: Makefile + @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) diff --git a/docs_zh-CN/api.rst b/docs_zh-CN/api.rst new file mode 100644 index 0000000000..191ad02732 --- /dev/null +++ b/docs_zh-CN/api.rst @@ -0,0 +1,53 @@ +API Reference +================= + +mmedit.core +-------------- +.. automodule:: mmedit.core + :members: + +mmedit.datasets +--------------- + +datasets +^^^^^^^^^^ +.. automodule:: mmedit.datasets + :members: + +pipelines +^^^^^^^^^^ +.. automodule:: mmedit.datasets.pipelines + :members: + +mmedit.models +-------------- + +models +^^^^^^^ +.. automodule:: mmedit.models + :members: + +common +^^^^^^^ +.. automodule:: mmedit.models.common + :members: + +backbones +^^^^^^^^^^^^ +.. automodule:: mmedit.models.backbones + :members: + +components +^^^^^^^^^^^^ +.. automodule:: mmedit.models.components + :members: + +losses +^^^^^^^^^^^^ +.. automodule:: mmedit.models.losses + :members: + +mmedit.utils +-------------- +.. automodule:: mmedit.utils + :members: diff --git a/docs_zh-CN/changelog.md b/docs_zh-CN/changelog.md new file mode 100644 index 0000000000..9017dfd219 --- /dev/null +++ b/docs_zh-CN/changelog.md @@ -0,0 +1 @@ +# 变更日志 diff --git a/docs_zh-CN/conf.py b/docs_zh-CN/conf.py new file mode 100644 index 0000000000..3bec9852df --- /dev/null +++ b/docs_zh-CN/conf.py @@ -0,0 +1,75 @@ +# Configuration file for the Sphinx documentation builder. +# +# This file only contains a selection of the most common options. For a full +# list see the documentation: +# https://www.sphinx-doc.org/en/master/usage/configuration.html + +# -- Path setup -------------------------------------------------------------- + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +# +import os +import subprocess +import sys + +sys.path.insert(0, os.path.abspath('..')) + +# -- Project information ----------------------------------------------------- + +project = 'MMEditing' +copyright = '2020, MMEditing Authors' +author = 'MMEditing Authors' + +# -- General configuration --------------------------------------------------- + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = [ + 'sphinx.ext.autodoc', 'sphinx.ext.napoleon', 'sphinx.ext.viewcode', + 'recommonmark', 'sphinx_markdown_tables' +] + +autodoc_mock_imports = [ + 'mmedit.version', 'skimage', 'mmcv.ops.ModulatedDeformConv2d', + 'mmcv.ops.modulated_deform_conv2d', 'mmcv._ext' +] + +source_suffix = { + '.rst': 'restructuredtext', + '.md': 'markdown', +} + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +# This pattern also affects html_static_path and html_extra_path. +exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] + +# -- Options for HTML output ------------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +# +html_theme = 'sphinx_rtd_theme' + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = [] + +# The master toctree document. +master_doc = 'index' + + +def builder_inited_handler(app): + subprocess.run(['./merge_docs.sh']) + subprocess.run(['./stat.py']) + + +def setup(app): + app.connect('builder-inited', builder_inited_handler) diff --git a/docs_zh-CN/config.md b/docs_zh-CN/config.md new file mode 100644 index 0000000000..0432a9f7dc --- /dev/null +++ b/docs_zh-CN/config.md @@ -0,0 +1 @@ +# 教程 1: 配置文件 diff --git a/docs_zh-CN/config_generation.md b/docs_zh-CN/config_generation.md new file mode 100644 index 0000000000..a264b1a018 --- /dev/null +++ b/docs_zh-CN/config_generation.md @@ -0,0 +1 @@ +# 配置文件 - 生成 diff --git a/docs_zh-CN/config_inpainting.md b/docs_zh-CN/config_inpainting.md new file mode 100644 index 0000000000..9937c19736 --- /dev/null +++ b/docs_zh-CN/config_inpainting.md @@ -0,0 +1 @@ +# 配置文件 - 补全 diff --git a/docs_zh-CN/config_matting.md b/docs_zh-CN/config_matting.md new file mode 100644 index 0000000000..a81a69bc5d --- /dev/null +++ b/docs_zh-CN/config_matting.md @@ -0,0 +1 @@ +# 配置文件 - 抠图 diff --git a/docs_zh-CN/config_restoration.md b/docs_zh-CN/config_restoration.md new file mode 100644 index 0000000000..42bf363d02 --- /dev/null +++ b/docs_zh-CN/config_restoration.md @@ -0,0 +1 @@ +# 配置文件 - 复原 diff --git a/docs_zh-CN/demo.md b/docs_zh-CN/demo.md new file mode 100644 index 0000000000..1473388140 --- /dev/null +++ b/docs_zh-CN/demo.md @@ -0,0 +1 @@ +### 演示 diff --git a/docs_zh-CN/faq.md b/docs_zh-CN/faq.md new file mode 100644 index 0000000000..2f351a3b67 --- /dev/null +++ b/docs_zh-CN/faq.md @@ -0,0 +1 @@ +## 常见问题解答 diff --git a/docs_zh-CN/getting_started.md b/docs_zh-CN/getting_started.md new file mode 100644 index 0000000000..76d1d5cf5a --- /dev/null +++ b/docs_zh-CN/getting_started.md @@ -0,0 +1 @@ +# 入门 diff --git a/docs_zh-CN/index.rst b/docs_zh-CN/index.rst new file mode 100644 index 0000000000..2bf51c162e --- /dev/null +++ b/docs_zh-CN/index.rst @@ -0,0 +1,77 @@ +Welcome to MMEditing's documentation! +===================================== + +.. toctree:: + :maxdepth: 2 + :caption: 开始你的第一步 + + install.md + demo.md + +.. toctree:: + :maxdepth: 2 + :caption: 模型库 + + modelzoo.md + inpainting_models.md + mattors_models.md + restorers_models.md + synthesizers_models.md + +.. toctree:: + :maxdepth: 2 + :caption: 数据集 + + datasets.md + inpainting_datasets.md + matting_datasets.md + sr_datasets.md + generation_datasets.md + +.. toctree:: + :maxdepth: 2 + :caption: 快速启动 + + quick_run.md + +.. toctree:: + :maxdepth: 2 + :caption: 教程 + + config.md + +.. toctree:: + :maxdepth: 2 + :caption: 实用工具与脚本 + + tools_scripts.md + +.. toctree:: + :maxdepth: 2 + :caption: 说明 + + notes.md + +.. toctree:: + :maxdepth: 2 + :caption: FAQ + + faq.md + +.. toctree:: + :caption: 语言切换 + + switch_language.md + +.. toctree:: + :maxdepth: 2 + :caption: 接口文档 + + api.rst + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/docs_zh-CN/install.md b/docs_zh-CN/install.md new file mode 100644 index 0000000000..2e2d906318 --- /dev/null +++ b/docs_zh-CN/install.md @@ -0,0 +1,11 @@ +## 依赖 + +- Linux (Windows is not officially supported) +- Python 3.6+ +- PyTorch 1.3 or higher +- CUDA 9.0 or higher +- NCCL 2 +- GCC 4.9 or higher +- [mmcv](https://github.com/open-mmlab/mmcv) + +## 安装 diff --git a/docs_zh-CN/make.bat b/docs_zh-CN/make.bat new file mode 100644 index 0000000000..8a3a0e25b4 --- /dev/null +++ b/docs_zh-CN/make.bat @@ -0,0 +1,36 @@ +@ECHO OFF + +pushd %~dp0 + +REM Command file for Sphinx documentation + +if "%SPHINXBUILD%" == "" ( + set SPHINXBUILD=sphinx-build +) +set SOURCEDIR=. +set BUILDDIR=_build + +if "%1" == "" goto help + +%SPHINXBUILD% >NUL 2>NUL +if errorlevel 9009 ( + echo. + echo.The 'sphinx-build' command was not found. Make sure you have Sphinx + echo.installed, then set the SPHINXBUILD environment variable to point + echo.to the full path of the 'sphinx-build' executable. Alternatively you + echo.may add the Sphinx directory to PATH. + echo. + echo.If you don't have Sphinx installed, grab it from + echo.http://sphinx-doc.org/ + exit /b 1 +) + + +%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% +goto end + +:help +%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% + +:end +popd diff --git a/docs_zh-CN/merge_docs.sh b/docs_zh-CN/merge_docs.sh new file mode 100755 index 0000000000..d459b2570f --- /dev/null +++ b/docs_zh-CN/merge_docs.sh @@ -0,0 +1,36 @@ +#!/usr/bin/env bash + +sed -i '$a\\n
\n' ../configs/inpainting/*/*_zh-CN.md +sed -i '$a\\n
\n' ../configs/mattors/*/*_zh-CN.md +sed -i '$a\\n
\n' ../configs/restorers/*/*_zh-CN.md +sed -i '$a\\n
\n' ../configs/synthesizers/*/*_zh-CN.md + +# gather models +cat ../configs/inpainting/*/*_zh-CN.md | sed "s/md###t/html#t/g" | sed "s/#/#&/" | sed '1i\# 补全模型' | sed 's/](\/docs_zh_CN\//](/g' | sed 's=](/=](https://github.com/open-mmlab/mmediting/tree/master/=g' >inpainting_models.md +cat ../configs/mattors/*/*_zh-CN.md | sed "s/md###t/html#t/g" | sed "s/#/#&/" | sed '1i\# 抠图模型' | sed 's/](\/docs_zh_CN\//](/g' | sed 's=](/=](https://github.com/open-mmlab/mmediting/tree/master/=g' >mattors_models.md +cat ../configs/restorers/*/*_zh-CN.md | sed "s/md###t/html#t/g" | sed "s/#/#&/" | sed '1i\# 超分辨率模型' | sed 's/](\/docs_zh_CN\//](/g' | sed 's=](/=](https://github.com/open-mmlab/mmediting/tree/master/=g' >restorers_models.md +cat ../configs/synthesizers/*/*_zh-CN.md | sed "s/md###t/html#t/g" | sed "s/#/#&/" | sed '1i\# 生成模型' | sed 's/](\/docs_zh_CN\//](/g' | sed 's=](/=](https://github.com/open-mmlab/mmediting/tree/master/=g' >synthesizers_models.md + +# gather datasets +cat ../tools/data/generation/*_zh-CN.md > generation_datasets.md +cat ../tools/data/inpainting/*_zh-CN.md > inpainting_datasets.md +cat ../tools/data/matting/*_zh-CN.md > matting_datasets.md +cat ../tools/data/super-resolution/*_zh-CN.md > sr_datasets.md + +sed -i 's=(paired-pix2pix/README_zh-CN.md)=(#paired-dataset-for-pix2pix)=g' generation_datasets.md +sed -i 's=(unpaired-cyclegan/README_zh-CN.md)=(#unpaired-dataset-for-cyclegan)=g' generation_datasets.md +sed -i 's=(paris-street-view/README_zh-CN.md)=(#paris-street-view-dataset)=g' inpainting_datasets.md +sed -i 's=(celeba-hq/README_zh-CN.md)=(#celeba-hq-dataset)=g' inpainting_datasets.md +sed -i 's=(places365/README_zh-CN.md)=(#places365-dataset)=g' inpainting_datasets.md +sed -i 's=(comp1k/README_zh-CN.md)=(#composition-1k-dataset)=g' matting_datasets.md +sed -i 's=(div2k/README_zh-CN.md)=(#div2k-dataset)=g' sr_datasets.md +sed -i 's=(reds/README_zh-CN.md)=(#reds-dataset)=g' sr_datasets.md +sed -i 's=(vimeo90k/README_zh-CN.md)=(#vimeo90k-dataset)=g' sr_datasets.md + +cat ../tools/data/generation/*/*_zh-CN.md | sed 's/# Preparing/# /g' | sed "s/#/#&/" | sed 's/](\/docs\//](/g' | sed 's=](/=](https://github.com/open-mmlab/mmediting/tree/master/=g' >> generation_datasets.md +cat ../tools/data/inpainting/*/*_zh-CN.md | sed 's/# Preparing/# /g' | sed "s/#/#&/" | sed 's/](\/docs\//](/g' | sed 's=](/=](https://github.com/open-mmlab/mmediting/tree/master/=g' >> inpainting_datasets.md +cat ../tools/data/matting/*/*_zh-CN.md | sed 's/# Preparing/# /g' | sed "s/#/#&/" | sed 's/](\/docs\//](/g' | sed 's=](/=](https://github.com/open-mmlab/mmediting/tree/master/=g' >> matting_datasets.md +cat ../tools/data/super-resolution/*/*_zh-CN.md | sed 's/# Preparing/# /g' | sed "s/#/#&/" | sed 's/](\/docs\//](/g' | sed 's=](/=](https://github.com/open-mmlab/mmediting/tree/master/=g' >> sr_datasets.md + +# merge configs +cat config_*.md | sed "s/#/#&/" >> config.md diff --git a/docs_zh-CN/notes.md b/docs_zh-CN/notes.md new file mode 100644 index 0000000000..f96030bc6c --- /dev/null +++ b/docs_zh-CN/notes.md @@ -0,0 +1 @@ +## 基准 diff --git a/docs_zh-CN/quick_run.md b/docs_zh-CN/quick_run.md new file mode 100644 index 0000000000..c155d12aac --- /dev/null +++ b/docs_zh-CN/quick_run.md @@ -0,0 +1 @@ +## 使用预训练模型进行推理 diff --git a/docs_zh-CN/stat.py b/docs_zh-CN/stat.py new file mode 100755 index 0000000000..d182b610e7 --- /dev/null +++ b/docs_zh-CN/stat.py @@ -0,0 +1,174 @@ +#!/usr/bin/env python +import functools as func +import glob +import re +from os.path import basename, splitext + +import numpy as np +import titlecase + + +def anchor(name): + return re.sub(r'-+', '-', re.sub(r'[^a-zA-Z0-9]', '-', + name.strip().lower())).strip('-') + + +# Count algorithms + +files = sorted(glob.glob('*_models.md')) +# files = sorted(glob.glob('docs/*_models.md')) + +stats = [] + +for f in files: + with open(f, 'r') as content_file: + content = content_file.read() + + # title + title = content.split('\n')[0].replace('#', '') + + # count papers + papers = set( + (papertype, titlecase.titlecase(paper.lower().strip())) + for (papertype, paper) in re.findall( + r'\s*\n.*?\btitle\s*=\s*{(.*?)}', + content, re.DOTALL)) + # paper links + revcontent = '\n'.join(list(reversed(content.splitlines()))) + paperlinks = {} + for _, p in papers: + print(p) + paperlinks[p] = ' '.join( + (f'[⇨]({splitext(basename(f))[0]}.html#{anchor(paperlink)})' + for paperlink in re.findall( + rf'\btitle\s*=\s*{{\s*{p}\s*}}.*?\n## (.*?)\s*[,;]?\s*\n', + revcontent, re.DOTALL | re.IGNORECASE))) + print(' ', paperlinks[p]) + paperlist = '\n'.join( + sorted(f' - [{t}] {x} ({paperlinks[x]})' for t, x in papers)) + # count configs + configs = set(x.lower().strip() + for x in re.findall(r'https.*configs/.*\.py', content)) + + # count ckpts + ckpts = set(x.lower().strip() + for x in re.findall(r'https://download.*\.pth', content) + if 'mmedit' in x) + + statsmsg = f""" +## [{title}]({f}) + +* Number of checkpoints: {len(ckpts)} +* Number of configs: {len(configs)} +* Number of papers: {len(papers)} +{paperlist} + + """ + + stats.append((papers, configs, ckpts, statsmsg)) + +allpapers = func.reduce(lambda a, b: a.union(b), [p for p, _, _, _ in stats]) +allconfigs = func.reduce(lambda a, b: a.union(b), [c for _, c, _, _ in stats]) +allckpts = func.reduce(lambda a, b: a.union(b), [c for _, _, c, _ in stats]) + +# Summarize + +msglist = '\n'.join(x for _, _, _, x in stats) +papertypes, papercounts = np.unique([t for t, _ in allpapers], + return_counts=True) +countstr = '\n'.join( + [f' - {t}: {c}' for t, c in zip(papertypes, papercounts)]) + +modelzoo = f""" +# Overview + +* Number of checkpoints: {len(allckpts)} +* Number of configs: {len(allconfigs)} +* Number of papers: {len(allpapers)} +{countstr} + +For supported datasets, see [datasets overview](datasets.md). + +{msglist} + +""" + +with open('modelzoo.md', 'w') as f: + f.write(modelzoo) + +# Count datasets + +files = sorted(glob.glob('*_datasets.md')) + +datastats = [] + +for f in files: + with open(f, 'r') as content_file: + content = content_file.read() + + # title + title = content.split('\n')[0].replace('#', '') + + # count papers + papers = set( + (papertype, titlecase.titlecase(paper.lower().strip())) + for (papertype, paper) in re.findall( + r'\s*\n.*?\btitle\s*=\s*{(.*?)}', + content, re.DOTALL)) + # paper links + revcontent = '\n'.join(list(reversed(content.splitlines()))) + paperlinks = {} + for _, p in papers: + print(p) + paperlinks[p] = ', '.join( + (f'[{p} ⇨]({splitext(basename(f))[0]}.html#{anchor(p)})' + for p in re.findall( + rf'\btitle\s*=\s*{{\s*{p}\s*}}.*?\n## (.*?)\s*[,;]?\s*\n', + revcontent, re.DOTALL | re.IGNORECASE))) + print(' ', paperlinks[p]) + paperlist = '\n'.join( + sorted(f' - [{t}] {x} ({paperlinks[x]})' for t, x in papers)) + # count configs + configs = set(x.lower().strip() + for x in re.findall(r'https.*configs/.*\.py', content)) + + # count ckpts + ckpts = set(x.lower().strip() + for x in re.findall(r'https://download.*\.pth', content) + if 'mmedit' in x) + + statsmsg = f""" +## [{title}]({f}) + +* Number of papers: {len(papers)} +{paperlist} + + """ + + datastats.append((papers, configs, ckpts, statsmsg)) + +alldatapapers = func.reduce(lambda a, b: a.union(b), + [p for p, _, _, _ in datastats]) + +# Summarize + +msglist = '\n'.join(x for _, _, _, x in stats) +datamsglist = '\n'.join(x for _, _, _, x in datastats) +papertypes, papercounts = np.unique([t for t, _ in alldatapapers], + return_counts=True) +countstr = '\n'.join( + [f' - {t}: {c}' for t, c in zip(papertypes, papercounts)]) + +modelzoo = f""" +# Overview + +* Number of papers: {len(alldatapapers)} +{countstr} + +For supported editing algorithms, see [modelzoo overview](modelzoo.md). + +{datamsglist} +""" + +with open('datasets.md', 'w') as f: + f.write(modelzoo) diff --git a/docs_zh-CN/switch_language.md b/docs_zh-CN/switch_language.md new file mode 100644 index 0000000000..7ee684968e --- /dev/null +++ b/docs_zh-CN/switch_language.md @@ -0,0 +1,3 @@ +## English + +## 简体中文 diff --git a/docs_zh-CN/tools_scripts.md b/docs_zh-CN/tools_scripts.md new file mode 100644 index 0000000000..7919b0d91d --- /dev/null +++ b/docs_zh-CN/tools_scripts.md @@ -0,0 +1 @@ +## 有用工具 diff --git a/tools/data/generation/README_zh-CN.md b/tools/data/generation/README_zh-CN.md new file mode 100644 index 0000000000..9a15e067e0 --- /dev/null +++ b/tools/data/generation/README_zh-CN.md @@ -0,0 +1 @@ +# 数据集 - 生成 diff --git a/tools/data/generation/paired-pix2pix/README_zh-CN.md b/tools/data/generation/paired-pix2pix/README_zh-CN.md new file mode 100644 index 0000000000..97e81332b1 --- /dev/null +++ b/tools/data/generation/paired-pix2pix/README_zh-CN.md @@ -0,0 +1,13 @@ +# 为 Pix2pix 准备配对数据集 + + + +```bibtex +@inproceedings{isola2017image, + title={Image-to-image translation with conditional adversarial networks}, + author={Isola, Phillip and Zhu, Jun-Yan and Zhou, Tinghui and Efros, Alexei A}, + booktitle={Proceedings of the IEEE conference on computer vision and pattern recognition}, + pages={1125--1134}, + year={2017} +} +``` diff --git a/tools/data/generation/unpaired-cyclegan/README_zh-CN.md b/tools/data/generation/unpaired-cyclegan/README_zh-CN.md new file mode 100644 index 0000000000..7cbd3dad87 --- /dev/null +++ b/tools/data/generation/unpaired-cyclegan/README_zh-CN.md @@ -0,0 +1,13 @@ +# 为 CycleGAN 准备未配对数据集 + + + +```bibtex +@inproceedings{zhu2017unpaired, + title={Unpaired image-to-image translation using cycle-consistent adversarial networks}, + author={Zhu, Jun-Yan and Park, Taesung and Isola, Phillip and Efros, Alexei A}, + booktitle={Proceedings of the IEEE international conference on computer vision}, + pages={2223--2232}, + year={2017} +} +``` diff --git a/tools/data/inpainting/README_zh-CN.md b/tools/data/inpainting/README_zh-CN.md new file mode 100644 index 0000000000..403d64d4ae --- /dev/null +++ b/tools/data/inpainting/README_zh-CN.md @@ -0,0 +1 @@ +# 数据集 - 补全 diff --git a/tools/data/inpainting/celeba-hq/README_zh-CN.md b/tools/data/inpainting/celeba-hq/README_zh-CN.md new file mode 100644 index 0000000000..4fdd37c4ea --- /dev/null +++ b/tools/data/inpainting/celeba-hq/README_zh-CN.md @@ -0,0 +1,12 @@ +# 准备 CelebA-HQ 数据集 + + + +```bibtex +@article{karras2017progressive, + title={Progressive growing of gans for improved quality, stability, and variation}, + author={Karras, Tero and Aila, Timo and Laine, Samuli and Lehtinen, Jaakko}, + journal={arXiv preprint arXiv:1710.10196}, + year={2017} +} +``` diff --git a/tools/data/inpainting/paris-street-view/README_zh-CN.md b/tools/data/inpainting/paris-street-view/README_zh-CN.md new file mode 100644 index 0000000000..6df4c3226d --- /dev/null +++ b/tools/data/inpainting/paris-street-view/README_zh-CN.md @@ -0,0 +1,13 @@ +# 准备 Paris Street View 数据集 + + + +```bibtex +@inproceedings{pathak2016context, + title={Context encoders: Feature learning by inpainting}, + author={Pathak, Deepak and Krahenbuhl, Philipp and Donahue, Jeff and Darrell, Trevor and Efros, Alexei A}, + booktitle={Proceedings of the IEEE conference on computer vision and pattern recognition}, + pages={2536--2544}, + year={2016} +} +``` diff --git a/tools/data/inpainting/places365/README_zh-CN.md b/tools/data/inpainting/places365/README_zh-CN.md new file mode 100644 index 0000000000..655fcca242 --- /dev/null +++ b/tools/data/inpainting/places365/README_zh-CN.md @@ -0,0 +1,14 @@ +# 准备 Places365 数据集 + + + +```bibtex + @article{zhou2017places, + title={Places: A 10 million Image Database for Scene Recognition}, + author={Zhou, Bolei and Lapedriza, Agata and Khosla, Aditya and Oliva, Aude and Torralba, Antonio}, + journal={IEEE Transactions on Pattern Analysis and Machine Intelligence}, + year={2017}, + publisher={IEEE} + } + +``` diff --git a/tools/data/matting/README_zh-CN.md b/tools/data/matting/README_zh-CN.md new file mode 100644 index 0000000000..f4ecc080b4 --- /dev/null +++ b/tools/data/matting/README_zh-CN.md @@ -0,0 +1 @@ +# 数据集 - 抠图 diff --git a/tools/data/matting/comp1k/README_zh-CN.md b/tools/data/matting/comp1k/README_zh-CN.md new file mode 100644 index 0000000000..5c8962f68b --- /dev/null +++ b/tools/data/matting/comp1k/README_zh-CN.md @@ -0,0 +1 @@ +# 准备 Composition-1k 数据集 diff --git a/tools/data/super-resolution/README_zh-CN.md b/tools/data/super-resolution/README_zh-CN.md new file mode 100644 index 0000000000..b39b3a37b1 --- /dev/null +++ b/tools/data/super-resolution/README_zh-CN.md @@ -0,0 +1 @@ +# 数据集 - 复原 diff --git a/tools/data/super-resolution/div2k/README_zh-CN.md b/tools/data/super-resolution/div2k/README_zh-CN.md new file mode 100644 index 0000000000..3fd493c393 --- /dev/null +++ b/tools/data/super-resolution/div2k/README_zh-CN.md @@ -0,0 +1,13 @@ +# 准备 DIV2K 数据集 + + + +```bibtex +@InProceedings{Agustsson_2017_CVPR_Workshops, + author = {Agustsson, Eirikur and Timofte, Radu}, + title = {NTIRE 2017 Challenge on Single Image Super-Resolution: Dataset and Study}, + booktitle = {The IEEE Conference on Computer Vision and Pattern Recognition (CVPR) Workshops}, + month = {July}, + year = {2017} +} +``` diff --git a/tools/data/super-resolution/reds/README_zh-CN.md b/tools/data/super-resolution/reds/README_zh-CN.md new file mode 100644 index 0000000000..a2f608cf0b --- /dev/null +++ b/tools/data/super-resolution/reds/README_zh-CN.md @@ -0,0 +1,13 @@ +# 准备 REDS 数据集 + + + +```bibtex +@InProceedings{Nah_2019_CVPR_Workshops_REDS, + author = {Nah, Seungjun and Baik, Sungyong and Hong, Seokil and Moon, Gyeongsik and Son, Sanghyun and Timofte, Radu and Lee, Kyoung Mu}, + title = {NTIRE 2019 Challenge on Video Deblurring and Super-Resolution: Dataset and Study}, + booktitle = {The IEEE Conference on Computer Vision and Pattern Recognition (CVPR) Workshops}, + month = {June}, + year = {2019} +} +``` diff --git a/tools/data/super-resolution/vid4/README_zh-CN.md b/tools/data/super-resolution/vid4/README_zh-CN.md new file mode 100644 index 0000000000..3203fd3df3 --- /dev/null +++ b/tools/data/super-resolution/vid4/README_zh-CN.md @@ -0,0 +1,16 @@ +# 准备 Vid4 数据集 + + + +```bibtex +@article{xue2019video, + title={On Bayesian adaptive video super resolution}, + author={Liu, Ce and Sun, Deqing}, + journal={IEEE Transactions on Pattern Analysis and Machine Intelligence}, + volume={36}, + number={2}, + pages={346--360}, + year={2013}, + publisher={IEEE} +} +``` diff --git a/tools/data/super-resolution/vimeo90k/README_zh-CN.md b/tools/data/super-resolution/vimeo90k/README_zh-CN.md new file mode 100644 index 0000000000..c0452d7b33 --- /dev/null +++ b/tools/data/super-resolution/vimeo90k/README_zh-CN.md @@ -0,0 +1,16 @@ +# 准备 Vimeo90K 数据集 + + + +```bibtex +@article{xue2019video, + title={Video Enhancement with Task-Oriented Flow}, + author={Xue, Tianfan and Chen, Baian and Wu, Jiajun and Wei, Donglai and Freeman, William T}, + journal={International Journal of Computer Vision (IJCV)}, + volume={127}, + number={8}, + pages={1106--1125}, + year={2019}, + publisher={Springer} +} +```