Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Doc for datasets #194

Merged
merged 11 commits into from
Feb 8, 2021
Merged

Doc for datasets #194

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
e01f1fa
comp1k
innerlee Feb 3, 2021
809a3fe
hmm
innerlee Feb 8, 2021
9b9deb5
fix
innerlee Feb 8, 2021
420e134
cool
innerlee Feb 8, 2021
a533662
bibtex
innerlee Feb 8, 2021
6416d92
typo
innerlee Feb 8, 2021
208a781
tiny
innerlee Feb 8, 2021
46def91
tiny
innerlee Feb 8, 2021
6342ff6
ha
innerlee Feb 8, 2021
193150e
finally
innerlee Feb 8, 2021
f8f78b4
hm
innerlee Feb 8, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 2 additions & 3 deletions configs/inpainting/deepfillv1/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

[ALGORITHM]

```latex
```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},
Expand All @@ -14,15 +14,14 @@
}
```


## Results and models

### Places365-Challenge

| Method | Mask Type | Resolution | Train Iters | Test Set | l1 error | PSNR | SSIM | Download |
| :--------------------------------------------------------------------------: | :---------: | :--------: | :---------: | :-----------: | :------: | :----: | :---: | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
| [DeepFillv1](/configs/inpainting/deepfillv1/deepfillv1_256x256_8x2_places.py) | square bbox | 256x256 | 3500k | Places365-val | 11.019 | 23.429 | 0.862 | [model](https://download.openmmlab.com/mmediting/inpainting/deepfillv1/deepfillv1_256x256_8x2_places_20200619-c00a0e21.pth) \| [log](https://download.openmmlab.com/mmediting/inpainting/deepfillv1/deepfillv1_256x256_8x2_places_20200619-c00a0e21.log.json) |


### CelebA-HQ

| Method | Mask Type | Resolution | Train Iters | Test Set | l1 error | PSNR | SSIM | Download |
Expand Down
2 changes: 1 addition & 1 deletion configs/inpainting/deepfillv2/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

[ALGORITHM]

```latex
```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},
Expand Down
2 changes: 1 addition & 1 deletion configs/inpainting/global_local/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

[ALGORITHM]

```latex
```bibtex
@article{iizuka2017globally,
title={Globally and locally consistent image completion},
author={Iizuka, Satoshi and Simo-Serra, Edgar and Ishikawa, Hiroshi},
Expand Down
2 changes: 1 addition & 1 deletion configs/inpainting/partial_conv/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

[ALGORITHM]

```latex
```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},
Expand Down
2 changes: 1 addition & 1 deletion configs/mattors/dim/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

[ALGORITHM]

```latex
```bibtex
@inproceedings{xu2017deep,
title={Deep image matting},
author={Xu, Ning and Price, Brian and Cohen, Scott and Huang, Thomas},
Expand Down
2 changes: 1 addition & 1 deletion configs/mattors/gca/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

[ALGORITHM]

```latex
```bibtex
@inproceedings{li2020natural,
title={Natural Image Matting via Guided Contextual Attention},
author={Li, Yaoyi and Lu, Hongtao},
Expand Down
2 changes: 1 addition & 1 deletion configs/mattors/indexnet/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

[ALGORITHM]

```latex
```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},
Expand Down
2 changes: 1 addition & 1 deletion configs/restorers/edsr/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

[ALGORITHM]

```latex
```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},
Expand Down
2 changes: 1 addition & 1 deletion configs/restorers/edvr/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

[ALGORITHM]

```latex
```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},
Expand Down
2 changes: 1 addition & 1 deletion configs/restorers/esrgan/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

[ALGORITHM]

```latex
```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},
Expand Down
2 changes: 1 addition & 1 deletion configs/restorers/srcnn/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

[ALGORITHM]

```latex
```bibtex
@article{dong2015image,
title={Image super-resolution using deep convolutional networks},
author={Dong, Chao and Loy, Chen Change and He, Kaiming and Tang, Xiaoou},
Expand Down
2 changes: 1 addition & 1 deletion configs/restorers/srresnet_srgan/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

[ALGORITHM]

```latex
```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},
Expand Down
2 changes: 1 addition & 1 deletion configs/restorers/tof/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

[ALGORITHM]

```latex
```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},
Expand Down
2 changes: 1 addition & 1 deletion configs/synthesizers/cyclegan/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

[ALGORITHM]

```latex
```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},
Expand Down
4 changes: 2 additions & 2 deletions configs/synthesizers/pix2pix/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

[ALGORITHM]

```latex
```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},
Expand All @@ -16,7 +16,7 @@

## Results and Models

We use `FID` and `IS` metrics to evaluate the generation performance of pix2pix.
We use `FID` and `IS` metrics to evaluate the generation performance of pix2pix.

`FID` evaluation:

Expand Down
29 changes: 0 additions & 29 deletions docs/datasets_generation.md
View file
Open in desktop

This file was deleted.

102 changes: 0 additions & 102 deletions docs/datasets_matting.md
View file
Open in desktop

This file was deleted.

11 changes: 6 additions & 5 deletions docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,12 +20,13 @@ Welcome to MMEditing's documentation!

.. toctree::
:maxdepth: 2
:caption: Dataset Preparation
:caption: Datasets

datasets_generation.md
datasets_inpainting.md
datasets_matting.md
datasets_restoration.md
datasets.md
inpainting_datasets.md
matting_datasets.md
sr_datasets.md
generation_datasets.md

.. toctree::
:maxdepth: 2
Expand Down
49 changes: 23 additions & 26 deletions docs/merge_docs.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,32 +5,29 @@ sed -i '$a\\n' ../configs/mattors/*/*.md
sed -i '$a\\n' ../configs/restorers/*/*.md
sed -i '$a\\n' ../configs/synthesizers/*/*.md

cat ../configs/inpainting/*/*.md >inpainting_models.md
cat ../configs/mattors/*/*.md >mattors_models.md
cat ../configs/restorers/*/*.md >restorers_models.md
cat ../configs/synthesizers/*/*.md >synthesizers_models.md
# gather models
cat ../configs/inpainting/*/*.md | sed "s/md###t/html#t/g" | sed "s/#/#&/" | sed '1i\# Inpainting Models' | sed 's/](\/docs\//](/g' | sed 's=](/=](https://github.com/open-mmlab/mmediting/tree/master/=g' >inpainting_models.md
cat ../configs/mattors/*/*.md | sed "s/md###t/html#t/g" | sed "s/#/#&/" | sed '1i\# Matting Models' | sed 's/](\/docs\//](/g' | sed 's=](/=](https://github.com/open-mmlab/mmediting/tree/master/=g' >mattors_models.md
cat ../configs/restorers/*/*.md | sed "s/md###t/html#t/g" | sed "s/#/#&/" | sed '1i\# Super-Resolution Models' | sed 's/](\/docs\//](/g' | sed 's=](/=](https://github.com/open-mmlab/mmediting/tree/master/=g' >restorers_models.md
cat ../configs/synthesizers/*/*.md | sed "s/md###t/html#t/g" | sed "s/#/#&/" | sed '1i\# Generation Models' | sed 's/](\/docs\//](/g' | sed 's=](/=](https://github.com/open-mmlab/mmediting/tree/master/=g' >synthesizers_models.md

sed -i "s/#/#&/" inpainting_models.md
sed -i "s/#/#&/" mattors_models.md
sed -i "s/#/#&/" restorers_models.md
sed -i "s/#/#&/" synthesizers_models.md
# gather datasets
cat ../tools/data/generation/*.md > generation_datasets.md
cat ../tools/data/inpainting/*.md > inpainting_datasets.md
cat ../tools/data/matting/*.md > matting_datasets.md
cat ../tools/data/super-resolution/*.md > sr_datasets.md

sed -i "s/md###t/html#t/g" inpainting_models.md
sed -i "s/md###t/html#t/g" mattors_models.md
sed -i "s/md###t/html#t/g" restorers_models.md
sed -i "s/md###t/html#t/g" synthesizers_models.md
sed -i 's=(paired-pix2pix/README.md)=(#paired-dataset-for-pix2pix)=g' generation_datasets.md
sed -i 's=(unpaired-cyclegan/README.md)=(#unpaired-dataset-for-cyclegan)=g' generation_datasets.md
sed -i 's=(paris-street-view/README.md)=(#paris-street-view-dataset)=g' inpainting_datasets.md
sed -i 's=(celeba-hq/README.md)=(#celeba-hq-dataset)=g' inpainting_datasets.md
sed -i 's=(places365/README.md)=(#places365-dataset)=g' inpainting_datasets.md
sed -i 's=(comp1k/README.md)=(#composition-1k-dataset)=g' matting_datasets.md
sed -i 's=(div2k/README.md)=(#div2k-dataset)=g' sr_datasets.md
sed -i 's=(reds/README.md)=(#reds-dataset)=g' sr_datasets.md
sed -i 's=(vimeo90k/README.md)=(#vimeo90k-dataset)=g' sr_datasets.md

sed -i '1i\# Inpainting Models' inpainting_models.md
sed -i '1i\# Matting Models' mattors_models.md
sed -i '1i\# Restoration Models' restorers_models.md
sed -i '1i\# Generation Models' synthesizers_models.md

sed -i 's/](\/docs\//](/g' inpainting_models.md # remove /docs/ for link used in doc site
sed -i 's/](\/docs\//](/g' mattors_models.md
sed -i 's/](\/docs\//](/g' restorers_models.md
sed -i 's/](\/docs\//](/g' synthesizers_models.md

sed -i 's=](/=](https://github.com/open-mmlab/mmediting/tree/master/=g' inpainting_models.md
sed -i 's=](/=](https://github.com/open-mmlab/mmediting/tree/master/=g' mattors_models.md
sed -i 's=](/=](https://github.com/open-mmlab/mmediting/tree/master/=g' restorers_models.md
sed -i 's=](/=](https://github.com/open-mmlab/mmediting/tree/master/=g' synthesizers_models.md
cat ../tools/data/generation/*/*.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/*/*.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/*/*.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/*/*.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
Loading