https://github.com/eutropicai/final2x-core

core for Final2x
https://github.com/eutropicai/final2x-core

ccrestoration computer-vision cross-platform image-processing low-level-vision python3 pytorch super-resolution

Last synced: 8 months ago
JSON representation

core for Final2x

• Host: GitHub
• URL: https://github.com/eutropicai/final2x-core
• Owner: EutropicAI
• License: bsd-3-clause
• Created: 2023-06-21T17:26:00.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2025-09-27T00:34:57.000Z (9 months ago)
• Last Synced: 2025-09-27T02:37:40.445Z (9 months ago)
• Topics: ccrestoration, computer-vision, cross-platform, image-processing, low-level-vision, python3, pytorch, super-resolution
• Language: Python
• Homepage:
• Size: 1.02 MB
• Stars: 90
• Watchers: 3
• Forks: 19
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Final2x-core

![MacOS](https://img.shields.io/badge/Support-MacOS-blue?logo=Apple&style=flat-square)

![Windows](https://img.shields.io/badge/Support-Windows-blue?logo=Windows&style=flat-square)

![Linux](https://img.shields.io/badge/Support-Linux-blue?logo=Linux&style=flat-square)

[![codecov](https://codecov.io/gh/EutropicAI/Final2x-core/branch/main/graph/badge.svg?token=B2TNKYN4O4)](https://codecov.io/gh/EutropicAI/Final2x-core)

[![CI-test](https://github.com/EutropicAI/Final2x-core/actions/workflows/CI-test.yml/badge.svg)](https://github.com/EutropicAI/Final2x-core/actions/workflows/CI-test.yml)

[![Release](https://github.com/EutropicAI/Final2x-core/actions/workflows/Release.yml/badge.svg)](https://github.com/EutropicAI/Final2x-core/actions/workflows/Release.yml)

[![PyPI version](https://badge.fury.io/py/Final2x-core.svg)](https://badge.fury.io/py/Final2x-core)

![GitHub](https://img.shields.io/github/license/EutropicAI/Final2x-core)

Final2x-core is a cross-platform image super-resolution CLI tool for [Final2x](https://github.com/EutropicAI/Final2x). If you have any questions, please raise an issue [in this repository](https://github.com/EutropicAI/Final2x).

### Install

Download in [Release](https://github.com/EutropicAI/Final2x-core/releases) or use pip to install (Linux User).

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

```shell

pip install Final2x-core

```

### cli

```shell

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:

```shell

make gen

```

### Reference

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

After v4.0.0, we use cccv as the algorithm implementation, which implemented most of the features from ccrestoration

- [cccv](https://github.com/EutropicAI/cccv)

---

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

- [ccrestoration](https://github.com/EutropicAI/ccrestoration)

- [PyTorch](https://github.com/pytorch/pytorch)

---

- [ncnn](https://github.com/Tencent/ncnn)

### License

This project is licensed under the BSD 3-Clause - see

the [LICENSE file](./LICENSE) for details.