mirror of https://github.com/upscayl/upscayl.git synced 2024-11-12 01:40:53 +01:00

🆙 Upscayl - Free and Open Source AI Image Upscaler for Linux, MacOS and Windows built with Linux-First philosophy.

ai electron esrgan gigapixel gigapixel-images image image-upscaling topaz upscale upscalerimage upscayl

Go to file

NayamAmarshe 63c5deacc1 Update doc_issue.yml		2023-01-09 09:34:56 +05:30
.github	Update doc_issue.yml	2023-01-09 09:34:56 +05:30
build	Compress images	2022-10-16 09:49:31 +01:00
electron	Fixed #165 and #167	2022-12-27 12:15:16 +05:30
flatpak	Fixed flatpak metadata	2022-09-30 21:50:46 +05:30
future-use	Dropped video models, fixed build error	2022-12-24 13:17:10 +05:30
main	Fixed #165 and #167	2022-12-27 12:15:16 +05:30
renderer	Added donate and fixed gpuId	2022-12-27 17:03:39 +05:30
resources	Dropped video models, fixed build error	2022-12-24 13:17:10 +05:30
scripts	Compress images	2022-10-16 09:49:31 +01:00
ups	Fixed for v1.5 release	2022-09-19 05:24:45 +05:30
ups_upscayled	Compress images	2022-10-16 09:49:31 +01:00
ups_upscayled_sharpened	Compress images	2022-10-16 09:49:31 +01:00
.gitignore	Added upscayl on folder	2022-12-04 06:29:16 +05:30
download.jpg	Updated readme	2022-12-22 17:40:23 +05:30
LICENSE	Create LICENSE	2022-08-24 10:18:39 +05:30
next.config.js	Converted to Typescript	2022-11-12 02:09:28 +05:30
package.json	Removed redundant files and changed version	2022-12-27 12:36:47 +05:30
postcss.config.js	next and electron template	2022-08-15 10:23:14 +05:30
README.md	Update README.md	2022-12-27 12:36:05 +05:30
Real-ESRGAN_LICENSE.txt	Add files via upload	2022-08-24 16:23:22 +05:30
screen1.png	Updated readme	2022-12-22 17:40:23 +05:30
tailwind.config.js	Added zoom function	2022-12-21 16:02:45 +05:30
to_upscale.jpeg	Added upscaling functionality	2022-08-16 07:47:27 +05:30
tsconfig.json	Converted to Typescript	2022-11-12 02:09:28 +05:30
upscayl.mp4	Added mp4	2022-08-24 10:25:15 +05:30
yarn.lock	Removed react magnifier	2022-12-22 20:29:11 +05:30

README.md

For updates and more:

Upscayl 🆙

Free and Open Source AI Image Upscaler

Upscayl is a cross-platform application built with the Linux-first philosophy. This means that we prioritize Linux builds over others but that doesn't mean we'll break things for other OSes :)

NOTE: You'll need a Vulkan compatible GPU to upscale images. Many CPU and iGPUs do not work but no harm in trying.

Installation 👨‍💻

Linux 🐧

Go to releases section
Download the .AppImage file.
Right Click AppImage -> Go to Permissions tab -> Check allow file to execute and then double click the file to run Upscayl.

You can also download the flatpak version and double click the flatpak file to install via Store but wait for the full release, we'll be pushing it to Flathub for easy access.

MacOS 🍎

Go to releases section
Download the .dmg file.
Double click dmg, drag Upscayl icon into Applications folder.

Windows 🐌

Go to releases section
Download the .exe file.
Double click exe file, wait for installation, profit.

Comparisons: https://imgsli.com/MTQzMjI4/0/1

Medium Resolution Images (300-400 pixels wide):

Low Resolution Images (150 pixels wide):

Super Low Resolution Images (75 pixels wide):

UPSCALED TWICE

Roadmap 🤫

More AI models (Added ✅)
Allow video upscaling 📼
Make the whole world use FOSS (WIP 🚧)

Development 🛠

git clone https://github.com/TGS963/upscayl
cd upscayl

# INSTALL DEPENDENCIES
npm install

# RUN THE DEVELOPMENT SERVER LOCALLY
npm run start

# PACKAGE THE APP
npm run dist

# PUBLISH THE APP, MAKE SURE TO ADD GH_TOKEN= IN SHELL
npm run publish-app

FAQ 🤓

How does Upscayl work?
- Upscayl uses AI models to enhance your images by guessing what the details could be. It uses Real-ESRGAN (and more in the future) model to achieve this.
Is there a CLI available?
- The CLI tool is called real-esrgan-ncnn-vulkan and it's available on the Real-ESRGAN repository.
Do I need a GPU for this to work?
- Yes, unfortunately. NCNN Vulkan requires a Vulkan compatible GPU. Upscayl won't work on most iGPUs or CPUs.
How can I contribute?
- You can donate more NCNN compatible models or fix code by submitting PRs :)
You are not fully open source!!😡
- We are, we're using completely free and open source tech. We do ship a binary but that's because not including it would kill the entire purpose of the project. If you want to deal with all those PyTorch, NCNN, and Python errors, you're more than welcome to compile your own binary using the code provided by Real-ESRGAN. The binary is pre-compiled for convenience, if you do not trust it, then you can compile your own since everything is free and open source here :)

Upscayl uses Real-ESRGAN-ncnn-vulkan binaries to upscale images. More models and algorithms will come soon.

Donate

Credits ❤

Real-ESRGAN for their wonderful research work.
Real-ESRGAN: Copyright (c) 2021, Xintao Wang
Microsoft™ for their Fluent Emoji used as our logo.
@JanDeDinoMan, @xanderfrangos, @Fdawgs, @keturn for their code contributions :)
@aaronliu0130 for providing community support :)