tflite_support.task.vision.ObjectDetector

Class that performs object detection on images.

tflite_support.task.vision.ObjectDetector(
    options: tflite_support.task.vision.ObjectDetectorOptions,
    detector: _CppObjectDetector
) -> None

Methods

create_from_file

View source

@classmethod
create_from_file(
    file_path: str
) -> 'ObjectDetector'

Creates the ObjectDetector object from a TensorFlow Lite model.

Args
file_path Path to the model.

Returns
ObjectDetector object that's created from the model file.

Raises
ValueError if failed to create ObjectDetector object from the provided file such as invalid file.
RuntimeError If other types of error occurred.

create_from_options

View source

@classmethod
create_from_options(
    options: tflite_support.task.vision.ObjectDetectorOptions
) -> 'ObjectDetector'

Creates the ObjectDetector object from object detector options.

Args
options Options for the object detector task.

Returns
ObjectDetector object that's created from options.

Raises
ValueError If failed to create ObjectDetector object from ObjectDetectorOptions such as missing the model.
RuntimeError If other types of error occurred.

detect

View source

detect(
    image: tflite_support.task.vision.TensorImage
) -> tflite_support.task.processor.DetectionResult

Performs object detection on the provided TensorImage.

Args
image Tensor image, used to extract the feature vectors.

Returns
detection result.

Raises
ValueError If any of the input arguments is invalid.
RuntimeError If object detection failed to run.