Swin2sr Compressed Sr X4 48

🚀 Image Upscaling with Transformers.js

This project provides a way to use the caidas/swin2SR-compressed-sr-x4-48 model with ONNX weights, making it compatible with Transformers.js. It enables image upscaling in a JavaScript environment.

🚀 Quick Start

📦 Installation

If you haven't already, you can install the Transformers.js JavaScript library from NPM using the following command:

npm i @xenova/transformers

💻 Usage Examples

🔍 Basic Usage

Example: Upscale an image with Xenova/swin2SR-compressed-sr-x4-48.

import { pipeline } from '@xenova/transformers';

// Create image-to-image pipeline
const upscaler = await pipeline('image-to-image', 'Xenova/swin2SR-compressed-sr-x4-48', {
    // quantized: false, // Uncomment this line to use the quantized version
});

// Upscale an image
const url = 'https://huggingface.co/datasets/Xenova/transformers.js-docs/resolve/main/butterfly.jpg';
const output = await upscaler(url);
// RawImage {
//   data: Uint8Array(3145728) [ ... ],
//   width: 1024,
//   height: 1024,
//   channels: 3
// }

// (Optional) Save the upscaled image
output.save('upscaled.png');

📚 Additional Information

The model is sourced from https://huggingface.co/caidas/swin2SR-compressed-sr-x4-48 with ONNX weights for compatibility with Transformers.js.

⚠️ Important Note

Having a separate repo for ONNX weights is intended to be a temporary solution until WebML gains more traction. If you would like to make your models web-ready, we recommend converting to ONNX using 🤗 Optimum and structuring your repo like this one (with ONNX weights located in a subfolder named onnx).

📋 Model Details