Skip to content
/ upscayl Public
forked from upscayl/upscayl

πŸ†™ Upscayl - Free and Open Source AI Image Upscaler for Linux, MacOS and Windows built with Linux-First philosophy.

License

Notifications You must be signed in to change notification settings

vfiee/upscayl

Β 
Β 

Repository files navigation

New Project (33)
v1.3 will come around 12 September

Upscayl πŸ†™

Free and Open Source AI Image Upscaler

simplescreenrecorder-2022-08-23_20.17.02.mp4

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: Upscayl does not work without a GPU, sorry. You'll need a Vulkan compatible GPU to upscale images. CPU or iGPU won't work.

Installation πŸ‘¨β€πŸ’»

Linux πŸ§πŸ‘‘

  1. Go to releases section

  2. Download the .AppImage file.

  3. 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 🍎

  1. Go to releases section

  2. Download the .dmg file.

  3. Double click dmg, drag Upscayl icon into Applications folder.

  4. Open Terminal and enter this command: chmod +x /Applications/Upscayl.app/Contents/Resources/bin/upscayl. Press Enter, profit.

Windows 🐌

  1. Go to releases section

  2. Download the .exe file.

  3. Double click exe file, wait for installation, profit.

Comparisons:

Medium Resolution Images (300-400 pixels wide):

image image

Low Resolution Images (150 pixels wide):

image image

Super Low Resolution Images (75 pixels wide):

UPSCALED TWICE

image

Roadmap 🀫

  • Allow video upscalingπŸ“Ό
  • 2x, 3x upscaling modes
  • More models
  • Make the whole world use FOSS

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 iGPU or CPU.
  • 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.

Credits ❀

Copyright Β© 2022 - Upscayl
By Nayam Amarshe and TGS963
Made with πŸ–± & ⌨

About

πŸ†™ Upscayl - Free and Open Source AI Image Upscaler for Linux, MacOS and Windows built with Linux-First philosophy.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 74.0%
  • Python 23.3%
  • CSS 2.7%