ultralytics 8.2.81__tar.gz → 8.2.83__tar.gz

{ultralytics-8.2.81/ultralytics.egg-info → ultralytics-8.2.83}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ultralytics
-Version: 8.2.81
+Version: 8.2.83
 Summary: Ultralytics YOLOv8 for SOTA object detection, multi-object tracking, instance segmentation, pose estimation and image classification.
 Author: Glenn Jocher, Ayush Chaurasia, Jing Qiu
 Maintainer: Glenn Jocher, Ayush Chaurasia, Jing Qiu
@@ -96,6 +96,7 @@ Requires-Dist: pycocotools>=2.0.7; extra == "extra"
     <a href="https://hub.docker.com/r/ultralytics/ultralytics"><img src="https://img.shields.io/docker/pulls/ultralytics/ultralytics?logo=docker" alt="Ultralytics Docker Pulls"></a>
     <a href="https://ultralytics.com/discord"><img alt="Ultralytics Discord" src="https://img.shields.io/discord/1089800235347353640?logo=discord&logoColor=white&label=Discord&color=blue"></a>
     <a href="https://community.ultralytics.com"><img alt="Ultralytics Forums" src="https://img.shields.io/discourse/users?server=https%3A%2F%2Fcommunity.ultralytics.com&logo=discourse&label=Forums&color=blue"></a>
+    <a href="https://reddit.com/r/ultralytics"><img alt="Ultralytics Reddit" src="https://img.shields.io/reddit/subreddit-subscribers/ultralytics?style=flat&logo=reddit&logoColor=white&label=Reddit&color=blue"></a>
     <br>
     <a href="https://console.paperspace.com/github/ultralytics/ultralytics"><img src="https://assets.paperspace.io/img/gradient-badge.svg" alt="Run Ultralytics on Gradient"></a>
     <a href="https://colab.research.google.com/github/ultralytics/ultralytics/blob/main/examples/tutorial.ipynb"><img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open Ultralytics In Colab"></a>
@@ -105,7 +106,7 @@ Requires-Dist: pycocotools>=2.0.7; extra == "extra"
 
 [Ultralytics](https://ultralytics.com) [YOLOv8](https://github.com/ultralytics/ultralytics) is a cutting-edge, state-of-the-art (SOTA) model that builds upon the success of previous YOLO versions and introduces new features and improvements to further boost performance and flexibility. YOLOv8 is designed to be fast, accurate, and easy to use, making it an excellent choice for a wide range of object detection and tracking, instance segmentation, image classification and pose estimation tasks.
 
-We hope that the resources here will help you get the most out of YOLOv8. Please browse the YOLOv8 <a href="https://docs.ultralytics.com/">Docs</a> for details, raise an issue on <a href="https://github.com/ultralytics/ultralytics/issues/new/choose">GitHub</a> for support, and join our <a href="https://ultralytics.com/discord">Discord</a> community for questions and discussions!
+We hope that the resources here will help you get the most out of YOLOv8. Please browse the YOLOv8 <a href="https://docs.ultralytics.com/">Docs</a> for details, raise an issue on <a href="https://github.com/ultralytics/ultralytics/issues/new/choose">GitHub</a> for support, questions, or discussions, become a member of the Ultralytics <a href="https://ultralytics.com/discord">Discord</a>, <a href="https://reddit.com/r/ultralytics">Reddit</a> and <a href="https://community.ultralytics.com">Forums</a>!
 
 To request an Enterprise License please complete the form at [Ultralytics Licensing](https://ultralytics.com/license).
 
@@ -361,7 +362,7 @@ Ultralytics offers two licensing options to accommodate diverse use cases:
 
 ## <div align="center">Contact</div>
 
-For Ultralytics bug reports and feature requests please visit [GitHub Issues](https://github.com/ultralytics/ultralytics/issues), and join our [Discord](https://ultralytics.com/discord) community for questions and discussions!
+For Ultralytics bug reports and feature requests please visit [GitHub Issues](https://github.com/ultralytics/ultralytics/issues). Become a member of the Ultralytics [Discord](https://ultralytics.com/discord), [Reddit](https://reddit.com/r/ultralytics), or [Forums](https://community.ultralytics.com) for asking questions, sharing projects, learning discussions, or for help with all things Ultralytics!
 
 <br>
 <div align="center">

{ultralytics-8.2.81 → ultralytics-8.2.83}/README.md

@@ -12,6 +12,7 @@
     <a href="https://hub.docker.com/r/ultralytics/ultralytics"><img src="https://img.shields.io/docker/pulls/ultralytics/ultralytics?logo=docker" alt="Ultralytics Docker Pulls"></a>
     <a href="https://ultralytics.com/discord"><img alt="Ultralytics Discord" src="https://img.shields.io/discord/1089800235347353640?logo=discord&logoColor=white&label=Discord&color=blue"></a>
     <a href="https://community.ultralytics.com"><img alt="Ultralytics Forums" src="https://img.shields.io/discourse/users?server=https%3A%2F%2Fcommunity.ultralytics.com&logo=discourse&label=Forums&color=blue"></a>
+    <a href="https://reddit.com/r/ultralytics"><img alt="Ultralytics Reddit" src="https://img.shields.io/reddit/subreddit-subscribers/ultralytics?style=flat&logo=reddit&logoColor=white&label=Reddit&color=blue"></a>
     <br>
     <a href="https://console.paperspace.com/github/ultralytics/ultralytics"><img src="https://assets.paperspace.io/img/gradient-badge.svg" alt="Run Ultralytics on Gradient"></a>
     <a href="https://colab.research.google.com/github/ultralytics/ultralytics/blob/main/examples/tutorial.ipynb"><img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open Ultralytics In Colab"></a>
@@ -21,7 +22,7 @@
 
 [Ultralytics](https://ultralytics.com) [YOLOv8](https://github.com/ultralytics/ultralytics) is a cutting-edge, state-of-the-art (SOTA) model that builds upon the success of previous YOLO versions and introduces new features and improvements to further boost performance and flexibility. YOLOv8 is designed to be fast, accurate, and easy to use, making it an excellent choice for a wide range of object detection and tracking, instance segmentation, image classification and pose estimation tasks.
 
-We hope that the resources here will help you get the most out of YOLOv8. Please browse the YOLOv8 <a href="https://docs.ultralytics.com/">Docs</a> for details, raise an issue on <a href="https://github.com/ultralytics/ultralytics/issues/new/choose">GitHub</a> for support, and join our <a href="https://ultralytics.com/discord">Discord</a> community for questions and discussions!
+We hope that the resources here will help you get the most out of YOLOv8. Please browse the YOLOv8 <a href="https://docs.ultralytics.com/">Docs</a> for details, raise an issue on <a href="https://github.com/ultralytics/ultralytics/issues/new/choose">GitHub</a> for support, questions, or discussions, become a member of the Ultralytics <a href="https://ultralytics.com/discord">Discord</a>, <a href="https://reddit.com/r/ultralytics">Reddit</a> and <a href="https://community.ultralytics.com">Forums</a>!
 
 To request an Enterprise License please complete the form at [Ultralytics Licensing](https://ultralytics.com/license).
 
@@ -277,7 +278,7 @@ Ultralytics offers two licensing options to accommodate diverse use cases:
 
 ## <div align="center">Contact</div>
 
-For Ultralytics bug reports and feature requests please visit [GitHub Issues](https://github.com/ultralytics/ultralytics/issues), and join our [Discord](https://ultralytics.com/discord) community for questions and discussions!
+For Ultralytics bug reports and feature requests please visit [GitHub Issues](https://github.com/ultralytics/ultralytics/issues). Become a member of the Ultralytics [Discord](https://ultralytics.com/discord), [Reddit](https://reddit.com/r/ultralytics), or [Forums](https://community.ultralytics.com) for asking questions, sharing projects, learning discussions, or for help with all things Ultralytics!
 
 <br>
 <div align="center">

{ultralytics-8.2.81 → ultralytics-8.2.83}/pyproject.toml

@@ -171,12 +171,15 @@ split_before_first_argument = false
 [tool.ruff]
 line-length = 120
 
+[tool.ruff.format]
+docstring-code-format = true
+
 [tool.docformatter]
 wrap-summaries = 120
 wrap-descriptions = 120
-in-place = true
 pre-summary-newline = true
 close-quotes-on-newline = true
+in-place = true
 
 [tool.codespell]
 ignore-words-list = "crate,nd,ned,strack,dota,ane,segway,fo,gool,winn,commend,bloc,nam,afterall"

{ultralytics-8.2.81 → ultralytics-8.2.83}/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-8.2.81 → ultralytics-8.2.83}/ultralytics/__init__.py

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

{ultralytics-8.2.81 → ultralytics-8.2.83}/ultralytics/cfg/__init__.py

@@ -13,6 +13,7 @@ from ultralytics.utils import (
     DEFAULT_CFG,
     DEFAULT_CFG_DICT,
     DEFAULT_CFG_PATH,
+    IS_VSCODE,
     LOGGER,
     RANK,
     ROOT,
@@ -25,6 +26,7 @@ from ultralytics.utils import (
     checks,
     colorstr,
     deprecation_warn,
+    vscode_msg,
     yaml_load,
     yaml_print,
 )
@@ -198,15 +200,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 +237,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 +284,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 +347,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 +382,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 +413,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 +548,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.
@@ -793,11 +793,7 @@ def entrypoint(debug=""):
         from ultralytics import FastSAM
 
         model = FastSAM(model)
-    elif "sam2" in stem:
-        from ultralytics import SAM2
-
-        model = SAM2(model)
-    elif "sam" in stem:
+    elif "sam_" in stem or "sam2_" in stem:
         from ultralytics import SAM
 
         model = SAM(model)
@@ -836,6 +832,10 @@ def entrypoint(debug=""):
     # Show help
     LOGGER.info(f"💡 Learn more at https://docs.ultralytics.com/modes/{mode}")
 
+    # Recommend VS Code extension
+    if IS_VSCODE and SETTINGS.get("vscode_msg", True):
+        LOGGER.info(vscode_msg())
+
 
 # Special modes --------------------------------------------------------------------------------------------------------
 def copy_default_cfg():

{ultralytics-8.2.81 → ultralytics-8.2.83}/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-8.2.81 → ultralytics-8.2.83}/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-8.2.81 → ultralytics-8.2.83}/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
             )
             ```