Apply Ruff Docstring reformat (#13278)

* Apply Ruff Docstring reformat

Signed-off-by: Glenn Jocher <glenn.jocher@ultralytics.com>

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

* Update export.py

Signed-off-by: Glenn Jocher <glenn.jocher@ultralytics.com>

---------

Signed-off-by: Glenn Jocher <glenn.jocher@ultralytics.com>
Co-authored-by: UltralyticsAssistant <web@ultralytics.com>
Co-authored-by: Ultralytics Assistant <135830346+UltralyticsAssistant@users.noreply.github.com>

utils/loggers/__init__.py

@@ -350,7 +350,8 @@ class GenericLogger:
     """
     YOLOv5 General purpose logger for non-task specific logging
     Usage: from utils.loggers import GenericLogger; logger = GenericLogger(...)
-    Arguments
+
+    Arguments:
         opt:             Run arguments
         console_logger:  Console logger
         include:         loggers to include

utils/loggers/clearml/clearml_utils.py

@@ -80,7 +80,7 @@ class ClearmlLogger:
         - Initialize ClearML Task, this object will capture the experiment
         - Upload dataset version to ClearML Data if opt.upload_dataset is True
 
-        arguments:
+        Arguments:
         opt (namespace) -- Commandline arguments for this run
         hyp (dict) -- Hyperparameters for this run
 
@@ -133,7 +133,7 @@ class ClearmlLogger:
         """
         Log scalars/metrics to ClearML.
 
-        arguments:
+        Arguments:
         metrics (dict) Metrics in dict format: {"metrics/mAP": 0.8, ...}
         epoch (int) iteration number for the current set of metrics
         """
@@ -145,7 +145,7 @@ class ClearmlLogger:
         """
         Log model weights to ClearML.
 
-        arguments:
+        Arguments:
         model_path (PosixPath or str) Path to the model weights
         model_name (str) Name of the model visible in ClearML
         epoch (int) Iteration / epoch of the model weights
@@ -158,7 +158,7 @@ class ClearmlLogger:
         """
         Log final metrics to a summary table.
 
-        arguments:
+        Arguments:
         metrics (dict) Metrics in dict format: {"metrics/mAP": 0.8, ...}
         """
         for k, v in metrics.items():
@@ -168,7 +168,7 @@ class ClearmlLogger:
         """
         Log image as plot in the plot section of ClearML.
 
-        arguments:
+        Arguments:
         title (str) Title of the plot
         plot_path (PosixPath or str) Path to the saved image file
         """
@@ -183,7 +183,7 @@ class ClearmlLogger:
         """
         Log files (images) as debug samples in the ClearML task.
 
-        arguments:
+        Arguments:
         files (List(PosixPath)) a list of file paths in PosixPath format
         title (str) A title that groups together images with the same values
         """
@@ -199,7 +199,7 @@ class ClearmlLogger:
         """
         Draw the bounding boxes on a single image and report the result as a ClearML debug sample.
 
-        arguments:
+        Arguments:
         image_path (PosixPath) the path the original image file
         boxes (list): list of scaled predictions in the format - [xmin, ymin, xmax, ymax, confidence, class]
         class_names (dict): dict containing mapping of class int to class name

utils/loggers/wandb/wandb_utils.py

@@ -49,7 +49,7 @@ class WandbLogger:
         - Upload dataset if opt.upload_dataset is True
         - Setup training processes if job_type is 'Training'
 
-        arguments:
+        Arguments:
         opt (namespace) -- Commandline arguments for this run
         run_id (str) -- Run ID of W&B run to be resumed
         job_type (str) -- To set the job_type for this run
@@ -90,7 +90,7 @@ class WandbLogger:
           - Update data_dict, to contain info of previous run if resumed and the paths of dataset artifact if downloaded
           - Setup log_dict, initialize bbox_interval
 
-        arguments:
+        Arguments:
         opt (namespace) -- commandline arguments for this run
 
         """
@@ -120,7 +120,7 @@ class WandbLogger:
         """
         Log the model checkpoint as W&B artifact.
 
-        arguments:
+        Arguments:
         path (Path)   -- Path of directory containing the checkpoints
         opt (namespace) -- Command line arguments for this run
         epoch (int)  -- Current epoch number
@@ -159,7 +159,7 @@ class WandbLogger:
         """
         Save the metrics to the logging dictionary.
 
-        arguments:
+        Arguments:
         log_dict (Dict) -- metrics/media to be logged in current step
         """
         if self.wandb_run:
@@ -170,7 +170,7 @@ class WandbLogger:
         """
         Commit the log_dict, model artifacts and Tables to W&B and flush the log_dict.
 
-        arguments:
+        Arguments:
         best_result (boolean): Boolean representing if the result of this evaluation is best or not
         """
         if self.wandb_run:
@@ -197,7 +197,7 @@ class WandbLogger:
 
 @contextmanager
 def all_logging_disabled(highest_level=logging.CRITICAL):
-    """source - https://gist.github.com/simon-weber/7853144
+    """Source - https://gist.github.com/simon-weber/7853144
     A context manager that will prevent any logging messages triggered during the body from being processed.
     :param highest_level: the maximum logging level in use.
       This would only need to be changed if a custom level greater than CRITICAL is defined.