From ee2d0106e0708192d1613a48561880beca609a73 Mon Sep 17 00:00:00 2001
From: ys-li <56712176+Yshuo-Li@users.noreply.github.com>
Date: Mon, 17 May 2021 17:56:02 +0800
Subject: [PATCH] PWD metafile (#298)

* PWD metafile

* fix

* Update

Co-authored-by: liyinshuo <liyinshuo@sensetime.com>
---
 MANIFEST.in                                  |  5 ++
 configs/inpainting/global_local/metafile.yml | 26 +++++++
 configs/restorers/edsr/metafile.yml          | 81 ++++++++++++++++++++
 model_zoo.yml                                |  3 +
 setup.py                                     |  1 +
 5 files changed, 116 insertions(+)
 create mode 100644 MANIFEST.in
 create mode 100644 configs/inpainting/global_local/metafile.yml
 create mode 100644 configs/restorers/edsr/metafile.yml
 create mode 100644 model_zoo.yml

diff --git a/MANIFEST.in b/MANIFEST.in
new file mode 100644
index 0000000000..91c2d79044
--- /dev/null
+++ b/MANIFEST.in
@@ -0,0 +1,5 @@
+include requirements/*.txt
+include mmedit/VERSION
+include mmedit/model_zoo.yml
+recursive-include mmedit/configs *.py *.yml
+recursive-include mmedit/tools *.sh *.py
diff --git a/configs/inpainting/global_local/metafile.yml b/configs/inpainting/global_local/metafile.yml
new file mode 100644
index 0000000000..f196cedc65
--- /dev/null
+++ b/configs/inpainting/global_local/metafile.yml
@@ -0,0 +1,26 @@
+Collections:
+  - Name: GLInpaintor
+    Metadata:
+      Training Data: CelebA
+      Training Techniques:
+        - Adam
+      Training Resources: 1x TITAN Xp
+      Architecture:
+        - GLEncoderDecoder
+    Paper: https://dl.acm.org/doi/abs/10.1145/3072959.3073659
+    README: configs/inpainting/global_local/README.md
+
+Models:
+  - Name: gl_256x256_8x12_places
+    In Collection: GLInpaintor
+    Config: configs/inpainting/global_local/gl_256x256_8x12_celeba.py
+    Metadata:
+      Training Memory (GB): 3.24
+    Results:
+      - Task: Inpainting
+        Dataset: CelebA-val
+        Metrics:
+          L1 Error: 6.678
+          PSNR: 26.780
+          SSIM: 0.904
+    Weights: https://download.openmmlab.com/mmediting/inpainting/global_local/gl_256x256_8x12_celeba_20200619-5af0493f.pth
diff --git a/configs/restorers/edsr/metafile.yml b/configs/restorers/edsr/metafile.yml
new file mode 100644
index 0000000000..ecd94f6655
--- /dev/null
+++ b/configs/restorers/edsr/metafile.yml
@@ -0,0 +1,81 @@
+Collections:
+  - Name: EDSR
+    Metadata:
+      Training Data: DIV2K
+      Training Techniques:
+        - Adam
+      Training Resources: 1x TITAN Xp
+      Architecture:
+        - EDSR
+    Paper: http://openaccess.thecvf.com/content_cvpr_2017_workshops/w12/papers/Lim_Enhanced_Deep_Residual_CVPR_2017_paper.pdf
+    README: configs/restorers/edsr/README.md
+
+Models:
+  - Name: edsr_x2c64b16_g1_300k_div2k
+    In Collection: EDSR
+    Config: configs/restorers/edsr/edsr_x2c64b16_g1_300k_div2k.py
+    Metadata:
+      Training Memory (GB): 0.47
+    Results:
+      - Task: x2 Super Resolution
+        Dataset: Set5
+        Metrics:
+          PSNR: 35.7592
+          SSIM: 0.9372
+      - Task: x2 Super Resolution
+        Dataset: Set14
+        Metrics:
+          PSNR: 31.4290
+          SSIM: 0.8874
+      - Task: x2 Super Resolution
+        Dataset: DIV2K
+        Metrics:
+          PSNR: 34.5896
+          SSIM: 0.9352
+    Weights: https://download.openmmlab.com/mmediting/restorers/edsr/edsr_x2c64b16_1x16_300k_div2k_20200604-19fe95ea.pth
+
+  - Name: edsr_x3c64b16_g1_300k_div2k
+    In Collection: EDSR
+    Config: configs/restorers/edsr/edsr_x3c64b16_g1_300k_div2k.py
+    Metadata:
+      Training Memory (GB): 0.63
+    Results:
+      - Task: x3 Super Resolution
+        Dataset: Set5
+        Metrics:
+          PSNR: 32.3301
+          SSIM: 0.8912
+      - Task: x3 Super Resolution
+        Dataset: Set14
+        Metrics:
+          PSNR: 28.4125
+          SSIM: 0.8022
+      - Task: x3 Super Resolution
+        Dataset: DIV2K
+        Metrics:
+          PSNR: 30.9154
+          SSIM: 0.8711
+    Weights: https://download.openmmlab.com/mmediting/restorers/edsr/edsr_x3c64b16_1x16_300k_div2k_20200608-36d896f4.pth
+
+  - Name: edsr_x4c64b16_g1_300k_div2k
+    In Collection: EDSR
+    Config: configs/restorers/edsr/edsr_x4c64b16_g1_300k_div2k.py
+    Metadata:
+      Training Memory (GB): 1.0
+    Results:
+      - Task: x3 Super Resolution
+        Dataset: Set5
+        Metrics:
+          PSNR: 30.2223
+          SSIM: 0.8500
+      - Task: x3 Super Resolution
+        Dataset: Set14
+        Metrics:
+          PSNR: 26.7870
+          SSIM: 0.7366
+      - Task: x3 Super Resolution
+        Dataset: DIV2K
+        Metrics:
+          PSNR: 28.9675
+          SSIM: 0.8172
+    Weights: https://download.openmmlab.com/mmediting/restorers/edsr/edsr_x4c64b16_1x16_300k_div2k_20200608-3c2af8a3.pth
diff --git a/model_zoo.yml b/model_zoo.yml
new file mode 100644
index 0000000000..4aa6566597
--- /dev/null
+++ b/model_zoo.yml
@@ -0,0 +1,3 @@
+Import:
+  - configs/restorers/edsr/metafile.yml
+  - configs/inpainting/global_local/metafile.yml
diff --git a/setup.py b/setup.py
index 3f7621f5dc..0ec168d3e0 100644
--- a/setup.py
+++ b/setup.py
@@ -150,6 +150,7 @@ def gen_packages_items():
         'super-resolution, generation',
         url='https://github.com/open-mmlab/mmediting',
         packages=find_packages(exclude=('configs', 'tools', 'demo')),
+        include_package_data=True,
         classifiers=[
             'Development Status :: 4 - Beta',
             'License :: OSI Approved :: Apache Software License',