ultralytics 8.2.80__py3-none-any.whl → 8.2.82__py3-none-any.whl

tests/test_solutions.py

@@ -13,7 +13,6 @@ WORKOUTS_SOLUTION_DEMO = "https://github.com/ultralytics/assets/releases/downloa
 @pytest.mark.slow
 def test_major_solutions():
     """Test the object counting, heatmap, speed estimation and queue management solution."""
-
     safe_download(url=MAJOR_SOLUTIONS_DEMO)
     model = YOLO("yolov8n.pt")
     names = model.names
@@ -41,7 +40,6 @@ def test_major_solutions():
 @pytest.mark.slow
 def test_aigym():
     """Test the workouts monitoring solution."""
-
     safe_download(url=WORKOUTS_SOLUTION_DEMO)
     model = YOLO("yolov8n-pose.pt")
     cap = cv2.VideoCapture("solution_ci_pose_demo.mp4")
@@ -60,7 +58,6 @@ def test_aigym():
 @pytest.mark.slow
 def test_instance_segmentation():
     """Test the instance segmentation solution."""
-
     from ultralytics.utils.plotting import Annotator, colors
 
     model = YOLO("yolov8n-seg.pt")
@@ -86,5 +83,4 @@ def test_instance_segmentation():
 @pytest.mark.slow
 def test_streamlit_predict():
     """Test streamlit predict live inference solution."""
-
     solutions.inference()

ultralytics/__init__.py

@@ -1,6 +1,6 @@
 # Ultralytics YOLO 🚀, AGPL-3.0 license
 
-__version__ = "8.2.80"
+__version__ = "8.2.82"
 
 import os
 

ultralytics/cfg/__init__.py

@@ -198,15 +198,15 @@ def cfg2dict(cfg):
 
     Examples:
         Convert a YAML file path to a dictionary:
-        >>> config_dict = cfg2dict('config.yaml')
+        >>> config_dict = cfg2dict("config.yaml")
 
         Convert a SimpleNamespace to a dictionary:
         >>> from types import SimpleNamespace
-        >>> config_sn = SimpleNamespace(param1='value1', param2='value2')
+        >>> config_sn = SimpleNamespace(param1="value1", param2="value2")
         >>> config_dict = cfg2dict(config_sn)
 
         Pass through an already existing dictionary:
-        >>> config_dict = cfg2dict({'param1': 'value1', 'param2': 'value2'})
+        >>> config_dict = cfg2dict({"param1": "value1", "param2": "value2"})
 
     Notes:
         - If cfg is a path or string, it's loaded as YAML and converted to a dictionary.
@@ -235,7 +235,7 @@ def get_cfg(cfg: Union[str, Path, Dict, SimpleNamespace] = DEFAULT_CFG_DICT, ove
     Examples:
         >>> from ultralytics.cfg import get_cfg
         >>> config = get_cfg()  # Load default configuration
-        >>> config = get_cfg('path/to/config.yaml', overrides={'epochs': 50, 'batch_size': 16})
+        >>> config = get_cfg("path/to/config.yaml", overrides={"epochs": 50, "batch_size": 16})
 
     Notes:
         - If both `cfg` and `overrides` are provided, the values in `overrides` will take precedence.
@@ -282,10 +282,10 @@ def check_cfg(cfg, hard=True):
 
     Examples:
         >>> config = {
-        ...     'epochs': 50,     # valid integer
-        ...     'lr0': 0.01,      # valid float
-        ...     'momentum': 1.2,  # invalid float (out of 0.0-1.0 range)
-        ...     'save': 'true',   # invalid bool
+        ...     "epochs": 50,  # valid integer
+        ...     "lr0": 0.01,  # valid float
+        ...     "momentum": 1.2,  # invalid float (out of 0.0-1.0 range)
+        ...     "save": "true",  # invalid bool
         ... }
         >>> check_cfg(config, hard=False)
         >>> print(config)
@@ -345,12 +345,11 @@ def get_save_dir(args, name=None):
 
     Examples:
         >>> from types import SimpleNamespace
-        >>> args = SimpleNamespace(project='my_project', task='detect', mode='train', exist_ok=True)
+        >>> args = SimpleNamespace(project="my_project", task="detect", mode="train", exist_ok=True)
         >>> save_dir = get_save_dir(args)
         >>> print(save_dir)
         my_project/detect/train
     """
-
     if getattr(args, "save_dir", None):
         save_dir = args.save_dir
     else:
@@ -381,7 +380,6 @@ def _handle_deprecation(custom):
         equivalents. It also handles value conversions where necessary, such as inverting boolean values for
         'hide_labels' and 'hide_conf'.
     """
-
     for key in custom.copy().keys():
         if key == "boxes":
             deprecation_warn(key, "show_boxes")
@@ -413,8 +411,8 @@ def check_dict_alignment(base: Dict, custom: Dict, e=None):
         SystemExit: If mismatched keys are found between the custom and base dictionaries.
 
     Examples:
-        >>> base_cfg = {'epochs': 50, 'lr0': 0.01, 'batch_size': 16}
-        >>> custom_cfg = {'epoch': 100, 'lr': 0.02, 'batch_size': 32}
+        >>> base_cfg = {"epochs": 50, "lr0": 0.01, "batch_size": 16}
+        >>> custom_cfg = {"epoch": 100, "lr": 0.02, "batch_size": 32}
         >>> try:
         ...     check_dict_alignment(base_cfg, custom_cfg)
         ... except SystemExit:
@@ -548,9 +546,9 @@ def handle_yolo_settings(args: List[str]) -> None:
 
 def handle_explorer(args: List[str]):
     """
-    This function launches a graphical user interface that provides tools for interacting with and analyzing datasets
-    using the Ultralytics Explorer API. It checks for the required 'streamlit' package and informs the user that the
-    Explorer dashboard is loading.
+    Launches a graphical user interface that provides tools for interacting with and analyzing datasets using the
+    Ultralytics Explorer API. It checks for the required 'streamlit' package and informs the user that the Explorer
+    dashboard is loading.
 
     Args:
         args (List[str]): A list of optional command line arguments.

ultralytics/data/annotator.py

@@ -21,7 +21,7 @@ def auto_annotate(data, det_model="yolov8x.pt", sam_model="sam_b.pt", device="",
 
     Examples:
         >>> from ultralytics.data.annotator import auto_annotate
-        >>> auto_annotate(data='ultralytics/assets', det_model='yolov8n.pt', sam_model='mobile_sam.pt')
+        >>> auto_annotate(data="ultralytics/assets", det_model="yolov8n.pt", sam_model="mobile_sam.pt")
 
     Notes:
         - The function creates a new directory for output if not specified.

ultralytics/data/augment.py

@@ -38,7 +38,7 @@ class BaseTransform:
 
     Examples:
         >>> transform = BaseTransform()
-        >>> labels = {'image': np.array(...), 'instances': [...], 'semantic': np.array(...)}
+        >>> labels = {"image": np.array(...), "instances": [...], "semantic": np.array(...)}
         >>> transformed_labels = transform(labels)
     """
 
@@ -93,7 +93,7 @@ class BaseTransform:
 
         Examples:
             >>> transform = BaseTransform()
-            >>> labels = {'instances': Instances(xyxy=torch.rand(5, 4), cls=torch.randint(0, 80, (5,)))}
+            >>> labels = {"instances": Instances(xyxy=torch.rand(5, 4), cls=torch.randint(0, 80, (5,)))}
             >>> transformed_labels = transform.apply_instances(labels)
         """
         pass
@@ -135,7 +135,7 @@ class BaseTransform:
 
         Examples:
             >>> transform = BaseTransform()
-            >>> labels = {'img': np.random.rand(640, 640, 3), 'instances': []}
+            >>> labels = {"img": np.random.rand(640, 640, 3), "instances": []}
             >>> transformed_labels = transform(labels)
         """
         self.apply_image(labels)
@@ -338,6 +338,7 @@ class BaseMixTransform:
         ...     def _mix_transform(self, labels):
         ...         # Implement custom mix logic here
         ...         return labels
+        ...
         ...     def get_indexes(self):
         ...         return [random.randint(0, len(self.dataset) - 1) for _ in range(3)]
         >>> dataset = YourDataset()
@@ -421,7 +422,7 @@ class BaseMixTransform:
 
         Examples:
             >>> transform = BaseMixTransform(dataset)
-            >>> labels = {'image': img, 'bboxes': boxes, 'mix_labels': [{'image': img2, 'bboxes': boxes2}]}
+            >>> labels = {"image": img, "bboxes": boxes, "mix_labels": [{"image": img2, "bboxes": boxes2}]}
             >>> augmented_labels = transform._mix_transform(labels)
         """
         raise NotImplementedError
@@ -456,20 +457,17 @@ class BaseMixTransform:
 
         Examples:
             >>> labels = {
-            ...     'texts': [['cat'], ['dog']],
-            ...     'cls': torch.tensor([[0], [1]]),
-            ...     'mix_labels': [{
-            ...         'texts': [['bird'], ['fish']],
-            ...         'cls': torch.tensor([[0], [1]])
-            ...     }]
+            ...     "texts": [["cat"], ["dog"]],
+            ...     "cls": torch.tensor([[0], [1]]),
+            ...     "mix_labels": [{"texts": [["bird"], ["fish"]], "cls": torch.tensor([[0], [1]])}],
             ... }
             >>> updated_labels = self._update_label_text(labels)
-            >>> print(updated_labels['texts'])
+            >>> print(updated_labels["texts"])
             [['cat'], ['dog'], ['bird'], ['fish']]
-            >>> print(updated_labels['cls'])
+            >>> print(updated_labels["cls"])
             tensor([[0],
                     [1]])
-            >>> print(updated_labels['mix_labels'][0]['cls'])
+            >>> print(updated_labels["mix_labels"][0]["cls"])
             tensor([[2],
                     [3]])
         """
@@ -616,9 +614,12 @@ class Mosaic(BaseMixTransform):
 
         Examples:
             >>> mosaic = Mosaic(dataset, imgsz=640, p=1.0, n=3)
-            >>> labels = {'img': np.random.rand(480, 640, 3), 'mix_labels': [{'img': np.random.rand(480, 640, 3)} for _ in range(2)]}
+            >>> labels = {
+            ...     "img": np.random.rand(480, 640, 3),
+            ...     "mix_labels": [{"img": np.random.rand(480, 640, 3)} for _ in range(2)],
+            ... }
             >>> result = mosaic._mosaic3(labels)
-            >>> print(result['img'].shape)
+            >>> print(result["img"].shape)
             (640, 640, 3)
         """
         mosaic_labels = []
@@ -670,9 +671,10 @@ class Mosaic(BaseMixTransform):
 
         Examples:
             >>> mosaic = Mosaic(dataset, imgsz=640, p=1.0, n=4)
-            >>> labels = {"img": np.random.rand(480, 640, 3), "mix_labels": [
-            ...     {"img": np.random.rand(480, 640, 3)} for _ in range(3)
-            ... ]}
+            >>> labels = {
+            ...     "img": np.random.rand(480, 640, 3),
+            ...     "mix_labels": [{"img": np.random.rand(480, 640, 3)} for _ in range(3)],
+            ... }
             >>> result = mosaic._mosaic4(labels)
             >>> assert result["img"].shape == (1280, 1280, 3)
         """
@@ -734,7 +736,7 @@ class Mosaic(BaseMixTransform):
             >>> mosaic = Mosaic(dataset, imgsz=640, p=1.0, n=9)
             >>> input_labels = dataset[0]
             >>> mosaic_result = mosaic._mosaic9(input_labels)
-            >>> mosaic_image = mosaic_result['img']
+            >>> mosaic_image = mosaic_result["img"]
         """
         mosaic_labels = []
         s = self.imgsz
@@ -898,7 +900,7 @@ class MixUp(BaseMixTransform):
 
         Examples:
             >>> from ultralytics.data.dataset import YOLODataset
-            >>> dataset = YOLODataset('path/to/data.yaml')
+            >>> dataset = YOLODataset("path/to/data.yaml")
             >>> mixup = MixUp(dataset, pre_transform=None, p=0.5)
         """
         super().__init__(dataset=dataset, pre_transform=pre_transform, p=p)
@@ -974,10 +976,10 @@ class RandomPerspective:
     Examples:
         >>> transform = RandomPerspective(degrees=10, translate=0.1, scale=0.1, shear=10)
         >>> image = np.random.randint(0, 255, (640, 640, 3), dtype=np.uint8)
-        >>> labels = {'img': image, 'cls': np.array([0, 1]), 'instances': Instances(...)}
+        >>> labels = {"img": image, "cls": np.array([0, 1]), "instances": Instances(...)}
         >>> result = transform(labels)
-        >>> transformed_image = result['img']
-        >>> transformed_instances = result['instances']
+        >>> transformed_image = result["img"]
+        >>> transformed_instances = result["instances"]
     """
 
     def __init__(
@@ -1003,7 +1005,6 @@ class RandomPerspective:
             >>> transform = RandomPerspective(degrees=10.0, translate=0.1, scale=0.5, shear=5.0)
             >>> result = transform(labels)  # Apply random perspective to labels
         """
-
         self.degrees = degrees
         self.translate = translate
         self.scale = scale
@@ -1036,7 +1037,6 @@ class RandomPerspective:
             >>> border = (10, 10)
             >>> transformed_img, matrix, scale = affine_transform(img, border)
         """
-
         # Center
         C = np.eye(3, dtype=np.float32)
 
@@ -1209,12 +1209,12 @@ class RandomPerspective:
             >>> transform = RandomPerspective()
             >>> image = np.random.randint(0, 255, (640, 640, 3), dtype=np.uint8)
             >>> labels = {
-            ...     'img': image,
-            ...     'cls': np.array([0, 1, 2]),
-            ...     'instances': Instances(bboxes=np.array([[10, 10, 50, 50], [100, 100, 150, 150]]))
+            ...     "img": image,
+            ...     "cls": np.array([0, 1, 2]),
+            ...     "instances": Instances(bboxes=np.array([[10, 10, 50, 50], [100, 100, 150, 150]])),
             ... }
             >>> result = transform(labels)
-            >>> assert result['img'].shape[:2] == result['resized_shape']
+            >>> assert result["img"].shape[:2] == result["resized_shape"]
         """
         if self.pre_transform and "mosaic_border" not in labels:
             labels = self.pre_transform(labels)
@@ -1358,9 +1358,9 @@ class RandomHSV:
 
         Examples:
             >>> hsv_augmenter = RandomHSV(hgain=0.5, sgain=0.5, vgain=0.5)
-            >>> labels = {'img': np.random.randint(0, 255, (100, 100, 3), dtype=np.uint8)}
+            >>> labels = {"img": np.random.randint(0, 255, (100, 100, 3), dtype=np.uint8)}
             >>> hsv_augmenter(labels)
-            >>> augmented_img = labels['img']
+            >>> augmented_img = labels["img"]
         """
         img = labels["img"]
         if self.hgain or self.sgain or self.vgain:
@@ -1394,7 +1394,7 @@ class RandomFlip:
         __call__: Applies the random flip transformation to an image and its annotations.
 
     Examples:
-        >>> transform = RandomFlip(p=0.5, direction='horizontal')
+        >>> transform = RandomFlip(p=0.5, direction="horizontal")
         >>> result = transform({"img": image, "instances": instances})
         >>> flipped_image = result["img"]
         >>> flipped_instances = result["instances"]
@@ -1416,8 +1416,8 @@ class RandomFlip:
             AssertionError: If direction is not 'horizontal' or 'vertical', or if p is not between 0 and 1.
 
         Examples:
-            >>> flip = RandomFlip(p=0.5, direction='horizontal')
-            >>> flip = RandomFlip(p=0.7, direction='vertical', flip_idx=[1, 0, 3, 2, 5, 4])
+            >>> flip = RandomFlip(p=0.5, direction="horizontal")
+            >>> flip = RandomFlip(p=0.7, direction="vertical", flip_idx=[1, 0, 3, 2, 5, 4])
         """
         assert direction in {"horizontal", "vertical"}, f"Support direction `horizontal` or `vertical`, got {direction}"
         assert 0 <= p <= 1.0, f"The probability should be in range [0, 1], but got {p}."
@@ -1446,8 +1446,8 @@ class RandomFlip:
                 'instances' (ultralytics.utils.instance.Instances): Updated instances matching the flipped image.
 
         Examples:
-            >>> labels = {'img': np.random.rand(640, 640, 3), 'instances': Instances(...)}
-            >>> random_flip = RandomFlip(p=0.5, direction='horizontal')
+            >>> labels = {"img": np.random.rand(640, 640, 3), "instances": Instances(...)}
+            >>> random_flip = RandomFlip(p=0.5, direction="horizontal")
             >>> flipped_labels = random_flip(labels)
         """
         img = labels["img"]
@@ -1493,8 +1493,8 @@ class LetterBox:
     Examples:
         >>> transform = LetterBox(new_shape=(640, 640))
         >>> result = transform(labels)
-        >>> resized_img = result['img']
-        >>> updated_instances = result['instances']
+        >>> resized_img = result["img"]
+        >>> updated_instances = result["instances"]
     """
 
     def __init__(self, new_shape=(640, 640), auto=False, scaleFill=False, scaleup=True, center=True, stride=32):
@@ -1548,9 +1548,9 @@ class LetterBox:
 
         Examples:
             >>> letterbox = LetterBox(new_shape=(640, 640))
-            >>> result = letterbox(labels={'img': np.zeros((480, 640, 3)), 'instances': Instances(...)})
-            >>> resized_img = result['img']
-            >>> updated_instances = result['instances']
+            >>> result = letterbox(labels={"img": np.zeros((480, 640, 3)), "instances": Instances(...)})
+            >>> resized_img = result["img"]
+            >>> updated_instances = result["instances"]
         """
         if labels is None:
             labels = {}
@@ -1616,7 +1616,7 @@ class LetterBox:
 
         Examples:
             >>> letterbox = LetterBox(new_shape=(640, 640))
-            >>> labels = {'instances': Instances(...)}
+            >>> labels = {"instances": Instances(...)}
             >>> ratio = (0.5, 0.5)
             >>> padw, padh = 10, 20
             >>> updated_labels = letterbox._update_labels(labels, ratio, padw, padh)
@@ -1643,7 +1643,7 @@ class CopyPaste:
     Examples:
         >>> copypaste = CopyPaste(p=0.5)
         >>> augmented_labels = copypaste(labels)
-        >>> augmented_image = augmented_labels['img']
+        >>> augmented_image = augmented_labels["img"]
     """
 
     def __init__(self, p=0.5) -> None:
@@ -1680,7 +1680,7 @@ class CopyPaste:
             (Dict): Dictionary with augmented image and updated instances under 'img', 'cls', and 'instances' keys.
 
         Examples:
-            >>> labels = {'img': np.random.rand(640, 640, 3), 'cls': np.array([0, 1, 2]), 'instances': Instances(...)}
+            >>> labels = {"img": np.random.rand(640, 640, 3), "cls": np.array([0, 1, 2]), "instances": Instances(...)}
             >>> augmenter = CopyPaste(p=0.5)
             >>> augmented_labels = augmenter(labels)
         """
@@ -1765,8 +1765,8 @@ class Albumentations:
         Examples:
             >>> transform = Albumentations(p=0.5)
             >>> augmented = transform(image=image, bboxes=bboxes, class_labels=classes)
-            >>> augmented_image = augmented['image']
-            >>> augmented_bboxes = augmented['bboxes']
+            >>> augmented_image = augmented["image"]
+            >>> augmented_bboxes = augmented["bboxes"]
 
         Notes:
             - Requires Albumentations version 1.0.3 or higher.
@@ -1871,7 +1871,7 @@ class Albumentations:
             >>> labels = {
             ...     "img": np.random.rand(640, 640, 3),
             ...     "cls": np.array([0, 1]),
-            ...     "instances": Instances(bboxes=np.array([[0, 0, 1, 1], [0.5, 0.5, 0.8, 0.8]]))
+            ...     "instances": Instances(bboxes=np.array([[0, 0, 1, 1], [0.5, 0.5, 0.8, 0.8]])),
             ... }
             >>> augmented = transform(labels)
             >>> assert augmented["img"].shape == (640, 640, 3)
@@ -1927,11 +1927,11 @@ class Format:
         _format_segments: Converts polygon points to bitmap masks.
 
     Examples:
-        >>> formatter = Format(bbox_format='xywh', normalize=True, return_mask=True)
+        >>> formatter = Format(bbox_format="xywh", normalize=True, return_mask=True)
         >>> formatted_labels = formatter(labels)
-        >>> img = formatted_labels['img']
-        >>> bboxes = formatted_labels['bboxes']
-        >>> masks = formatted_labels['masks']
+        >>> img = formatted_labels["img"]
+        >>> bboxes = formatted_labels["bboxes"]
+        >>> masks = formatted_labels["masks"]
     """
 
     def __init__(
@@ -1975,7 +1975,7 @@ class Format:
             bgr (float): The probability to return BGR images.
 
         Examples:
-            >>> format = Format(bbox_format='xyxy', return_mask=True, return_keypoint=False)
+            >>> format = Format(bbox_format="xyxy", return_mask=True, return_keypoint=False)
             >>> print(format.bbox_format)
             xyxy
         """
@@ -2013,8 +2013,8 @@ class Format:
                 - 'batch_idx': Batch index tensor (if batch_idx is True).
 
         Examples:
-            >>> formatter = Format(bbox_format='xywh', normalize=True, return_mask=True)
-            >>> labels = {'img': np.random.rand(640, 640, 3), 'cls': np.array([0, 1]), 'instances': Instances(...)}
+            >>> formatter = Format(bbox_format="xywh", normalize=True, return_mask=True)
+            >>> labels = {"img": np.random.rand(640, 640, 3), "cls": np.array([0, 1]), "instances": Instances(...)}
             >>> formatted_labels = formatter(labels)
             >>> print(formatted_labels.keys())
         """
@@ -2275,8 +2275,8 @@ def v8_transforms(dataset, imgsz, hyp, stretch=False):
 
     Examples:
         >>> from ultralytics.data.dataset import YOLODataset
-        >>> dataset = YOLODataset(img_path='path/to/images', imgsz=640)
-        >>> hyp = {'mosaic': 1.0, 'copy_paste': 0.5, 'degrees': 10.0, 'translate': 0.2, 'scale': 0.9}
+        >>> dataset = YOLODataset(img_path="path/to/images", imgsz=640)
+        >>> hyp = {"mosaic": 1.0, "copy_paste": 0.5, "degrees": 10.0, "translate": 0.2, "scale": 0.9}
         >>> transforms = v8_transforms(dataset, imgsz=640, hyp=hyp)
         >>> augmented_data = transforms(dataset[0])
     """
@@ -2343,7 +2343,7 @@ def classify_transforms(
 
     Examples:
         >>> transforms = classify_transforms(size=224)
-        >>> img = Image.open('path/to/image.jpg')
+        >>> img = Image.open("path/to/image.jpg")
         >>> transformed_img = transforms(img)
     """
     import torchvision.transforms as T  # scope for faster 'import ultralytics'
@@ -2415,7 +2415,7 @@ def classify_augmentations(
         (torchvision.transforms.Compose): A composition of image augmentation transforms.
 
     Examples:
-        >>> transforms = classify_augmentations(size=224, auto_augment='randaugment')
+        >>> transforms = classify_augmentations(size=224, auto_augment="randaugment")
         >>> augmented_image = transforms(original_image)
     """
     # Transforms to apply if Albumentations not installed

ultralytics/data/base.py

@@ -298,10 +298,10 @@ class BaseDataset(Dataset):
                 im_file=im_file,
                 shape=shape,  # format: (height, width)
                 cls=cls,
-                bboxes=bboxes, # xywh
+                bboxes=bboxes,  # xywh
                 segments=segments,  # xy
-                keypoints=keypoints, # xy
-                normalized=True, # or False
+                keypoints=keypoints,  # xy
+                normalized=True,  # or False
                 bbox_format="xyxy",  # or xywh, ltwh
             )
             ```

ultralytics/data/converter.py

@@ -115,7 +115,7 @@ def coco91_to_coco80_class():
 
 
 def coco80_to_coco91_class():
-    """
+    r"""
     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/.
 
@@ -123,8 +123,8 @@ def coco80_to_coco91_class():
         ```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')
+        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
         ```
@@ -236,14 +236,13 @@ def convert_coco(
         ```python
         from ultralytics.data.converter import convert_coco
 
-        convert_coco('../datasets/coco/annotations/', use_segments=True, use_keypoints=False, cls91to80=True)
-        convert_coco('../datasets/lvis/annotations/', use_segments=True, use_keypoints=False, cls91to80=False, lvis=True)
+        convert_coco("../datasets/coco/annotations/", use_segments=True, use_keypoints=False, cls91to80=True)
+        convert_coco("../datasets/lvis/annotations/", use_segments=True, use_keypoints=False, cls91to80=False, lvis=True)
         ```
 
     Output:
         Generates output files in the specified output directory.
     """
-
     # Create dataset directory
     save_dir = increment_path(save_dir)  # increment if save directory already exists
     for p in save_dir / "labels", save_dir / "images":
@@ -351,7 +350,7 @@ def convert_segment_masks_to_yolo_seg(masks_dir, output_dir, classes):
         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)
+        convert_segment_masks_to_yolo_seg("path/to/masks_directory", "path/to/output/directory", classes=80)
         ```
 
     Notes:
@@ -429,7 +428,7 @@ def convert_dota_to_yolo_obb(dota_root_path: str):
         ```python
         from ultralytics.data.converter import convert_dota_to_yolo_obb
 
-        convert_dota_to_yolo_obb('path/to/DOTA')
+        convert_dota_to_yolo_obb("path/to/DOTA")
         ```
 
     Notes:

ultralytics/data/explorer/explorer.py

@@ -163,7 +163,7 @@ class Explorer:
             ```python
             exp = Explorer()
             exp.create_embeddings_table()
-            similar = exp.query(img='https://ultralytics.com/images/zidane.jpg')
+            similar = exp.query(img="https://ultralytics.com/images/zidane.jpg")
             ```
         """
         if self.table is None:
@@ -226,6 +226,7 @@ class Explorer:
     def plot_sql_query(self, query: str, labels: bool = True) -> Image.Image:
         """
         Plot the results of a SQL-Like query on the table.
+
         Args:
             query (str): SQL query to run.
             labels (bool): Whether to plot the labels or not.
@@ -271,7 +272,7 @@ class Explorer:
             ```python
             exp = Explorer()
             exp.create_embeddings_table()
-            similar = exp.get_similar(img='https://ultralytics.com/images/zidane.jpg')
+            similar = exp.get_similar(img="https://ultralytics.com/images/zidane.jpg")
             ```
         """
         assert return_type in {"pandas", "arrow"}, f"Return type should be `pandas` or `arrow`, but got {return_type}"
@@ -306,7 +307,7 @@ class Explorer:
             ```python
             exp = Explorer()
             exp.create_embeddings_table()
-            similar = exp.plot_similar(img='https://ultralytics.com/images/zidane.jpg')
+            similar = exp.plot_similar(img="https://ultralytics.com/images/zidane.jpg")
             ```
         """
         similar = self.get_similar(img, idx, limit, return_type="arrow")
@@ -395,8 +396,8 @@ class Explorer:
             exp.create_embeddings_table()
 
             similarity_idx_plot = exp.plot_similarity_index()
-            similarity_idx_plot.show() # view image preview
-            similarity_idx_plot.save('path/to/save/similarity_index_plot.png') # save contents to file
+            similarity_idx_plot.show()  # view image preview
+            similarity_idx_plot.save("path/to/save/similarity_index_plot.png")  # save contents to file
             ```
         """
         sim_idx = self.similarity_index(max_dist=max_dist, top_k=top_k, force=force)
@@ -447,7 +448,7 @@ class Explorer:
             ```python
             exp = Explorer()
             exp.create_embeddings_table()
-            answer = exp.ask_ai('Show images with 1 person and 2 dogs')
+            answer = exp.ask_ai("Show images with 1 person and 2 dogs")
             ```
         """
         result = prompt_sql_query(query)
@@ -457,20 +458,3 @@ class Explorer:
             LOGGER.error("AI generated query is not valid. Please try again with a different prompt")
             LOGGER.error(e)
             return None
-
-    def visualize(self, result):
-        """
-        Visualize the results of a query. TODO.
-
-        Args:
-            result (pyarrow.Table): Table containing the results of a query.
-        """
-        pass
-
-    def generate_report(self, result):
-        """
-        Generate a report of the dataset.
-
-        TODO
-        """
-        pass

ultralytics/data/loaders.py

@@ -240,7 +240,7 @@ class LoadScreenshots:
         return self
 
     def __next__(self):
-        """mss screen capture: get raw pixels from the screen as np array."""
+        """Screen capture with 'mss' to get raw pixels from the screen as np array."""
         im0 = np.asarray(self.sct.grab(self.monitor))[:, :, :3]  # BGRA to BGR
         s = f"screen {self.screen} (LTWH): {self.left},{self.top},{self.width},{self.height}: "