🎥 Make videos programmatically with React
Add stale Whisper model cleanup API
Jonny Burger0e988cdc15ee
diff --git a/packages/convert/app/components/transcribe/App.tsx b/packages/convert/app/components/transcribe/App.tsxindex 842d7bd1f7..61399877bd 100644--- a/packages/convert/app/components/transcribe/App.tsx+++ b/packages/convert/app/components/transcribe/App.tsx@@ -1,4 +1,5 @@import {+ clearStaleModels,getAvailableModels,isWhisperModelCached,type WhisperWebGpuModel,@@ -19,11 +20,31 @@ const Transcribe: React.FC<{const [selectedModel, setSelectedModel] =useState<WhisperWebGpuModel>('tiny.en');- const [cachedModels, setCachedModels] = useState<- WhisperWebGpuModel[] | null- >(null);+ const [cachedModels, setCachedModels] = useState<WhisperWebGpuModel[] | null>(+ null,+ );+ const [staleModelsCleared, setStaleModelsCleared] = useState(false);useEffect(() => {+ let cancelled = false;+ clearStaleModels()+ .catch(() => undefined)+ .then(() => {+ if (!cancelled) {+ setStaleModelsCleared(true);+ }+ });++ return () => {+ cancelled = true;+ };+ }, []);++ useEffect(() => {+ if (!staleModelsCleared) {+ return;+ }+if (state.type !== 'idle' && state.type !== 'error') {return;}@@ -47,7 +68,7 @@ const Transcribe: React.FC<{return () => {cancelled = true;};- }, [state.type]);+ }, [staleModelsCleared, state.type]);return (<>diff --git a/packages/docs/docs/whisper-webgpu/clear-stale-models.mdx b/packages/docs/docs/whisper-webgpu/clear-stale-models.mdxnew file mode 100644index 0000000000..97816d81dc--- /dev/null+++ b/packages/docs/docs/whisper-webgpu/clear-stale-models.mdx@@ -0,0 +1,30 @@+---+image: /generated/articles-docs-whisper-webgpu-clear-stale-models.png+title: clearStaleModels()+crumb: '@remotion/whisper-webgpu'+---++# clearStaleModels()<AvailableFrom v="4.0.518" />++Removes cached model files that are no longer returned by [`getAvailableModels()`](/docs/whisper-webgpu/get-available-models). There are no stale models in the current version, so this function resolves without changing the cache.++Call this function when the page loads to remove models discontinued by a newer version of `@remotion/whisper-webgpu`.++```ts twoslash title="clear-stale-models.ts"+import {clearStaleModels} from '@remotion/whisper-webgpu';++await clearStaleModels();+```++## Return type++A `Promise<void>` that resolves after stale models have been removed.++## Compatibility++<CompatibilityTable chrome firefox safari nodejs="" bun="" serverlessFunctions="" clientSideRendering={false} serverSideRendering player studio hideServers />++## See also++- [`getAvailableModels()`](/docs/whisper-webgpu/get-available-models)+- [`isWhisperModelCached()`](/docs/whisper-webgpu/is-whisper-model-cached)diff --git a/packages/docs/docs/whisper-webgpu/get-available-models.mdx b/packages/docs/docs/whisper-webgpu/get-available-models.mdxindex 8adfff6d6f..cd5123de6a 100644--- a/packages/docs/docs/whisper-webgpu/get-available-models.mdx+++ b/packages/docs/docs/whisper-webgpu/get-available-models.mdx@@ -19,7 +19,7 @@ Each item contains the short `name`, Hugging Face `modelId`, parameter count, whAvailable sizes are `tiny`, `base`, `small`, `medium`, and `large-v3-turbo`. English-only `.en` variants are available through `medium`.-The set of available models may change between versions as faster variants of these models are in development by Hugging Face. If the set of models is changing, we will introduce an API for clearing stale models.+The set of available models may change between versions as faster variants of these models are in development by Hugging Face. Call [`clearStaleModels()`](/docs/whisper-webgpu/clear-stale-models) to remove cached models that are no longer available after upgrading.The estimates cover model weights. Browser caches and supporting model files may add a small amount.@@ -30,5 +30,6 @@ The estimates cover model weights. Browser caches and supporting model files may## See also- [`transcribe()`](/docs/whisper-webgpu/transcribe)+- [`clearStaleModels()`](/docs/whisper-webgpu/clear-stale-models)- [`isWhisperModelCached()`](/docs/whisper-webgpu/is-whisper-model-cached)- [`loadWhisperModel()`](/docs/whisper-webgpu/load-whisper-model)diff --git a/packages/docs/docs/whisper-webgpu/table-of-contents.tsx b/packages/docs/docs/whisper-webgpu/table-of-contents.tsxindex b78ee89d52..a451665fa7 100644--- a/packages/docs/docs/whisper-webgpu/table-of-contents.tsx+++ b/packages/docs/docs/whisper-webgpu/table-of-contents.tsx@@ -13,6 +13,10 @@ export const TableOfContents: React.FC = () => {<strong>getAvailableModels()</strong><div>List timestamped models and their download sizes</div></TOCItem>+ <TOCItem link="/docs/whisper-webgpu/clear-stale-models">+ <strong>clearStaleModels()</strong>+ <div>Remove models discontinued by newer versions</div>+ </TOCItem><TOCItem link="/docs/whisper-webgpu/is-whisper-model-cached"><strong>isWhisperModelCached()</strong><div>Check whether a model is downloaded</div>diff --git a/packages/docs/sidebars.ts b/packages/docs/sidebars.tsindex d50e1a0f1a..e7822be2d0 100644--- a/packages/docs/sidebars.ts+++ b/packages/docs/sidebars.ts@@ -989,6 +989,7 @@ const sidebars: SidebarsConfig = {items: ['whisper-webgpu/can-use-whisper-webgpu','whisper-webgpu/get-available-models',+ 'whisper-webgpu/clear-stale-models','whisper-webgpu/is-whisper-model-cached','whisper-webgpu/load-whisper-model','whisper-webgpu/transcribe',diff --git a/packages/docs/src/data/articles.ts b/packages/docs/src/data/articles.tsindex cbd6a70d11..791d651f8e 100644--- a/packages/docs/src/data/articles.ts+++ b/packages/docs/src/data/articles.ts@@ -8984,6 +8984,15 @@ export const articles = [noAi: false,slug: 'whisper-webgpu/can-use-whisper-webgpu',},+ {+ id: 'whisper-webgpu/clear-stale-models',+ title: 'clearStaleModels()',+ relativePath: 'docs/whisper-webgpu/clear-stale-models.mdx',+ compId: 'articles-docs-whisper-webgpu-clear-stale-models',+ crumb: '@remotion/whisper-webgpu',+ noAi: false,+ slug: 'whisper-webgpu/clear-stale-models',+ },{id: 'whisper-webgpu/dispose-whisper-model',title: 'disposeWhisperModel()',diff --git a/packages/docs/static/generated/articles-docs-whisper-webgpu-clear-stale-models.png b/packages/docs/static/generated/articles-docs-whisper-webgpu-clear-stale-models.pngnew file mode 100644index 0000000000..c682392a07Binary files /dev/null and b/packages/docs/static/generated/articles-docs-whisper-webgpu-clear-stale-models.png differdiff --git a/packages/whisper-webgpu/src/clear-stale-models.ts b/packages/whisper-webgpu/src/clear-stale-models.tsnew file mode 100644index 0000000000..dcebb89fad--- /dev/null+++ b/packages/whisper-webgpu/src/clear-stale-models.ts@@ -0,0 +1 @@+export const clearStaleModels = (): Promise<void> => Promise.resolve();diff --git a/packages/whisper-webgpu/src/index.ts b/packages/whisper-webgpu/src/index.tsindex 5b8357a0fa..a020d03828 100644--- a/packages/whisper-webgpu/src/index.ts+++ b/packages/whisper-webgpu/src/index.ts@@ -3,6 +3,7 @@ export {WhisperWebGpuUnsupportedReason,} from './can-use-whisper-webgpu';export type {CanUseWhisperWebGpuResult} from './can-use-whisper-webgpu';+export {clearStaleModels} from './clear-stale-models';export {disposeWhisperModel, loadWhisperModel} from './load-whisper-model';export type {DisposeWhisperModelOptions,diff --git a/packages/whisper-webgpu/src/test/transcribe.test.ts b/packages/whisper-webgpu/src/test/transcribe.test.tsindex 8ce6adcff4..fedc7f8346 100644--- a/packages/whisper-webgpu/src/test/transcribe.test.ts+++ b/packages/whisper-webgpu/src/test/transcribe.test.ts@@ -106,6 +106,7 @@ test('transcribes with word timestamps using WebGPU', async () => {const api = await import('../index');const {canUseWhisperWebGpu,+ clearStaleModels,disposeWhisperModel,getAvailableModels,isWhisperModelCached,@@ -113,6 +114,7 @@ test('transcribes with word timestamps using WebGPU', async () => {transcribe,WhisperWebGpuUnsupportedReason,} = api;+ await expect(clearStaleModels()).resolves.toBeUndefined();const channelWaveform = new Float32Array(16_000 * 3);const result = await transcribe({channelWaveform,