docs: add model life cycle diagram

JacobLinCool · Jan 23, 2024 · ca75dd9 · ca75dd9
1 parent 953b397
commit ca75dd9
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/src/whisper.ts b/src/whisper.ts
@@ -126,3 +126,12 @@ export class Whisper {
 		await model.free();
 	}
 }
+
+/**
+ * Here's a life cycle diagram of a model:
+ * | Method     | (0) Not Available | (1) Loading | (2) Available | (3) Freeing | (0) Not Available |
+ * |------------|-------------------|-------------|---------------|-------------|-------------------|
+ * | load       | V                 | -           | -             | -           | V                 |
+ * | free       | -                 | -           | wait tasks, V | -           | -                 |
+ * | transcribe | load              | load        | V             | load        | load              |
+ */