YOLOv5 模型构建源码详解：yaml 配置与 parse_model 解析

Conv 模块参数解读

backbone 的 [-1, 1, Conv, [128, 3, 2]] 行作为解读参考，在 parse_model(d, ch) 中表示 f, n, m, args = [-1, 1, Conv, [128, 3, 2]]。

• f 为取 ch[f] 通道 (ch 保存通道，-1 取上次通道数);
• m 为调用模块函数，通常在 common.py 中;
• n 为网络深度 depth，使用 max[1, int(n*depth_multiple)] 赋值，即 m 结构循环次数；
• args 对应 [128, 3, 2]，表示通道数 args[0],该值会根据 math.ceil(args[0]/8)*8 调整，args[1] 表示 kernel 大小，args[2] 表示 stride，
• args[-2:] 后 2 位为 m 模块传递参数;

C3 模块参数解读

backbone 的 [-1, 3, C3, [128]] 行作为解读参考，在 parse_model(d, ch) 中表示 f, n, m, args = [-1, 1, Conv, [128, 3, 2]]。

• f 为取 ch[f] 通道 (ch 保存通道，-1 取上次通道数);
• m 为调用模块函数，通常在 common.py 中;
• n 为网络深度 depth，使用 max[1, int(n*depth_multiple)] 赋值，即 m 结构循环次数；
• args 对应 [128]，表示通道数 args[0] 为 c2，该值会根据 math.ceil(args[0]/8)*8 调整，决定当前层输出通道数量，而后在 parse_model 中被下面代码直接忽略，会被插值 n=1，在 C3 代码中表示循环次数，
• 顺便说下 args 对应 [128,False]，在 C3 中的 False 表示是否需要 shortcut。

c1, c2 = ch[f], args[0] if c2 != no: # if not output 
    c2 = make_divisible(c2 * gw, 8) 
    args = [c1, c2, *args[1:]] # 通过模块，更换 n 值 
    if m in [BottleneckCSP, C3, C3TR, C3Ghost]: 
        args.insert(2, n) # number of repeats 
        n = 1 

C3 模块代码如下:

class C3(nn.Module): # CSP Bottleneck with 3 convolutions 
def __init__(self, c1, c2, n=1, shortcut=True, g=1, e=0.5): # ch_in, ch_out, number, shortcut, groups, expansion 
    super().__init__() 
    c_ = int(c2 * e) # hidden channels 
    self.cv1 = Conv(c1, c_, 1, 1) 
    self.cv2 = Conv(c1, c_, 1, 1) 
    self.cv3 = Conv(2 * c_, c2, 1) # act=FReLU(c2) 
    self.m = nn.Sequential(*[Bottleneck(c_, c_, shortcut, g, e=1.0) for _ in range(n)]) # self.m = nn.Sequential(*[CrossConv(c_, c_, 3, 1, g, 1.0, shortcut) for _ in range(n)]) 
def forward(self, x): 
    return self.cv3(torch.cat((self.m(self.cv1(x)), self.cv2(x)), dim=1)) 

2. yaml 的 head 解读

head 参数

head: [[-1, 1, Conv, [512, 1, 1]], 
 [-1, 1, nn.Upsample, [None, 2, 'nearest']], 
 [[-1, 6], 1, Concat, [1]], # cat backbone P4 
 [-1, 3, C3, [512, False]], # 13 
 [-1, 1, Conv, [256, 1, 1]], 
 [-1, 1, nn.Upsample, [None, 2, 'nearest']], 
 [[-1, 4], 1, Concat, [1]], # cat backbone P3 
 [-1, 3, C3, [256, False]], # 17 (P3/8-small) 
 [-1, 1, Conv, [256, 3, 2]], 
 [[-1, 14], 1, Concat, [1]], # cat head P4 
 [-1, 3, C3, [512, False]], # 20 (P4/16-medium) 
 [-1, 1, Conv, [512, 3, 2]], 
 [[-1, 10], 1, Concat, [1]], # cat head P5 
 [-1, 3, C3, [1024, False]], # 23 (P5/32-large) 
 [[17, 20, 23], 1, Detect, [nc, anchors]], # Detect(P3, P4, P5) 
]

Concat 模块参数解读

head 的 [[-1, 6], 1, Concat, [1]] 行作为解读参考，在 parse_model(d, ch) 中表示 f, n, m, args = [[-1, 6], 1, Concat, [1]]。

• f 为取 ch[-1] 与 ch[6] 通道数和，且 6 会被保存到 save 列表中，在 forward 中该列表对应层模块输出会被保存;
• m 为调用模块函数，通常在 common.py 中;
• n 为网络深度 depth，使用 max[1, int(n*depth_multiple)] 赋值，即 m 结构循环次数，但这里必然为 1；
• args 对应 [1]，表示通 cat 维度，这里为 1，表示通道叠加；

Detect 模块参数解读

head 的 [[17, 20, 23], 1, Detect, [nc, anchors]] 行作为解读参考，在 parse_model(d, ch) 中表示 f, n, m, args = [[17, 20, 23], 1, Detect, [nc, anchors]]。

• f 表示需要使用的层，并分别在 17,20,23 层获取对应通道，可通过 yaml 从 backbone 开始从 0 开始数的那一行，如 17 对应 [-1, 3, C3, [256, False]], # 17 (P3/8-small)，
• 同时，17、20、23 也会被保存到 save 列表;
• m 为调用模块函数，通常在 common.py 中;
• n 为网络深度 depth，使用 max[1, int(n*depth_multiple)] 赋值，即 m 结构循环次数，但这里必然为 1；
• args 对应 [nc, anchors]，表示去 nc 数量与 anchor 三个列表，同时会将 f 找到的通道作为列表添加到 args 中，如下代码示意，
• 最终 args 大致为 [80, [[10, 13, 16, 30, 33, 23], [30, 61, 62, 45, 59, 119], [116, 90, 156, 198, 373, 326]], [128, 256, 512]]，
• 80 为类别 nc，[128, 256, 512] 为 f 对应的通道，其它为 anchor 值；

elif m is Detect: 
    args.append([ch[x] for x in f]) 
    if isinstance(args[1], int): # number of anchors 
        args[1] = [list(range(args[1] * 2))] * len(f) 

四、模型构建整体解读

YOLOv5 模型集成网络代码如下，其重要解读已在代码中注释。

class Model(nn.Module): 
    def __init__(self, cfg='yolov5s.yaml', ch=3, nc=None, anchors=None): # model, input channels, number of classes 
        super().__init__() 
        if isinstance(cfg, dict): 
            self.yaml = cfg # model dict 
        else: # is *.yaml 
            import yaml # for torch hub 
            self.yaml_file = Path(cfg).name 
            with open(cfg, errors='ignore') as f: 
                self.yaml = yaml.safe_load(f) # model dict 
        # Define model 
        ch = self.yaml['ch'] = self.yaml.get('ch', ch) # input channels 
        if nc and nc != self.yaml['nc']: 
            LOGGER.info(f"Overriding model.yaml nc={self.yaml['nc']} with nc={nc}") 
            self.yaml['nc'] = nc # override yaml value 
        if anchors: 
            LOGGER.info(f'Overriding model.yaml anchors with anchors={anchors}') 
            self.yaml['anchors'] = round(anchors) # override yaml value 
        self.model, self.save = parse_model(deepcopy(self.yaml), ch=[ch]) # model, savelist 
        self.names = [str(i) for i in range(self.yaml['nc'])] # default names，将其对应数字转为字符串 
        self.inplace = self.yaml.get('inplace', True) # Build strides, anchors 
        # 以下为 detect 模块设置参数 
        m = self.model[-1] # Detect() 
        if isinstance(m, Detect): 
            s = 256 # 2x min stride 
            m.inplace = self.inplace # 通过给定假设输入为 torch.zeros(1, ch, s, s) 获得 stride 
            m.stride = torch.tensor([s / x.shape[-2] for x in self.forward(torch.zeros(1, ch, s, s))]) # forward 
            m.anchors /= m.stride.view(-1, 1, 1) # 变换获得每一特征层的 anchor 
            check_anchor_order(m) 
            self.stride = m.stride # [8,16,32] 
            self._initialize_biases() # only run once，为检测 detect 设置 bias 初始化 
        # Init weights, biases 
        initialize_weights(self) 
        self.info() 
        LOGGER.info('') 
    def forward(self, x, augment=False, profile=False, visualize=False): 
        if augment: 
            return self._forward_augment(x) # augmented inference, None 
        return self._forward_once(x, profile, visualize) # single-scale inference, train 

以上代码最重要网络搭建模块，如下代码调用，我将在下一节解读。

self.model, self.save = parse_model(deepcopy(self.yaml), ch=[ch]) # model, savelist 

以上代码最重要网络运行 forward，如下代码调用，我将重点解读。 模型在训练时候，是调用下面模块，如下：

return self._forward_once(x, profile, visualize) # single-scale inference, train 

m.f 和 m.i 已在上面 yaml 中介绍，实际需重点关注 y 保存 save 列表对应的特征层输出，若没有则保留为 none 占位，其代码解读已在有注释，详情如下：

def _forward_once(self, x, profile=False, visualize=False): 
    y, dt = [], [] # outputs 
    for m in self.model: # 通过 m.f 确定改变 m 模块输入变量值，若为列表如 [-1,6] 一般为 cat 或 detect，一般需要给定输入什么特征 
        if m.f != -1: # if not from previous layer 
            # 若 m.f 为 [-1,6] 这种情况，则 [x if j == -1 else y[j] for j in m.f] 运行此块，该块将 -1 变成了上一层输出 x 与对应 6 的输出 
            x = y[m.f] if isinstance(m.f, int) else [x if j == -1 else y[j] for j in m.f] # from earlier layers 
        if profile: 
            self._profile_one_layer(m, x, dt) 
        x = m(x) # run 
        # 通过之前 parse_model 获得 save 列表 (已赋值给 self.save)，将其 m 模块输出结果保存到 y 列表中，否则使用 none 代替位置 
        # 这里 m.i 是索引，是 yaml 每行的模块索引 
        y.append(x if m.i in self.save else None) # save output 
        if visualize: 
            feature_visualization(x, m.type, m.i, save_dir=visualize) 
    return x 

五、构建模型 parse_model 源码解读

该部分是 YOLOv5 根据对应 yaml 模型文件搭建的网络，需结合对应 yaml 文件一起解读，我已在上面介绍了 yaml 文件，可自行查看。 同时，也需要重点关注 m_.i, m_.f, m_.type, m_.np = i, f, t, np，会在上面 _forward_once 函数中用到。 本模块代码解读，也已在代码注释中，请查看源码理解，代码如下：

def parse_model(d, ch): # model_dict, input_channels(3) 
    LOGGER.info('\n%3s%18s%3s%10s %-40s%-30s' % ('', 'from', 'n', 'params', 'module', 'arguments')) 
    anchors, nc, gd, gw = d['anchors'], d['nc'], d['depth_multiple'], d['width_multiple'] 
    na = (len(anchors[0]) // 2) if isinstance(anchors, list) else anchors # number of anchors，获得每个特征点 anchor 数量，为 3 
    no = na * (nc + 5) # 最终预测输出数量，number of outputs = anchors * (classes + 5) # layers 
    # layers 保存 yaml 每一行处理作为一层，使用列表保存，最后输出使用 nn.Sequential(*layers) 处理作为模型层连接 
    # c2 为 yaml 每一行通道输出预定义数量，需与 width_multiple 参数共同决定 
    layers, save, c2 = [], [], ch[-1] # layers, savelist, ch out 
    # ch 为 channel 数量，初始值为 [3] 
    for i, (f, n, m, args) in enumerate(d['backbone'] + d['head']): # from, number, module, args 
        # eval 这个函数会把里面的字符串参数的引号去掉，把中间的内容当成 Python 的代码 
        # i 为每一层附带索引，相当于对 yaml 每一行的模块设置编号 
        m = eval(m) if isinstance(m, str) else m # eval strings 
        for j, a in enumerate(args): 
            try: 
                args[j] = eval(a) if isinstance(a, str) else a # eval strings 
            except NameError: 
                pass 
        n = n_ = max(round(n * gd), 1) if n > 1 else n # 获得最终深度，循环次数，depth gain 
        # 不同网络结构模块处理，同时会改变对应 c2 通道 
        if m in [Conv, GhostConv, Bottleneck, GhostBottleneck, SPP, SPPF, DWConv, MixConv2d, Focus, CrossConv, BottleneckCSP, C3, C3TR, C3SPP, C3Ghost]: # 是否在设定模块内 
            c1, c2 = ch[f], args[0] if c2 != no: # if not output 
                c2 = make_divisible(c2 * gw, 8) 
                args = [c1, c2, *args[1:]] # 通过模块，更换 n 值 
                if m in [BottleneckCSP, C3, C3TR, C3Ghost]: 
                    args.insert(2, n) # number of repeats 
                    n = 1 
            elif m is nn.BatchNorm2d: 
                args = [ch[f]] 
            elif m is Concat: 
                c2 = sum([ch[x] for x in f]) # 将最后一层通道数与 cancet 通道叠加求和，如 [[-1, 6], 1, Concat, [1]] 将 -1 与第 6 通道求和 
            elif m is Detect: 
                args.append([ch[x] for x in f]) 
                if isinstance(args[1], int): # number of anchors 
                    args[1] = [list(range(args[1] * 2))] * len(f) 
            elif m is Contract: 
                c2 = ch[f] * args[0] ** 2 
            elif m is Expand: 
                c2 = ch[f] // args[0] ** 2 
            else: 
                c2 = ch[f] 
        m_ = nn.Sequential(*[m(*args) for _ in range(n)]) if n > 1 else m(*args) # module 
        t = str(m)[8:-2].replace('__main__.', '') # module type 
        np = sum([x.numel() for x in m_.parameters()]) # number params，计算参数量 
        m_.i, m_.f, m_.type, m_.np = i, f, t, np # attach index, 'from' index, type, number params，将其赋给模型，后面 forward 会使用到 
        LOGGER.info('%3s%18s%3s%10.0f %-40s%-30s' % (i, f, n_, np, t, args)) # print 
        save.extend(x % i for x in ([f] if isinstance(f, int) else f) if x != -1) # append to savelist 
        layers.append(m_) # if i == 0: ch = [] # 删除 输入的 3 通道 
        ch.append(c2) # 保存每个模块的通道，即 yaml 的每行均保存，包含 concat 啥都保存 
    return nn.Sequential(*layers), sorted(save)