【YOLO】v5s 6.1版本detect.py文件源码解读

本文结构和某些内容参考博文【YOLOV5-5.x 源码解读】detect.py，但可能由于版本不同等原因与我下载的源码存在出入，因此我结合原博文和自身对代码的理解写这篇博文。

0. 导入需要的包和基本配置

import argparse  # python的命令行解析的标准模块  可以让我们直接在命令行中就可以向程序中传入参数并让程序运行
import os
import sys       # sys系统模块 包含了与Python解释器和它的环境有关的函数。
from pathlib import Path  # Path将str转换为Path对象 使字符串路径易于操作的模块

import torch  # pytorch模块
import torch.backends.cudnn as cudnn  # cuda模块

# ---------感觉给系统添加环境变量（不确定） -----------------
FILE = Path(__file__).resolve()
ROOT = FILE.parents[0]  # YOLOv5 root directory
if str(ROOT) not in sys.path:
    sys.path.append(str(ROOT))  # add ROOT to PATH
ROOT = Path(os.path.relpath(ROOT, Path.cwd()))  # relative

# ----------------- 导入自定义的其他包 -------------------
from models.common import DetectMultiBackend
from utils.datasets import IMG_FORMATS, VID_FORMATS, LoadImages, LoadStreams
from utils.general import (LOGGER, check_file, check_img_size, check_imshow, check_requirements, colorstr, cv2,
                           increment_path, non_max_suppression, print_args, scale_coords, strip_optimizer, xyxy2xywh)
from utils.plots import Annotator, colors, save_one_box
from utils.torch_utils import select_device, time_sync

1. 设置opt参数

def parse_opt():
    """
       opt参数解析
       weights: 模型的权重地址 默认 weights/best.pt
       source: 测试数据文件(图片或视频)的保存路径 默认data/images
       imgsz: 网络输入图片的大小 默认640
       conf-thres: 置信度阈值 默认0.25，越大标注框越少
       iou-thres: 交并比阈值 默认0.45，越大所得的重叠框越多
       max-det: 每张图片最大的目标个数 默认1000
       device: 设置代码执行的设备 cuda device, i.e. 0 or 0,1,2,3 or cpu
       view-img: 是否展示预测之后的图片或视频 默认False
       save-txt: 是否将预测的框坐标以txt文件格式保存 默认True 会在runs/detect/expn/labels下生成每张图片预测的txt文件
       save-conf: 是否保存预测每个目标的置信度到预测tx文件中 默认True
       save-crop: 是否需要将预测到的目标从原图中扣出来 剪切好 并保存 会在runs/detect/expn下生成crops文件，将剪切的图片保存在里面  默认False
       nosave: 是否不要保存预测后的图片  默认False 就是默认要保存预测后的图片
       classes: 在nms中是否是只保留某些特定的类 默认是None 就是所有类只要满足条件都可以保留
       agnostic-nms: 进行nms是否也除去不同类别之间的框 默认False
       augment: 预测是否也要采用数据增强 TTA
       visualize：可视化特征，默认False
       update: 是否将optimizer从ckpt中删除  更新模型  默认False
       project: 当前测试结果放在哪个主文件夹下 默认runs/detect
       name: 当前测试结果放在run/detect下的文件名  默认是exp
       exist-ok: 是否存在当前文件 默认False 一般是 no exist-ok 连用  所以一般都要重新创建文件夹
       line-thickness: 画框的框框的线宽  默认是 3
       hide-labels: 画出的框框是否需要隐藏label信息 默认False
       hide-conf: 画出的框框是否需要隐藏conf信息 默认False
       half: 是否使用半精度 Float16 推理 可以缩短推理时间 但是默认是False
       dnn：
    """
    parser = argparse.ArgumentParser()
    parser.add_argument('--weights', nargs='+', type=str, default=ROOT / 'yolov5s.pt', help='model path(s)')
    parser.add_argument('--source', type=str, default=ROOT / 'data/images', help='file/dir/URL/glob, 0 for webcam')
    parser.add_argument('--data', type=str, default=ROOT / 'data/coco128.yaml', help='(optional) dataset.yaml path')
    parser.add_argument('--imgsz', '--img', '--img-size', nargs='+', type=int, default=[640], help='inference size h,w')
    parser.add_argument('--conf-thres', type=float, default=0.25, help='confidence threshold')
    parser.add_argument('--iou-thres', type=float, default=0.45, help='NMS IoU threshold')
    parser.add_argument('--max-det', type=int, default=1000, help='maximum detections per image')
    parser.add_argument('--device', default='', help='cuda device, i.e. 0 or 0,1,2,3 or cpu')
    parser.add_argument('--view-img', action='store_true', help='show results')
    parser.add_argument('--save-txt', action='store_true', help='save results to *.txt')
    parser.add_argument('--save-conf', action='store_true', help='save confidences in --save-txt labels')
    parser.add_argument('--save-crop', action='store_true', help='save cropped prediction boxes')
    parser.add_argument('--nosave', action='store_true', help='do not save images/videos')
    parser.add_argument('--classes', nargs='+', type=int, help='filter by class: --classes 0, or --classes 0 2 3')
    parser.add_argument('--agnostic-nms', action='store_true', help='class-agnostic NMS')
    parser.add_argument('--augment', action='store_true', help='augmented inference')
    parser.add_argument('--visualize', action='store_true', help='visualize features')
    parser.add_argument('--update', action='store_true', help='update all models')
    parser.add_argument('--project', default=ROOT / 'runs/detect', help='save results to project/name')
    parser.add_argument('--name', default='exp', help='save results to project/name')
    parser.add_argument('--exist-ok', action='store_true', help='existing project/name ok, do not increment')
    parser.add_argument('--line-thickness', default=3, type=int, help='bounding box thickness (pixels)')
    parser.add_argument('--hide-labels', default=False, action='store_true', help='hide labels')
    parser.add_argument('--hide-conf', default=False, action='store_true', help='hide confidences')
    parser.add_argument('--half', action='store_true', help='use FP16 half-precision inference')
    parser.add_argument('--dnn', action='store_true', help='use OpenCV DNN for ONNX inference')
    opt = parser.parse_args()  # 解析输入行
    opt.imgsz *= 2 if len(opt.imgsz) == 1 else 1  # expand
    print_args(vars(opt))
    return opt

2. 执行main函数

def main(opt):
    check_requirements(exclude=('tensorboard', 'thop'))
    run(**vars(opt))   # opt本身是一个类，通过vars返回对象object的属性和属性值的字典对象


if __name__ == "__main__":
    opt = parse_opt()
    main(opt)
  

Python vars() 函数

3. 执行run函数

3.1 载入参数

此部分是给参数设置了一个默认值，各个参数的意义与“1. 设置opt参数”是相同的。

@torch.no_grad()
def run(
        weights=ROOT / 'yolov5s.pt',  # model.pt path(s)
        source=ROOT / 'data/images',  # file/dir/URL/glob, 0 for webcam
        data=ROOT / 'data/coco128.yaml',  # dataset.yaml path
        imgsz=(640, 640),  # inference size (height, width)
        conf_thres=0.25,  # confidence threshold
        iou_thres=0.45,  # NMS IOU threshold
        max_det=1000,  # maximum detections per image
        device='',  # cuda device, i.e. 0 or 0,1,2,3 or cpu
        view_img=False,  # show results
        save_txt=False,  # save results to *.txt
        save_conf=False,  # save confidences in --save-txt labels
        save_crop=False,  # save cropped prediction boxes
        nosave=False,  # do not save images/videos
        classes=None,  # filter by class: --class 0, or --class 0 2 3
        agnostic_nms=False,  # class-agnostic NMS
        augment=False,  # augmented inference
        visualize=False,  # visualize features
        update=False,  # update all models
        project=ROOT / 'runs/detect',  # save results to project/name
        name='exp',  # save results to project/name
        exist_ok=False,  # existing project/name ok, do not increment
        line_thickness=3,  # bounding box thickness (pixels)
        hide_labels=False,  # hide labels
        hide_conf=False,  # hide confidences
        half=False,  # use FP16 half-precision inference
        dnn=False,  # use OpenCV DNN for ONNX inference
):

3.2 输入检查和输出设置

# ========================1. 输入检查和输出设置=================================
    source = str(source)
    # 是否保存预测后的图片 默认nosave=False 所以只要传入的文件地址不是以.txt结尾 就都是要保存预测后的图片的
    save_img = not nosave and not source.endswith('.txt')  # save inference images
    # 检查输入源是否为文件、域名或是摄像头数据
    is_file = Path(source).suffix[1:] in (IMG_FORMATS + VID_FORMATS)
    is_url = source.lower().startswith(('rtsp://', 'rtmp://', 'http://', 'https://'))
    webcam = source.isnumeric() or source.endswith('.txt') or (is_url and not is_file)
    # 如果是域名也是文件，则ling'xu
    if is_url and is_file:
        source = check_file(source)  # download

    # 检查当前Path(project) / name是否存在 如果存在就新建新的save_dir 默认exist_ok=False 需要重建
    # 将原先传入的名字扩展成新的save_dir 如runs/detect/exp存在 就扩展成 runs/detect/exp1
    save_dir = increment_path(Path(project) / name, exist_ok=exist_ok)  # increment run
    # 如果需要save txt就新建save_dir / 'labels' 否则就新建save_dir
    # 默认save_txt=False 所以这里一般都是新建一个 save_dir(runs/detect/expn)
    (save_dir / 'labels' if save_txt else save_dir).mkdir(parents=True, exist_ok=True)  # make dir
    

3.3 载入模型和模型参数

# ========================2. 载入模型和模型参数============================
    # 选择设备，比如cuda:0或是cpu等
    device = select_device(device)
    # 加载模型，这里包含使用half的判断， 如果使用half包括模型半精度和输入图片半精度
    model = DetectMultiBackend(weights, device=device, dnn=dnn, data=data, fp16=half)
    # 模型的一些参数（待研究）
    stride, names, pt = model.stride, model.names, model.pt
    # 检查图片格式，进行resize + pad，输入图片的长宽必须是32的倍数
    imgsz = check_img_size(imgsz, s=stride)  # check image size
数并调整模型

3.4 加载推理数据

    # ========================3. 加载推理数据=================================
    if webcam:
        view_img = check_imshow()
        cudnn.benchmark = True  # set True to speed up constant image size inference
        dataset = LoadStreams(source, img_size=imgsz, stride=stride, auto=pt)
        bs = len(dataset)  # batch_size
    else:
        dataset = LoadImages(source, img_size=imgsz, stride=stride, auto=pt)
        bs = 1  # batch_size
    vid_path, vid_writer = [None] * bs, [None] * bs  # ？

3.5 推理前测试

# ========================4. 推理前测试=================================
    # Run inference
    model.warmup(imgsz=(1 if pt else bs, 3, *imgsz))  # warmup

3.6 正式推理

# ========================5. 正式推理=================================
dt, seen = [0.0, 0.0, 0.0], 0
# path: 图片/视频的路径
# im: 进行resize + pad之后的图片
# img0s: 原尺寸的图片
# vid_cap: 当读取图片时为None, 读取视频时为视频源
# s: 一个字符串，包含当前处理源文件的路径名称等信息
for path, im, im0s, vid_cap, s in dataset:

3.6.1 处理每一张图片/视频的格式

	# 5.1、处理每一张图片/视频的格式
	t1 = time_sync()
	im = torch.from_numpy(im).to(device)
	im = im.half() if model.fp16 else im.float()  # 半精度训练 uint8 to fp16/32
	im /= 255  # 归一化 0 - 255 to 0.0 - 1.0
	# 如果图片是3维(RGB) 就在前面添加一个维度1当中batch_size=1
	# 因为输入网络的图片需要是4维的 [batch_size, channel, w, h]
	if len(im.shape) == 3:
	    im = im[None]  # expand for batch dim
	t2 = time_sync()
	     dt[0] += t2 - t1

3.6.2 对每张图片/视频进行前向推理

	# 5.2、对每张图片/视频进行前向推理
	visualize = increment_path(save_dir / Path(path).stem, mkdir=True) if visualize else False
	pred = model(im, augment=augment, visualize=visualize)
	t3 = time_sync()
	dt[1] += t3 - t2

nms除去多余的框

	# 5.3、nms除去多余的框
	# Apply NMS  进行NMS
	# conf_thres: 置信度阈值
	# iou_thres: iou阈值
	# classes: 是否只保留特定的类别 默认为None
	# agnostic_nms: 进行nms是否也去除不同类别之间的框
	# max_det: 每张图片的最大目标个数 默认1000
	# pred: [num_obj, 6] = [5, 6]   这里的预测信息pred还是相对于 img_size(640) 的
	pred = non_max_suppression(pred, conf_thres, iou_thres, classes, agnostic_nms, max_det=max_det)
	dt[2] += time_sync() - t3

3.6.5 后续保存或者打印预测信息

# 5.4 后续保存或者打印预测信息
# 对每张图片进行处理  将pred(相对img_size 640)映射回原图img0 size
for i, det in enumerate(pred):  # per image
    seen += 1
    if webcam:  # batch_size >= 1
        # 如果输入源是webcam（网页）则batch_size>=1 取出dataset中的一张图片
        p, im0, frame = path[i], im0s[i].copy(), dataset.count
        s += f'{i}: '
    else:
        # 但是大部分我们一般都是从LoadImages流读取本都文件中的照片或者视频 所以batch_size=1
        # p: 当前图片/视频的绝对路径 如 F:\yolo_v5\yolov5-U\data\images\bus.jpg
        # im0: 原始图片 letterbox + pad 之前的图片
        # frame: 初始为0  可能是当前图片属于视频中的第几帧？
        p, im0, frame = path, im0s.copy(), getattr(dataset, 'frame', 0)

    # 当前图片路径 如 F:\yolo_v5\yolov5-U\data\images\bus.jpg
    p = Path(p)  # to Path
    # 图片/视频的保存路径save_path 如 runs\\detect\\exp8\\bus.jpg
    save_path = str(save_dir / p.name)  # im.jpg
    # txt文件(保存预测框坐标)保存路径 如 runs\\detect\\exp8\\labels\\bus
    txt_path = str(save_dir / 'labels' / p.stem) + ('' if dataset.mode == 'image' else f'_{frame}')  # im.txt
    # print string  输出信息  图片shape (w, h)
    s += '%gx%g ' % im.shape[2:]  # print string
    #  normalization gain gn = [w, h, w, h]  用于后面的归一化
    gn = torch.tensor(im0.shape)[[1, 0, 1, 0]]  # normalization gain whwh
    # imc: for save_crop 在save_crop中使用
    imc = im0.copy() if save_crop else im0  # for save_crop
    # annotator用于绘制边界框等信息
    annotator = Annotator(im0, line_width=line_thickness, example=str(names))
    if len(det):
        # Rescale boxes from img_size to im0 size
        # 将预测信息（相对img_size 640）映射回原图 img0 size
        det[:, :4] = scale_coords(im.shape[2:], det[:, :4], im0.shape).round()

        # Print results
        # 输出信息s + 检测到的各个类别的目标个数
        for c in det[:, -1].unique():
            n = (det[:, -1] == c).sum()  # detections per class
            s += f"{n} {names[int(c)]}{'s' * (n > 1)}, "  # add to string

        # Write results
        # 保存预测信息: txt、img0上画框、crop_img
        for *xyxy, conf, cls in reversed(det):
            # 将每个图片的预测信息分别存入save_dir/labels下的xxx.txt中 每行: class_id+score+xywh
            if save_txt:  # Write to file
                # 将xyxy(左上角 + 右下角)格式转换为xywh(中心的 + 宽高)格式 并除以gn(whwh)做归一化 转为list再保存
                xywh = (xyxy2xywh(torch.tensor(xyxy).view(1, 4)) / gn).view(-1).tolist()  # normalized xywh
                line = (cls, *xywh, conf) if save_conf else (cls, *xywh)  # label format
                with open(txt_path + '.txt', 'a') as f:
                    f.write(('%g ' * len(line)).rstrip() % line + '\n')

            # 在原图上画框 + 将预测到的目标剪切出来 保存成图片 保存在save_dir/crops下
            if save_img or save_crop or view_img:  # Add bbox to image
                c = int(cls)  # integer class
                label = None if hide_labels else (names[c] if hide_conf else f'{names[c]} {conf:.2f}')
                annotator.box_label(xyxy, label, color=colors(c, True))
                if save_crop:
                    save_one_box(xyxy, imc, file=save_dir / 'crops' / names[c] / f'{p.stem}.jpg', BGR=True)

    # Stream results
    im0 = annotator.result()
    # 是否需要显示我们预测后的结果  img0(此时已将pred结果可视化到了img0中)
    if view_img:
        cv2.imshow(str(p), im0)
        cv2.waitKey(1)  # 1 millisecond

    # Save results (image with detections)
    # 是否需要保存图片或视频（检测后的图片/视频 里面已经被我们画好了框的） img0
    if save_img:
        if dataset.mode == 'image':
            cv2.imwrite(save_path, im0)
        else:  # 'video' or 'stream'
            if vid_path[i] != save_path:  # new video
                vid_path[i] = save_path
                if isinstance(vid_writer[i], cv2.VideoWriter):
                    vid_writer[i].release()  # release previous video writer
                if vid_cap:  # video
                    fps = vid_cap.get(cv2.CAP_PROP_FPS)
                    w = int(vid_cap.get(cv2.CAP_PROP_FRAME_WIDTH))
                    h = int(vid_cap.get(cv2.CAP_PROP_FRAME_HEIGHT))
                else:  # stream
                    fps, w, h = 30, im0.shape[1], im0.shape[0]
                save_path = str(Path(save_path).with_suffix('.mp4'))  # force *.mp4 suffix on results videos
                vid_writer[i] = cv2.VideoWriter(save_path, cv2.VideoWriter_fourcc(*'mp4v'), fps, (w, h))
            vid_writer[i].write(im0)
                    

3.6.6 打印所花费时间，仅供参考

# Print time (inference-only)
# 打印所花费时间，仅供参考
LOGGER.info(f'{s}Done. ({t3 - t2:.3f}s)')

3.7 推理结束, 保存结果, 打印信息

# ========================6. 推理结束, 保存结果, 打印信息==========================
# Print results
t = tuple(x / seen * 1E3 for x in dt)  # speeds per image
LOGGER.info(f'Speed: %.1fms pre-process, %.1fms inference, %.1fms NMS per image at shape {(1, 3, *imgsz)}' % t)
# 保存预测的label信息 xywh等   save_txt
if save_txt or save_img:
    s = f"\n{len(list(save_dir.glob('labels/*.txt')))} labels saved to {save_dir / 'labels'}" if save_txt else ''
    LOGGER.info(f"Results saved to {colorstr('bold', save_dir)}{s}")
if update:
    #  strip_optimizer函数将optimizer从ckpt中删除  更新模型
    strip_optimizer(weights)  # update model (to fix SourceChangeWarning)

感谢满船清梦压星河HK博主。

4. 拓展：yolov5中值得学习的python用法

1. Path替代os.path

   from pathlib import Path
   # 1. p.suffix
   is_file = Path(source).suffix[1:] in (IMG_FORMATS + VID_FORMATS)
   # 2. p.name
   save_path = str(save_dir / p.name)  # im.jpg
   # 3. p.stem
   txt_path = str(save_dir / 'labels' / p.stem) + ('' if dataset.mode == 'image' else f'_{frame}')  # im.txt
   

   测试：

   from pathlib import Path
   
   source = r'D://a//b//c//d.jpg'
   p = Path(source)
   print(p.suffix)   # .jpg
   print(p.name)  # d.jpg
   print(p.stem)  # d
   

2. 复杂字符串格式输出

   s += f"{n} {detect_model.names[int(c)]}{'s' * (n > 1)}, " 
   

   测试：

   s = ''
   n = 2
   names = "aa'dd'gg"
   s += f"{n} {names}{'s' * (n > 1)}, " 
   print(s)   # 2 aa'dd'ggs,