dgenerate-ultralytics-headless 8.3.214__py3-none-any.whl → 8.3.248__py3-none-any.whl

ultralytics/engine/results.py

@@ -21,12 +21,11 @@ from ultralytics.utils.plotting import Annotator, colors, save_one_box
 
 
 class BaseTensor(SimpleClass):
-    """
-    Base tensor class with additional methods for easy manipulation and device handling.
+    """Base tensor class with additional methods for easy manipulation and device handling.
 
-    This class provides a foundation for tensor-like objects with device management capabilities,
-    supporting both PyTorch tensors and NumPy arrays. It includes methods for moving data between
-    devices and converting between tensor types.
+    This class provides a foundation for tensor-like objects with device management capabilities, supporting both
+    PyTorch tensors and NumPy arrays. It includes methods for moving data between devices and converting between tensor
+    types.
 
     Attributes:
         data (torch.Tensor | np.ndarray): Prediction data such as bounding boxes, masks, or keypoints.
@@ -49,18 +48,11 @@ class BaseTensor(SimpleClass):
     """
 
     def __init__(self, data: torch.Tensor | np.ndarray, orig_shape: tuple[int, int]) -> None:
-        """
-        Initialize BaseTensor with prediction data and the original shape of the image.
+        """Initialize BaseTensor with prediction data and the original shape of the image.
 
         Args:
             data (torch.Tensor | np.ndarray): Prediction data such as bounding boxes, masks, or keypoints.
             orig_shape (tuple[int, int]): Original shape of the image in (height, width) format.
-
-        Examples:
-            >>> import torch
-            >>> data = torch.tensor([[1, 2, 3], [4, 5, 6]])
-            >>> orig_shape = (720, 1280)
-            >>> base_tensor = BaseTensor(data, orig_shape)
         """
         assert isinstance(data, (torch.Tensor, np.ndarray)), "data must be torch.Tensor or np.ndarray"
         self.data = data
@@ -68,8 +60,7 @@ class BaseTensor(SimpleClass):
 
     @property
     def shape(self) -> tuple[int, ...]:
-        """
-        Return the shape of the underlying data tensor.
+        """Return the shape of the underlying data tensor.
 
         Returns:
             (tuple[int, ...]): The shape of the data tensor.
@@ -83,8 +74,7 @@ class BaseTensor(SimpleClass):
         return self.data.shape
 
     def cpu(self):
-        """
-        Return a copy of the tensor stored in CPU memory.
+        """Return a copy of the tensor stored in CPU memory.
 
         Returns:
             (BaseTensor): A new BaseTensor object with the data tensor moved to CPU memory.
@@ -101,29 +91,26 @@ class BaseTensor(SimpleClass):
         return self if isinstance(self.data, np.ndarray) else self.__class__(self.data.cpu(), self.orig_shape)
 
     def numpy(self):
-        """
-        Return a copy of the tensor as a numpy array.
+        """Return a copy of this object with its data converted to a NumPy array.
 
         Returns:
-            (np.ndarray): A numpy array containing the same data as the original tensor.
+            (BaseTensor): A new instance with `data` as a NumPy array.
 
         Examples:
             >>> data = torch.tensor([[1, 2, 3], [4, 5, 6]])
             >>> orig_shape = (720, 1280)
             >>> base_tensor = BaseTensor(data, orig_shape)
-            >>> numpy_array = base_tensor.numpy()
-            >>> print(type(numpy_array))
+            >>> numpy_tensor = base_tensor.numpy()
+            >>> print(type(numpy_tensor.data))
             <class 'numpy.ndarray'>
         """
         return self if isinstance(self.data, np.ndarray) else self.__class__(self.data.numpy(), self.orig_shape)
 
     def cuda(self):
-        """
-        Move the tensor to GPU memory.
+        """Move the tensor to GPU memory.
 
         Returns:
-            (BaseTensor): A new BaseTensor instance with the data moved to GPU memory if it's not already a
-                numpy array, otherwise returns self.
+            (BaseTensor): A new BaseTensor instance with the data moved to GPU memory.
 
         Examples:
             >>> import torch
@@ -137,8 +124,7 @@ class BaseTensor(SimpleClass):
         return self.__class__(torch.as_tensor(self.data).cuda(), self.orig_shape)
 
     def to(self, *args, **kwargs):
-        """
-        Return a copy of the tensor with the specified device and dtype.
+        """Return a copy of the tensor with the specified device and dtype.
 
         Args:
             *args (Any): Variable length argument list to be passed to torch.Tensor.to().
@@ -155,8 +141,7 @@ class BaseTensor(SimpleClass):
         return self.__class__(torch.as_tensor(self.data).to(*args, **kwargs), self.orig_shape)
 
     def __len__(self) -> int:
-        """
-        Return the length of the underlying data tensor.
+        """Return the length of the underlying data tensor.
 
         Returns:
             (int): The number of elements in the first dimension of the data tensor.
@@ -170,8 +155,7 @@ class BaseTensor(SimpleClass):
         return len(self.data)
 
     def __getitem__(self, idx):
-        """
-        Return a new BaseTensor instance containing the specified indexed elements of the data tensor.
+        """Return a new BaseTensor instance containing the specified indexed elements of the data tensor.
 
         Args:
             idx (int | list[int] | torch.Tensor): Index or indices to select from the data tensor.
@@ -190,12 +174,11 @@ class BaseTensor(SimpleClass):
 
 
 class Results(SimpleClass, DataExportMixin):
-    """
-    A class for storing and manipulating inference results.
+    """A class for storing and manipulating inference results.
 
-    This class provides comprehensive functionality for handling inference results from various
-    Ultralytics models, including detection, segmentation, classification, and pose estimation.
-    It supports visualization, data export, and various coordinate transformations.
+    This class provides comprehensive functionality for handling inference results from various Ultralytics models,
+    including detection, segmentation, classification, and pose estimation. It supports visualization, data export, and
+    various coordinate transformations.
 
     Attributes:
         orig_img (np.ndarray): The original image as a numpy array.
@@ -217,14 +200,14 @@ class Results(SimpleClass, DataExportMixin):
         cuda: Move all tensors in the Results object to GPU memory.
         to: Move all tensors to the specified device and dtype.
         new: Create a new Results object with the same image, path, names, and speed attributes.
-        plot: Plot detection results on an input RGB image.
+        plot: Plot detection results on an input BGR image.
         show: Display the image with annotated inference results.
         save: Save annotated inference results image to file.
         verbose: Return a log string for each task in the results.
         save_txt: Save detection results to a text file.
         save_crop: Save cropped detection images to specified directory.
         summary: Convert inference results to a summarized dictionary.
-        to_df: Convert detection results to a Polars Dataframe.
+        to_df: Convert detection results to a Polars DataFrame.
         to_json: Convert detection results to JSON format.
         to_csv: Convert detection results to a CSV format.
 
@@ -249,8 +232,7 @@ class Results(SimpleClass, DataExportMixin):
         obb: torch.Tensor | None = None,
         speed: dict[str, float] | None = None,
     ) -> None:
-        """
-        Initialize the Results class for storing and manipulating inference results.
+        """Initialize the Results class for storing and manipulating inference results.
 
         Args:
             orig_img (np.ndarray): The original image as a numpy array.
@@ -263,12 +245,6 @@ class Results(SimpleClass, DataExportMixin):
             obb (torch.Tensor | None): A 2D tensor of oriented bounding box coordinates for each detection.
             speed (dict | None): A dictionary containing preprocess, inference, and postprocess speeds (ms/image).
 
-        Examples:
-            >>> results = model("path/to/image.jpg")
-            >>> result = results[0]  # Get the first result
-            >>> boxes = result.boxes  # Get the boxes for the first result
-            >>> masks = result.masks  # Get the masks for the first result
-
         Notes:
             For the default pose model, keypoint indices for human body pose estimation are:
             0: Nose, 1: Left Eye, 2: Right Eye, 3: Left Ear, 4: Right Ear
@@ -290,8 +266,7 @@ class Results(SimpleClass, DataExportMixin):
         self._keys = "boxes", "masks", "probs", "keypoints", "obb"
 
     def __getitem__(self, idx):
-        """
-        Return a Results object for a specific index of inference results.
+        """Return a Results object for a specific index of inference results.
 
         Args:
             idx (int | slice): Index or slice to retrieve from the Results object.
@@ -307,12 +282,11 @@ class Results(SimpleClass, DataExportMixin):
         return self._apply("__getitem__", idx)
 
     def __len__(self) -> int:
-        """
-        Return the number of detections in the Results object.
+        """Return the number of detections in the Results object.
 
         Returns:
-            (int): The number of detections, determined by the length of the first non-empty
-                attribute in (masks, probs, keypoints, or obb).
+            (int): The number of detections, determined by the length of the first non-empty attribute in (masks, probs,
+                keypoints, or obb).
 
         Examples:
             >>> results = Results(orig_img, path, names, boxes=torch.rand(5, 4))
@@ -332,15 +306,14 @@ class Results(SimpleClass, DataExportMixin):
         obb: torch.Tensor | None = None,
         keypoints: torch.Tensor | None = None,
     ):
-        """
-        Update the Results object with new detection data.
+        """Update the Results object with new detection data.
 
-        This method allows updating the boxes, masks, probabilities, and oriented bounding boxes (OBB) of the
-        Results object. It ensures that boxes are clipped to the original image shape.
+        This method allows updating the boxes, masks, probabilities, and oriented bounding boxes (OBB) of the Results
+        object. It ensures that boxes are clipped to the original image shape.
 
         Args:
-            boxes (torch.Tensor | None): A tensor of shape (N, 6) containing bounding box coordinates and
-                confidence scores. The format is (x1, y1, x2, y2, conf, class).
+            boxes (torch.Tensor | None): A tensor of shape (N, 6) containing bounding box coordinates and confidence
+                scores. The format is (x1, y1, x2, y2, conf, class).
             masks (torch.Tensor | None): A tensor of shape (N, H, W) containing segmentation masks.
             probs (torch.Tensor | None): A tensor of shape (num_classes,) containing class probabilities.
             obb (torch.Tensor | None): A tensor of shape (N, 5) containing oriented bounding box coordinates.
@@ -363,8 +336,7 @@ class Results(SimpleClass, DataExportMixin):
             self.keypoints = Keypoints(keypoints, self.orig_shape)
 
     def _apply(self, fn: str, *args, **kwargs):
-        """
-        Apply a function to all non-empty attributes and return a new Results object with modified attributes.
+        """Apply a function to all non-empty attributes and return a new Results object with modified attributes.
 
         This method is internally called by methods like .to(), .cuda(), .cpu(), etc.
 
@@ -390,8 +362,7 @@ class Results(SimpleClass, DataExportMixin):
         return r
 
     def cpu(self):
-        """
-        Return a copy of the Results object with all its tensors moved to CPU memory.
+        """Return a copy of the Results object with all its tensors moved to CPU memory.
 
         This method creates a new Results object with all tensor attributes (boxes, masks, probs, keypoints, obb)
         transferred to CPU memory. It's useful for moving data from GPU to CPU for further processing or saving.
@@ -407,8 +378,7 @@ class Results(SimpleClass, DataExportMixin):
         return self._apply("cpu")
 
     def numpy(self):
-        """
-        Convert all tensors in the Results object to numpy arrays.
+        """Convert all tensors in the Results object to numpy arrays.
 
         Returns:
             (Results): A new Results object with all tensors converted to numpy arrays.
@@ -426,8 +396,7 @@ class Results(SimpleClass, DataExportMixin):
         return self._apply("numpy")
 
     def cuda(self):
-        """
-        Move all tensors in the Results object to GPU memory.
+        """Move all tensors in the Results object to GPU memory.
 
         Returns:
             (Results): A new Results object with all tensors moved to CUDA device.
@@ -441,8 +410,7 @@ class Results(SimpleClass, DataExportMixin):
         return self._apply("cuda")
 
     def to(self, *args, **kwargs):
-        """
-        Move all tensors in the Results object to the specified device and dtype.
+        """Move all tensors in the Results object to the specified device and dtype.
 
         Args:
             *args (Any): Variable length argument list to be passed to torch.Tensor.to().
@@ -460,8 +428,7 @@ class Results(SimpleClass, DataExportMixin):
         return self._apply("to", *args, **kwargs)
 
     def new(self):
-        """
-        Create a new Results object with the same image, path, names, and speed attributes.
+        """Create a new Results object with the same image, path, names, and speed attributes.
 
         Returns:
             (Results): A new Results object with copied attributes from the original instance.
@@ -493,8 +460,7 @@ class Results(SimpleClass, DataExportMixin):
         color_mode: str = "class",
         txt_color: tuple[int, int, int] = (255, 255, 255),
     ) -> np.ndarray:
-        """
-        Plot detection results on an input RGB image.
+        """Plot detection results on an input BGR image.
 
         Args:
             conf (bool): Whether to plot detection confidence scores.
@@ -514,10 +480,10 @@ class Results(SimpleClass, DataExportMixin):
             save (bool): Whether to save the annotated image.
             filename (str | None): Filename to save image if save is True.
             color_mode (str): Specify the color mode, e.g., 'instance' or 'class'.
-            txt_color (tuple[int, int, int]): Specify the RGB text color for classification task.
+            txt_color (tuple[int, int, int]): Text color in BGR format for classification output.
 
         Returns:
-            (np.ndarray): Annotated image as a numpy array.
+            (np.ndarray | PIL.Image.Image): Annotated image as a NumPy array (BGR) or PIL image (RGB) if `pil=True`.
 
         Examples:
             >>> results = model("image.jpg")
@@ -527,7 +493,7 @@ class Results(SimpleClass, DataExportMixin):
         """
         assert color_mode in {"instance", "class"}, f"Expected color_mode='instance' or 'class', not {color_mode}."
         if img is None and isinstance(self.orig_img, torch.Tensor):
-            img = (self.orig_img[0].detach().permute(1, 2, 0).contiguous() * 255).to(torch.uint8).cpu().numpy()
+            img = (self.orig_img[0].detach().permute(1, 2, 0).contiguous() * 255).byte().cpu().numpy()
 
         names = self.names
         is_obb = self.obb is not None
@@ -610,11 +576,10 @@ class Results(SimpleClass, DataExportMixin):
         if save:
             annotator.save(filename or f"results_{Path(self.path).name}")
 
-        return annotator.im if pil else annotator.result()
+        return annotator.result(pil)
 
     def show(self, *args, **kwargs):
-        """
-        Display the image with annotated inference results.
+        """Display the image with annotated inference results.
 
         This method plots the detection results on the original image and displays it. It's a convenient way to
         visualize the model's predictions directly.
@@ -632,15 +597,14 @@ class Results(SimpleClass, DataExportMixin):
         self.plot(show=True, *args, **kwargs)
 
     def save(self, filename: str | None = None, *args, **kwargs) -> str:
-        """
-        Save annotated inference results image to file.
+        """Save annotated inference results image to file.
 
         This method plots the detection results on the original image and saves the annotated image to a file. It
         utilizes the `plot` method to generate the annotated image and then saves it to the specified filename.
 
         Args:
-            filename (str | Path | None): The filename to save the annotated image. If None, a default filename
-                is generated based on the original image path.
+            filename (str | Path | None): The filename to save the annotated image. If None, a default filename is
+                generated based on the original image path.
             *args (Any): Variable length argument list to be passed to the `plot` method.
             **kwargs (Any): Arbitrary keyword arguments to be passed to the `plot` method.
 
@@ -661,15 +625,14 @@ class Results(SimpleClass, DataExportMixin):
         return filename
 
     def verbose(self) -> str:
-        """
-        Return a log string for each task in the results, detailing detection and classification outcomes.
+        """Return a log string for each task in the results, detailing detection and classification outcomes.
 
         This method generates a human-readable string summarizing the detection and classification results. It includes
         the number of detections for each class and the top probabilities for classification tasks.
 
         Returns:
-            (str): A formatted string containing a summary of the results. For detection tasks, it includes the
-                number of detections per class. For classification tasks, it includes the top 5 class probabilities.
+            (str): A formatted string containing a summary of the results. For detection tasks, it includes the number
+                of detections per class. For classification tasks, it includes the top 5 class probabilities.
 
         Examples:
             >>> results = model("path/to/image.jpg")
@@ -693,8 +656,7 @@ class Results(SimpleClass, DataExportMixin):
             return "".join(f"{n} {self.names[i]}{'s' * (n > 1)}, " for i, n in enumerate(counts) if n > 0)
 
     def save_txt(self, txt_file: str | Path, save_conf: bool = False) -> str:
-        """
-        Save detection results to a text file.
+        """Save detection results to a text file.
 
         Args:
             txt_file (str | Path): Path to the output text file.
@@ -750,8 +712,7 @@ class Results(SimpleClass, DataExportMixin):
         return str(txt_file)
 
     def save_crop(self, save_dir: str | Path, file_name: str | Path = Path("im.jpg")):
-        """
-        Save cropped detection images to specified directory.
+        """Save cropped detection images to specified directory.
 
         This method saves cropped images of detected objects to a specified directory. Each crop is saved in a
         subdirectory named after the object's class, with the filename based on the input file_name.
@@ -760,22 +721,22 @@ class Results(SimpleClass, DataExportMixin):
             save_dir (str | Path): Directory path where cropped images will be saved.
             file_name (str | Path): Base filename for the saved cropped images.
 
+        Examples:
+            >>> results = model("path/to/image.jpg")
+            >>> for result in results:
+            >>>     result.save_crop(save_dir="path/to/crops", file_name="detection")
+
         Notes:
             - This method does not support Classify or Oriented Bounding Box (OBB) tasks.
             - Crops are saved as 'save_dir/class_name/file_name.jpg'.
             - The method will create necessary subdirectories if they don't exist.
             - Original image is copied before cropping to avoid modifying the original.
-
-        Examples:
-            >>> results = model("path/to/image.jpg")
-            >>> for result in results:
-            >>>     result.save_crop(save_dir="path/to/crops", file_name="detection")
         """
         if self.probs is not None:
-            LOGGER.warning("Classify task do not support `save_crop`.")
+            LOGGER.warning("Classify task does not support `save_crop`.")
             return
         if self.obb is not None:
-            LOGGER.warning("OBB task do not support `save_crop`.")
+            LOGGER.warning("OBB task does not support `save_crop`.")
             return
         for d in self.boxes:
             save_one_box(
@@ -786,11 +747,10 @@ class Results(SimpleClass, DataExportMixin):
             )
 
     def summary(self, normalize: bool = False, decimals: int = 5) -> list[dict[str, Any]]:
-        """
-        Convert inference results to a summarized dictionary with optional normalization for box coordinates.
+        """Convert inference results to a summarized dictionary with optional normalization for box coordinates.
 
-        This method creates a list of detection dictionaries, each containing information about a single
-        detection or classification result. For classification tasks, it returns the top class and its
+        This method creates a list of detection dictionaries, each containing information about a single detection or
+        classification result. For classification tasks, it returns the top class and its
         confidence. For detection tasks, it includes class information, bounding box coordinates, and
         optionally mask segments and keypoints.
 
@@ -799,8 +759,8 @@ class Results(SimpleClass, DataExportMixin):
             decimals (int): Number of decimal places to round the output values to.
 
         Returns:
-            (list[dict[str, Any]]): A list of dictionaries, each containing summarized information for a single detection
-                or classification result. The structure of each dictionary varies based on the task type
+            (list[dict[str, Any]]): A list of dictionaries, each containing summarized information for a single
+                detection or classification result. The structure of each dictionary varies based on the task type
                 (classification or detection) and available information (boxes, masks, keypoints).
 
         Examples:
@@ -853,12 +813,11 @@ class Results(SimpleClass, DataExportMixin):
 
 
 class Boxes(BaseTensor):
-    """
-    A class for managing and manipulating detection boxes.
+    """A class for managing and manipulating detection boxes.
 
     This class provides comprehensive functionality for handling detection boxes, including their coordinates,
-    confidence scores, class labels, and optional tracking IDs. It supports various box formats and offers
-    methods for easy manipulation and conversion between different coordinate systems.
+    confidence scores, class labels, and optional tracking IDs. It supports various box formats and offers methods for
+    easy manipulation and conversion between different coordinate systems.
 
     Attributes:
         data (torch.Tensor | np.ndarray): The raw tensor containing detection boxes and associated data.
@@ -890,31 +849,16 @@ class Boxes(BaseTensor):
     """
 
     def __init__(self, boxes: torch.Tensor | np.ndarray, orig_shape: tuple[int, int]) -> None:
-        """
-        Initialize the Boxes class with detection box data and the original image shape.
+        """Initialize the Boxes class with detection box data and the original image shape.
 
-        This class manages detection boxes, providing easy access and manipulation of box coordinates,
-        confidence scores, class identifiers, and optional tracking IDs. It supports multiple formats
-        for box coordinates, including both absolute and normalized forms.
+        This class manages detection boxes, providing easy access and manipulation of box coordinates, confidence
+        scores, class identifiers, and optional tracking IDs. It supports multiple formats for box coordinates,
+        including both absolute and normalized forms.
 
         Args:
-            boxes (torch.Tensor | np.ndarray): A tensor or numpy array with detection boxes of shape
-                (num_boxes, 6) or (num_boxes, 7). Columns should contain
-                [x1, y1, x2, y2, (optional) track_id, confidence, class].
+            boxes (torch.Tensor | np.ndarray): A tensor or numpy array with detection boxes of shape (num_boxes, 6) or
+                (num_boxes, 7). Columns should contain [x1, y1, x2, y2, (optional) track_id, confidence, class].
             orig_shape (tuple[int, int]): The original image shape as (height, width). Used for normalization.
-
-        Attributes:
-            data (torch.Tensor): The raw tensor containing detection boxes and their associated data.
-            orig_shape (tuple[int, int]): The original image size, used for normalization.
-            is_track (bool): Indicates whether tracking IDs are included in the box data.
-
-        Examples:
-            >>> import torch
-            >>> boxes = torch.tensor([[100, 50, 150, 100, 0.9, 0]])
-            >>> orig_shape = (480, 640)
-            >>> detection_boxes = Boxes(boxes, orig_shape)
-            >>> print(detection_boxes.xyxy)
-            tensor([[100.,  50., 150., 100.]])
         """
         if boxes.ndim == 1:
             boxes = boxes[None, :]
@@ -926,12 +870,11 @@ class Boxes(BaseTensor):
 
     @property
     def xyxy(self) -> torch.Tensor | np.ndarray:
-        """
-        Return bounding boxes in [x1, y1, x2, y2] format.
+        """Return bounding boxes in [x1, y1, x2, y2] format.
 
         Returns:
-            (torch.Tensor | np.ndarray): A tensor or numpy array of shape (n, 4) containing bounding box
-                coordinates in [x1, y1, x2, y2] format, where n is the number of boxes.
+            (torch.Tensor | np.ndarray): A tensor or numpy array of shape (n, 4) containing bounding box coordinates in
+                [x1, y1, x2, y2] format, where n is the number of boxes.
 
         Examples:
             >>> results = model("image.jpg")
@@ -943,12 +886,11 @@ class Boxes(BaseTensor):
 
     @property
     def conf(self) -> torch.Tensor | np.ndarray:
-        """
-        Return the confidence scores for each detection box.
+        """Return the confidence scores for each detection box.
 
         Returns:
-            (torch.Tensor | np.ndarray): A 1D tensor or array containing confidence scores for each detection,
-                with shape (N,) where N is the number of detections.
+            (torch.Tensor | np.ndarray): A 1D tensor or array containing confidence scores for each detection, with
+                shape (N,) where N is the number of detections.
 
         Examples:
             >>> boxes = Boxes(torch.tensor([[10, 20, 30, 40, 0.9, 0]]), orig_shape=(100, 100))
@@ -960,12 +902,11 @@ class Boxes(BaseTensor):
 
     @property
     def cls(self) -> torch.Tensor | np.ndarray:
-        """
-        Return the class ID tensor representing category predictions for each bounding box.
+        """Return the class ID tensor representing category predictions for each bounding box.
 
         Returns:
-            (torch.Tensor | np.ndarray): A tensor or numpy array containing the class IDs for each detection box.
-                The shape is (N,), where N is the number of boxes.
+            (torch.Tensor | np.ndarray): A tensor or numpy array containing the class IDs for each detection box. The
+                shape is (N,), where N is the number of boxes.
 
         Examples:
             >>> results = model("image.jpg")
@@ -977,12 +918,11 @@ class Boxes(BaseTensor):
 
     @property
     def id(self) -> torch.Tensor | np.ndarray | None:
-        """
-        Return the tracking IDs for each detection box if available.
+        """Return the tracking IDs for each detection box if available.
 
         Returns:
-            (torch.Tensor | None): A tensor containing tracking IDs for each box if tracking is enabled,
-                otherwise None. Shape is (N,) where N is the number of boxes.
+            (torch.Tensor | None): A tensor containing tracking IDs for each box if tracking is enabled, otherwise None.
+                Shape is (N,) where N is the number of boxes.
 
         Examples:
             >>> results = model.track("path/to/video.mp4")
@@ -1003,36 +943,33 @@ class Boxes(BaseTensor):
     @property
     @lru_cache(maxsize=2)
     def xywh(self) -> torch.Tensor | np.ndarray:
-        """
-        Convert bounding boxes from [x1, y1, x2, y2] format to [x, y, width, height] format.
+        """Convert bounding boxes from [x1, y1, x2, y2] format to [x, y, width, height] format.
 
         Returns:
-            (torch.Tensor | np.ndarray): Boxes in [x_center, y_center, width, height] format, where x_center,
-                y_center are the coordinates of the center point of the bounding box, width, height are the
-                dimensions of the bounding box and the shape of the returned tensor is (N, 4), where N is the
-                number of boxes.
+            (torch.Tensor | np.ndarray): Boxes in [x_center, y_center, width, height] format, where x_center, y_center
+                are the coordinates of the center point of the bounding box, width, height are the dimensions of the
+                bounding box and the shape of the returned tensor is (N, 4), where N is the number of boxes.
 
         Examples:
             >>> boxes = Boxes(torch.tensor([[100, 50, 150, 100], [200, 150, 300, 250]]), orig_shape=(480, 640))
             >>> xywh = boxes.xywh
             >>> print(xywh)
-            tensor([[100.0000,  50.0000,  50.0000,  50.0000],
-                    [200.0000, 150.0000, 100.0000, 100.0000]])
+            tensor([[125.0000,  75.0000,  50.0000,  50.0000],
+                    [250.0000, 200.0000, 100.0000, 100.0000]])
         """
         return ops.xyxy2xywh(self.xyxy)
 
     @property
     @lru_cache(maxsize=2)
     def xyxyn(self) -> torch.Tensor | np.ndarray:
-        """
-        Return normalized bounding box coordinates relative to the original image size.
+        """Return normalized bounding box coordinates relative to the original image size.
 
-        This property calculates and returns the bounding box coordinates in [x1, y1, x2, y2] format,
-        normalized to the range [0, 1] based on the original image dimensions.
+        This property calculates and returns the bounding box coordinates in [x1, y1, x2, y2] format, normalized to the
+        range [0, 1] based on the original image dimensions.
 
         Returns:
-            (torch.Tensor | np.ndarray): Normalized bounding box coordinates with shape (N, 4), where N is
-                the number of boxes. Each row contains [x1, y1, x2, y2] values normalized to [0, 1].
+            (torch.Tensor | np.ndarray): Normalized bounding box coordinates with shape (N, 4), where N is the number of
+                boxes. Each row contains [x1, y1, x2, y2] values normalized to [0, 1].
 
         Examples:
             >>> boxes = Boxes(torch.tensor([[100, 50, 300, 400, 0.9, 0]]), orig_shape=(480, 640))
@@ -1048,16 +985,15 @@ class Boxes(BaseTensor):
     @property
     @lru_cache(maxsize=2)
     def xywhn(self) -> torch.Tensor | np.ndarray:
-        """
-        Return normalized bounding boxes in [x, y, width, height] format.
+        """Return normalized bounding boxes in [x, y, width, height] format.
 
-        This property calculates and returns the normalized bounding box coordinates in the format
-        [x_center, y_center, width, height], where all values are relative to the original image dimensions.
+        This property calculates and returns the normalized bounding box coordinates in the format [x_center, y_center,
+        width, height], where all values are relative to the original image dimensions.
 
         Returns:
-            (torch.Tensor | np.ndarray): Normalized bounding boxes with shape (N, 4), where N is the
-                number of boxes. Each row contains [x_center, y_center, width, height] values normalized
-                to [0, 1] based on the original image dimensions.
+            (torch.Tensor | np.ndarray): Normalized bounding boxes with shape (N, 4), where N is the number of boxes.
+                Each row contains [x_center, y_center, width, height] values normalized to [0, 1] based on the original
+                image dimensions.
 
         Examples:
             >>> boxes = Boxes(torch.tensor([[100, 50, 150, 100, 0.9, 0]]), orig_shape=(480, 640))
@@ -1072,11 +1008,10 @@ class Boxes(BaseTensor):
 
 
 class Masks(BaseTensor):
-    """
-    A class for storing and manipulating detection masks.
+    """A class for storing and manipulating detection masks.
 
-    This class extends BaseTensor and provides functionality for handling segmentation masks,
-    including methods for converting between pixel and normalized coordinates.
+    This class extends BaseTensor and provides functionality for handling segmentation masks, including methods for
+    converting between pixel and normalized coordinates.
 
     Attributes:
         data (torch.Tensor | np.ndarray): The raw tensor or array containing mask data.
@@ -1099,19 +1034,11 @@ class Masks(BaseTensor):
     """
 
     def __init__(self, masks: torch.Tensor | np.ndarray, orig_shape: tuple[int, int]) -> None:
-        """
-        Initialize the Masks class with detection mask data and the original image shape.
+        """Initialize the Masks class with detection mask data and the original image shape.
 
         Args:
             masks (torch.Tensor | np.ndarray): Detection masks with shape (num_masks, height, width).
             orig_shape (tuple): The original image shape as (height, width). Used for normalization.
-
-        Examples:
-            >>> import torch
-            >>> from ultralytics.engine.results import Masks
-            >>> masks = torch.rand(10, 160, 160)  # 10 masks of 160x160 resolution
-            >>> orig_shape = (720, 1280)  # Original image shape
-            >>> mask_obj = Masks(masks, orig_shape)
         """
         if masks.ndim == 2:
             masks = masks[None, :]
@@ -1120,15 +1047,14 @@ class Masks(BaseTensor):
     @property
     @lru_cache(maxsize=1)
     def xyn(self) -> list[np.ndarray]:
-        """
-        Return normalized xy-coordinates of the segmentation masks.
+        """Return normalized xy-coordinates of the segmentation masks.
 
-        This property calculates and caches the normalized xy-coordinates of the segmentation masks. The coordinates
-        are normalized relative to the original image shape.
+        This property calculates and caches the normalized xy-coordinates of the segmentation masks. The coordinates are
+        normalized relative to the original image shape.
 
         Returns:
-            (list[np.ndarray]): A list of numpy arrays, where each array contains the normalized xy-coordinates
-                of a single segmentation mask. Each array has shape (N, 2), where N is the number of points in the
+            (list[np.ndarray]): A list of numpy arrays, where each array contains the normalized xy-coordinates of a
+                single segmentation mask. Each array has shape (N, 2), where N is the number of points in the
                 mask contour.
 
         Examples:
@@ -1145,16 +1071,14 @@ class Masks(BaseTensor):
     @property
     @lru_cache(maxsize=1)
     def xy(self) -> list[np.ndarray]:
-        """
-        Return the [x, y] pixel coordinates for each segment in the mask tensor.
+        """Return the [x, y] pixel coordinates for each segment in the mask tensor.
 
-        This property calculates and returns a list of pixel coordinates for each segmentation mask in the
-        Masks object. The coordinates are scaled to match the original image dimensions.
+        This property calculates and returns a list of pixel coordinates for each segmentation mask in the Masks object.
+        The coordinates are scaled to match the original image dimensions.
 
         Returns:
-            (list[np.ndarray]): A list of numpy arrays, where each array contains the [x, y] pixel
-                coordinates for a single segmentation mask. Each array has shape (N, 2), where N is the
-                number of points in the segment.
+            (list[np.ndarray]): A list of numpy arrays, where each array contains the [x, y] pixel coordinates for a
+                single segmentation mask. Each array has shape (N, 2), where N is the number of points in the segment.
 
         Examples:
             >>> results = model("image.jpg")
@@ -1170,12 +1094,10 @@ class Masks(BaseTensor):
 
 
 class Keypoints(BaseTensor):
-    """
-    A class for storing and manipulating detection keypoints.
+    """A class for storing and manipulating detection keypoints.
 
-    This class encapsulates functionality for handling keypoint data, including coordinate manipulation,
-    normalization, and confidence values. It supports keypoint detection results with optional visibility
-    information.
+    This class encapsulates functionality for handling keypoint data, including coordinate manipulation, normalization,
+    and confidence values. It supports keypoint detection results with optional visibility information.
 
     Attributes:
         data (torch.Tensor): The raw tensor containing keypoint data.
@@ -1203,22 +1125,16 @@ class Keypoints(BaseTensor):
     """
 
     def __init__(self, keypoints: torch.Tensor | np.ndarray, orig_shape: tuple[int, int]) -> None:
-        """
-        Initialize the Keypoints object with detection keypoints and original image dimensions.
+        """Initialize the Keypoints object with detection keypoints and original image dimensions.
 
-        This method processes the input keypoints tensor, handling both 2D and 3D formats. For 3D tensors
-        (x, y, confidence), it masks out low-confidence keypoints by setting their coordinates to zero.
+        This method processes the input keypoints tensor, handling both 2D and 3D formats. For 3D tensors (x, y,
+        confidence), it masks out low-confidence keypoints by setting their coordinates to zero.
 
         Args:
             keypoints (torch.Tensor): A tensor containing keypoint data. Shape can be either:
                 - (num_objects, num_keypoints, 2) for x, y coordinates only
                 - (num_objects, num_keypoints, 3) for x, y coordinates and confidence scores
             orig_shape (tuple[int, int]): The original image dimensions (height, width).
-
-        Examples:
-            >>> kpts = torch.rand(1, 17, 3)  # 1 object, 17 keypoints (COCO format), x,y,conf
-            >>> orig_shape = (720, 1280)  # Original image height, width
-            >>> keypoints = Keypoints(kpts, orig_shape)
         """
         if keypoints.ndim == 2:
             keypoints = keypoints[None, :]
@@ -1228,12 +1144,11 @@ class Keypoints(BaseTensor):
     @property
     @lru_cache(maxsize=1)
     def xy(self) -> torch.Tensor | np.ndarray:
-        """
-        Return x, y coordinates of keypoints.
+        """Return x, y coordinates of keypoints.
 
         Returns:
-            (torch.Tensor): A tensor containing the x, y coordinates of keypoints with shape (N, K, 2), where N is
-                the number of detections and K is the number of keypoints per detection.
+            (torch.Tensor): A tensor containing the x, y coordinates of keypoints with shape (N, K, 2), where N is the
+                number of detections and K is the number of keypoints per detection.
 
         Examples:
             >>> results = model("image.jpg")
@@ -1252,13 +1167,12 @@ class Keypoints(BaseTensor):
     @property
     @lru_cache(maxsize=1)
     def xyn(self) -> torch.Tensor | np.ndarray:
-        """
-        Return normalized coordinates (x, y) of keypoints relative to the original image size.
+        """Return normalized coordinates (x, y) of keypoints relative to the original image size.
 
         Returns:
             (torch.Tensor | np.ndarray): A tensor or array of shape (N, K, 2) containing normalized keypoint
-                coordinates, where N is the number of instances, K is the number of keypoints, and the last
-                dimension contains [x, y] values in the range [0, 1].
+                coordinates, where N is the number of instances, K is the number of keypoints, and the last dimension
+                contains [x, y] values in the range [0, 1].
 
         Examples:
             >>> keypoints = Keypoints(torch.rand(1, 17, 2), orig_shape=(480, 640))
@@ -1274,13 +1188,11 @@ class Keypoints(BaseTensor):
     @property
     @lru_cache(maxsize=1)
     def conf(self) -> torch.Tensor | np.ndarray | None:
-        """
-        Return confidence values for each keypoint.
+        """Return confidence values for each keypoint.
 
         Returns:
-            (torch.Tensor | None): A tensor containing confidence scores for each keypoint if available,
-                otherwise None. Shape is (num_detections, num_keypoints) for batched data or (num_keypoints,)
-                for single detection.
+            (torch.Tensor | None): A tensor containing confidence scores for each keypoint if available, otherwise None.
+                Shape is (num_detections, num_keypoints) for batched data or (num_keypoints,) for single detection.
 
         Examples:
             >>> keypoints = Keypoints(torch.rand(1, 17, 3), orig_shape=(640, 640))  # 1 detection, 17 keypoints
@@ -1291,11 +1203,10 @@ class Keypoints(BaseTensor):
 
 
 class Probs(BaseTensor):
-    """
-    A class for storing and manipulating classification probabilities.
+    """A class for storing and manipulating classification probabilities.
 
-    This class extends BaseTensor and provides methods for accessing and manipulating
-    classification probabilities, including top-1 and top-5 predictions.
+    This class extends BaseTensor and provides methods for accessing and manipulating classification probabilities,
+    including top-1 and top-5 predictions.
 
     Attributes:
         data (torch.Tensor | np.ndarray): The raw tensor or array containing classification probabilities.
@@ -1325,42 +1236,22 @@ class Probs(BaseTensor):
     """
 
     def __init__(self, probs: torch.Tensor | np.ndarray, orig_shape: tuple[int, int] | None = None) -> None:
-        """
-        Initialize the Probs class with classification probabilities.
+        """Initialize the Probs class with classification probabilities.
 
         This class stores and manages classification probabilities, providing easy access to top predictions and their
         confidences.
 
         Args:
             probs (torch.Tensor | np.ndarray): A 1D tensor or array of classification probabilities.
-            orig_shape (tuple | None): The original image shape as (height, width). Not used in this class but kept
-                for consistency with other result classes.
-
-        Attributes:
-            data (torch.Tensor | np.ndarray): The raw tensor or array containing classification probabilities.
-            top1 (int): Index of the top 1 class.
-            top5 (list[int]): Indices of the top 5 classes.
-            top1conf (torch.Tensor | np.ndarray): Confidence of the top 1 class.
-            top5conf (torch.Tensor | np.ndarray): Confidences of the top 5 classes.
-
-        Examples:
-            >>> import torch
-            >>> probs = torch.tensor([0.1, 0.3, 0.2, 0.4])
-            >>> p = Probs(probs)
-            >>> print(p.top1)
-            3
-            >>> print(p.top1conf)
-            tensor(0.4000)
-            >>> print(p.top5)
-            [3, 1, 2, 0]
+            orig_shape (tuple | None): The original image shape as (height, width). Not used in this class but kept for
+                consistency with other result classes.
         """
         super().__init__(probs, orig_shape)
 
     @property
     @lru_cache(maxsize=1)
     def top1(self) -> int:
-        """
-        Return the index of the class with the highest probability.
+        """Return the index of the class with the highest probability.
 
         Returns:
             (int): Index of the class with the highest probability.
@@ -1375,8 +1266,7 @@ class Probs(BaseTensor):
     @property
     @lru_cache(maxsize=1)
     def top5(self) -> list[int]:
-        """
-        Return the indices of the top 5 class probabilities.
+        """Return the indices of the top 5 class probabilities.
 
         Returns:
             (list[int]): A list containing the indices of the top 5 class probabilities, sorted in descending order.
@@ -1391,8 +1281,7 @@ class Probs(BaseTensor):
     @property
     @lru_cache(maxsize=1)
     def top1conf(self) -> torch.Tensor | np.ndarray:
-        """
-        Return the confidence score of the highest probability class.
+        """Return the confidence score of the highest probability class.
 
         This property retrieves the confidence score (probability) of the class with the highest predicted probability
         from the classification results.
@@ -1411,16 +1300,15 @@ class Probs(BaseTensor):
     @property
     @lru_cache(maxsize=1)
     def top5conf(self) -> torch.Tensor | np.ndarray:
-        """
-        Return confidence scores for the top 5 classification predictions.
+        """Return confidence scores for the top 5 classification predictions.
 
-        This property retrieves the confidence scores corresponding to the top 5 class probabilities
-        predicted by the model. It provides a quick way to access the most likely class predictions
-        along with their associated confidence levels.
+        This property retrieves the confidence scores corresponding to the top 5 class probabilities predicted by the
+        model. It provides a quick way to access the most likely class predictions along with their associated
+        confidence levels.
 
         Returns:
-            (torch.Tensor | np.ndarray): A tensor or array containing the confidence scores for the
-                top 5 predicted classes, sorted in descending order of probability.
+            (torch.Tensor | np.ndarray): A tensor or array containing the confidence scores for the top 5 predicted
+                classes, sorted in descending order of probability.
 
         Examples:
             >>> results = model("image.jpg")
@@ -1432,12 +1320,10 @@ class Probs(BaseTensor):
 
 
 class OBB(BaseTensor):
-    """
-    A class for storing and manipulating Oriented Bounding Boxes (OBB).
+    """A class for storing and manipulating Oriented Bounding Boxes (OBB).
 
-    This class provides functionality to handle oriented bounding boxes, including conversion between
-    different formats, normalization, and access to various properties of the boxes. It supports
-    both tracking and non-tracking scenarios.
+    This class provides functionality to handle oriented bounding boxes, including conversion between different formats,
+    normalization, and access to various properties of the boxes. It supports both tracking and non-tracking scenarios.
 
     Attributes:
         data (torch.Tensor): The raw OBB tensor containing box coordinates and associated data.
@@ -1466,32 +1352,19 @@ class OBB(BaseTensor):
     """
 
     def __init__(self, boxes: torch.Tensor | np.ndarray, orig_shape: tuple[int, int]) -> None:
-        """
-        Initialize an OBB (Oriented Bounding Box) instance with oriented bounding box data and original image shape.
+        """Initialize an OBB (Oriented Bounding Box) instance with oriented bounding box data and original image shape.
 
-        This class stores and manipulates Oriented Bounding Boxes (OBB) for object detection tasks. It provides
-        various properties and methods to access and transform the OBB data.
+        This class stores and manipulates Oriented Bounding Boxes (OBB) for object detection tasks. It provides various
+        properties and methods to access and transform the OBB data.
 
         Args:
-            boxes (torch.Tensor | np.ndarray): A tensor or numpy array containing the detection boxes,
-                with shape (num_boxes, 7) or (num_boxes, 8). The last two columns contain confidence and class values.
-                If present, the third last column contains track IDs, and the fifth column contains rotation.
+            boxes (torch.Tensor | np.ndarray): A tensor or numpy array containing the detection boxes, with shape
+                (num_boxes, 7) or (num_boxes, 8). The last two columns contain confidence and class values. If present,
+                the third last column contains track IDs, and the fifth column contains rotation.
             orig_shape (tuple[int, int]): Original image size, in the format (height, width).
 
-        Attributes:
-            data (torch.Tensor | np.ndarray): The raw OBB tensor.
-            orig_shape (tuple[int, int]): The original image shape.
-            is_track (bool): Whether the boxes include tracking IDs.
-
         Raises:
             AssertionError: If the number of values per box is not 7 or 8.
-
-        Examples:
-            >>> import torch
-            >>> boxes = torch.rand(3, 7)  # 3 boxes with 7 values each
-            >>> orig_shape = (640, 480)
-            >>> obb = OBB(boxes, orig_shape)
-            >>> print(obb.xywhr)  # Access the boxes in xywhr format
         """
         if boxes.ndim == 1:
             boxes = boxes[None, :]
@@ -1503,8 +1376,7 @@ class OBB(BaseTensor):
 
     @property
     def xywhr(self) -> torch.Tensor | np.ndarray:
-        """
-        Return boxes in [x_center, y_center, width, height, rotation] format.
+        """Return boxes in [x_center, y_center, width, height, rotation] format.
 
         Returns:
             (torch.Tensor | np.ndarray): A tensor or numpy array containing the oriented bounding boxes with format
@@ -1521,15 +1393,14 @@ class OBB(BaseTensor):
 
     @property
     def conf(self) -> torch.Tensor | np.ndarray:
-        """
-        Return the confidence scores for Oriented Bounding Boxes (OBBs).
+        """Return the confidence scores for Oriented Bounding Boxes (OBBs).
 
         This property retrieves the confidence values associated with each OBB detection. The confidence score
         represents the model's certainty in the detection.
 
         Returns:
-            (torch.Tensor | np.ndarray): A tensor or numpy array of shape (N,) containing confidence scores
-                for N detections, where each score is in the range [0, 1].
+            (torch.Tensor | np.ndarray): A tensor or numpy array of shape (N,) containing confidence scores for N
+                detections, where each score is in the range [0, 1].
 
         Examples:
             >>> results = model("image.jpg")
@@ -1541,12 +1412,11 @@ class OBB(BaseTensor):
 
     @property
     def cls(self) -> torch.Tensor | np.ndarray:
-        """
-        Return the class values of the oriented bounding boxes.
+        """Return the class values of the oriented bounding boxes.
 
         Returns:
-            (torch.Tensor | np.ndarray): A tensor or numpy array containing the class values for each oriented
-                bounding box. The shape is (N,), where N is the number of boxes.
+            (torch.Tensor | np.ndarray): A tensor or numpy array containing the class values for each oriented bounding
+                box. The shape is (N,), where N is the number of boxes.
 
         Examples:
             >>> results = model("image.jpg")
@@ -1559,12 +1429,11 @@ class OBB(BaseTensor):
 
     @property
     def id(self) -> torch.Tensor | np.ndarray | None:
-        """
-        Return the tracking IDs of the oriented bounding boxes (if available).
+        """Return the tracking IDs of the oriented bounding boxes (if available).
 
         Returns:
-            (torch.Tensor | np.ndarray | None): A tensor or numpy array containing the tracking IDs for each
-                oriented bounding box. Returns None if tracking IDs are not available.
+            (torch.Tensor | np.ndarray | None): A tensor or numpy array containing the tracking IDs for each oriented
+                bounding box. Returns None if tracking IDs are not available.
 
         Examples:
             >>> results = model("image.jpg", tracker=True)  # Run inference with tracking
@@ -1579,12 +1448,11 @@ class OBB(BaseTensor):
     @property
     @lru_cache(maxsize=2)
     def xyxyxyxy(self) -> torch.Tensor | np.ndarray:
-        """
-        Convert OBB format to 8-point (xyxyxyxy) coordinate format for rotated bounding boxes.
+        """Convert OBB format to 8-point (xyxyxyxy) coordinate format for rotated bounding boxes.
 
         Returns:
-            (torch.Tensor | np.ndarray): Rotated bounding boxes in xyxyxyxy format with shape (N, 4, 2), where N is
-                the number of boxes. Each box is represented by 4 points (x, y), starting from the top-left corner and
+            (torch.Tensor | np.ndarray): Rotated bounding boxes in xyxyxyxy format with shape (N, 4, 2), where N is the
+                number of boxes. Each box is represented by 4 points (x, y), starting from the top-left corner and
                 moving clockwise.
 
         Examples:
@@ -1598,13 +1466,12 @@ class OBB(BaseTensor):
     @property
     @lru_cache(maxsize=2)
     def xyxyxyxyn(self) -> torch.Tensor | np.ndarray:
-        """
-        Convert rotated bounding boxes to normalized xyxyxyxy format.
+        """Convert rotated bounding boxes to normalized xyxyxyxy format.
 
         Returns:
             (torch.Tensor | np.ndarray): Normalized rotated bounding boxes in xyxyxyxy format with shape (N, 4, 2),
-                where N is the number of boxes. Each box is represented by 4 points (x, y), normalized relative to
-                the original image dimensions.
+                where N is the number of boxes. Each box is represented by 4 points (x, y), normalized relative to the
+                original image dimensions.
 
         Examples:
             >>> obb = OBB(torch.rand(10, 7), orig_shape=(640, 480))  # 10 random OBBs
@@ -1620,16 +1487,15 @@ class OBB(BaseTensor):
     @property
     @lru_cache(maxsize=2)
     def xyxy(self) -> torch.Tensor | np.ndarray:
-        """
-        Convert oriented bounding boxes (OBB) to axis-aligned bounding boxes in xyxy format.
+        """Convert oriented bounding boxes (OBB) to axis-aligned bounding boxes in xyxy format.
 
-        This property calculates the minimal enclosing rectangle for each oriented bounding box and returns it in
-        xyxy format (x1, y1, x2, y2). This is useful for operations that require axis-aligned bounding boxes, such
-        as IoU calculation with non-rotated boxes.
+        This property calculates the minimal enclosing rectangle for each oriented bounding box and returns it in xyxy
+        format (x1, y1, x2, y2). This is useful for operations that require axis-aligned bounding boxes, such as IoU
+        calculation with non-rotated boxes.
 
         Returns:
-            (torch.Tensor | np.ndarray): Axis-aligned bounding boxes in xyxy format with shape (N, 4), where N
-                is the number of boxes. Each row contains [x1, y1, x2, y2] coordinates.
+            (torch.Tensor | np.ndarray): Axis-aligned bounding boxes in xyxy format with shape (N, 4), where N is the
+                number of boxes. Each row contains [x1, y1, x2, y2] coordinates.
 
         Examples:
             >>> import torch