refactor: package structure updated, docs updated

docs/index.rst

@@ -120,11 +120,11 @@ License
    :maxdepth: 2
    :caption: API
 
-   pages/api/core
+   pages/api/nn
    pages/api/models
-   pages/api/criterions
    pages/api/datasets
    pages/api/utils
+   pages/api/catalyst
 
 Indices and tables
 ==================

docs/pages/api/catalyst.rst

@@ -0,0 +1,28 @@
+Catalyst
+========
+
+Various features for customization/modification of `Catalyst <https://catalyst-team.com>`__ pipelines e.g., runners, metrics, callbacks:
+
+.. toctree::
+   :titlesonly:
+
+.. contents::
+   :local:
+
+
+Runners
+-------
+
+GANRunner
+^^^^^^^^^
+
+.. autoclass:: esrgan.runner.GANRunner
+    :members:
+    :undoc-members:
+
+GANConfigRunner
+^^^^^^^^^^^^^^^
+
+.. autoclass:: esrgan.runner.GANConfigRunner
+    :members:
+    :undoc-members:

docs/pages/api/datasets.rst

@@ -6,27 +6,36 @@ implemented. Hence, they can all be passed to a :class:`torch.utils.data.DataLoa
 parallelly using ``torch.multiprocessing`` workers.
 For example: ::
 
-    div2k_data = esrgan.dataset.DIV2KDataset('path/to/div2k_root/')
+    div2k_data = esrgan.datasets.DIV2KDataset('path/to/div2k_root/')
     data_loader = torch.utils.data.DataLoader(div2k_data, batch_size=4, shuffle=True)
 
 
+The models subpackage contains definitions for the following datasets for image super-resolution:
+
+.. toctree::
+   :titlesonly:
+
+.. contents::
+   :local:
+
+
 DIV2K
 ^^^^^
 
-.. autoclass:: esrgan.dataset.DIV2KDataset
+.. autoclass:: esrgan.datasets.DIV2KDataset
     :members:
 
 
 Flickr2K
 ^^^^^^^^
 
-.. autoclass:: esrgan.dataset.Flickr2KDataset
+.. autoclass:: esrgan.datasets.Flickr2KDataset
     :members:
 
 
 Folder of Images
 ^^^^^^^^^^^^^^^^
 
-.. autoclass:: esrgan.dataset.ImageFolderDataset
+.. autoclass:: esrgan.datasets.ImageFolderDataset
     :members:
     :undoc-members:

docs/pages/api/models.rst

@@ -1,71 +1,82 @@
 Models
 ======
 
-Generator
----------
+The models subpackage contains definitions of models for addressing image super-resolution tasks:
 
-.. automodule:: esrgan.model.generator
+.. toctree::
+   :titlesonly:
+
+.. contents::
+   :local:
+
+
+Generators
+----------
+
+EncoderDecoderNet
+^^^^^^^^^^^^^^^^^
+
+.. autoclass:: esrgan.models.EncoderDecoderNet
     :members:
     :undoc-members:
 
+
 SRGAN
 ^^^^^
 
-.. automodule:: esrgan.model.module.srresnet
+SRResNetEncoder
+~~~~~~~~~~~~~~~
+
+.. autoclass:: esrgan.models.SRResNetEncoder
     :members:
     :undoc-members:
 
-ESRGAN
-^^^^^^
+SRResNetDecoder
+~~~~~~~~~~~~~~~
 
-.. automodule:: esrgan.model.module.esrnet
+.. autoclass:: esrgan.models.SRResNetDecoder
     :members:
     :undoc-members:
 
 
-Discriminator
--------------
+ESRGAN
+^^^^^^
 
-.. automodule:: esrgan.model.discriminator
-    :members:
-    :undoc-members:
-.. automodule:: esrgan.model.module.conv
-    :members:
-    :undoc-members:
-.. automodule:: esrgan.model.module.linear
+ESREncoder
+~~~~~~~~~~
+
+.. autoclass:: esrgan.models.ESREncoder
     :members:
     :undoc-members:
 
+ESRNetDecoder
+~~~~~~~~~~~~~
 
-Layers
-------
-
-These are the basic building block for graphs
-
-Containers
-^^^^^^^^^^
-
-.. automodule:: esrgan.model.module.blocks.container
+.. autoclass:: esrgan.models.ESRNetDecoder
     :members:
     :undoc-members:
 
-Residual-in-Residual Block
-^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-.. automodule:: esrgan.model.module.blocks.rrdb
+Discriminators
+--------------
+
+VGGConv
+^^^^^^^
+
+.. autoclass:: esrgan.models.VGGConv
     :members:
     :undoc-members:
 
-Upsample
-^^^^^^^^
+StridedConvEncoder
+~~~~~~~~~~~~~~~~~~
 
-.. automodule:: esrgan.model.module.blocks.upsampling
+.. autoclass:: esrgan.models.StridedConvEncoder
     :members:
     :undoc-members:
 
-Misc
-^^^^
+LinearHead
+~~~~~~~~~~
 
-.. automodule:: esrgan.model.module.blocks.misc
+.. autoclass:: esrgan.models.LinearHead
     :members:
     :undoc-members:

docs/pages/api/nn.rst

@@ -0,0 +1,101 @@
+NN
+==
+
+These are the basic building block for graphs:
+
+.. toctree::
+   :titlesonly:
+
+.. contents::
+   :local:
+
+
+Containers
+----------
+
+ConcatInputModule
+^^^^^^^^^^^^^^^^^
+
+.. autoclass:: esrgan.nn.ConcatInputModule
+    :members:
+    :undoc-members:
+
+ResidualModule
+^^^^^^^^^^^^^^
+
+.. autoclass:: esrgan.nn.ResidualModule
+    :members:
+    :undoc-members:
+
+
+Residual-in-Residual layers
+---------------------------
+
+ResidualDenseBlock
+^^^^^^^^^^^^^^^^^^
+
+.. autoclass:: esrgan.nn.ResidualDenseBlock
+    :members:
+    :undoc-members:
+
+ResidualInResidualDenseBlock
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. autoclass:: esrgan.nn.ResidualInResidualDenseBlock
+    :members:
+    :undoc-members:
+
+
+UpSampling layers
+-----------------
+
+InterpolateConv
+^^^^^^^^^^^^^^^
+
+.. autoclass:: esrgan.nn.InterpolateConv
+    :members:
+    :undoc-members:
+
+SubPixelConv
+^^^^^^^^^^^^
+
+.. autoclass:: esrgan.nn.SubPixelConv
+    :members:
+    :undoc-members:
+
+
+Loss functions
+--------------
+
+AdversarialLoss
+^^^^^^^^^^^^^^^
+
+.. autoclass:: esrgan.nn.AdversarialLoss
+    :members:
+    :undoc-members:
+
+RelativisticAdversarialLoss
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. autoclass:: esrgan.nn.RelativisticAdversarialLoss
+    :members:
+    :undoc-members:
+
+PerceptualLoss
+^^^^^^^^^^^^^^
+
+.. autoclass:: esrgan.nn.PerceptualLoss
+    :members:
+    :undoc-members:
+
+
+Misc
+----
+
+.. autoclass:: esrgan.nn.Conv2dSN
+    :members:
+    :undoc-members:
+
+.. autoclass:: esrgan.nn.LinearSN
+    :members:
+    :undoc-members:

docs/pages/api/utils.rst

@@ -1,7 +1,13 @@
 Utilities
 =========
 
-Set of utilities that can make life a little bit easier.
+Set of utilities that can make life a little bit easier:
+
+.. toctree::
+   :titlesonly:
+
+.. contents::
+   :local:
 
 
 Augmentation