CreateMonitor

Experimental: This is an experimental technology
Check the Browser compatibility table carefully before using this in production.

Secure context: This feature is available only in secure contexts (HTTPS), in some or all supporting browsers.

The CreateMonitor interface provides information on the progress of an AI model download, for example a language pack or some fine-tuning data.

It can be used via:

EventTargetCreateMonitor

Events

Inherits events from its parent, EventTarget.

downloadprogress

Fired when progress is made on the AI model download.

Examples

undefined

Basic CreateMonitor usage

A CreateMonitor instance is used via the monitor property of an AI API's create() method (Summarizer.create() is shown below). The monitor property takes a callback function as a value, the argument of which is the CreateMonitor instance. You can then monitor download progress via the instance's downloadprogress event.

js
const summarizer = await Summarizer.create({
  sharedContext:
    "A general summary to help a user decide if the text is worth reading",
  monitor(monitor) {
    monitor.addEventListener("downloadprogress", (e) => {
      console.log(`download progress: ${e.loaded}/${e.total}`);
    });
  },
});

const summary = await summarizer.summarize(myText);

Specifications

See also