ultralytics 8.3.143__py3-none-any.whl → 8.3.144__py3-none-any.whl

tests/conftest.py

@@ -7,15 +7,7 @@ from tests import TMP
 
 
 def pytest_addoption(parser):
-    """
-    Add custom command-line options to pytest.
-
-    Args:
-        parser (pytest.config.Parser): The pytest parser object for adding custom command-line options.
-
-    Returns:
-        (None)
-    """
+    """Add custom command-line options to pytest."""
     parser.addoption("--slow", action="store_true", default=False, help="Run slow tests")
 
 
@@ -24,11 +16,8 @@ def pytest_collection_modifyitems(config, items):
     Modify the list of test items to exclude tests marked as slow if the --slow option is not specified.
 
     Args:
-        config (pytest.config.Config): The pytest configuration object that provides access to command-line options.
+        config: The pytest configuration object that provides access to command-line options.
         items (list): The list of collected pytest item objects to be modified based on the presence of --slow option.
-
-    Returns:
-        (None): The function modifies the 'items' list in place.
     """
     if not config.getoption("--slow"):
         # Remove the item entirely from the list of test items if it's marked as 'slow'
@@ -43,16 +32,13 @@ def pytest_sessionstart(session):
     test collection. It sets the initial seeds and prepares the temporary directory for the test session.
 
     Args:
-        session (pytest.Session): The pytest session object.
-
-    Returns:
-        (None)
+        session: The pytest session object.
     """
     from ultralytics.utils.torch_utils import init_seeds
 
     init_seeds()
-    shutil.rmtree(TMP, ignore_errors=True)  # delete any existing tests/tmp directory
-    TMP.mkdir(parents=True, exist_ok=True)  # create a new empty directory
+    shutil.rmtree(TMP, ignore_errors=True)  # Delete any existing tests/tmp directory
+    TMP.mkdir(parents=True, exist_ok=True)  # Create a new empty directory
 
 
 def pytest_terminal_summary(terminalreporter, exitstatus, config):
@@ -63,12 +49,9 @@ def pytest_terminal_summary(terminalreporter, exitstatus, config):
     and directories used during testing.
 
     Args:
-        terminalreporter (pytest.terminal.TerminalReporter): The terminal reporter object used for terminal output.
+        terminalreporter: The terminal reporter object used for terminal output.
         exitstatus (int): The exit status of the test run.
-        config (pytest.config.Config): The pytest config object.
-
-    Returns:
-        (None)
+        config: The pytest config object.
     """
     from ultralytics.utils import WEIGHTS_DIR
 

tests/test_cli.py

@@ -55,7 +55,7 @@ def test_export(model: str) -> None:
 
 def test_rtdetr(task: str = "detect", model: str = "yolov8n-rtdetr.yaml", data: str = "coco8.yaml") -> None:
     """Test the RTDETR functionality within Ultralytics for detection tasks using specified model and data."""
-    # Warning: must use imgsz=640 (note also add coma, spaces, fraction=0.25 args to test single-image training)
+    # Warning: must use imgsz=640 (note also add comma, spaces, fraction=0.25 args to test single-image training)
     run(f"yolo train {task} model={model} data={data} --imgsz= 160 epochs =1, cache = disk fraction=0.25")  # spaces
     run(f"yolo predict {task} model={model} source={ASSETS / 'bus.jpg'} imgsz=160 save save_crop save_txt")
     if TORCH_1_9:

tests/test_cuda.py

@@ -22,7 +22,10 @@ if CUDA_IS_AVAILABLE:
     else:
         gpu_info = GPUInfo()
         gpu_info.print_status()
-        idle_gpus = gpu_info.select_idle_gpu(count=2, min_memory_fraction=0.2)
+        autodevice_fraction = __import__("os").environ.get("YOLO_AUTODEVICE_FRACTION_FREE", 0.3)
+        idle_gpus = gpu_info.select_idle_gpu(
+            count=2, min_memory_fraction=autodevice_fraction, min_util_fraction=autodevice_fraction
+        )
         if idle_gpus:
             DEVICES = idle_gpus
 
@@ -114,7 +117,9 @@ def test_train():
     if not IS_JETSON:
         visible = eval(os.environ["CUDA_VISIBLE_DEVICES"])
         assert visible == device, f"Passed GPUs '{device}', but used GPUs '{visible}'"
-        assert results is (None if len(DEVICES) > 1 else not None)  # DDP returns None, single-GPU returns metrics
+        assert (
+            (results is None) if len(DEVICES) > 1 else (results is not None)
+        )  # DDP returns None, single-GPU returns metrics
 
 
 @pytest.mark.slow

tests/test_engine.py

@@ -17,7 +17,7 @@ def test_func(*args):  # noqa
 
 
 def test_export():
-    """Tests the model exporting function by adding a callback and asserting its execution."""
+    """Test model exporting functionality by adding a callback and verifying its execution."""
     exporter = Exporter()
     exporter.add_callback("on_export_start", test_func)
     assert test_func in exporter.callbacks["on_export_start"], "callback test failed"
@@ -48,11 +48,12 @@ def test_detect():
     pred = detect.DetectionPredictor(overrides={"imgsz": [64, 64]})
     pred.add_callback("on_predict_start", test_func)
     assert test_func in pred.callbacks["on_predict_start"], "callback test failed"
-    # Confirm there is no issue with sys.argv being empty.
+    # Confirm there is no issue with sys.argv being empty
     with mock.patch.object(sys, "argv", []):
         result = pred(source=ASSETS, model=MODEL)
         assert len(result), "predictor test failed"
 
+    # Test resume functionality
     overrides["resume"] = trainer.last
     trainer = detect.DetectionTrainer(overrides=overrides)
     try:
@@ -61,16 +62,15 @@ def test_detect():
         print(f"Expected exception caught: {e}")
         return
 
-    Exception("Resume test failed!")
+    raise Exception("Resume test failed!")
 
 
 def test_segment():
-    """Tests image segmentation training, validation, and prediction pipelines using YOLO models."""
+    """Test image segmentation training, validation, and prediction pipelines using YOLO models."""
     overrides = {"data": "coco8-seg.yaml", "model": "yolo11n-seg.yaml", "imgsz": 32, "epochs": 1, "save": False}
     cfg = get_cfg(DEFAULT_CFG)
     cfg.data = "coco8-seg.yaml"
     cfg.imgsz = 32
-    # YOLO(CFG_SEG).train(**overrides)  # works
 
     # Trainer
     trainer = segment.SegmentationTrainer(overrides=overrides)
@@ -91,7 +91,7 @@ def test_segment():
     result = pred(source=ASSETS, model=WEIGHTS_DIR / "yolo11n-seg.pt")
     assert len(result), "predictor test failed"
 
-    # Test resume
+    # Test resume functionality
     overrides["resume"] = trainer.last
     trainer = segment.SegmentationTrainer(overrides=overrides)
     try:
@@ -100,7 +100,7 @@ def test_segment():
         print(f"Expected exception caught: {e}")
         return
 
-    Exception("Resume test failed!")
+    raise Exception("Resume test failed!")
 
 
 def test_classify():
@@ -109,7 +109,6 @@ def test_classify():
     cfg = get_cfg(DEFAULT_CFG)
     cfg.data = "imagenet10"
     cfg.imgsz = 32
-    # YOLO(CFG_SEG).train(**overrides)  # works
 
     # Trainer
     trainer = classify.ClassificationTrainer(overrides=overrides)

tests/test_exports.py

@@ -24,7 +24,7 @@ from ultralytics.utils.torch_utils import TORCH_1_9, TORCH_1_13
 
 
 def test_export_torchscript():
-    """Test YOLO model exporting to TorchScript format for compatibility and correctness."""
+    """Test YOLO model export to TorchScript format for compatibility and correctness."""
     file = YOLO(MODEL).export(format="torchscript", optimize=False, imgsz=32)
     YOLO(file)(SOURCE, imgsz=32)  # exported model inference
 
@@ -37,7 +37,7 @@ def test_export_onnx():
 
 @pytest.mark.skipif(not TORCH_1_13, reason="OpenVINO requires torch>=1.13")
 def test_export_openvino():
-    """Test YOLO exports to OpenVINO format for model inference compatibility."""
+    """Test YOLO export to OpenVINO format for model inference compatibility."""
     file = YOLO(MODEL).export(format="openvino", imgsz=32)
     YOLO(file)(SOURCE, imgsz=32)  # exported model inference
 
@@ -55,7 +55,7 @@ def test_export_openvino():
     ],
 )
 def test_export_openvino_matrix(task, dynamic, int8, half, batch, nms):
-    """Test YOLO model exports to OpenVINO under various configuration matrix conditions."""
+    """Test YOLO model export to OpenVINO under various configuration matrix conditions."""
     file = YOLO(TASK2MODEL[task]).export(
         format="openvino",
         imgsz=32,
@@ -87,7 +87,7 @@ def test_export_openvino_matrix(task, dynamic, int8, half, batch, nms):
     ],
 )
 def test_export_onnx_matrix(task, dynamic, int8, half, batch, simplify, nms):
-    """Test YOLO exports to ONNX format with various configurations and parameters."""
+    """Test YOLO export to ONNX format with various configurations and parameters."""
     file = YOLO(TASK2MODEL[task]).export(
         format="onnx", imgsz=32, dynamic=dynamic, int8=int8, half=half, batch=batch, simplify=simplify, nms=nms
     )
@@ -105,7 +105,7 @@ def test_export_onnx_matrix(task, dynamic, int8, half, batch, simplify, nms):
     ],
 )
 def test_export_torchscript_matrix(task, dynamic, int8, half, batch, nms):
-    """Tests YOLO model exports to TorchScript format under varied configurations."""
+    """Test YOLO model export to TorchScript format under varied configurations."""
     file = YOLO(TASK2MODEL[task]).export(
         format="torchscript", imgsz=32, dynamic=dynamic, int8=int8, half=half, batch=batch, nms=nms
     )
@@ -126,7 +126,7 @@ def test_export_torchscript_matrix(task, dynamic, int8, half, batch, nms):
     ],
 )
 def test_export_coreml_matrix(task, dynamic, int8, half, batch):
-    """Test YOLO exports to CoreML format with various parameter configurations."""
+    """Test YOLO export to CoreML format with various parameter configurations."""
     file = YOLO(TASK2MODEL[task]).export(
         format="coreml",
         imgsz=32,
@@ -135,7 +135,7 @@ def test_export_coreml_matrix(task, dynamic, int8, half, batch):
         half=half,
         batch=batch,
     )
-    YOLO(file)([SOURCE] * batch, imgsz=32)  # exported model inference at batch=3
+    YOLO(file)([SOURCE] * batch, imgsz=32)  # exported model inference
     shutil.rmtree(file)  # cleanup
 
 
@@ -156,11 +156,11 @@ def test_export_coreml_matrix(task, dynamic, int8, half, batch):
     ],
 )
 def test_export_tflite_matrix(task, dynamic, int8, half, batch, nms):
-    """Test YOLO exports to TFLite format considering various export configurations."""
+    """Test YOLO export to TFLite format considering various export configurations."""
     file = YOLO(TASK2MODEL[task]).export(
         format="tflite", imgsz=32, dynamic=dynamic, int8=int8, half=half, batch=batch, nms=nms
     )
-    YOLO(file)([SOURCE] * batch, imgsz=32)  # exported model inference at batch=3
+    YOLO(file)([SOURCE] * batch, imgsz=32)  # exported model inference
     Path(file).unlink()  # cleanup
 
 
@@ -169,7 +169,7 @@ def test_export_tflite_matrix(task, dynamic, int8, half, batch, nms):
 @pytest.mark.skipif(LINUX and ARM64, reason="CoreML not supported on aarch64 Linux")
 @pytest.mark.skipif(checks.IS_PYTHON_3_13, reason="CoreML not supported in Python 3.13")
 def test_export_coreml():
-    """Test YOLO exports to CoreML format and check for errors."""
+    """Test YOLO export to CoreML format and check for errors."""
     # Capture stdout and stderr
     stdout, stderr = io.StringIO(), io.StringIO()
     with redirect_stdout(stdout), redirect_stderr(stderr):
@@ -187,7 +187,7 @@ def test_export_coreml():
 @pytest.mark.skipif(not checks.IS_PYTHON_MINIMUM_3_10, reason="TFLite export requires Python>=3.10")
 @pytest.mark.skipif(not LINUX, reason="Test disabled as TF suffers from install conflicts on Windows and macOS")
 def test_export_tflite():
-    """Test YOLO exports to TFLite format under specific OS and Python version conditions."""
+    """Test YOLO export to TFLite format under specific OS and Python version conditions."""
     model = YOLO(MODEL)
     file = model.export(format="tflite", imgsz=32)
     YOLO(file)(SOURCE, imgsz=32)
@@ -196,7 +196,7 @@ def test_export_tflite():
 @pytest.mark.skipif(True, reason="Test disabled")
 @pytest.mark.skipif(not LINUX, reason="TF suffers from install conflicts on Windows and macOS")
 def test_export_pb():
-    """Test YOLO exports to TensorFlow's Protobuf (*.pb) format."""
+    """Test YOLO export to TensorFlow's Protobuf (*.pb) format."""
     model = YOLO(MODEL)
     file = model.export(format="pb", imgsz=32)
     YOLO(file)(SOURCE, imgsz=32)
@@ -204,20 +204,20 @@ def test_export_pb():
 
 @pytest.mark.skipif(True, reason="Test disabled as Paddle protobuf and ONNX protobuf requirements conflict.")
 def test_export_paddle():
-    """Test YOLO exports to Paddle format, noting protobuf conflicts with ONNX."""
+    """Test YOLO export to Paddle format, noting protobuf conflicts with ONNX."""
     YOLO(MODEL).export(format="paddle", imgsz=32)
 
 
 @pytest.mark.slow
 def test_export_mnn():
-    """Test YOLO exports to MNN format (WARNING: MNN test must precede NCNN test or CI error on Windows)."""
+    """Test YOLO export to MNN format (WARNING: MNN test must precede NCNN test or CI error on Windows)."""
     file = YOLO(MODEL).export(format="mnn", imgsz=32)
     YOLO(file)(SOURCE, imgsz=32)  # exported model inference
 
 
 @pytest.mark.slow
 def test_export_ncnn():
-    """Test YOLO exports to NCNN format."""
+    """Test YOLO export to NCNN format."""
     file = YOLO(MODEL).export(format="ncnn", imgsz=32)
     YOLO(file)(SOURCE, imgsz=32)  # exported model inference
 
@@ -225,7 +225,7 @@ def test_export_ncnn():
 @pytest.mark.skipif(True, reason="Test disabled as keras and tensorflow version conflicts with TFlite export.")
 @pytest.mark.skipif(not LINUX or MACOS, reason="Skipping test on Windows and Macos")
 def test_export_imx():
-    """Test YOLO exports to IMX format."""
+    """Test YOLO export to IMX format."""
     model = YOLO("yolov8n.pt")
     file = model.export(format="imx", imgsz=32)
     YOLO(file)(SOURCE, imgsz=32)

tests/test_integrations.py

@@ -32,7 +32,7 @@ def test_model_ray_tune():
 
 @pytest.mark.skipif(not check_requirements("mlflow", install=False), reason="mlflow not installed")
 def test_mlflow():
-    """Test training with MLflow tracking enabled (see https://mlflow.org/ for details)."""
+    """Test training with MLflow tracking enabled."""
     SETTINGS["mlflow"] = True
     YOLO("yolo11n-cls.yaml").train(data="imagenet10", imgsz=32, epochs=3, plots=False, device="cpu")
     SETTINGS["mlflow"] = False

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)
@@ -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.143"
+__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"""
@@ -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.
@@ -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)