Update Google-style docstrings (#2359)

* Update Google-style docstrings

Signed-off-by: Glenn Jocher <[email protected]>

* Auto-format by https://ultralytics.com/actions

* Auto-format by https://ultralytics.com/actions

---------

Signed-off-by: Glenn Jocher <[email protected]>
Co-authored-by: UltralyticsAssistant <[email protected]>

Author: glenn-jocher

benchmarks.py

@@ -60,8 +60,7 @@ def run(
     pt_only=False,  # test PyTorch only
     hard_fail=False,  # throw error on benchmark failure
 ):
-    """
-    Run YOLOv3 benchmarks on multiple export formats and validate performance metrics.
+    """Run YOLOv3 benchmarks on multiple export formats and validate performance metrics.
 
     Args:
         weights (str | Path): Path to the weights file. Defaults to 'yolov5s.pt'.
@@ -77,11 +76,6 @@ def run(
     Returns:
         None
 
-    Notes:
-        This function iterates over multiple export formats, performs the export, and then validates the model's performance
-        using appropriate validation functions for detection and segmentation models. The results are logged, and optionally,
-        benchmarks can be configured to raise errors on failures using the `hard_fail` argument.
-
     Examples:
         ```python
         # Run benchmarks on the default 'yolov5s.pt' model with an image size of 640 pixels
@@ -93,6 +87,11 @@ def run(
         # Test only PyTorch export
         run(pt_only=True)
         ```
+
+    Notes:
+        This function iterates over multiple export formats, performs the export, and then validates the model's performance
+        using appropriate validation functions for detection and segmentation models. The results are logged, and optionally,
+        benchmarks can be configured to raise errors on failures using the `hard_fail` argument.
     """
     y, t = [], time.time()
     device = select_device(device)
@@ -158,8 +157,7 @@ def test(
     pt_only=False,  # test PyTorch only
     hard_fail=False,  # throw error on benchmark failure
 ):
-    """
-    Run YOLOv3 export tests for various formats and log the results, including export success status.
+    """Run YOLOv3 export tests for various formats and log the results, including export success status.
 
     Args:
         weights (str | Path): Path to the weights file. Defaults to ROOT / "yolov5s.pt".
@@ -222,8 +220,7 @@ def test(
 
 
 def parse_opt():
-    """
-    Parses command line arguments for YOLOv3 inference and export configurations.
+    """Parses command line arguments for YOLOv3 inference and export configurations.
 
     Args:
         --weights (str): Path to the weights file. Default is 'ROOT / "yolov3-tiny.pt"'.
@@ -241,7 +238,7 @@ def parse_opt():
     Returns:
         argparse.Namespace: The parsed arguments as a namespace object.
 
-    Example:
+    Examples:
         To run inference on the YOLOv3-tiny model with a different image size:
 
         ```python
@@ -272,8 +269,7 @@ def parse_opt():
 
 
 def main(opt):
-    """
-    Executes the export and benchmarking pipeline for YOLOv3 models, testing multiple export formats and validating
+    """Executes the export and benchmarking pipeline for YOLOv3 models, testing multiple export formats and validating
     performance metrics.
 
     Args:
@@ -287,18 +283,18 @@ def main(opt):
             - mAP50-95: Mean Average Precision for the model
             - Inference time (ms): Time taken for inference
 
-    Notes:
-        The function runs the main pipeline by exporting the YOLOv3 model to various formats and running benchmarks to
-        evaluate performance. If `opt.test` is set to True, it only tests the export process and logs the results.
-
-    Example:
+    Examples:
         Running the function from command line with required arguments:
 
         ```python
         $ python benchmarks.py --weights yolov5s.pt --img 640
         ```
 
     For more details, visit the Ultralytics YOLOv3 repository on [GitHub](https://github.com/ultralytics/ultralytics).
+
+    Notes:
+        The function runs the main pipeline by exporting the YOLOv3 model to various formats and running benchmarks to
+        evaluate performance. If `opt.test` is set to True, it only tests the export process and logs the results.
     """
     test(**vars(opt)) if opt.test else run(**vars(opt))
 

detect.py

@@ -95,13 +95,12 @@ def run(
     dnn=False,  # use OpenCV DNN for ONNX inference
     vid_stride=1,  # video frame-rate stride
 ):
-    """
-    Run YOLOv3 detection inference on various input sources such as images, videos, streams, and YouTube URLs.
+    """Run YOLOv3 detection inference on various input sources such as images, videos, streams, and YouTube URLs.
 
     Args:
         weights (str | Path): Path to the model weights file or a Triton URL (default: 'yolov5s.pt').
         source (str | Path): Source of input data such as a file, directory, URL, glob pattern, or device identifier
-            (default: 'data/images').
+        (default: 'data/images').
         data (str | Path): Path to the dataset YAML file (default: 'data/coco128.yaml').
         imgsz (tuple[int, int]): Inference size as a tuple (height, width) (default: (640, 640)).
         conf_thres (float): Confidence threshold for detection (default: 0.25).
@@ -120,7 +119,8 @@ def run(
         update (bool): Whether to update all models (default: False).
         project (str | Path): Path to the project directory where results will be saved (default: 'runs/detect').
         name (str): Name for the specific run within the project directory (default: 'exp').
-        exist_ok (bool): Whether to allow existing project/name directory without incrementing run index (default: False).
+        exist_ok (bool): Whether to allow existing project/name directory without incrementing run index (default:
+            False).
         line_thickness (int): Thickness of bounding box lines in pixels (default: 3).
         hide_labels (bool): Whether to hide labels in the results (default: False).
         hide_conf (bool): Whether to hide confidences in the results (default: False).
@@ -131,12 +131,6 @@ def run(
     Returns:
         None
 
-    Notes:
-        This function supports a variety of input sources such as image files, video files, directories, URL patterns,
-        webcam streams, and YouTube links. It also supports multiple model formats including PyTorch, ONNX, OpenVINO,
-        TensorRT, CoreML, TensorFlow, PaddlePaddle, and others. The results can be visualized in real-time or saved to
-        specified directories. Use command-line arguments to modify the behavior of the function.
-
     Examples:
         ```python
         # Run YOLOv3 inference on an image
@@ -148,6 +142,12 @@ def run(
         # Run YOLOv3 inference on a webcam
         run(weights='yolov5s.pt', source='0', view_img=True)
         ```
+
+    Notes:
+        This function supports a variety of input sources such as image files, video files, directories, URL patterns,
+        webcam streams, and YouTube links. It also supports multiple model formats including PyTorch, ONNX, OpenVINO,
+        TensorRT, CoreML, TensorFlow, PaddlePaddle, and others. The results can be visualized in real-time or saved to
+        specified directories. Use command-line arguments to modify the behavior of the function.
     """
     source = str(source)
     save_img = not nosave and not source.endswith(".txt")  # save inference images
@@ -286,8 +286,7 @@ def run(
 
 
 def parse_opt():
-    """
-    Parses and returns command-line options for running YOLOv3 model detection.
+    """Parses and returns command-line options for running YOLOv3 model detection.
 
     Args:
         --weights (list[str]): Model path or Triton URL. Default: ROOT / "yolov3-tiny.pt".
@@ -321,7 +320,7 @@ def parse_opt():
     Returns:
         argparse.Namespace: Parsed command-line arguments for YOLOv3 inference configurations.
 
-    Example:
+    Examples:
         ```python
         options = parse_opt()
         run(**vars(options))
@@ -364,8 +363,7 @@ def parse_opt():
 
 
 def main(opt):
-    """
-    Entry point for running the YOLO model; checks requirements and calls `run` with parsed options.
+    """Entry point for running the YOLO model; checks requirements and calls `run` with parsed options.
 
     Args:
         opt (argparse.Namespace): Parsed command-line options, which include:
@@ -400,7 +398,7 @@ def main(opt):
     Returns:
         None
 
-    Example:
+    Examples:
         ```python
         if __name__ == "__main__":
             opt = parse_opt()