Memory Management

View this page on the UpscalerJS website

This guide demonstrates additional techniques for managing memory when using UpscalerJS.

Open in Codesandbox.

Disposing of an UpscalerJS Instance

caution

The most important consideration is to dispose of tensors. If you provide a tensor, or specify a tensor as the return type, you are responsible for disposing of the tensor. Read more about that here. (Any tensors not explicitly specified, UpscalerJS will clear for you.)

If working with multiple upscalers within a page, we may want to clean up upscaler instances when done with them. We can do so with the below:

import Upscaler from 'upscaler'
const upscaler = new Upscaler()

upscaler.dispose().then(() => {
  console.log('UpscalerJS is cleaned up')
})

dispose will return a promise that resolves once all memory is freed up. All inflight upscale requests will be aborted.

Next we can learn about additional arguments and methods that we can use to interact with an UpscalerJS instance.