Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

upscaler

thekevinscott2.9kMIT1.0.0-beta.19TypeScript support: included

Enhance Images with Javascript and AI. Increase resolution, retouch, denoise, and more. Open Source, Browser and Node Compatible, MIT License.

image enhancement, super resolution, upscaling, tensorflow.js, neural network, ai, retouching, low light, deblur, denoise, dehaze, derain, esrgan, maxim

readme

UpscalerJS

Latest UpscalerJS NPM Version License for UpscalerJS Downloads per week on NPM for UpscalerJS Status of tests for UpscalerJS repository Code Coverage for UpscalerJS DeepSource issues for UpscalerJS

Enhance Images with Javascript and AI. Increase resolution, retouch, denoise, and more. Open Source, Browser & Node Compatible, MIT License.

  • 🎁 Pretrained Models: Enhance images using UpscalerJS's diverse pretrained models, designed to suit various image styles and requirements including increasing image resolution, denoising, deblurring, and more.
  • 🔌 Seamless Platform Integration: Integrate UpscalerJS across Browser, Node (CPU and GPU), and Workers environments.
  • 📘 Comprehensive Documentation: Leverage UpscalerJS confidently with extensive documentation, thorough examples, and TypeScript support.
  • 🚀 UI-Focused Enhancement: Performant UI support with built-in patch-based processing that supports performance without sacrificing quality.
  • 📱 Device Compatibility: Consistent image enhancement across a variety of devices, including desktops, tablets, and phones.
  • 🧩 Custom Model Integration: Extend UpscalerJS by integrating your own pretrained models for personalized image enhancements.

Demo

A live demo is here.

Quick Start

import Upscaler from 'upscaler';
const upscaler = new Upscaler();
upscaler.upscale('/path/to/image').then(upscaledImage => {
  console.log(upscaledImage); // base64 representation of image src
});

Documentation

View the docs here.

Guides

You can view runnable code examples. You can also find the guides here on Github.

Support the Project

Add a ⭐️ star on GitHub or ❤️ tweet to support the project!

License

MIT License © Kevin Scott

changelog

Change Log

All notable changes to this project will be documented in this file. See Conventional Commits for commit guidelines.

0.12.3 (2021-04-24)

bug: Export a node-gpu build in the published folder.

0.12.1 (2021-03-16)

bug: Include tensor-as-base64 as an explicit dependency.

0.12.0 (2021-03-5)

feat: Add support for abort method to cancel all in flight upscale requests, along with an optional signal option for an upscale request that aborts that specific request.

0.11.0 (2021-03-2)

feat: Add support for progress callback to receive a second argument, the current slice of procesed image

0.10.0 (2021-02-25)

feat: Add Node support feat: Add upscaler.dispose() property fix: memory leaks docs: update for Node

0.9.0 (2021-01-23)

Upgrades TFJS dependencies

0.8.23 (2021-08-06)

Note: Version bump only for package upscaler

0.8.22 (2021-03-15)

Note: Version bump only for package upscaler

0.8.21 (2021-03-15)

Note: Version bump only for package upscaler

0.8.20 (2021-03-15)

Note: Version bump only for package upscaler

0.8.19 (2021-03-15)

Note: Version bump only for package upscaler

0.8.18 (2021-03-15)

Note: Version bump only for package upscaler

0.8.17 (2021-03-15)

Note: Version bump only for package upscaler

0.8.16 (2021-03-15)

Note: Version bump only for package upscaler

0.8.15 (2021-03-15)

Note: Version bump only for package upscaler

Note: Version bump only for package upscaler

0.8.13 (2021-03-15)

Note: Version bump only for package upscaler

0.8.12 (2021-03-15)

Note: Version bump only for package upscaler

0.8.11 (2021-03-15)

Note: Version bump only for package upscaler

0.8.10 (2021-03-15)

Note: Version bump only for package upscaler

0.8.9 (2021-03-15)

Note: Version bump only for package upscaler

0.8.8 (2021-03-15)

Note: Version bump only for package upscaler

0.8.7 (2021-03-15)

Note: Version bump only for package upscaler

0.8.6 (2021-03-15)

Note: Version bump only for package upscaler

0.8.6-alpha.1 (2021-03-14)

Note: Version bump only for package upscaler