tflite_support.task.vision.ImageClassifier

Class that performs classification on images.

tflite_support.task.vision.ImageClassifier(
    options: tflite_support.task.vision.ImageClassifierOptions,
    classifier: _CppImageClassifier
) -> None

options

Methods

classify

View source

classify(
    image: tflite_support.task.vision.TensorImage,
    bounding_box: Optional[tflite_support.task.processor.BoundingBox] = None
) -> tflite_support.task.processor.ClassificationResult

Performs classification on the provided TensorImage.

Args
image Tensor image, used to extract the feature vectors.
bounding_box Bounding box, optional. If set, performed feature vector extraction only on the provided region of interest. Note that the region of interest is not clamped, so this method will fail if the region is out of bounds of the input image.

Returns
classification result.

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

create_from_file

View source

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

Creates the ImageClassifier object from a TensorFlow Lite model.

Args
file_path Path to the model.

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

Raises
ValueError If failed to create ImageClassifier 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.ImageClassifierOptions
) -> 'ImageClassifier'

Creates the ImageClassifier object from image classifier options.

Args
options Options for the image classifier task.

Returns
ImageClassifier object that's created from options.

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