Merge pull request #8 from leverxgroup/docs/fixes

docs: copyright footer updated
leverxgroup · Mar 28, 2022 · c590a73 · c590a73
2 parents 832a29c + 1a6f622
commit c590a73
Show file tree

Hide file tree

Showing 54 changed files with 95 additions and 30 deletions.
diff --git a/README.md b/README.md
@@ -39,11 +39,11 @@ where `esrgan/config.yml` is a path to the [config](config.yml) file.
 ## Results
 Some examples of work of ESRGAN model trained on [DIV2K](https://data.vision.ee.ethz.ch/cvl/DIV2K) dataset:
 
-| LR</br>(low resolution) | ESRGAN</br>(ours) | HR</br>(high resolution) |
-|:---:|:---:|:---:|
-| <img src="docs/_static/sq_crop_lr.png" height="128" width="128"/> | <img src="docs/_static/sq_crop_sr_x4.png" height="128" width="128"/> | <img src="docs/_static/sq_crop_hr.png" height="128" width="128"/> |
-| <img src="docs/_static/wf_crop_lr.png" height="128" width="128"/> | <img src="docs/_static/wf_crop_sr_x4.png" height="128" width="128"/> | <img src="docs/_static/wf_crop_hr.png" height="128" width="128"/> |
-| <img src="docs/_static/fish_crop_lr.png" height="128" width="128"/> | <img src="docs/_static/fish_crop_sr_x4.png" height="128" width="128"/> | <img src="docs/_static/fish_crop_hr.png" height="128" width="128"/> |
+| LR</br>(low resolution) | ESRGAN</br>(original) | ESRGAN</br>(ours) | HR</br>(high resolution) |
+|:---:|:---:|:---:|:---:|
+| <img src="docs/_static/0853lr.png" height="128" width="128"/> | <img src="docs/_static/0853sr.png" height="128" width="128"/> | <img src="docs/_static/0853.png" height="128" width="128"/> | <img src="docs/_static/0853hr.png" height="128" width="128"/> |
+| <img src="docs/_static/0857lr.png" height="128" width="128"/> | <img src="docs/_static/0857sr.png" height="128" width="128"/> | <img src="docs/_static/0857.png" height="128" width="128"/> | <img src="docs/_static/0857hr.png" height="128" width="128"/> |
+| <img src="docs/_static/0887lr.png" height="128" width="128"/> | <img src="docs/_static/0887sr.png" height="128" width="128"/> | <img src="docs/_static/0887.png" height="128" width="128"/> | <img src="docs/_static/0887hr.png" height="128" width="128"/> |
 
 ## Documentation
 Full documentation for the project is available at https://esrgan.readthedocs.io/

diff --git a/config.yml b/config.yml
@@ -94,7 +94,7 @@ stages:
                       - _target_: albumentations.Normalize
                         mean: 0
                         std: 1
-                      - _target_: albumentations.ToTensorV2
+                      - _target_: albumentations.pytorch.ToTensorV2
                     additional_targets:
                       real_image: image
               low_resolution_image_key: image

diff --git a/docs/_static/0802.png b/docs/_static/0802.png
diff --git a/docs/_static/0802hr.png b/docs/_static/0802hr.png
diff --git a/docs/_static/0802lr.png b/docs/_static/0802lr.png
diff --git a/docs/_static/0802sr.png b/docs/_static/0802sr.png
diff --git a/docs/_static/0805.png b/docs/_static/0805.png
diff --git a/docs/_static/0805hr.png b/docs/_static/0805hr.png
diff --git a/docs/_static/0805lr.png b/docs/_static/0805lr.png
diff --git a/docs/_static/0805sr.png b/docs/_static/0805sr.png
diff --git a/docs/_static/0811.png b/docs/_static/0811.png
diff --git a/docs/_static/0811hr.png b/docs/_static/0811hr.png
diff --git a/docs/_static/0811lr.png b/docs/_static/0811lr.png
diff --git a/docs/_static/0811sr.png b/docs/_static/0811sr.png
diff --git a/docs/_static/0815.png b/docs/_static/0815.png
diff --git a/docs/_static/0815hr.png b/docs/_static/0815hr.png
diff --git a/docs/_static/0815lr.png b/docs/_static/0815lr.png
diff --git a/docs/_static/0815sr.png b/docs/_static/0815sr.png
diff --git a/docs/_static/0829.png b/docs/_static/0829.png
diff --git a/docs/_static/0829hr.png b/docs/_static/0829hr.png
diff --git a/docs/_static/0829lr.png b/docs/_static/0829lr.png
diff --git a/docs/_static/0829sr.png b/docs/_static/0829sr.png
diff --git a/docs/_static/0845.png b/docs/_static/0845.png
diff --git a/docs/_static/0845hr.png b/docs/_static/0845hr.png
diff --git a/docs/_static/0845lr.png b/docs/_static/0845lr.png
diff --git a/docs/_static/0845sr.png b/docs/_static/0845sr.png
diff --git a/docs/_static/0853.png b/docs/_static/0853.png
diff --git a/docs/_static/0853hr.png b/docs/_static/0853hr.png
diff --git a/docs/_static/0853lr.png b/docs/_static/0853lr.png
diff --git a/docs/_static/0853sr.png b/docs/_static/0853sr.png
diff --git a/docs/_static/0857.png b/docs/_static/0857.png
diff --git a/docs/_static/0857hr.png b/docs/_static/0857hr.png
diff --git a/docs/_static/0857lr.png b/docs/_static/0857lr.png
diff --git a/docs/_static/0857sr.png b/docs/_static/0857sr.png
diff --git a/docs/_static/0886.png b/docs/_static/0886.png
diff --git a/docs/_static/0886hr.png b/docs/_static/0886hr.png
diff --git a/docs/_static/0886lr.png b/docs/_static/0886lr.png
diff --git a/docs/_static/0886sr.png b/docs/_static/0886sr.png
diff --git a/docs/_static/0887.png b/docs/_static/0887.png
diff --git a/docs/_static/0887hr.png b/docs/_static/0887hr.png
diff --git a/docs/_static/0887lr.png b/docs/_static/0887lr.png
diff --git a/docs/_static/0887sr.png b/docs/_static/0887sr.png
diff --git a/docs/_static/fish_crop_hr.png b/docs/_static/fish_crop_hr.png
diff --git a/docs/_static/fish_crop_lr.png b/docs/_static/fish_crop_lr.png
diff --git a/docs/_static/fish_crop_sr_x4.png b/docs/_static/fish_crop_sr_x4.png
diff --git a/docs/_static/sq_crop_hr.png b/docs/_static/sq_crop_hr.png
diff --git a/docs/_static/sq_crop_lr.png b/docs/_static/sq_crop_lr.png
diff --git a/docs/_static/sq_crop_sr_x4.png b/docs/_static/sq_crop_sr_x4.png
diff --git a/docs/_static/wf_crop_hr.png b/docs/_static/wf_crop_hr.png
diff --git a/docs/_static/wf_crop_lr.png b/docs/_static/wf_crop_lr.png
diff --git a/docs/_static/wf_crop_sr_x4.png b/docs/_static/wf_crop_sr_x4.png
diff --git a/docs/conf.py b/docs/conf.py
@@ -30,7 +30,7 @@ def _get_project_meta():
 
 pkg_meta = _get_project_meta()
 project = str(pkg_meta["name"])
-copyright = "2020, Emerline, Inc. and its affiliates."  # noqa: WPS125
+copyright = "2022, Emerline, Inc. All Rights Reserved."  # noqa: WPS125
 author = "Emerline"
 
 # The short X.Y version
@@ -101,3 +101,5 @@ def _get_project_meta():
 html_static_path = ["_static"]
 
 html_short_title = project
+
+html_scaled_image_link = False
diff --git a/docs/index.rst b/docs/index.rst
@@ -62,26 +62,28 @@ Results
 Some examples of work of ESRGAN model trained on `DIV2K <https://data.vision.ee.ethz.ch/cvl/DIV2K>`__ dataset:
 
 .. table::
-   :widths: 33 33 33
-
-   +---------------------------------------+------------------------------------------+---------------------------------------+
-   | .. centered:: LR (low resolution)     | .. centered:: ESRGAN (ours)              | .. centered:: HR (high resolution)    |
-   +=======================================+==========================================+=======================================+
-   | .. image:: ./_static/sq_crop_lr.png   | .. image:: ./_static/sq_crop_sr_x4.png   | .. image:: ./_static/sq_crop_hr.png   |
-   |    :width: 128px                      |    :width: 128px                         |    :width: 128px                      |
-   |    :height: 128px                     |    :height: 128px                        |    :height: 128px                     |
-   |    :align: center                     |    :align: center                        |    :align: center                     |
-   +---------------------------------------+------------------------------------------+---------------------------------------+
-   | .. image:: ./_static/wf_crop_lr.png   | .. image:: ./_static/wf_crop_sr_x4.png   | .. image:: ./_static/wf_crop_hr.png   |
-   |    :width: 128px                      |    :width: 128px                         |    :width: 128px                      |
-   |    :height: 128px                     |    :height: 128px                        |    :height: 128px                     |
-   |    :align: center                     |    :align: center                        |    :align: center                     |
-   +---------------------------------------+------------------------------------------+---------------------------------------+
-   | .. image:: ./_static/fish_crop_lr.png | .. image:: ./_static/fish_crop_sr_x4.png | .. image:: ./_static/fish_crop_hr.png |
-   |    :width: 128px                      |    :width: 128px                         |    :width: 128px                      |
-   |    :height: 128px                     |    :height: 128px                        |    :height: 128px                     |
-   |    :align: center                     |    :align: center                        |    :align: center                     |
-   +---------------------------------------+------------------------------------------+---------------------------------------+
+   :widths: 25 25 25 25
+
+   +-----------------------------------+---------------------------------+-------------------------------+------------------------------------+
+   | .. centered:: LR (low resolution) | .. centered:: `ESRGAN`_         | .. centered:: ESRGAN (ours)   | .. centered:: HR (high resolution) |
+   +===================================+=================================+===============================+====================================+
+   | .. image:: ./_static/0853lr.png   | .. image:: ./_static/0853sr.png | .. image:: ./_static/0853.png | .. image:: ./_static/0853hr.png    |
+   |    :width: 128px                  |    :width: 128px                |    :width: 128px              |    :width: 128px                   |
+   |    :height: 128px                 |    :height: 128px               |    :height: 128px             |    :height: 128px                  |
+   |    :align: center                 |    :align: center               |    :align: center             |    :align: center                  |
+   +-----------------------------------+---------------------------------+-------------------------------+------------------------------------+
+   | .. image:: ./_static/0857lr.png   | .. image:: ./_static/0857sr.png | .. image:: ./_static/0857.png | .. image:: ./_static/0857hr.png    |
+   |    :width: 128px                  |    :width: 128px                |    :width: 128px              |    :width: 128px                   |
+   |    :height: 128px                 |    :height: 128px               |    :height: 128px             |    :height: 128px                  |
+   |    :align: center                 |    :align: center               |    :align: center             |    :align: center                  |
+   +-----------------------------------+---------------------------------+-------------------------------+------------------------------------+
+   | .. image:: ./_static/0887lr.png   | .. image:: ./_static/0887sr.png | .. image:: ./_static/0887.png | .. image:: ./_static/0887hr.png    |
+   |    :width: 128px                  |    :width: 128px                |    :width: 128px              |    :width: 128px                   |
+   |    :height: 128px                 |    :height: 128px               |    :height: 128px             |    :height: 128px                  |
+   |    :align: center                 |    :align: center               |    :align: center             |    :align: center                  |
+   +-----------------------------------+---------------------------------+-------------------------------+------------------------------------+
+
+.. _ESRGAN: https://github.com/xinntao/ESRGAN
 
 
 GitHub

diff --git a/docs/pages/esrgan.rst b/docs/pages/esrgan.rst
@@ -3,7 +3,7 @@ ESRGAN
 ======
 
 
-Network Architecture
+Network architecture
 ====================
 
 .. image:: ../_static/architecture.png
@@ -19,7 +19,68 @@ Main modifications in the structure of generator G, discriminator D, and trainin
 4. perceptual loss on features before activation.
 
 
-Qualitative Results
+Some results
+============
+
+.. table::
+   :widths: 25 25 25 25
+
+   +-----------------------------------+----------------------------------+--------------------------------+------------------------------------+
+   | .. centered:: LR (low resolution) | .. centered:: ESRGAN `\[1\]`_    | .. centered:: ESRGAN (ours)    | .. centered:: HR (high resolution) |
+   +===================================+==================================+================================+====================================+
+   | .. image:: ../_static/0802lr.png  | .. image:: ../_static/0802sr.png | .. image:: ../_static/0802.png | .. image:: ../_static/0802hr.png   |
+   |    :width: 128px                  |    :width: 128px                 |    :width: 128px               |    :width: 128px                   |
+   |    :height: 128px                 |    :height: 128px                |    :height: 128px              |    :height: 128px                  |
+   |    :align: center                 |    :align: center                |    :align: center              |    :align: center                  |
+   +-----------------------------------+----------------------------------+--------------------------------+------------------------------------+
+   | .. image:: ../_static/0805lr.png  | .. image:: ../_static/0805sr.png | .. image:: ../_static/0805.png | .. image:: ../_static/0805hr.png   |
+   |    :width: 128px                  |    :width: 128px                 |    :width: 128px               |    :width: 128px                   |
+   |    :height: 128px                 |    :height: 128px                |    :height: 128px              |    :height: 128px                  |
+   |    :align: center                 |    :align: center                |    :align: center              |    :align: center                  |
+   +-----------------------------------+----------------------------------+--------------------------------+------------------------------------+
+   | .. image:: ../_static/0811lr.png  | .. image:: ../_static/0811sr.png | .. image:: ../_static/0811.png | .. image:: ../_static/0811hr.png   |
+   |    :width: 128px                  |    :width: 128px                 |    :width: 128px               |    :width: 128px                   |
+   |    :height: 128px                 |    :height: 128px                |    :height: 128px              |    :height: 128px                  |
+   |    :align: center                 |    :align: center                |    :align: center              |    :align: center                  |
+   +-----------------------------------+----------------------------------+--------------------------------+------------------------------------+
+   | .. image:: ../_static/0815lr.png  | .. image:: ../_static/0815sr.png | .. image:: ../_static/0815.png | .. image:: ../_static/0815hr.png   |
+   |    :width: 128px                  |    :width: 128px                 |    :width: 128px               |    :width: 128px                   |
+   |    :height: 128px                 |    :height: 128px                |    :height: 128px              |    :height: 128px                  |
+   |    :align: center                 |    :align: center                |    :align: center              |    :align: center                  |
+   +-----------------------------------+----------------------------------+--------------------------------+------------------------------------+
+   | .. image:: ../_static/0829lr.png  | .. image:: ../_static/0829sr.png | .. image:: ../_static/0829.png | .. image:: ../_static/0829hr.png   |
+   |    :width: 128px                  |    :width: 128px                 |    :width: 128px               |    :width: 128px                   |
+   |    :height: 128px                 |    :height: 128px                |    :height: 128px              |    :height: 128px                  |
+   |    :align: center                 |    :align: center                |    :align: center              |    :align: center                  |
+   +-----------------------------------+----------------------------------+--------------------------------+------------------------------------+
+   | .. image:: ../_static/0845lr.png  | .. image:: ../_static/0845sr.png | .. image:: ../_static/0845.png | .. image:: ../_static/0845hr.png   |
+   |    :width: 128px                  |    :width: 128px                 |    :width: 128px               |    :width: 128px                   |
+   |    :height: 128px                 |    :height: 128px                |    :height: 128px              |    :height: 128px                  |
+   |    :align: center                 |    :align: center                |    :align: center              |    :align: center                  |
+   +-----------------------------------+----------------------------------+--------------------------------+------------------------------------+
+   | .. image:: ../_static/0853lr.png  | .. image:: ../_static/0853sr.png | .. image:: ../_static/0853.png | .. image:: ../_static/0853hr.png   |
+   |    :width: 128px                  |    :width: 128px                 |    :width: 128px               |    :width: 128px                   |
+   |    :height: 128px                 |    :height: 128px                |    :height: 128px              |    :height: 128px                  |
+   |    :align: center                 |    :align: center                |    :align: center              |    :align: center                  |
+   +-----------------------------------+----------------------------------+--------------------------------+------------------------------------+
+   | .. image:: ../_static/0857lr.png  | .. image:: ../_static/0857sr.png | .. image:: ../_static/0857.png | .. image:: ../_static/0857hr.png   |
+   |    :width: 128px                  |    :width: 128px                 |    :width: 128px               |    :width: 128px                   |
+   |    :height: 128px                 |    :height: 128px                |    :height: 128px              |    :height: 128px                  |
+   |    :align: center                 |    :align: center                |    :align: center              |    :align: center                  |
+   +-----------------------------------+----------------------------------+--------------------------------+------------------------------------+
+   | .. image:: ../_static/0886lr.png  | .. image:: ../_static/0886sr.png | .. image:: ../_static/0886.png | .. image:: ../_static/0886hr.png   |
+   |    :width: 128px                  |    :width: 128px                 |    :width: 128px               |    :width: 128px                   |
+   |    :height: 128px                 |    :height: 128px                |    :height: 128px              |    :height: 128px                  |
+   |    :align: center                 |    :align: center                |    :align: center              |    :align: center                  |
+   +-----------------------------------+----------------------------------+--------------------------------+------------------------------------+
+   | .. image:: ../_static/0887lr.png  | .. image:: ../_static/0887sr.png | .. image:: ../_static/0887.png | .. image:: ../_static/0887hr.png   |
+   |    :width: 128px                  |    :width: 128px                 |    :width: 128px               |    :width: 128px                   |
+   |    :height: 128px                 |    :height: 128px                |    :height: 128px              |    :height: 128px                  |
+   |    :align: center                 |    :align: center                |    :align: center              |    :align: center                  |
+   +-----------------------------------+----------------------------------+--------------------------------+------------------------------------+
+
+
+Qualitative results
 ===================
 
     PSNR (evaluated on the Y channel) and the perceptual index used in the PIRM-SR challenge
@@ -35,7 +96,7 @@ Qualitative Results
    :width: 100%
 
 
-Ablation Study
+Ablation study
 ==============
 
     Overall visual comparisons for showing the effects of each component in ESRGAN.