Skip to content

Tohrusky/Final2x-core

Repository files navigation

Final2x-core

MacOS x64 MacOS arm64 Windows x64 Windows arm64 Linux x64 Linux arm64 codecov CI-test pip-test Release PyPI version GitHub

Final2x-core is a cross-platform image super-resolution CLI tool for Final2x. If you have any questions, please raise an issue in this repository.

Install

Download in Release or use pip to install (Linux User).

Make sure you have Python >= 3.9 and PyTorch >= 1.13 installed

pip install Final2x-core

cli

usage: Final2x-core [-h] [-b BASE64] [-j JSON] [-y YAML] [-l] [-n]

when para is not specified, the config.yaml file in the directory will be read automatically

options:
  -h, --help            show this help message and exit
  -b BASE64, --BASE64 BASE64
                        base64 string for config json
  -j JSON, --JSON JSON  JSON string for config
  -y YAML, --YAML YAML  yaml config file path
  -l, --LOG             save log
  -n, --NOTOPENFOLDER   don't open output folder

Config

Refer to config.yaml which generated by the following command:

make gen

Reference

The following references were used in the development of this project:

After v3.0.0, ncnn will be deprecated, and the project will use ccrestoration(PyTorch) as the algorithm implementation.


License

This project is licensed under the BSD 3-Clause - see the LICENSE file for details.