useImageEmbedder(
config,options?):object
Defined in: hooks/useImageEmbedder.ts:25
React hook to load and run an image embedding model.
This hook manages downloading (if remote URLs are provided) and loading the model assets, compiling them, tracking download progress and load errors, and releasing native memory when the component unmounts or the configuration changes.
For imperative usage, see createImageEmbedder.
The image embedder model configuration. See ImageEmbedderModel.
Load and caching options. See ResourceOptions.
object
The same object as ImageEmbedder (without dispose),
combined with loading state and download progress.
downloadProgress:
number
embed: (
input) =>Promise<Float32Array<ArrayBufferLike>> |undefined=model.embed
embedWorklet: (
input) =>Float32Array|undefined=model.embedWorklet
error:
Error|undefined
isReady:
boolean=!!model
resource:
ImageEmbedderModel|undefined