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

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

"use strict";

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

/**
 * React hook for managing an Object Detection model instance.
 * @typeParam C - A {@link ObjectDetectionModelSources} config specifying which built-in model to load.
 * @category Hooks
 * @param props - Configuration object containing `model` config and optional `preventLoad` flag.
 * @returns An object with model state (`error`, `isReady`, `isGenerating`, `downloadProgress`) and typed `forward` and `runOnFrame` functions.
 */
export const useObjectDetection = ({
  model,
  preventLoad = false
}) => {
  const {
    error,
    isReady,
    isGenerating,
    downloadProgress,
    runForward,
    runOnFrame,
    instance
  } = useModuleFactory({
    factory: (config, onProgress) => ObjectDetectionModule.fromModelName(config, onProgress),
    config: model,
    deps: [model.modelName, model.modelSource],
    preventLoad
  });
  const forward = (input, options) => runForward(inst => inst.forward(input, options));
  const getAvailableInputSizes = () => instance?.getAvailableInputSizes() ?? undefined;
  return {
    error,
    isReady,
    isGenerating,
    downloadProgress,
    forward,
    runOnFrame,
    getAvailableInputSizes
  };
};
//# sourceMappingURL=useObjectDetection.js.map