yolov5——train.py代码注释详解使用教程
Posted Charms@
tags:
篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了yolov5——train.py代码注释详解使用教程相关的知识，希望对你有一定的参考价值。
yolov5——train.py代码【注释、详解、使用教程】
yolov5——train.py代码【注释、详解、使用教程】
前言
最近在用yolov5参加比赛，yolov5的技巧很多，仅仅用来参加比赛，着实有点浪费，所以有必要好好学习一番，在认真学习之前，首先向yolov5的作者致敬，对了我是用的版本是v6。每每看到这些大神的作品，实在是有点惭愧，要学的太多了。
1. parse_opt函数
def parse_opt(known=False):
"""
argparse 使用方法：
parse = argparse.ArgumentParser()
parse.add_argument('--s', type=int, default=2, help='flag_int')
"""
parser = argparse.ArgumentParser()
# weights 权重的路径./weights/yolov5s.pt....
# yolov5提供4个不同深度不同宽度的预训练权重 用户可以根据自己的需求选择下载
parser.add_argument('--weights', type=str, default=ROOT / 'yolov5s.pt', help='initial weights path')
# cfg 配置文件（网络结构） anchor/backbone/numclasses/head，训练自己的数据集需要自己生成
# 生成方式——例如我的yolov5s_mchar.yaml 根据自己的需求选择复制./models/下面.yaml文件，5个文件的区别在于模型的深度和宽度依次递增
parser.add_argument('--cfg', type=str, default='', help='model.yaml path')
# data 数据集配置文件（路径） train/val/label/， 该文件需要自己生成
# 生成方式——例如我的/data/mchar.yaml 训练集和验证集的路径 + 类别数 + 类别名称
parser.add_argument('--data', type=str, default=ROOT / 'data/coco128.yaml', help='dataset.yaml path')
# hpy超参数设置文件（lr/sgd/mixup）./data/hyps/下面有5个超参数设置文件，每个文件的超参数初始值有细微区别，用户可以根据自己的需求选择其中一个
parser.add_argument('--hyp', type=str, default=ROOT / 'data/hyps/hyp.scratch-low.yaml', help='hyperparameters path')
# epochs 训练轮次， 默认轮次为300次
parser.add_argument('--epochs', type=int, default=300)
# batchsize 训练批次， 默认bs=16
parser.add_argument('--batch-size', type=int, default=16, help='total batch size for all GPUs, -1 for autobatch')
# imagesize 设置图片大小, 默认640*640
parser.add_argument('--imgsz', '--img', '--img-size', type=int, default=640, help='train, val image size (pixels)')
# rect 是否采用矩形训练，默认为False
parser.add_argument('--rect', action='store_true', help='rectangular training')
# resume 是否接着上次的训练结果，继续训练
parser.add_argument('--resume', nargs='?', const=True, default=False, help='resume most recent training')
# nosave 不保存模型 默认False(保存) 在./runs/exp*/train/weights/保存两个模型 一个是最后一次的模型 一个是最好的模型
# best.pt/ last.pt 不建议运行代码添加 --nosave
parser.add_argument('--nosave', action='store_true', help='only save final checkpoint')
# noval 最后进行测试, 设置了之后就是训练结束都测试一下， 不设置每轮都计算mAP, 建议不设置
parser.add_argument('--noval', action='store_true', help='only validate final epoch')
# noautoanchor 不自动调整anchor, 默认False, 自动调整anchor
parser.add_argument('--noautoanchor', action='store_true', help='disable AutoAnchor')
# evolve参数进化， 遗传算法调参
parser.add_argument('--evolve', type=int, nargs='?', const=300, help='evolve hyperparameters for x generations')
# bucket谷歌优盘 / 一般用不到
parser.add_argument('--bucket', type=str, default='', help='gsutil bucket')
# cache 是否提前缓存图片到内存，以加快训练速度，默认False
parser.add_argument('--cache', type=str, nargs='?', const='ram', help='--cache images in "ram" (default) or "disk"')
# mage-weights 使用图片采样策略，默认不使用
parser.add_argument('--image-weights', action='store_true', help='use weighted image selection for training')
# device 设备选择
parser.add_argument('--device', default='', help='cuda device, i.e. 0 or 0,1,2,3 or cpu')
# multi-scale 多测度训练
parser.add_argument('--multi-scale', action='store_true', help='vary img-size +/- 50%%')
# single-cls 数据集是否多类/默认True
parser.add_argument('--single-cls', action='store_true', help='train multi-class data as single-class')
# optimizer 优化器选择 / 提供了三种优化器
parser.add_argument('--optimizer', type=str, choices=['SGD', 'Adam', 'AdamW'], default='SGD', help='optimizer')
# sync-bn:是否使用跨卡同步BN,在DDP模式使用
parser.add_argument('--sync-bn', action='store_true', help='use SyncBatchNorm, only available in DDP mode')
# workers/dataloader的最大worker数量
parser.add_argument('--workers', type=int, default=8, help='max dataloader workers (per RANK in DDP mode)')
# 保存路径 / 默认保存路径 ./runs/ train
parser.add_argument('--project', default=ROOT / 'runs/train', help='save to project/name')
# 实验名称
parser.add_argument('--name', default='exp', help='save to project/name')
# 项目位置是否存在 / 默认是都不存在
parser.add_argument('--exist-ok', action='store_true', help='existing project/name ok, do not increment')
parser.add_argument('--quad', action='store_true', help='quad dataloader')
# cos-lr 余弦学习率
parser.add_argument('--cos-lr', action='store_true', help='cosine LR scheduler')
# 标签平滑 / 默认不增强， 用户可以根据自己标签的实际情况设置这个参数，建议设置小一点 0.1 / 0.05
parser.add_argument('--label-smoothing', type=float, default=0.0, help='Label smoothing epsilon')
# 早停止忍耐次数 / 100次不更新就停止训练
parser.add_argument('--patience', type=int, default=100, help='EarlyStopping patience (epochs without improvement)')
# --freeze冻结训练 可以设置 default = [0] 数据量大的情况下，建议不设置这个参数
parser.add_argument('--freeze', nargs='+', type=int, default=[0], help='Freeze layers: backbone=10, first3=0 1 2')
# --save-period 多少个epoch保存一下checkpoint
parser.add_argument('--save-period', type=int, default=-1, help='Save checkpoint every x epochs (disabled if < 1)')
# --local_rank 进程编号 / 多卡使用
parser.add_argument('--local_rank', type=int, default=-1, help='DDP parameter, do not modify')
# Weights & Biases arguments
# 在线可视化工具，类似于tensorboard工具，想了解这款工具可以查看https://zhuanlan.zhihu.com/p/266337608
parser.add_argument('--entity', default=None, help='W&B: Entity')
# upload_dataset: 是否上传dataset到wandb tabel(将数据集作为交互式 dsviz表 在浏览器中查看、查询、筛选和分析数据集) 默认False
parser.add_argument('--upload_dataset', nargs='?', const=True, default=False, help='W&B: Upload data, "val" option')
# bbox_interval: 设置界框图像记录间隔 Set bounding-box image logging interval for W&B 默认-1 opt.epochs // 10
parser.add_argument('--bbox_interval', type=int, default=-1, help='W&B: Set bounding-box image logging interval')
# 使用数据的版本
parser.add_argument('--artifact_alias', type=str, default='latest', help='W&B: Version of dataset artifact to use')
# 传入的基本配置中没有的参数也不会报错# parse_args()和parse_known_args()
# parse = argparse.ArgumentParser()
# parse.add_argument('--s', type=int, default=2, help='flag_int')
# parser.parse_args() / parse_args()
opt = parser.parse_known_args()[0] if known else parser.parse_args()
return opt
2. main函数
2.1 main函数——打印关键词/安装环境
def main(opt, callbacks=Callbacks()):
############################################### 1. Checks ##################################################
if RANK in [-1, 0]:
# 输出所有训练参数 / 参数以彩色的方式表现
print_args(FILE.stem, opt)
# 检查代码版本是否更新
check_git_status()
# 检查安装是否都安装了 requirements.txt， 缺少安装包安装。
# 缺少安装包：建议使用 pip install -i https://pypi.tuna.tsinghua.edu.cn/simple -r requirements.txt
check_requirements(exclude=['thop'])
2.2 main函数——是否进行断点训练
############################################### 2. Resume ##################################################
# 初始化可视化工具wandb,wandb使用教程看https://zhuanlan.zhihu.com/p/266337608
# 断点训练使用教程可以查看：https://blog.csdn.net/CharmsLUO/article/details/123410081
if opt.resume and not check_wandb_resume(opt) and not opt.evolve: # resume an interrupted run
# isinstance()是否是已经知道的类型
# 如果resume是True，则通过get_lastest_run()函数找到runs为文件夹中最近的权重文件last.pt
ckpt = opt.resume if isinstance(opt.resume, str) else get_latest_run() # specified or most recent path
# 判断是否是文件
assert os.path.isfile(ckpt), 'ERROR: --resume checkpoint does not exist'
# # 相关的opt参数也要替换成last.pt中的opt参数 safe_load()yaml文件加载数据
with open(Path(ckpt).parent.parent / 'opt.yaml', errors='ignore') as f:
# argparse.Namespace 可以理解为字典
opt = argparse.Namespace(**yaml.safe_load(f)) # replace
opt.cfg, opt.weights, opt.resume = '', ckpt, True # reinstate
# 打印断点训练信息
LOGGER.info(f'Resuming training from ckpt')
else:
# 不使用断点训练就在加载输入的参数
opt.data, opt.cfg, opt.hyp, opt.weights, opt.project = \\
check_file(opt.data), check_yaml(opt.cfg), check_yaml(opt.hyp), str(opt.weights), str(opt.project) # checks
assert len(opt.cfg) or len(opt.weights), 'either --cfg or --weights must be specified'
# opt.evolve=False,opt.name='exp' opt.evolve=True,opt.name='evolve'
if opt.evolve:
if opt.project == str(ROOT / 'runs/train'): # if default project name, rename to runs/evolve
opt.project = str(ROOT / 'runs/evolve')
opt.exist_ok, opt.resume = opt.resume, False # pass resume to exist_ok and disable resume
# 保存相关信息
opt.save_dir = str(increment_path(Path(opt.project) / opt.name, exist_ok=opt.exist_ok))
2.3 main函数——是否分布式训练
# ############################################## 3.DDP mode ###############################################
# 选择设备cpu/cuda
device = select_device(opt.device, batch_size=opt.batch_size)
# 多卡训练GPU
if LOCAL_RANK != -1:
msg = 'is not compatible with YOLOv5 Multi-GPU DDP training'
assert not opt.image_weights, f'--image-weights msg'
assert not opt.evolve, f'--evolve msg'
assert opt.batch_size != -1, f'AutoBatch with --batch-size -1 msg, please pass a valid --batch-size'
assert opt.batch_size % WORLD_SIZE == 0, f'--batch-size opt.batch_size must be multiple of WORLD_SIZE'
assert torch.cuda.device_count() > LOCAL_RANK, 'insufficient CUDA devices for DDP command'
# 根据编号选择设备
#使用torch.cuda.set_device()可以更方便地将模型和数据加载到对应GPU上, 直接定义模型之前加入一行代码即可
# torch.cuda.set_device(gpu_id) #单卡
# torch.cuda.set_device('cuda:'+str(gpu_ids)) #可指定多卡
torch.cuda.set_device(LOCAL_RANK)
device = torch.device('cuda', LOCAL_RANK)
# 初始化多进程
dist.init_process_group(backend="nccl" if dist.is_nccl_available() else "gloo")
2.4 main函数——是否进化训练/遗传算法调参
################################################ 4. Train #################################################
# 不设置evolve直接调用train训练
if not opt.evolve:
train(opt.hyp, opt, device, callbacks)
# 分布式训练 WORLD_SIZE=主机的数量
# 如果是使用多卡训练, 那么销毁进程组
if WORLD_SIZE > 1 and RANK == 0:
LOGGER.info('Destroying process group... ')
# 使用多卡训练, 那么销毁进程组
dist.destroy_process_group()
# Evolve hyperparameters (optional)
# 遗传净化算法/一边训练一遍进化
# 了解遗传算法可以查看我的博客：
else:
# Hyperparameter evolution metadata (mutation scale 0-1, lower_limit, upper_limit)
# 超参数列表(突变范围 - 最小值 - 最大值)
meta = 'lr0': (1, 1e-5, 1e-1), # initial learning rate (SGD=1E-2, Adam=1E-3)
'lrf': (1, 0.01, 1.0), # final OneCycleLR learning rate (lr0 * lrf)
'momentum': (0.3, 0.6, 0.98), # SGD momentum/Adam beta1
'weight_decay': (1, 0.0, 0.001), # optimizer weight decay
'warmup_epochs': (1, 0.0, 5.0), # warmup epochs (fractions ok)
'warmup_momentum': (1, 0.0, 0.95), # warmup initial momentum
'warmup_bias_lr': (1, 0.0, 0.2), # warmup initial bias lr
'box': (1, 0.02, 0.2), # box loss gain
'cls': (1, 0.2, 4.0), # cls loss gain
'cls_pw': (1, 0.5, 2.0), # cls BCELoss positive_weight
'obj': (1, 0.2, 4.0), # obj loss gain (scale with pixels)
'obj_pw': (1, 0.5, 2.0), # obj BCELoss positive_weight
'iou_t': (0, 0.1, 0.7), # IoU training threshold
'anchor_t': (1, 2.0, 8.0), # anchor-multiple threshold
'anchors': (2, 2.0, 10.0), # anchors per output grid (0 to ignore)
'fl_gamma': (0, 0.0, 2.0), # focal loss gamma (efficientDet default gamma=1.5)
'hsv_h': (1, 0.0, 0.1), # image HSV-Hue augmentation (fraction)
'hsv_s': (1, 0.0, 0.9), # image HSV-Saturation augmentation (fraction)
'hsv_v': (1, 0.0, 0.9), # image HSV-Value augmentation (fraction)
'degrees': (1, 0.0, 45.0), # image rotation (+/- deg)
'translate': (1, 0.0, 0.9), # image translation (+/- fraction)
'scale': (1, 0.0, 0.9), # image scale (+/- gain)
'shear': (1, 0.0, 10.0), # image shear (+/- deg)
'perspective': (0, 0.0, 0.001), # image perspective (+/- fraction), range 0-0.001
'flipud': (1, 0.0, 1.0), # image flip up-down (probability)
'fliplr': (0, 0.0, 1.0), # image flip left-right (probability)
'mosaic': (1, 0.0, 1.0), # image mixup (probability)
'mixup': (1, 0.0, 1.0), # image mixup (probability)
'copy_paste': (1, 0.0, 1.0) # segment copy-paste (probability)
with open(opt.hyp, errors='ignore') as f:
# 加载yaml超参数
hyp = yaml.safe_load(f) # load hyps dict
if 'anchors' not in hyp: YOLOv5源码逐行超详细注释与解读——验证部分val（test）.py