ultralytics 8.3.88__py3-none-any.whl → 8.3.89__py3-none-any.whl

ultralytics/__init__.py

@@ -1,6 +1,6 @@
 # Ultralytics 🚀 AGPL-3.0 License - https://ultralytics.com/license
 
-__version__ = "8.3.88"
+__version__ = "8.3.89"
 
 import os
 

ultralytics/data/base.py

@@ -312,15 +312,13 @@ class BaseDataset(Dataset):
         """
         Users can customize augmentations here.
 
-        Example:
-            ```python
-            if self.augment:
-                # Training transforms
-                return Compose([])
-            else:
-                # Val transforms
-                return Compose([])
-            ```
+        Examples:
+            >>> if self.augment:
+            ...     # Training transforms
+            ...     return Compose([])
+            >>> else:
+            ...    # Val transforms
+            ...    return Compose([])
         """
         raise NotImplementedError
 

ultralytics/data/converter.py

@@ -124,15 +124,16 @@ def coco80_to_coco91_class():
     Converts 80-index (val2014) to 91-index (paper).
     For details see https://tech.amikelive.com/node-718/what-object-categories-labels-are-in-coco-dataset/.
 
-    Example:
-        ```python
-        import numpy as np
-
-        a = np.loadtxt("data/coco.names", dtype="str", delimiter="\n")
-        b = np.loadtxt("data/coco_paper.names", dtype="str", delimiter="\n")
-        x1 = [list(a[i] == b).index(True) + 1 for i in range(80)]  # darknet to coco
-        x2 = [list(b[i] == a).index(True) if any(b[i] == a) else None for i in range(91)]  # coco to darknet
-        ```
+    Examples:
+        >>> import numpy as np
+        >>> a = np.loadtxt("data/coco.names", dtype="str", delimiter="\n")
+        >>> b = np.loadtxt("data/coco_paper.names", dtype="str", delimiter="\n")
+
+        Convert the darknet to COCO format
+        >>> x1 = [list(a[i] == b).index(True) + 1 for i in range(80)]
+
+        Convert the COCO to darknet format
+        >>> x2 = [list(b[i] == a).index(True) if any(b[i] == a) else None for i in range(91)]
     """
     return [
         1,
@@ -237,15 +238,20 @@ def convert_coco(
         cls91to80 (bool, optional): Whether to map 91 COCO class IDs to the corresponding 80 COCO class IDs.
         lvis (bool, optional): Whether to convert data in lvis dataset way.
 
-    Example:
-        ```python
-        from ultralytics.data.converter import convert_coco
+    Examples:
+        >>> from ultralytics.data.converter import convert_coco
+
+        Convert COCO annotations to YOLO format
+        >>> convert_coco("../datasets/coco/annotations/", use_segments=True, use_keypoints=False, cls91to80=False)
 
-        convert_coco("../datasets/coco/annotations/", use_segments=True, use_keypoints=False, cls91to80=False)
-        convert_coco(
-            "../datasets/lvis/annotations/", use_segments=True, use_keypoints=False, cls91to80=False, lvis=True
-        )
-        ```
+        Convert LVIS annotations to YOLO format
+        >>> convert_coco(
+        >>>    "../datasets/lvis/annotations/",
+        ...     use_segments=True,
+        ...     use_keypoints=False,
+        ...     cls91to80=False,
+        ...     lvis=True
+        ... )
 
     Output:
         Generates output files in the specified output directory.
@@ -353,13 +359,11 @@ def convert_segment_masks_to_yolo_seg(masks_dir, output_dir, classes):
         output_dir (str): The path to the directory where the converted YOLO segmentation masks will be stored.
         classes (int): Total classes in the dataset i.e. for COCO classes=80
 
-    Example:
-        ```python
-        from ultralytics.data.converter import convert_segment_masks_to_yolo_seg
+    Examples:
+        >>> from ultralytics.data.converter import convert_segment_masks_to_yolo_seg
 
-        # The classes here is the total classes in the dataset, for COCO dataset we have 80 classes
-        convert_segment_masks_to_yolo_seg("path/to/masks_directory", "path/to/output/directory", classes=80)
-        ```
+        The classes here is the total classes in the dataset, for COCO dataset we have 80 classes
+        >>> convert_segment_masks_to_yolo_seg("path/to/masks_directory", "path/to/output/directory", classes=80)
 
     Notes:
         The expected directory structure for the masks is:
@@ -429,12 +433,9 @@ def convert_dota_to_yolo_obb(dota_root_path: str):
     Args:
         dota_root_path (str): The root directory path of the DOTA dataset.
 
-    Example:
-        ```python
-        from ultralytics.data.converter import convert_dota_to_yolo_obb
-
-        convert_dota_to_yolo_obb("path/to/DOTA")
-        ```
+    Examples:
+        >>> from ultralytics.data.converter import convert_dota_to_yolo_obb
+        >>> convert_dota_to_yolo_obb("path/to/DOTA")
 
     Notes:
         The directory structure assumed for the DOTA dataset:

ultralytics/data/utils.py

@@ -478,21 +478,19 @@ class HUBDatasetStats:
         task (str): Dataset task. Options are 'detect', 'segment', 'pose', 'classify'. Default is 'detect'.
         autodownload (bool): Attempt to download dataset if not found locally. Default is False.
 
-    Example:
+    Note:
         Download *.zip files from https://github.com/ultralytics/hub/tree/main/example_datasets
-            i.e. https://github.com/ultralytics/hub/raw/main/example_datasets/coco8.zip for coco8.zip.
-        ```python
-        from ultralytics.data.utils import HUBDatasetStats
-
-        stats = HUBDatasetStats("path/to/coco8.zip", task="detect")  # detect dataset
-        stats = HUBDatasetStats("path/to/coco8-seg.zip", task="segment")  # segment dataset
-        stats = HUBDatasetStats("path/to/coco8-pose.zip", task="pose")  # pose dataset
-        stats = HUBDatasetStats("path/to/dota8.zip", task="obb")  # OBB dataset
-        stats = HUBDatasetStats("path/to/imagenet10.zip", task="classify")  # classification dataset
-
-        stats.get_json(save=True)
-        stats.process_images()
-        ```
+        i.e. https://github.com/ultralytics/hub/raw/main/example_datasets/coco8.zip for coco8.zip.
+
+    Examples:
+        >>> from ultralytics.data.utils import HUBDatasetStats
+        >>> stats = HUBDatasetStats("path/to/coco8.zip", task="detect")  # detect dataset
+        >>> stats = HUBDatasetStats("path/to/coco8-seg.zip", task="segment")  # segment dataset
+        >>> stats = HUBDatasetStats("path/to/coco8-pose.zip", task="pose")  # pose dataset
+        >>> stats = HUBDatasetStats("path/to/dota8.zip", task="obb")  # OBB dataset
+        >>> stats = HUBDatasetStats("path/to/imagenet10.zip", task="classify")  # classification dataset
+        >>> stats.get_json(save=True)
+        >>> stats.process_images()
     """
 
     def __init__(self, path="coco8.yaml", task="detect", autodownload=False):
@@ -639,14 +637,11 @@ def compress_one_image(f, f_new=None, max_dim=1920, quality=50):
         max_dim (int, optional): The maximum dimension (width or height) of the output image. Default is 1920 pixels.
         quality (int, optional): The image compression quality as a percentage. Default is 50%.
 
-    Example:
-        ```python
-        from pathlib import Path
-        from ultralytics.data.utils import compress_one_image
-
-        for f in Path("path/to/dataset").rglob("*.jpg"):
-            compress_one_image(f)
-        ```
+    Examples:
+        >>> from pathlib import Path
+        >>> from ultralytics.data.utils import compress_one_image
+        >>> for f in Path("path/to/dataset").rglob("*.jpg"):
+        >>>    compress_one_image(f)
     """
     try:  # use PIL
         im = Image.open(f)
@@ -673,12 +668,9 @@ def autosplit(path=DATASETS_DIR / "coco8/images", weights=(0.9, 0.1, 0.0), annot
         weights (list | tuple, optional): Train, validation, and test split fractions. Defaults to (0.9, 0.1, 0.0).
         annotated_only (bool, optional): If True, only images with an associated txt file are used. Defaults to False.
 
-    Example:
-        ```python
-        from ultralytics.data.utils import autosplit
-
-        autosplit()
-        ```
+    Examples:
+        >>> from ultralytics.data.utils import autosplit
+        >>> autosplit()
     """
     path = Path(path)  # images dir
     files = sorted(x for x in path.rglob("*.*") if x.suffix[1:].lower() in IMG_FORMATS)  # image files only

ultralytics/engine/model.py

@@ -1146,8 +1146,8 @@ class Model(torch.nn.Module):
             (Model): The model instance with evaluation mode set.
 
         Examples:
-            >> model = YOLO("yolo11n.pt")
-            >> model.eval()
+            >>> model = YOLO("yolo11n.pt")
+            >>> model.eval()
         """
         self.model.eval()
         return self

ultralytics/engine/tuner.py

@@ -7,14 +7,11 @@ Hyperparameter tuning is the process of systematically searching for the optimal
 that yield the best model performance. This is particularly crucial in deep learning models like YOLO,
 where small changes in hyperparameters can lead to significant differences in model accuracy and efficiency.
 
-Example:
+Examples:
     Tune hyperparameters for YOLO11n on COCO8 at imgsz=640 and epochs=30 for 300 tuning iterations.
-    ```python
-    from ultralytics import YOLO
-
-    model = YOLO("yolo11n.pt")
-    model.tune(data="coco8.yaml", epochs=10, iterations=300, optimizer="AdamW", plots=False, save=False, val=False)
-    ```
+    >>> from ultralytics import YOLO
+    >>> model = YOLO("yolo11n.pt")
+    >>> model.tune(data="coco8.yaml", epochs=10, iterations=300, optimizer="AdamW", plots=False, save=False, val=False)
 """
 
 import random
@@ -49,22 +46,15 @@ class Tuner:
         __call__():
             Executes the hyperparameter evolution across multiple iterations.
 
-    Example:
+    Examples:
         Tune hyperparameters for YOLO11n on COCO8 at imgsz=640 and epochs=30 for 300 tuning iterations.
-        ```python
-        from ultralytics import YOLO
-
-        model = YOLO("yolo11n.pt")
-        model.tune(data="coco8.yaml", epochs=10, iterations=300, optimizer="AdamW", plots=False, save=False, val=False)
-        ```
-
+        >>> from ultralytics import YOLO
+        >>> model = YOLO("yolo11n.pt")
+        >>> model.tune(
+        ...     data="coco8.yaml", epochs=10, iterations=300, optimizer="AdamW", plots=False, save=False, val=False
+        ... )
         Tune with custom search space.
-        ```python
-        from ultralytics import YOLO
-
-        model = YOLO("yolo11n.pt")
-        model.tune(space={key1: val1, key2: val2})  # custom search space dictionary
-        ```
+        >>> model.tune(space={key1: val1, key2: val2})  # custom search space dictionary
     """
 
     def __init__(self, args=DEFAULT_CFG, _callbacks=None):

ultralytics/hub/__init__.py

@@ -71,12 +71,9 @@ def logout():
     """
     Log out of Ultralytics HUB by removing the API key from the settings file. To log in again, use 'yolo login'.
 
-    Example:
-        ```python
-        from ultralytics import hub
-
-        hub.logout()
-        ```
+    Examples:
+        >>> from ultralytics import hub
+        >>> hub.logout()
     """
     SETTINGS["api_key"] = ""
     LOGGER.info(f"{PREFIX}logged out ✅. To log in again, use 'yolo login'.")
@@ -129,18 +126,17 @@ def check_dataset(path: str, task: str) -> None:
         path (str): Path to data.zip (with data.yaml inside data.zip).
         task (str): Dataset task. Options are 'detect', 'segment', 'pose', 'classify', 'obb'.
 
-    Example:
+    Note:
         Download *.zip files from https://github.com/ultralytics/hub/tree/main/example_datasets
-            i.e. https://github.com/ultralytics/hub/raw/main/example_datasets/coco8.zip for coco8.zip.
-        ```python
-        from ultralytics.hub import check_dataset
-
-        check_dataset("path/to/coco8.zip", task="detect")  # detect dataset
-        check_dataset("path/to/coco8-seg.zip", task="segment")  # segment dataset
-        check_dataset("path/to/coco8-pose.zip", task="pose")  # pose dataset
-        check_dataset("path/to/dota8.zip", task="obb")  # OBB dataset
-        check_dataset("path/to/imagenet10.zip", task="classify")  # classification dataset
-        ```
+        i.e. https://github.com/ultralytics/hub/raw/main/example_datasets/coco8.zip for coco8.zip.
+
+    Examples:
+        >>> from ultralytics.hub import check_dataset
+        >>> check_dataset("path/to/coco8.zip", task="detect")  # detect dataset
+        >>> check_dataset("path/to/coco8-seg.zip", task="segment")  # segment dataset
+        >>> check_dataset("path/to/coco8-pose.zip", task="pose")  # pose dataset
+        >>> check_dataset("path/to/dota8.zip", task="obb")  # OBB dataset
+        >>> check_dataset("path/to/imagenet10.zip", task="classify")  # classification dataset
     """
     HUBDatasetStats(path=path, task=task).get_json()
     LOGGER.info(f"Checks completed correctly ✅. Upload this dataset to {HUB_WEB_ROOT}/datasets/.")

ultralytics/models/fastsam/model.py

@@ -12,13 +12,10 @@ class FastSAM(Model):
     """
     FastSAM model interface.
 
-    Example:
-        ```python
-        from ultralytics import FastSAM
-
-        model = FastSAM("last.pt")
-        results = model.predict("ultralytics/assets/bus.jpg")
-        ```
+    Examples:
+        >>> from ultralytics import FastSAM
+        >>> model = FastSAM("last.pt")
+        >>> results = model.predict("ultralytics/assets/bus.jpg")
     """
 
     def __init__(self, model="FastSAM-x.pt"):

ultralytics/models/nas/model.py

@@ -2,13 +2,10 @@
 """
 YOLO-NAS model interface.
 
-Example:
-    ```python
-    from ultralytics import NAS
-
-    model = NAS("yolo_nas_s")
-    results = model.predict("ultralytics/assets/bus.jpg")
-    ```
+Examples:
+    >>> from ultralytics import NAS
+    >>> model = NAS("yolo_nas_s")
+    >>> results = model.predict("ultralytics/assets/bus.jpg")
 """
 
 from pathlib import Path
@@ -31,13 +28,10 @@ class NAS(Model):
     This class provides an interface for the YOLO-NAS models and extends the `Model` class from Ultralytics engine.
     It is designed to facilitate the task of object detection using pre-trained or custom-trained YOLO-NAS models.
 
-    Example:
-        ```python
-        from ultralytics import NAS
-
-        model = NAS("yolo_nas_s")
-        results = model.predict("ultralytics/assets/bus.jpg")
-        ```
+    Examples:
+        >>> from ultralytics import NAS
+        >>> model = NAS("yolo_nas_s")
+        >>> results = model.predict("ultralytics/assets/bus.jpg")
 
     Attributes:
         model (str): Path to the pre-trained model or model name. Defaults to 'yolo_nas_s.pt'.

ultralytics/models/nas/predict.py

@@ -18,15 +18,13 @@ class NASPredictor(BasePredictor):
     Attributes:
         args (Namespace): Namespace containing various configurations for post-processing.
 
-    Example:
-        ```python
-        from ultralytics import NAS
-
-        model = NAS("yolo_nas_s")
-        predictor = model.predictor
-        # Assumes that raw_preds, img, orig_imgs are available
-        results = predictor.postprocess(raw_preds, img, orig_imgs)
-        ```
+    Examples:
+        >>> from ultralytics import NAS
+        >>> model = NAS("yolo_nas_s")
+        >>> predictor = model.predictor
+
+        Assumes that raw_preds, img, orig_imgs are available
+        >>> results = predictor.postprocess(raw_preds, img, orig_imgs)
 
     Note:
         Typically, this class is not instantiated directly. It is used internally within the `NAS` class.

ultralytics/models/nas/val.py

@@ -20,15 +20,13 @@ class NASValidator(DetectionValidator):
         args (Namespace): Namespace containing various configurations for post-processing, such as confidence and IoU.
         lb (torch.Tensor): Optional tensor for multilabel NMS.
 
-    Example:
-        ```python
-        from ultralytics import NAS
-
-        model = NAS("yolo_nas_s")
-        validator = model.validator
-        # Assumes that raw_preds are available
-        final_preds = validator.postprocess(raw_preds)
-        ```
+    Examples:
+        >>> from ultralytics import NAS
+        >>> model = NAS("yolo_nas_s")
+        >>> validator = model.validator
+
+        Assumes that raw_preds are available
+        >>> final_preds = validator.postprocess(raw_preds)
 
     Note:
         This class is generally not instantiated directly but is used internally within the `NAS` class.

ultralytics/models/rtdetr/predict.py

@@ -16,15 +16,12 @@ class RTDETRPredictor(BasePredictor):
     This class leverages the power of Vision Transformers to provide real-time object detection while maintaining
     high accuracy. It supports key features like efficient hybrid encoding and IoU-aware query selection.
 
-    Example:
-        ```python
-        from ultralytics.utils import ASSETS
-        from ultralytics.models.rtdetr import RTDETRPredictor
-
-        args = dict(model="rtdetr-l.pt", source=ASSETS)
-        predictor = RTDETRPredictor(overrides=args)
-        predictor.predict_cli()
-        ```
+    Examples:
+        >>> from ultralytics.utils import ASSETS
+        >>> from ultralytics.models.rtdetr import RTDETRPredictor
+        >>> args = dict(model="rtdetr-l.pt", source=ASSETS)
+        >>> predictor = RTDETRPredictor(overrides=args)
+        >>> predictor.predict_cli()
 
     Attributes:
         imgsz (int): Image size for inference (must be square and scale-filled).

ultralytics/models/rtdetr/train.py

@@ -21,14 +21,11 @@ class RTDETRTrainer(DetectionTrainer):
         - F.grid_sample used in RT-DETR does not support the `deterministic=True` argument.
         - AMP training can lead to NaN outputs and may produce errors during bipartite graph matching.
 
-    Example:
-        ```python
-        from ultralytics.models.rtdetr.train import RTDETRTrainer
-
-        args = dict(model="rtdetr-l.yaml", data="coco8.yaml", imgsz=640, epochs=3)
-        trainer = RTDETRTrainer(overrides=args)
-        trainer.train()
-        ```
+    Examples:
+        >>> from ultralytics.models.rtdetr.train import RTDETRTrainer
+        >>> args = dict(model="rtdetr-l.yaml", data="coco8.yaml", imgsz=640, epochs=3)
+        >>> trainer = RTDETRTrainer(overrides=args)
+        >>> trainer.train()
     """
 
     def get_model(self, cfg=None, weights=None, verbose=True):

ultralytics/models/rtdetr/val.py

@@ -58,14 +58,11 @@ class RTDETRValidator(DetectionValidator):
     The class allows building of an RTDETR-specific dataset for validation, applies Non-maximum suppression for
     post-processing, and updates evaluation metrics accordingly.
 
-    Example:
-        ```python
-        from ultralytics.models.rtdetr import RTDETRValidator
-
-        args = dict(model="rtdetr-l.pt", data="coco8.yaml")
-        validator = RTDETRValidator(args=args)
-        validator()
-        ```
+    Examples:
+        >>> from ultralytics.models.rtdetr import RTDETRValidator
+        >>> args = dict(model="rtdetr-l.pt", data="coco8.yaml")
+        >>> validator = RTDETRValidator(args=args)
+        >>> validator()
 
     Note:
         For further details on the attributes and methods, refer to the parent DetectionValidator class.

ultralytics/models/yolo/classify/predict.py

@@ -16,15 +16,12 @@ class ClassificationPredictor(BasePredictor):
     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="yolo11n-cls.pt", source=ASSETS)
-        predictor = ClassificationPredictor(overrides=args)
-        predictor.predict_cli()
-        ```
+    Examples:
+        >>> from ultralytics.utils import ASSETS
+        >>> from ultralytics.models.yolo.classify import ClassificationPredictor
+        >>> args = dict(model="yolo11n-cls.pt", source=ASSETS)
+        >>> predictor = ClassificationPredictor(overrides=args)
+        >>> predictor.predict_cli()
     """
 
     def __init__(self, cfg=DEFAULT_CFG, overrides=None, _callbacks=None):

ultralytics/models/yolo/classify/train.py

@@ -20,14 +20,11 @@ class ClassificationTrainer(BaseTrainer):
     Notes:
         - Torchvision classification models can also be passed to the 'model' argument, i.e. model='resnet18'.
 
-    Example:
-        ```python
-        from ultralytics.models.yolo.classify import ClassificationTrainer
-
-        args = dict(model="yolo11n-cls.pt", data="imagenet10", epochs=3)
-        trainer = ClassificationTrainer(overrides=args)
-        trainer.train()
-        ```
+    Examples:
+        >>> from ultralytics.models.yolo.classify import ClassificationTrainer
+        >>> args = dict(model="yolo11n-cls.pt", data="imagenet10", epochs=3)
+        >>> trainer = ClassificationTrainer(overrides=args)
+        >>> trainer.train()
     """
 
     def __init__(self, cfg=DEFAULT_CFG, overrides=None, _callbacks=None):

ultralytics/models/yolo/classify/val.py

@@ -16,14 +16,11 @@ class ClassificationValidator(BaseValidator):
     Notes:
         - Torchvision classification models can also be passed to the 'model' argument, i.e. model='resnet18'.
 
-    Example:
-        ```python
-        from ultralytics.models.yolo.classify import ClassificationValidator
-
-        args = dict(model="yolo11n-cls.pt", data="imagenet10")
-        validator = ClassificationValidator(args=args)
-        validator()
-        ```
+    Examples:
+        >>> from ultralytics.models.yolo.classify import ClassificationValidator
+        >>> args = dict(model="yolo11n-cls.pt", data="imagenet10")
+        >>> validator = ClassificationValidator(args=args)
+        >>> validator()
     """
 
     def __init__(self, dataloader=None, save_dir=None, pbar=None, args=None, _callbacks=None):

ultralytics/models/yolo/detect/predict.py

@@ -9,15 +9,12 @@ class DetectionPredictor(BasePredictor):
     """
     A class extending the BasePredictor class for prediction based on a detection model.
 
-    Example:
-        ```python
-        from ultralytics.utils import ASSETS
-        from ultralytics.models.yolo.detect import DetectionPredictor
-
-        args = dict(model="yolo11n.pt", source=ASSETS)
-        predictor = DetectionPredictor(overrides=args)
-        predictor.predict_cli()
-        ```
+    Examples:
+        >>> from ultralytics.utils import ASSETS
+        >>> from ultralytics.models.yolo.detect import DetectionPredictor
+        >>> args = dict(model="yolo11n.pt", source=ASSETS)
+        >>> predictor = DetectionPredictor(overrides=args)
+        >>> predictor.predict_cli()
     """
 
     def postprocess(self, preds, img, orig_imgs, **kwargs):

ultralytics/models/yolo/detect/train.py

@@ -20,14 +20,11 @@ class DetectionTrainer(BaseTrainer):
     """
     A class extending the BaseTrainer class for training based on a detection model.
 
-    Example:
-        ```python
-        from ultralytics.models.yolo.detect import DetectionTrainer
-
-        args = dict(model="yolo11n.pt", data="coco8.yaml", epochs=3)
-        trainer = DetectionTrainer(overrides=args)
-        trainer.train()
-        ```
+    Examples:
+        >>> from ultralytics.models.yolo.detect import DetectionTrainer
+        >>> args = dict(model="yolo11n.pt", data="coco8.yaml", epochs=3)
+        >>> trainer = DetectionTrainer(overrides=args)
+        >>> trainer.train()
     """
 
     def build_dataset(self, img_path, mode="train", batch=None):

ultralytics/models/yolo/detect/val.py

@@ -18,14 +18,11 @@ class DetectionValidator(BaseValidator):
     """
     A class extending the BaseValidator class for validation based on a detection model.
 
-    Example:
-        ```python
-        from ultralytics.models.yolo.detect import DetectionValidator
-
-        args = dict(model="yolo11n.pt", data="coco8.yaml")
-        validator = DetectionValidator(args=args)
-        validator()
-        ```
+    Examples:
+        >>> from ultralytics.models.yolo.detect import DetectionValidator
+        >>> args = dict(model="yolo11n.pt", data="coco8.yaml")
+        >>> validator = DetectionValidator(args=args)
+        >>> validator()
     """
 
     def __init__(self, dataloader=None, save_dir=None, pbar=None, args=None, _callbacks=None):

ultralytics/models/yolo/obb/predict.py

@@ -11,15 +11,12 @@ class OBBPredictor(DetectionPredictor):
     """
     A class extending the DetectionPredictor class for prediction based on an Oriented Bounding Box (OBB) model.
 
-    Example:
-        ```python
-        from ultralytics.utils import ASSETS
-        from ultralytics.models.yolo.obb import OBBPredictor
-
-        args = dict(model="yolo11n-obb.pt", source=ASSETS)
-        predictor = OBBPredictor(overrides=args)
-        predictor.predict_cli()
-        ```
+    Examples:
+        >>> from ultralytics.utils import ASSETS
+        >>> from ultralytics.models.yolo.obb import OBBPredictor
+        >>> args = dict(model="yolo11n-obb.pt", source=ASSETS)
+        >>> predictor = OBBPredictor(overrides=args)
+        >>> predictor.predict_cli()
     """
 
     def __init__(self, cfg=DEFAULT_CFG, overrides=None, _callbacks=None):