react-native-executorch/lib/module/hooks/computer_vision/useImageEmbeddings.js

An easy way to run AI models in React Native with ExecuTorch

"use strict";

import { ImageEmbeddingsModule } from '../../modules/computer_vision/ImageEmbeddingsModule';
import { useModuleFactory } from '../useModuleFactory';

/**
 * React hook for managing an Image Embeddings model instance.
 * @category Hooks
 * @param ImageEmbeddingsProps - Configuration object containing `model` source and optional `preventLoad` flag.
 * @returns Ready to use Image Embeddings model.
 */
export const useImageEmbeddings = ({
  model,
  preventLoad = false
}) => {
  const {
    error,
    isReady,
    isGenerating,
    downloadProgress,
    runForward,
    runOnFrame
  } = useModuleFactory({
    factory: (config, onProgress) => ImageEmbeddingsModule.fromModelName(config, onProgress),
    config: model,
    deps: [model.modelName, model.modelSource],
    preventLoad
  });
  const forward = imageSource => runForward(inst => inst.forward(imageSource));
  return {
    error,
    isReady,
    isGenerating,
    downloadProgress,
    forward,
    runOnFrame
  };
};
//# sourceMappingURL=useImageEmbeddings.js.map