Final2x Documentation

A cross-platform image super-resolution tool

RAW Doc

Technical Documentation: EutropicAI/Final2x

โ„น๏ธ Provenance: Multi-Tier Ingestion ยท CodeWiki Reference

Overview (`README.md`)

[](https://trendshift.io/repositories/19699) Final2x




A cross-platform image super-resolution tool for Windows, macOS, and Linux.

Use built-in models or load your own. See the custom model demo to get started.

๐Ÿ–ผ๏ธ Screenshots

๐Ÿ“ฆ Installation

Download the latest release for your platform.

๐ŸชŸ Windows

Install from the release page, or use a package manager such as winget or Scoop. Package manager versions may lag behind the latest release.

๐ŸŽ macOS

If macOS blocks the app on first launch, run the following command in Terminal after placing it in /Applications:

bash
xattr -cr /Applications/Final2x.app

๐Ÿง Linux

Install Python >= 3.10 and PyTorch >= 2.0, then install the backend and required system libraries. On Debian or Ubuntu:

bash
pip install Final2x-core
Final2x-core -h # Verify the backend installation
sudo apt install -y libomp5 xdg-utils

๐Ÿงฉ References

The Python CLI and desktop backend live in core and share the desktop app's version number.

This project builds on the following open-source projects:

๐Ÿ“„ License

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

๐Ÿ’™ Acknowledgements

Feel free to reach out to the project maintainers with any questions or concerns~


Overview (`core/README.md`)

Final2x-core

Final2x-core is the cross-platform image super-resolution CLI and desktop backend for Final2x.

Install

Install the CLI from PyPI. Desktop builds bundle the matching core where required.

Make sure you have Python >= 3.10 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

--- METRICS ---