ready event not exposed on ProgressInfo type

[pelikhan]

System Info

transformers.js 3.1.0
typescript 5.7.2

Environment/Platform

• Website/web-app
• Browser extension
• Server-side (e.g., Node.js, Deno, Bun)
• Desktop app (e.g., Electron)
• Other (e.g., VSCode extension)

Description

The type definition of ProgressInfo does not expose the "ready" event that gets sent when the model is fully loaded.

Reproduction

const generator = await pipeline('text-generation', 'Xenova/distilgpt2'. {
  progress_callback: ev => console.log(ev.status) // this will print "ready" when the model is loaded
});
const text = 'I enjoy walking with my cute dog,';
const output = await generator(text);

[xenova]

A follow-up PR to #1034 would be great! cc @ocavue if you're able to take a look.

[emojiiii]

I guess what you want to find is "done"

[pelikhan]

I guess what you want to find is "done"

"done" is emitted for each file and "ready" is emitted once all files are loaded. It's the last event.

[emojiiii]

I guess what you want to find is "done"

"done" is emitted for each file and "ready" is emitted once all files are loaded. It's the last event.

you are right. https://github.com/huggingface/transformers.js/blob/main/src/pipelines.js#L3267

[ocavue]

I did miss that part. I will fix it.

TypeScript can actually find the error but there isn't any type check task in the CI pipeline so I didn't find it out in my original PR. @xenova I can add a TypeScript type checking GitHub Actions pipeline to transformers.js, if you want.

[ocavue]

I've submitted a PR to fix this type issue.

[xenova]

Thanks @ocavue! 🔥 Also, that PR for a type checking github action would be great. Do note that there may be a lot of these warnings/errors, especially for undefined variables on configs (as they are specific to certain models).

[ocavue]

@xenova I submitted #1081 for type checking. Since npm run build will do type checking, I didn't add a new github action.