ultralytics 8.2.81__py3-none-any.whl → 8.2.83__py3-none-any.whl

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

@@ -84,7 +84,7 @@ class LoadStreams:
             # Start thread to read frames from video stream
             st = f"{i + 1}/{n}: {s}... "
             if urlparse(s).hostname in {"www.youtube.com", "youtube.com", "youtu.be"}:  # if source is YouTube video
-                # YouTube format i.e. 'https://www.youtube.com/watch?v=Zgi9g1ksQHc' or 'https://youtu.be/LNwODJXcvt4'
+                # YouTube format i.e. 'https://www.youtube.com/watch?v=Jsn8D3aC840' or 'https://youtu.be/Jsn8D3aC840'
                 s = get_best_youtube_url(s)
             s = eval(s) if s.isnumeric() else s  # i.e. s = '0' local webcam
             if s == 0 and (IS_COLAB or IS_KAGGLE):
@@ -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}: "
 

ultralytics/data/split_dota.py

@@ -19,11 +19,19 @@ from shapely.geometry import Polygon
 
 def bbox_iof(polygon1, bbox2, eps=1e-6):
     """
-    Calculate iofs between bbox1 and bbox2.
+    Calculate Intersection over Foreground (IoF) between polygons and bounding boxes.
 
     Args:
-        polygon1 (np.ndarray): Polygon coordinates, (n, 8).
-        bbox2 (np.ndarray): Bounding boxes, (n ,4).
+        polygon1 (np.ndarray): Polygon coordinates, shape (n, 8).
+        bbox2 (np.ndarray): Bounding boxes, shape (n, 4).
+        eps (float, optional): Small value to prevent division by zero. Defaults to 1e-6.
+
+    Returns:
+        (np.ndarray): IoF scores, shape (n, 1) or (n, m) if bbox2 is (m, 4).
+
+    Note:
+        Polygon format: [x1, y1, x2, y2, x3, y3, x4, y4].
+        Bounding box format: [x_min, y_min, x_max, y_max].
     """
     polygon1 = polygon1.reshape(-1, 4, 2)
     lt_point = np.min(polygon1, axis=-2)  # left-top

ultralytics/data/utils.py

@@ -265,7 +265,6 @@ def check_det_dataset(dataset, autodownload=True):
     Returns:
         (dict): Parsed dataset information and paths.
     """
-
     file = check_file(dataset)
 
     # Download (optional)
@@ -363,7 +362,6 @@ def check_cls_dataset(dataset, split=""):
             - 'nc' (int): The number of classes in the dataset.
             - 'names' (dict): A dictionary of class names in the dataset.
     """
-
     # Download (optional if dataset=https://file.zip is passed directly)
     if str(dataset).startswith(("http:/", "https:/")):
         dataset = safe_download(dataset, dir=DATASETS_DIR, unzip=True, delete=False)
@@ -438,11 +436,11 @@ class HUBDatasetStats:
         ```python
         from ultralytics.data.utils import HUBDatasetStats
 
-        stats = HUBDatasetStats('path/to/coco8.zip', task='detect')  # detect dataset
-        stats = HUBDatasetStats('path/to/coco8-seg.zip', task='segment')  # segment dataset
-        stats = HUBDatasetStats('path/to/coco8-pose.zip', task='pose')  # pose dataset
-        stats = HUBDatasetStats('path/to/dota8.zip', task='obb')  # OBB dataset
-        stats = HUBDatasetStats('path/to/imagenet10.zip', task='classify')  # classification dataset
+        stats = HUBDatasetStats("path/to/coco8.zip", task="detect")  # detect dataset
+        stats = HUBDatasetStats("path/to/coco8-seg.zip", task="segment")  # segment dataset
+        stats = HUBDatasetStats("path/to/coco8-pose.zip", task="pose")  # pose dataset
+        stats = HUBDatasetStats("path/to/dota8.zip", task="obb")  # OBB dataset
+        stats = HUBDatasetStats("path/to/imagenet10.zip", task="classify")  # classification dataset
 
         stats.get_json(save=True)
         stats.process_images()
@@ -598,11 +596,10 @@ def compress_one_image(f, f_new=None, max_dim=1920, quality=50):
         from pathlib import Path
         from ultralytics.data.utils import compress_one_image
 
-        for f in Path('path/to/dataset').rglob('*.jpg'):
+        for f in Path("path/to/dataset").rglob("*.jpg"):
             compress_one_image(f)
         ```
     """
-
     try:  # use PIL
         im = Image.open(f)
         r = max_dim / max(im.height, im.width)  # ratio
@@ -635,7 +632,6 @@ def autosplit(path=DATASETS_DIR / "coco8/images", weights=(0.9, 0.1, 0.0), annot
         autosplit()
         ```
     """
-
     path = Path(path)  # images dir
     files = sorted(x for x in path.rglob("*.*") if x.suffix[1:].lower() in IMG_FORMATS)  # image files only
     n = len(files)  # number of files

ultralytics/engine/exporter.py

@@ -1,6 +1,6 @@
 # Ultralytics YOLO 🚀, AGPL-3.0 license
 """
-Export a YOLOv8 PyTorch model to other formats. TensorFlow exports authored by https://github.com/zldrobit
+Export a YOLOv8 PyTorch model to other formats. TensorFlow exports authored by https://github.com/zldrobit.
 
 Format                  | `format=argument`         | Model
 ---                     | ---                       | ---
@@ -533,9 +533,7 @@ class Exporter:
 
     @try_export
     def export_ncnn(self, prefix=colorstr("NCNN:")):
-        """
-        YOLOv8 NCNN export using PNNX https://github.com/pnnx/pnnx.
-        """
+        """YOLOv8 NCNN export using PNNX https://github.com/pnnx/pnnx."""
         check_requirements("ncnn")
         import ncnn  # noqa
 

ultralytics/engine/model.py

@@ -72,11 +72,11 @@ class Model(nn.Module):
 
     Examples:
         >>> from ultralytics import YOLO
-        >>> model = YOLO('yolov8n.pt')
-        >>> results = model.predict('image.jpg')
-        >>> model.train(data='coco128.yaml', epochs=3)
+        >>> model = YOLO("yolov8n.pt")
+        >>> results = model.predict("image.jpg")
+        >>> model.train(data="coco128.yaml", epochs=3)
         >>> metrics = model.val()
-        >>> model.export(format='onnx')
+        >>> model.export(format="onnx")
     """
 
     def __init__(
@@ -166,8 +166,8 @@ class Model(nn.Module):
                 Results object.
 
         Examples:
-            >>> model = YOLO('yolov8n.pt')
-            >>> results = model('https://ultralytics.com/images/bus.jpg')
+            >>> model = YOLO("yolov8n.pt")
+            >>> results = model("https://ultralytics.com/images/bus.jpg")
             >>> for r in results:
             ...     print(f"Detected {len(r)} objects in image")
         """
@@ -188,9 +188,9 @@ class Model(nn.Module):
             (bool): True if the model string is a valid Triton Server URL, False otherwise.
 
         Examples:
-            >>> Model.is_triton_model('http://localhost:8000/v2/models/yolov8n')
+            >>> Model.is_triton_model("http://localhost:8000/v2/models/yolov8n")
             True
-            >>> Model.is_triton_model('yolov8n.pt')
+            >>> Model.is_triton_model("yolov8n.pt")
             False
         """
         from urllib.parse import urlsplit
@@ -253,7 +253,7 @@ class Model(nn.Module):
 
         Examples:
             >>> model = Model()
-            >>> model._new('yolov8n.yaml', task='detect', verbose=True)
+            >>> model._new("yolov8n.yaml", task="detect", verbose=True)
         """
         cfg_dict = yaml_model_load(cfg)
         self.cfg = cfg
@@ -284,8 +284,8 @@ class Model(nn.Module):
 
         Examples:
             >>> model = Model()
-            >>> model._load('yolov8n.pt')
-            >>> model._load('path/to/weights.pth', task='detect')
+            >>> model._load("yolov8n.pt")
+            >>> model._load("path/to/weights.pth", task="detect")
         """
         if weights.lower().startswith(("https://", "http://", "rtsp://", "rtmp://", "tcp://")):
             weights = checks.check_file(weights, download_dir=SETTINGS["weights_dir"])  # download and return local file
@@ -348,7 +348,7 @@ class Model(nn.Module):
             AssertionError: If the model is not a PyTorch model.
 
         Examples:
-            >>> model = Model('yolov8n.pt')
+            >>> model = Model("yolov8n.pt")
             >>> model.reset_weights()
         """
         self._check_is_pytorch_model()
@@ -377,8 +377,8 @@ class Model(nn.Module):
 
         Examples:
             >>> model = Model()
-            >>> model.load('yolov8n.pt')
-            >>> model.load(Path('path/to/weights.pt'))
+            >>> model.load("yolov8n.pt")
+            >>> model.load(Path("path/to/weights.pt"))
         """
         self._check_is_pytorch_model()
         if isinstance(weights, (str, Path)):
@@ -402,8 +402,8 @@ class Model(nn.Module):
             AssertionError: If the model is not a PyTorch model.
 
         Examples:
-            >>> model = Model('yolov8n.pt')
-            >>> model.save('my_model.pt')
+            >>> model = Model("yolov8n.pt")
+            >>> model.save("my_model.pt")
         """
         self._check_is_pytorch_model()
         from copy import deepcopy
@@ -439,7 +439,7 @@ class Model(nn.Module):
             TypeError: If the model is not a PyTorch model.
 
         Examples:
-            >>> model = Model('yolov8n.pt')
+            >>> model = Model("yolov8n.pt")
             >>> model.info()  # Prints model summary
             >>> info_list = model.info(detailed=True, verbose=False)  # Returns detailed info as a list
         """
@@ -494,8 +494,8 @@ class Model(nn.Module):
             AssertionError: If the model is not a PyTorch model.
 
         Examples:
-            >>> model = YOLO('yolov8n.pt')
-            >>> image = 'https://ultralytics.com/images/bus.jpg'
+            >>> model = YOLO("yolov8n.pt")
+            >>> image = "https://ultralytics.com/images/bus.jpg"
             >>> embeddings = model.embed(image)
             >>> print(embeddings[0].shape)
         """
@@ -531,8 +531,8 @@ class Model(nn.Module):
                 Results object.
 
         Examples:
-            >>> model = YOLO('yolov8n.pt')
-            >>> results = model.predict(source='path/to/image.jpg', conf=0.25)
+            >>> model = YOLO("yolov8n.pt")
+            >>> results = model.predict(source="path/to/image.jpg", conf=0.25)
             >>> for r in results:
             ...     print(r.boxes.data)  # print detection bounding boxes
 
@@ -592,8 +592,8 @@ class Model(nn.Module):
             AttributeError: If the predictor does not have registered trackers.
 
         Examples:
-            >>> model = YOLO('yolov8n.pt')
-            >>> results = model.track(source='path/to/video.mp4', show=True)
+            >>> model = YOLO("yolov8n.pt")
+            >>> results = model.track(source="path/to/video.mp4", show=True)
             >>> for r in results:
             ...     print(r.boxes.id)  # print tracking IDs
 
@@ -635,8 +635,8 @@ class Model(nn.Module):
             AssertionError: If the model is not a PyTorch model.
 
         Examples:
-            >>> model = YOLO('yolov8n.pt')
-            >>> results = model.val(data='coco128.yaml', imgsz=640)
+            >>> model = YOLO("yolov8n.pt")
+            >>> results = model.val(data="coco128.yaml", imgsz=640)
             >>> print(results.box.map)  # Print mAP50-95
         """
         custom = {"rect": True}  # method defaults
@@ -677,8 +677,8 @@ class Model(nn.Module):
             AssertionError: If the model is not a PyTorch model.
 
         Examples:
-            >>> model = YOLO('yolov8n.pt')
-            >>> results = model.benchmark(data='coco8.yaml', imgsz=640, half=True)
+            >>> model = YOLO("yolov8n.pt")
+            >>> results = model.benchmark(data="coco8.yaml", imgsz=640, half=True)
             >>> print(results)
         """
         self._check_is_pytorch_model()
@@ -727,8 +727,8 @@ class Model(nn.Module):
             RuntimeError: If the export process fails due to errors.
 
         Examples:
-            >>> model = YOLO('yolov8n.pt')
-            >>> model.export(format='onnx', dynamic=True, simplify=True)
+            >>> model = YOLO("yolov8n.pt")
+            >>> model.export(format="onnx", dynamic=True, simplify=True)
             'path/to/exported/model.onnx'
         """
         self._check_is_pytorch_model()
@@ -782,8 +782,8 @@ class Model(nn.Module):
             ModuleNotFoundError: If the HUB SDK is not installed.
 
         Examples:
-            >>> model = YOLO('yolov8n.pt')
-            >>> results = model.train(data='coco128.yaml', epochs=3)
+            >>> model = YOLO("yolov8n.pt")
+            >>> results = model.train(data="coco128.yaml", epochs=3)
         """
         self._check_is_pytorch_model()
         if hasattr(self.session, "model") and self.session.model.id:  # Ultralytics HUB session with loaded model
@@ -847,7 +847,7 @@ class Model(nn.Module):
             AssertionError: If the model is not a PyTorch model.
 
         Examples:
-            >>> model = YOLO('yolov8n.pt')
+            >>> model = YOLO("yolov8n.pt")
             >>> results = model.tune(use_ray=True, iterations=20)
             >>> print(results)
         """
@@ -907,7 +907,7 @@ class Model(nn.Module):
             AttributeError: If the model or predictor does not have a 'names' attribute.
 
         Examples:
-            >>> model = YOLO('yolov8n.pt')
+            >>> model = YOLO("yolov8n.pt")
             >>> print(model.names)
             {0: 'person', 1: 'bicycle', 2: 'car', ...}
         """
@@ -957,7 +957,7 @@ class Model(nn.Module):
             (object | None): The transform object of the model if available, otherwise None.
 
         Examples:
-            >>> model = YOLO('yolov8n.pt')
+            >>> model = YOLO("yolov8n.pt")
             >>> transforms = model.transforms
             >>> if transforms:
             ...     print(f"Model transforms: {transforms}")
@@ -986,9 +986,9 @@ class Model(nn.Module):
         Examples:
             >>> def on_train_start(trainer):
             ...     print("Training is starting!")
-            >>> model = YOLO('yolov8n.pt')
+            >>> model = YOLO("yolov8n.pt")
             >>> model.add_callback("on_train_start", on_train_start)
-            >>> model.train(data='coco128.yaml', epochs=1)
+            >>> model.train(data="coco128.yaml", epochs=1)
         """
         self.callbacks[event].append(func)
 
@@ -1005,9 +1005,9 @@ class Model(nn.Module):
                 recognized by the Ultralytics callback system.
 
         Examples:
-            >>> model = YOLO('yolov8n.pt')
-            >>> model.add_callback('on_train_start', lambda: print('Training started'))
-            >>> model.clear_callback('on_train_start')
+            >>> model = YOLO("yolov8n.pt")
+            >>> model.add_callback("on_train_start", lambda: print("Training started"))
+            >>> model.clear_callback("on_train_start")
             >>> # All callbacks for 'on_train_start' are now removed
 
         Notes:
@@ -1035,8 +1035,8 @@ class Model(nn.Module):
         modifications, ensuring consistent behavior across different runs or experiments.
 
         Examples:
-            >>> model = YOLO('yolov8n.pt')
-            >>> model.add_callback('on_train_start', custom_function)
+            >>> model = YOLO("yolov8n.pt")
+            >>> model.add_callback("on_train_start", custom_function)
             >>> model.reset_callbacks()
             # All callbacks are now reset to their default functions
         """
@@ -1059,7 +1059,7 @@ class Model(nn.Module):
             (dict): A new dictionary containing only the specified include keys from the input arguments.
 
         Examples:
-            >>> original_args = {'imgsz': 640, 'data': 'coco.yaml', 'task': 'detect', 'batch': 16, 'epochs': 100}
+            >>> original_args = {"imgsz": 640, "data": "coco.yaml", "task": "detect", "batch": 16, "epochs": 100}
             >>> reset_args = Model._reset_ckpt_args(original_args)
             >>> print(reset_args)
             {'imgsz': 640, 'data': 'coco.yaml', 'task': 'detect'}
@@ -1090,9 +1090,9 @@ class Model(nn.Module):
             NotImplementedError: If the specified key is not supported for the current task.
 
         Examples:
-            >>> model = Model(task='detect')
-            >>> predictor = model._smart_load('predictor')
-            >>> trainer = model._smart_load('trainer')
+            >>> model = Model(task="detect")
+            >>> predictor = model._smart_load("predictor")
+            >>> trainer = model._smart_load("trainer")
 
         Notes:
             - This method is typically used internally by other methods of the Model class.
@@ -1128,8 +1128,8 @@ class Model(nn.Module):
         Examples:
             >>> model = Model()
             >>> task_map = model.task_map
-            >>> detect_class_map = task_map['detect']
-            >>> segment_class_map = task_map['segment']
+            >>> detect_class_map = task_map["detect"]
+            >>> segment_class_map = task_map["segment"]
 
         Note:
             The actual implementation of this method may vary depending on the specific tasks and

ultralytics/engine/predictor.py

@@ -384,7 +384,7 @@ class BasePredictor:
             cv2.imwrite(save_path, im)
 
     def show(self, p=""):
-        """Display an image in a window using OpenCV imshow()."""
+        """Display an image in a window using the OpenCV imshow function."""
         im = self.plotted_img
         if platform.system() == "Linux" and p not in self.windows:
             self.windows.append(p)