Neural Network for image Super-Resolution

Description

This repository provides tools for training convolutional neural networks (CNNs) for image super-resolution (upscaling) tasks.

Installation

UV

# clone project
git clone https://github.com/kowusek/SRNet.git
cd SRNet

# create UV environment
uv venv
source .venv/bin/activate
uv pip install -e .

How to run

Train model with default configuration

# train on CPU
python src/srnet/train.py trainer=cpu

# train on GPU
python src/srnet/train.py trainer=gpu

Train model with chosen experiment configuration from configs/experiment/

python src/srnet/train.py experiment=experiment_name.yaml

You can override any parameter from command line like this

python src/srnet/train.py trainer.max_epochs=20 data.batch_size=64

License

SRNet is licensed under the MIT License.

MIT License

Copyright (c) 2021 ashleve

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.