Standardize headers and docstrings (#4417)

* Implement new headers

* Reformat 1

* Reformat 2

* Reformat 3 - math

* Reformat 4 - yaml

models/common.py

@@ -1,11 +1,14 @@
-# YOLOv5 common modules
+# YOLOv5 🚀 by Ultralytics, GPL-3.0 license
+"""
+Common modules
+"""
 
 import logging
+import math
 import warnings
 from copy import copy
 from pathlib import Path
 
-import math
 import numpy as np
 import pandas as pd
 import requests

models/experimental.py

@@ -1,10 +1,13 @@
-# YOLOv5 experimental modules
+# YOLOv5 🚀 by Ultralytics, GPL-3.0 license
+"""
+Experimental modules
+"""
 
 import numpy as np
 import torch
 import torch.nn as nn
 
-from models.common import Conv, DWConv
+from models.common import Conv
 from utils.downloads import attempt_download
 
 

models/hub/anchors.yaml

@@ -1,4 +1,5 @@
-# Default YOLOv5 anchors for COCO data
+# YOLOv5 🚀 by Ultralytics, GPL-3.0 license
+# Default anchors for COCO data
 
 
 # P5 -------------------------------------------------------------------------------------------------------------------

models/hub/yolov3-spp.yaml

@@ -1,3 +1,5 @@
+# YOLOv5 🚀 by Ultralytics, GPL-3.0 license
+
 # Parameters
 nc: 80  # number of classes
 depth_multiple: 1.0  # model depth multiple

models/hub/yolov3-tiny.yaml

@@ -1,3 +1,5 @@
+# YOLOv5 🚀 by Ultralytics, GPL-3.0 license
+
 # Parameters
 nc: 80  # number of classes
 depth_multiple: 1.0  # model depth multiple

models/hub/yolov3.yaml

@@ -1,3 +1,5 @@
+# YOLOv5 🚀 by Ultralytics, GPL-3.0 license
+
 # Parameters
 nc: 80  # number of classes
 depth_multiple: 1.0  # model depth multiple

models/hub/yolov5-bifpn.yaml

@@ -1,3 +1,5 @@
+# YOLOv5 🚀 by Ultralytics, GPL-3.0 license
+
 # Parameters
 nc: 80  # number of classes
 depth_multiple: 1.0  # model depth multiple

models/hub/yolov5-fpn.yaml

@@ -1,3 +1,5 @@
+# YOLOv5 🚀 by Ultralytics, GPL-3.0 license
+
 # Parameters
 nc: 80  # number of classes
 depth_multiple: 1.0  # model depth multiple

models/hub/yolov5-p2.yaml

@@ -1,3 +1,5 @@
+# YOLOv5 🚀 by Ultralytics, GPL-3.0 license
+
 # Parameters
 nc: 80  # number of classes
 depth_multiple: 1.0  # model depth multiple

models/hub/yolov5-p6.yaml

@@ -1,3 +1,5 @@
+# YOLOv5 🚀 by Ultralytics, GPL-3.0 license
+
 # Parameters
 nc: 80  # number of classes
 depth_multiple: 1.0  # model depth multiple

models/hub/yolov5-p7.yaml

@@ -1,3 +1,5 @@
+# YOLOv5 🚀 by Ultralytics, GPL-3.0 license
+
 # Parameters
 nc: 80  # number of classes
 depth_multiple: 1.0  # model depth multiple

models/hub/yolov5-panet.yaml

@@ -1,3 +1,5 @@
+# YOLOv5 🚀 by Ultralytics, GPL-3.0 license
+
 # Parameters
 nc: 80  # number of classes
 depth_multiple: 1.0  # model depth multiple

models/hub/yolov5l6.yaml

@@ -1,3 +1,5 @@
+# YOLOv5 🚀 by Ultralytics, GPL-3.0 license
+
 # Parameters
 nc: 80  # number of classes
 depth_multiple: 1.0  # model depth multiple

models/hub/yolov5m6.yaml

@@ -1,3 +1,5 @@
+# YOLOv5 🚀 by Ultralytics, GPL-3.0 license
+
 # Parameters
 nc: 80  # number of classes
 depth_multiple: 0.67  # model depth multiple

models/hub/yolov5s-ghost.yaml

@@ -1,3 +1,5 @@
+# YOLOv5 🚀 by Ultralytics, GPL-3.0 license
+
 # Parameters
 nc: 80  # number of classes
 depth_multiple: 0.33  # model depth multiple

models/hub/yolov5s-transformer.yaml

@@ -1,3 +1,5 @@
+# YOLOv5 🚀 by Ultralytics, GPL-3.0 license
+
 # Parameters
 nc: 80  # number of classes
 depth_multiple: 0.33  # model depth multiple

models/hub/yolov5s6.yaml

@@ -1,3 +1,5 @@
+# YOLOv5 🚀 by Ultralytics, GPL-3.0 license
+
 # Parameters
 nc: 80  # number of classes
 depth_multiple: 0.33  # model depth multiple

models/hub/yolov5x6.yaml

@@ -1,3 +1,5 @@
+# YOLOv5 🚀 by Ultralytics, GPL-3.0 license
+
 # Parameters
 nc: 80  # number of classes
 depth_multiple: 1.33  # model depth multiple

models/yolo.py

@@ -1,4 +1,6 @@
-"""YOLOv5-specific modules
+# YOLOv5 🚀 by Ultralytics, GPL-3.0 license
+"""
+YOLO-specific modules
 
 Usage:
     $ python path/to/models/yolo.py --cfg yolov5s.yaml

models/yolov5l.yaml

@@ -1,3 +1,5 @@
+# YOLOv5 🚀 by Ultralytics, GPL-3.0 license
+
 # Parameters
 nc: 80  # number of classes
 depth_multiple: 1.0  # model depth multiple

models/yolov5m.yaml

@@ -1,3 +1,5 @@
+# YOLOv5 🚀 by Ultralytics, GPL-3.0 license
+
 # Parameters
 nc: 80  # number of classes
 depth_multiple: 0.67  # model depth multiple

models/yolov5s.yaml

@@ -1,3 +1,5 @@
+# YOLOv5 🚀 by Ultralytics, GPL-3.0 license
+
 # Parameters
 nc: 80  # number of classes
 depth_multiple: 0.33  # model depth multiple

models/yolov5x.yaml

@@ -1,3 +1,5 @@
+# YOLOv5 🚀 by Ultralytics, GPL-3.0 license
+
 # Parameters
 nc: 80  # number of classes
 depth_multiple: 1.33  # model depth multiple