# Technical Documentation: EutropicAI/Final2x

> ℹ️ **Provenance:** Multi-Tier Ingestion · [CodeWiki Reference](https://codewiki.google/github.com/EutropicAI/Final2x)

### Overview (`README.md`)

<h1>
  <a href="https://trendshift.io/repositories/19699"><img align="right" src="https://trendshift.io/api/badge/repositories/19699" alt="Final2x on Trendshift" width="200" height="44" /></a>
  Final2x
</h1>




[](https://github.com/EutropicAI/Final2x/actions/workflows/CI-test.yml)
[](https://github.com/EutropicAI/Final2x/actions/workflows/CI-test-core.yml)
[](https://github.com/EutropicAI/Final2x/actions/workflows/CI-build.yml)
[](https://github.com/EutropicAI/Final2x/actions/workflows/Release.yml)



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](https://github.com/EutropicAI/cccv_demo_remote_model) to get started.

## 🖼️ Screenshots

<div align=center>
<img width="40%" alt="image" src="https://github.com/user-attachments/assets/37f6d444-766b-4c28-b64a-018f78ae1f35" />
<img width="40%" alt="image" src="https://github.com/user-attachments/assets/3f86e693-f667-48fd-8830-0d96fb5229d2" />
</div>

## 📦 Installation

[Download the latest release](https://github.com/EutropicAI/Final2x/releases) 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`](./core) and share the desktop app's version number.

This project builds on the following open-source projects:

- [cccv](https://github.com/EutropicAI/cccv) — image restoration and super-resolution backend
- [naive-ui](https://github.com/tusen-ai/naive-ui)
- [electron-vite](https://github.com/alex8088/electron-vite)

## 📄 License

This project is licensed under the BSD 3-Clause - see
the [LICENSE file](./LICENSE) 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 ---
- Files Extracted: 2
- Estimated Token Budget: ~806 tokens
- Canonical Reference: https://codewiki.google/github.com/EutropicAI/Final2x