Skip to content

Reference for ultralytics/models/yolo/classify/predict.py

Note

Full source code for this file is available at https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/yolo/classify/predict.py. Help us fix any issues you see by submitting a Pull Request 🛠️. Thank you 🙏!


ultralytics.models.yolo.classify.predict.ClassificationPredictor

Bases: BasePredictor

A class extending the BasePredictor class for prediction based on a classification model.

Notes
  • Torchvision classification models can also be passed to the 'model' argument, i.e. model='resnet18'.
Example
from ultralytics.utils import ASSETS
from ultralytics.models.yolo.classify import ClassificationPredictor

args = dict(model='yolov8n-cls.pt', source=ASSETS)
predictor = ClassificationPredictor(overrides=args)
predictor.predict_cli()
Source code in ultralytics/models/yolo/classify/predict.py
class ClassificationPredictor(BasePredictor):
    """
    A class extending the BasePredictor class for prediction based on a classification model.

    Notes:
        - Torchvision classification models can also be passed to the 'model' argument, i.e. model='resnet18'.

    Example:
        ```python
        from ultralytics.utils import ASSETS
        from ultralytics.models.yolo.classify import ClassificationPredictor

        args = dict(model='yolov8n-cls.pt', source=ASSETS)
        predictor = ClassificationPredictor(overrides=args)
        predictor.predict_cli()
        ```
    """

    def __init__(self, cfg=DEFAULT_CFG, overrides=None, _callbacks=None):
        super().__init__(cfg, overrides, _callbacks)
        self.args.task = 'classify'

    def preprocess(self, img):
        """Converts input image to model-compatible data type."""
        if not isinstance(img, torch.Tensor):
            img = torch.stack([self.transforms(im) for im in img], dim=0)
        img = (img if isinstance(img, torch.Tensor) else torch.from_numpy(img)).to(self.model.device)
        return img.half() if self.model.fp16 else img.float()  # uint8 to fp16/32

    def postprocess(self, preds, img, orig_imgs):
        """Post-processes predictions to return Results objects."""
        if not isinstance(orig_imgs, list):  # input images are a torch.Tensor, not a list
            orig_imgs = ops.convert_torch2numpy_batch(orig_imgs)

        results = []
        for i, pred in enumerate(preds):
            orig_img = orig_imgs[i]
            img_path = self.batch[0][i]
            results.append(Results(orig_img, path=img_path, names=self.model.names, probs=pred))
        return results

postprocess(preds, img, orig_imgs)

Post-processes predictions to return Results objects.

Source code in ultralytics/models/yolo/classify/predict.py
def postprocess(self, preds, img, orig_imgs):
    """Post-processes predictions to return Results objects."""
    if not isinstance(orig_imgs, list):  # input images are a torch.Tensor, not a list
        orig_imgs = ops.convert_torch2numpy_batch(orig_imgs)

    results = []
    for i, pred in enumerate(preds):
        orig_img = orig_imgs[i]
        img_path = self.batch[0][i]
        results.append(Results(orig_img, path=img_path, names=self.model.names, probs=pred))
    return results

preprocess(img)

Converts input image to model-compatible data type.

Source code in ultralytics/models/yolo/classify/predict.py
def preprocess(self, img):
    """Converts input image to model-compatible data type."""
    if not isinstance(img, torch.Tensor):
        img = torch.stack([self.transforms(im) for im in img], dim=0)
    img = (img if isinstance(img, torch.Tensor) else torch.from_numpy(img)).to(self.model.device)
    return img.half() if self.model.fp16 else img.float()  # uint8 to fp16/32




Created 2023-07-16, Updated 2023-08-20
Authors: glenn-jocher (6), Laughing-q (1)