dgenerate-ultralytics-headless 8.3.141__py3-none-any.whl → 8.3.144__py3-none-any.whl

tests/test_solutions.py

@@ -156,14 +156,14 @@ SOLUTIONS = [
         "StreamlitInference",
         solutions.Inference,
         False,
-        None,  # streamlit application don't require video file
-        {},  # streamlit application don't accept arguments
+        None,  # streamlit application doesn't require video file
+        {},  # streamlit application doesn't accept arguments
     ),
 ]
 
 
-def process_video(solution, video_path, needs_frame_count=False):
-    """Process video with solution, feeding frames and optional frame count."""
+def process_video(solution, video_path: str, needs_frame_count: bool = False):
+    """Process video with solution, feeding frames and optional frame count to the solution instance."""
     cap = cv2.VideoCapture(video_path)
     assert cap.isOpened(), f"Error reading video file {video_path}"
 
@@ -183,7 +183,7 @@ def process_video(solution, video_path, needs_frame_count=False):
 @pytest.mark.skipif(IS_RASPBERRYPI, reason="Disabled for testing due to --slow test errors after YOLOE PR.")
 @pytest.mark.parametrize("name, solution_class, needs_frame_count, video, kwargs", SOLUTIONS)
 def test_solution(name, solution_class, needs_frame_count, video, kwargs):
-    """Test individual Ultralytics solution."""
+    """Test individual Ultralytics solution with video processing and parameter validation."""
     if video:
         if name != "ObjectCounterVertical":
             safe_download(url=f"{ASSETS_URL}/{video}", dir=TMP)
@@ -208,14 +208,14 @@ def test_solution(name, solution_class, needs_frame_count, video, kwargs):
 @pytest.mark.skipif(checks.IS_PYTHON_3_8, reason="Disabled due to unsupported CLIP dependencies.")
 @pytest.mark.skipif(IS_RASPBERRYPI, reason="Disabled due to slow performance on Raspberry Pi.")
 def test_similarity_search():
-    """Test similarity search solution."""
-    safe_download(f"{ASSETS_URL}/4-imgs-similaritysearch.zip", dir=TMP)  # 4 dog images for testing in a zip file.
+    """Test similarity search solution with sample images and text query."""
+    safe_download(f"{ASSETS_URL}/4-imgs-similaritysearch.zip", dir=TMP)  # 4 dog images for testing in a zip file
     searcher = solutions.VisualAISearch(data=str(TMP / "4-imgs-similaritysearch"))
     _ = searcher("a dog sitting on a bench")  # Returns the results in format "- img name | similarity score"
 
 
 def test_left_click_selection():
-    """Test distance calculation left click."""
+    """Test distance calculation left click selection functionality."""
     dc = solutions.DistanceCalculation()
     dc.boxes, dc.track_ids = [[10, 10, 50, 50]], [1]
     dc.mouse_event_for_distance(cv2.EVENT_LBUTTONDOWN, 30, 30, None, None)
@@ -223,7 +223,7 @@ def test_left_click_selection():
 
 
 def test_right_click_reset():
-    """Test distance calculation right click."""
+    """Test distance calculation right click reset functionality."""
     dc = solutions.DistanceCalculation()
     dc.selected_boxes, dc.left_mouse_count = {1: [10, 10, 50, 50]}, 1
     dc.mouse_event_for_distance(cv2.EVENT_RBUTTONDOWN, 0, 0, None, None)
@@ -232,7 +232,7 @@ def test_right_click_reset():
 
 
 def test_parking_json_none():
-    """Test that ParkingManagement skips or errors cleanly when no JSON is provided."""
+    """Test that ParkingManagement handles missing JSON gracefully."""
     im0 = np.zeros((640, 480, 3), dtype=np.uint8)
     try:
         parkingmanager = solutions.ParkingManagement(json_path=None)
@@ -245,7 +245,7 @@ def test_analytics_graph_not_supported():
     """Test that unsupported analytics type raises ModuleNotFoundError."""
     try:
         analytics = solutions.Analytics(analytics_type="test")  # 'test' is unsupported
-        analytics.process(im0=None, frame_number=0)
+        analytics.process(im0=np.zeros((640, 480, 3), dtype=np.uint8), frame_number=0)
         assert False, "Expected ModuleNotFoundError for unsupported chart type"
     except ModuleNotFoundError as e:
         assert "test chart is not supported" in str(e)
@@ -266,7 +266,7 @@ def test_config_update_method_with_invalid_argument():
         obj.update(invalid_key=123)
         assert False, "Expected ValueError for invalid update argument"
     except ValueError as e:
-        assert "❌ invalid_key is not a valid solution argument" in str(e)
+        assert "is not a valid solution argument" in str(e)
 
 
 def test_plot_with_no_masks():

ultralytics/__init__.py

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

ultralytics/cfg/__init__.py

@@ -70,7 +70,7 @@ TASK2METRIC = {
     "pose": "metrics/mAP50-95(P)",
     "obb": "metrics/mAP50-95(B)",
 }
-MODELS = frozenset({TASK2MODEL[task] for task in TASKS})
+MODELS = frozenset(TASK2MODEL[task] for task in TASKS)
 
 ARGV = sys.argv or ["", ""]  # sometimes sys.argv = []
 SOLUTIONS_HELP_MSG = f"""
@@ -108,8 +108,8 @@ CLI_HELP_MSG = f"""
 
         yolo TASK MODE ARGS
 
-        Where   TASK (optional) is one of {TASKS}
-                MODE (required) is one of {MODES}
+        Where   TASK (optional) is one of {list(TASKS)}
+                MODE (required) is one of {list(MODES)}
                 ARGS (optional) are any number of custom 'arg=value' pairs like 'imgsz=320' that override defaults.
                     See all ARGS at https://docs.ultralytics.com/usage/cfg or with 'yolo cfg'
 
@@ -240,7 +240,7 @@ CFG_BOOL_KEYS = frozenset(
 
 def cfg2dict(cfg: Union[str, Path, Dict, SimpleNamespace]) -> Dict:
     """
-    Converts a configuration object to a dictionary.
+    Convert a configuration object to a dictionary.
 
     Args:
         cfg (str | Path | Dict | SimpleNamespace): Configuration object to be converted. Can be a file path,
@@ -323,7 +323,7 @@ def get_cfg(cfg: Union[str, Path, Dict, SimpleNamespace] = DEFAULT_CFG_DICT, ove
 
 def check_cfg(cfg: Dict, hard: bool = True) -> None:
     """
-    Checks configuration argument types and values for the Ultralytics library.
+    Check configuration argument types and values for the Ultralytics library.
 
     This function validates the types and values of configuration arguments, ensuring correctness and converting
     them if necessary. It checks for specific key types defined in global variables such as `CFG_FLOAT_KEYS`,
@@ -385,7 +385,7 @@ def check_cfg(cfg: Dict, hard: bool = True) -> None:
 
 def get_save_dir(args: SimpleNamespace, name: str = None) -> Path:
     """
-    Returns the directory path for saving outputs, derived from arguments or default settings.
+    Return the directory path for saving outputs, derived from arguments or default settings.
 
     Args:
         args (SimpleNamespace): Namespace object containing configurations such as 'project', 'name', 'task',
@@ -417,11 +417,14 @@ def get_save_dir(args: SimpleNamespace, name: str = None) -> Path:
 
 def _handle_deprecation(custom: Dict) -> Dict:
     """
-    Handles deprecated configuration keys by mapping them to current equivalents with deprecation warnings.
+    Handle deprecated configuration keys by mapping them to current equivalents with deprecation warnings.
 
     Args:
         custom (dict): Configuration dictionary potentially containing deprecated keys.
 
+    Returns:
+        (dict): Updated configuration dictionary with deprecated keys replaced.
+
     Examples:
         >>> custom_config = {"boxes": True, "hide_labels": "False", "line_thickness": 2}
         >>> _handle_deprecation(custom_config)
@@ -458,7 +461,7 @@ def _handle_deprecation(custom: Dict) -> Dict:
 
 def check_dict_alignment(base: Dict, custom: Dict, e: Exception = None) -> None:
     """
-    Checks alignment between custom and base configuration dictionaries, handling deprecated keys and providing error
+    Check alignment between custom and base configuration dictionaries, handling deprecated keys and providing error
     messages for mismatched keys.
 
     Args:
@@ -498,7 +501,7 @@ def check_dict_alignment(base: Dict, custom: Dict, e: Exception = None) -> None:
 
 def merge_equals_args(args: List[str]) -> List[str]:
     """
-    Merges arguments around isolated '=' in a list of strings and joins fragments with brackets.
+    Merge arguments around isolated '=' in a list of strings and join fragments with brackets.
 
     This function handles the following cases:
         1. ['arg', '=', 'val'] becomes ['arg=val']
@@ -557,7 +560,7 @@ def merge_equals_args(args: List[str]) -> List[str]:
 
 def handle_yolo_hub(args: List[str]) -> None:
     """
-    Handles Ultralytics HUB command-line interface (CLI) commands for authentication.
+    Handle Ultralytics HUB command-line interface (CLI) commands for authentication.
 
     This function processes Ultralytics HUB CLI commands such as login and logout. It should be called when executing a
     script with arguments related to HUB authentication.
@@ -587,7 +590,7 @@ def handle_yolo_hub(args: List[str]) -> None:
 
 def handle_yolo_settings(args: List[str]) -> None:
     """
-    Handles YOLO settings command-line interface (CLI) commands.
+    Handle YOLO settings command-line interface (CLI) commands.
 
     This function processes YOLO settings CLI commands such as reset and updating individual settings. It should be
     called when executing a script with arguments related to YOLO settings management.
@@ -628,7 +631,7 @@ def handle_yolo_settings(args: List[str]) -> None:
 
 def handle_yolo_solutions(args: List[str]) -> None:
     """
-    Processes YOLO solutions arguments and runs the specified computer vision solutions pipeline.
+    Process YOLO solutions arguments and run the specified computer vision solutions pipeline.
 
     Args:
         args (List[str]): Command-line arguments for configuring and running the Ultralytics YOLO
@@ -740,7 +743,7 @@ def handle_yolo_solutions(args: List[str]) -> None:
 
 def parse_key_value_pair(pair: str = "key=value") -> tuple:
     """
-    Parses a key-value pair string into separate key and value components.
+    Parse a key-value pair string into separate key and value components.
 
     Args:
         pair (str): A string containing a key-value pair in the format "key=value".
@@ -774,7 +777,7 @@ def parse_key_value_pair(pair: str = "key=value") -> tuple:
 
 def smart_value(v: str) -> Any:
     """
-    Converts a string representation of a value to its appropriate Python type.
+    Convert a string representation of a value to its appropriate Python type.
 
     This function attempts to convert a given string into a Python object of the most appropriate type. It handles
     conversions to None, bool, int, float, and other types that can be evaluated safely.
@@ -909,9 +912,9 @@ def entrypoint(debug: str = "") -> None:
     mode = overrides.get("mode")
     if mode is None:
         mode = DEFAULT_CFG.mode or "predict"
-        LOGGER.warning(f"'mode' argument is missing. Valid modes are {MODES}. Using default 'mode={mode}'.")
+        LOGGER.warning(f"'mode' argument is missing. Valid modes are {list(MODES)}. Using default 'mode={mode}'.")
     elif mode not in MODES:
-        raise ValueError(f"Invalid 'mode={mode}'. Valid modes are {MODES}.\n{CLI_HELP_MSG}")
+        raise ValueError(f"Invalid 'mode={mode}'. Valid modes are {list(MODES)}.\n{CLI_HELP_MSG}")
 
     # Task
     task = overrides.pop("task", None)
@@ -919,11 +922,11 @@ def entrypoint(debug: str = "") -> None:
         if task not in TASKS:
             if task == "track":
                 LOGGER.warning(
-                    f"invalid 'task=track', setting 'task=detect' and 'mode=track'. Valid tasks are {TASKS}.\n{CLI_HELP_MSG}."
+                    f"invalid 'task=track', setting 'task=detect' and 'mode=track'. Valid tasks are {list(TASKS)}.\n{CLI_HELP_MSG}."
                 )
                 task, mode = "detect", "track"
             else:
-                raise ValueError(f"Invalid 'task={task}'. Valid tasks are {TASKS}.\n{CLI_HELP_MSG}")
+                raise ValueError(f"Invalid 'task={task}'. Valid tasks are {list(TASKS)}.\n{CLI_HELP_MSG}")
         if "model" not in overrides:
             overrides["model"] = TASK2MODEL[task]
 
@@ -991,7 +994,7 @@ def entrypoint(debug: str = "") -> None:
 # Special modes --------------------------------------------------------------------------------------------------------
 def copy_default_cfg() -> None:
     """
-    Copies the default configuration file and creates a new one with '_copy' appended to its name.
+    Copy the default configuration file and create a new one with '_copy' appended to its name.
 
     This function duplicates the existing default configuration file (DEFAULT_CFG_PATH) and saves it
     with '_copy' appended to its name in the current working directory. It provides a convenient way

ultralytics/data/annotator.py

@@ -22,19 +22,20 @@ def auto_annotate(
     Automatically annotate images using a YOLO object detection model and a SAM segmentation model.
 
     This function processes images in a specified directory, detects objects using a YOLO model, and then generates
-    segmentation masks using a SAM model. The resulting annotations are saved as text files.
+    segmentation masks using a SAM model. The resulting annotations are saved as text files in YOLO format.
 
     Args:
         data (str | Path): Path to a folder containing images to be annotated.
         det_model (str): Path or name of the pre-trained YOLO detection model.
         sam_model (str): Path or name of the pre-trained SAM segmentation model.
-        device (str): Device to run the models on (e.g., 'cpu', 'cuda', '0').
+        device (str): Device to run the models on (e.g., 'cpu', 'cuda', '0'). Empty string for auto-selection.
         conf (float): Confidence threshold for detection model.
         iou (float): IoU threshold for filtering overlapping boxes in detection results.
         imgsz (int): Input image resize dimension.
         max_det (int): Maximum number of detections per image.
-        classes (List[int] | None): Filter predictions to specified class IDs, returning only relevant detections.
-        output_dir (str | Path | None): Directory to save the annotated results. If None, a default directory is created.
+        classes (List[int], optional): Filter predictions to specified class IDs, returning only relevant detections.
+        output_dir (str | Path, optional): Directory to save the annotated results. If None, creates a default
+            directory based on the input data path.
 
     Examples:
         >>> from ultralytics.data.annotator import auto_annotate
@@ -53,7 +54,7 @@ def auto_annotate(
     )
 
     for result in det_results:
-        class_ids = result.boxes.cls.int().tolist()  # noqa
+        class_ids = result.boxes.cls.int().tolist()  # Extract class IDs from detection results
         if class_ids:
             boxes = result.boxes.xyxy  # Boxes object for bbox outputs
             sam_results = sam_model(result.orig_img, bboxes=boxes, verbose=False, save=False, device=device)