22.02 update

.github/.stale.yml

@@ -0,0 +1,13 @@
+# Number of days of inactivity before an issue becomes stale
+daysUntilStale: 60
+# Number of days of inactivity before a stale issue is closed
+daysUntilClose: 7
+# Label to use when marking an issue as stale
+staleLabel: wontfix
+# Comment to post when marking an issue as stale. Set to `false` to disable
+markComment: >
+  This issue has been automatically marked as stale because it has not had
+  recent activity. It will be closed if no further activity occurs. Thank you
+  for your contributions.
+# Comment to post when closing a stale issue. Set to `false` to disable
+closeComment: false

.github/workflows/build.yml

@@ -0,0 +1,55 @@
+name: build
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - master
+      - develop
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    timeout-minutes: 15
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Python 3.8
+        uses: actions/setup-python@v2
+        with:
+          python-version: 3.8
+
+      - name: Install poetry
+        run: |
+          pip install -U pip
+          curl -sSL "https://install.python-poetry.org" | python -
+          echo "${HOME}/.poetry/bin" >> $GITHUB_PATH
+
+      - name: Set up cache
+        uses: actions/cache@v2
+        with:
+          path: .venv
+          key: venv-${{ matrix.python-version }}-${{ hashFiles('poetry.lock') }}
+      - name: Install dependencies
+        run: |
+          poetry config virtualenvs.in-project true
+          poetry run pip install -U pip
+          poetry install
+
+      - name: Check codestyle
+        run: |
+          poetry run flake8 --show-source --statistics --count -- .
+          poetry run isort --check-only -- .
+          # poetry run mypy -- .
+          poetry run doc8 -q -- docs
+
+      # - name: Unit tests
+      #   run: |
+      #     poetry run pytest .
+
+      - name: Check dependencies compatibility
+        run: |
+          poetry run poetry check
+          poetry run pip check

.github/workflows/pipeline.yml

@@ -7,41 +7,46 @@ on:
   pull_request:
     branches:
       - master
+      - develop
 
 jobs:
-   build:
+  build:
     runs-on: ubuntu-latest
     timeout-minutes: 60
+    strategy:
+      matrix:
+        python-version: [3.8]
 
     steps:
       - uses: actions/checkout@v2
-      - name: Set up Python 3.8
+      - name: Set up Python ${{ matrix.python-version }}
         uses: actions/setup-python@v2
         with:
-          python-version: 3.8
+          python-version: ${{ matrix.python-version }}
 
-      - name: Get pip cache dir
-        id: pip-cache
+      - name: Install poetry
         run: |
-          echo "::set-output name=dir::$(pip cache dir)"
+          pip install -U pip
+          curl -sSL "https://install.python-poetry.org" | python -
+          echo "${HOME}/.poetry/bin" >> $GITHUB_PATH
+
       - name: Set up cache
         uses: actions/cache@v2
         with:
-          path: ${{ steps.pip-cache.outputs.dir }}
-          key: ${{ runner.os }}-pip-${{ hashFiles('requirements.txt') }}
-          restore-keys: |
-            ${{ runner.os }}-pip-
+          path: .venv
+          key: venv-${{ matrix.python-version }}-${{ hashFiles('poetry.lock') }}
       - name: Install dependencies
         run: |
-          pip install -r requirements.txt
-          python setup.py install
+          poetry config virtualenvs.in-project true
+          poetry run pip install -U pip
+          poetry install
 
       - name: Cache data
         id: cache-div2k
         uses: actions/cache@v2
         with:
           path: data/*.zip
-          key: ${{ runner.os }}-data
+          key: data-div2k
       - name: Download DIV2K dataset
         if: steps.cache-div2k.outputs.cache-hit != 'true'
         run: |
@@ -50,10 +55,6 @@ jobs:
           wget http://data.vision.ee.ethz.ch/cvl/DIV2K/DIV2K_valid_HR.zip -P ./data/
           wget https://data.vision.ee.ethz.ch/cvl/DIV2K/DIV2K_valid_LR_bicubic_X4.zip -P ./data/
 
-      - name: Check pipeline - phase 1 (supervised)
-        run: |
-          catalyst-dl run -C experiment/config_supervised.yml --check --stages/data_params/batch_size=2:int
-
-      - name: Check pipeline - phase 2(GAN)
+      - name: Check pipeline
         run: |
-          catalyst-dl run -C experiment/config_gan.yml --check --stages/data_params/batch_size=2:int
+          poetry run catalyst-dl run -C tests/pipeline/config.yml --check

.readthedocs.yml

@@ -6,5 +6,6 @@ sphinx:
 python:
   version: 3.8
   install:
+    - method: pip
+      path: .
     - requirements: docs/requirements.txt
-    - requirements: requirements.txt

README.md

@@ -19,29 +19,22 @@ Key points of ESRGAN:
 
 * `Catalyst` as pipeline runner for deep learning tasks. This new and rapidly developing [library](https://github.com/catalyst-team/catalyst).
   can significantly reduce the amount of boilerplate code. If you are familiar with the TensorFlow ecosystem, you can think of Catalyst
-  as Keras for PyTorch. This framework is integrated with logging systems such as the well-known [TensorBoard](https://www.tensorflow.org/tensorboard).
-* `Pytorch`, `torchvision`, and `PIQ` as main frameworks for deep learning.
-* `Albumentations` for data preprocessing.
+  as Keras for PyTorch. This framework is integrated with logging systems such as the well-known [TensorBoard](https://www.tensorflow.org/tensorboard);
+* `Pytorch` and `torchvision` as main frameworks for deep learning;
+* `Albumentations` and `PIQ` for data processing.
 
 ## Quick Start
 
 ### Setup environment
-`esrgan` requires python >= 3.8. The [requirements.txt](requirements.txt) file can be used to install the necessary packages.
-
-```
-git clone  https://github.com/leverxgroup/esrgan.git
-pip install ./esrgan
+```bash
+pip install git+https://github.com/leverxgroup/esrgan.git
 ```
 
 ### Run an experiment
+```bash
+catalyst-dl run -C esrgan/config.yml --benchmark
 ```
-# step 1 - supervised training of the model
-catalyst-dl run -C esrgan/experiment/config_supervised.yml --benchmark
-
-# step 2 - use weights from step 1 to train model using GAN approach
-catalyst-dl run -C esrgan/experiment/config_gan.yml --benchmark
-```
-where `esrgan/experiment/config.yml` is a path to the [config](experiment/config.yml) file.
+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:
@@ -52,5 +45,8 @@ Some examples of work of ESRGAN model trained on [DIV2K](https://data.vision.ee.
 | <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"/> |
 
+## Documentation
+Full documentation for the project is available at https://esrgan.readthedocs.io/
+
 ## License
 `esrgan` is released under a CC BY-NC-ND 4.0 license. See [LICENSE](LICENSE) for additional details about it.