/UpscalerJS

Image Upscaling in Javascript. Increase image resolution up to 4x using Tensorflow.js.

Primary LanguageTypeScriptMIT LicenseMIT

UpscalerJS

NPM npm Tests Codecov DeepSource

UpscalerJS is a tool for enhancing images in Javascript using Neural Networks. UpscalerJS features models enabling the following:

  • Super Resolution
  • Deblurring
  • Denoising
  • Deraining
  • Dehazing
  • Low Light Enhancement
  • Retouching
  • Inpainting (soon!)

Demo

A live demo is here.

Announcement

A beta version of 1.0.0 was released on 7/15/22. Learn more here about what's included.

If you are migrating from <=0.12, and you are using a custom model, you will need to modify how you load models. If you are using the default model (e.g., not providing a model argument) then no changes are needed.

Guides

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

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.

Developing

If cloning the repo, ensure that dvc is installed. dvc is used to manage the model files and has git pre-hooks enabled.

License

MIT License © Kevin Scott