Detectron 源码解析-模型训练

发表于   |   更新于 | 分类于 | 评论数： | 阅读次数：
本文字数： 9.7k | 阅读时长 ≈ 9 分钟

运行Faster-RCNN指令

1
2
3
python tools/train_net.py \
    --cfg configs/getting_started/tutorial_1gpu_e2e_faster_rcnn_R-50-FPN.yaml \
    OUTPUT_DIR /tmp/detectron-output

上面两行指令第一行指定了config文件的位置, 第二行指定了输出文件的位置.

在tutorial_1gpu_e2e_faster_rcnn_R-50-FPN.yaml文件中, 主要包含了以下几个关键信息:

  • MODEL: 包含模型类型, 卷积网络的骨干, 样本类别数目
  • SOLVER: 包含一些参数的值, 如: 权重衰减系数, LR_POLICY, GAMMA, MAX_ITER等等
  • FPN: 包含若干布尔值, 指示是否开启FPN, MULTILEVEL_ROIS/RPN 等等
  • FAST_RCNN: 与ROI相关的一些信息
  • TRAIN: 指定初始化权重文件的url, 以及数据集相关信息
  • TEST: 指定TEST数据集相关信息, NMS阈值
  • OUTPUT_DIR: . 被命令行的参数覆盖

上图为tools/train_net.py文件函数调用的关系图, 几乎所有的模型都是通过这个脚本运行的, 源码分析如下:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
# tools/train_net.py
from __future import ... # 导入__future__的相关包, 兼容python2
#...
import cv2 #由于cv2自身的bug, cv2必须在caffe2之前被导入
#...
from caffe2.python import workspace
# 导入detectron相关
from detectron.core.config import assert_and_infer_cfg

from detectron.core.config import cfg



from detectron.utils.logging import setup_logging
# helpful utilities for working with caffe2
import detectron.utils.c2 as c2_utils

# 训练文件
import detectron.utils.train

# 导入Detectron需要的相关contirb ops(nccl ops)
c2_utils.import_contrib_ops()
# 导入Detectron ops
c2_utils.import_detectron_ops()

cv2.ocl.setUseOpenCL(False) #源码注释已经说得很清楚, 就是为了安全而特意禁用opencl

def parse_args():
  # 定义了各种命令行参数, 一般只需要关注--cfg参数, 其他默认即可

def main():
  # 初始化caffe2的全局环境,
  #如果希望看到更加详细的初始化信息, 可以将log_level设置为1
  workspace.GlobalInit(
    ['caffe2', '--caffe2_log_level=0', '--caffe2_gpu_memory_tracking=1']
  )

  ## 设置logging, __name__ = '__main__', 使用了python的logging模块,
  logger = setup_logging(__name__)  
  #...
  # 解析命令行参数
  args = parse_args()
  #...

  if args.cfg_file is not None:
    # from detectron.core.config import merge_cfg_from_file
    merge_cfg_from_file(args.cfg_file)
  if args.opts is not None:
    # from detectron.core.config import merge_cfg_from_list
    merge_cfg_from_list(args.opts)
  assert_and_infer_cfg()

  # 获取并显示当前的nvidia相关信息
  smi_output, cuda_ver, cudnn_ver = c2_utils.get_nvidia_info()
  logger.info(...)
  #...

  # 设置随机种子, 以便每次训练时的网络状态都不同
  np.random.seed(cfg.RNG_SEED)

  # 最重要的一行代码, 执行训练!
  # import detectron.utils.train
  checkpoints = detectron.utils.train.train_model()

  # 测试训练好的模型
  if not args.skip_test:
    test_model(...)

def test_model(...):
  # 测试训练好的模型
  #...

if __name__ == "__main__":
  main()

train.py 文件

可以看到, 上面只是一个启动训练代码的脚本文件, 接下来看一下detectron/utils/train.py文件中的train_model()函数的详细情况:

1
2
3
4
5
6
#detectron/utils/train.py

def train_model():
  """循环训练模型"""
  model, weights_file, start_iter, checkpoints, output_dir = create_model()
  #...

create_model()

在这里, train_model()函数的开始调用了create_model()函数, 在进行后面的代码分析之前, 需要先看看这个函数具体做了什么, 返回了什么:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
#detectron/utils/train.py
def train_model():
    #...
def handle_critical_error(model,msg):
    #...
def create_model():
  """创建模型, 并且寻找保存的checkpoints用以继续训练"""
  logger = logging.getLogger(__name__)

  start_iter = 0
  checkpoints = {}
  # from detectron.core.config import get_output_dir
  # def get_output_dir(datasets, training=True)
  # 这里只是用了数据集的名字, 并不是使用数据集
  # 在OUTPUT文件夹(由config定义)会创建一个新的文件夹, 并返回该路径:
  # <output-dir>/<train|test>/<dataset-name>/<model-type>/
  # 对于本例来说, cfg.TRAIN.DATASETS = ('coco_2014_train',)
  output_dir = get_output_dir(cfg.TRAIN.DATASETS, train = True)

  # 默认为R-50.pkl的 url 下载地址
  weights_file = cfg.TRAIN.WEIGHTS
  if cfg.TRAIN.AUTO_RESUME: #TODO, 这个参数在哪里??
    #...

  # 对于本例, cfg.MODEL.TYPE = generalized_rcnn
  logger.info("Building model: {}".format(cfg.MODEL.TYPE))

  # from detectron.modeling import model_builder
  # def create(model_type_func, train=False, gpu_id=0)
  # 创建一个一般化的模型, 然后将其转化成特定的模型
  # 函数内部使用了detectron/modeling/detector.py 中的DetectionModelHelper类
  # 同时将cfg.MODEL.NUM_CLASSES信息传递给了该类
  # cfg.MODEL.TYPE = generalized_rcnn
  # TODO: 此行代码涉及的文件和代码较多, 暂时先不深入探讨, 可以认为是创建了一个模型
  model = model_builder.create(cfg.MODEL.TYPE, train=True)

  if cfg.MEMONGER: # TODO, 这个参数在哪里?
      optimize_memory(model)

  workspace.RunNetOnce(model.param_init_net)
  return model, wright_file, start_iter, checkpoints, output_dir

setup_model_for_training(...)

接着回到刚才的train_model()函数:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
#detectron/utils/train.py
def train_model():
    """循环训练模型"""

    # 由上面的函数可知:
    # model为DetectionModelHelper类创建的模型对象
    # weights_file即为cfg文件里定义的权重文件的url
    # start_iter = 0
    # checkpoints ={} 字典类型哦!
    # output_dir为根据cfg.OUTPUT_DIR和DATASETS名字创建的输出目录
    model, weights_file, start_iter, checkpoints, output_dir = create_model()

    if "final" in checkpoints:
        # 如果已经训练完成, 则直接返回
        return checkpoints

    # 这里调用了本文件的函数, 主要是为训练模型做准备工作
    setup_model_for_training(model, weights_file, output_dir)
    #...

具体看一下setup_model_for_training函数的内部实现

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
#detectron/utils/train.py

# 加载保存的权重文件, 同时在 C2 workspace 中创建 network
def setup_model_for_training(model, weights_file, output_dir):
    logger = logging.getLogger(__name__)

    #调用了本文件的函数, 主要用于加载训练数据集, 并且将训练输入绑定到model中
    # def add_model_training_inputs(model), 无返回值
    # 核心代码:
    # from detectron.datasets.roidb import combined_roidb_for_trainig
    # roidb = combined_roidb_for_training(cfg.TRAIN.DATASETS, cfg.TRAIN.PROPOSAL_FILES)
    # model_builder.add_training_inputs(model, roidb = roidb)
    # 添加roidb, 内部会调用model_builder.add_training_inputs,
    # 该函数会为model创建用于训练网络的input ops 和blobs, 需要在调用了model_builder.create()之后调用
    # 创建位于detectron.roi_data.loader中的RoIDataLoader对象进行数据载入
    # model.roi_data_loader = RoIDataLoader()
    # TODO: 数据集加载过程涉及文件较多,后面会单独解析, 此处不太多讨论
    add_model_training_inputs(model)

    # import detectron.utils.net as nu
    if weights_file:
        # 从权重文件中初始化模型, 覆盖随机初始化参数权重, 并且指定gpu
        nu.initialize_gpu_from_weights_file(model, weights_file, gpu_id=0)

    # 多GPU训练时,训练同步GPU之间的参数信息
    # if cfg.NUM_GPUS = 1 直接return, 所以这句话在单GPU下可有可无
    nu.broadcast_parameters(model)
    # 正式创建caffe2网络
    workspace.CreateNet(model.net)
    #...log info

    # 本文件内的函数: def dump_proto_files(model, output_dir)
    # 保存训练网络的参数初始化的prototxt 描述信息
    # 分别为output_dir里面的net.pbtxt和param_init_net.pbtxt文件
    dump_proto_files(model, output_dir)

    # 载入mini-batches, 同时enqueuing blobs
    model.roi_data_loader.register_sigint_handler()
    model.roi_data_loader.start(prefill=True)

    return output_dir

add_model_training_inputs(model)

1
2
3
4
5
6
7
8
9
10
#detectron/utils/train.py

def add_training_inputs(model):
    logger = logging.getLogger(__name__)
    logger.info('Loading dataset: {}'.format(cfg.TRAIN.DATASETS))
    roidb = combined_roidb_for_training(
        cfg.TRAIN.DATASETS, cfg.TRAIN.PROPOSAL_FILES
    )
    logger.info('{:d} roidb entries'.format(len(roidb)))
    model_builder.add_training_inputs(model, roidb=roidb)

再看 train_model()

接着回到刚才的train_model()函数:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
#detectron/utils/train.py
def train_model():
    """循环训练模型"""

    # 调用本文件的create_model()函数, 由上面的函数可知:
    # model为DetectionModelHelper类创建的模型对象
    # weights_file即为cfg文件里定义的权重文件的url
    # start_iter = 0
    # checkpoints ={} 字典类型哦!
    # output_dir为根据cfg.OUTPUT_DIR和DATASETS名字创建的输出目录
    model, weights_file, start_iter, checkpoints, output_dir = create_model()

    if "final" in checkpoints:
        # 如果已经训练完成, 则直接返回
        return checkpoints

    # 这里调用了本文件的函数, 主要是为训练模型做准备工作, 加载权重, 创建网络等等
    setup_model_for_training(model, weights_file, output_dir)

    # from detectron.utils.training_stats import TrainingStats
    # def __init__(self, model)
    # 跟踪模型训练时的关键统计数据
    training_stats = TrainingStats(model)

    # TODO SNAPSHOT_ITERS参数在哪?
    CHECKPOINT_PERIOD = int(cfg.TRAIN.SNAPSHOT_ITERS/cfg.NUM_GPUS)

    #循环训练过程cfg.SOLVER.MAX_ITER=60000次
    for cur_iter in range(start_iter, cfg.SOLVER.MAX_ITER):
        # model.roi_data_loader是位于detectron.roi_data.loader中的RoIDataLoader对象
        # def has_stopped(self): return self.coordinator.should_stop()
        # coordinator是位于detectron.utils.coordinator中的Coordinator类的对象, 该类用于多线程处理数据队列
        if model.roi_data_loader.has_stopped():
            handle_critical_error(model, 'roi_data_loader failed')
        # from detectron.utils.training_stats import TrainingStats
        # 用于训练计时, 计时开始
        training_stats.IterTic()
        #更新学习率
        lr = model.UpdateWorkspaceLr(cur_iter, lr_policy.get_lr_at_iter(cur_iter))
        # 运行网络!关键步骤
        workspace.RunNet(model.net.Proto().name)
        if cur_iter == start_iter: #首次迭代打印模型信息
        # import detectron.utils.net as nu
            nu.print_net(model)
        training_stats.IterToc() # 计时结束
        training_stats.UpdateIterStats()
        training_stats.LogIterStats(cur_iter, lr)

        # 迭代到指定次数以后, 自动保存模型
        if (cur_iter+1) % CHECKPOINT_PERIOD ==0 and cur_iter>start_iter:
            checkpoints[cur_iter] = os.path.join(output_dir, "model_iter{}.pkl".format(cur_iter))
            nu.save_model_to_weights_file(checkpoints[cur_iter], model)

        if cur_iter == start_iter + training_stats.LOG_PERIOD:
            training_stats.ResetIterTimer()
        # 判断损失函数是否出现了nan值, 如果出现,则报错,注意,nan不是inf, nan值代表不存在的值, 如log(-1), 而log(0)是inf, 不是nan
        if np.isnan(training_stats.iter_total_loss):
            handle_critical_error(model, "loss is NaN")

    checkpoints['final'] = os.path.join(output_dir, 'model_final.pkl')
    nu.save_model_to_weights_file(checkpoints['final'], model)
    model.roi_data_loader.shutdown()
    return checkpoints

以上,便是train_model()函数的整体流程, 执行该函数后,训练过程就已经开始, 在detectron中, 所有的模型可数据都是用这个脚本训练的, 根据config文件的具体参数来决定载入哪个model, 或者使用哪个数据集. 但是上面的过程太过笼统, 给人一种隔了一堵墙的感觉. 因此, 我们需要更加深入了理解detectron是如何处理数据的, 又是如何将数据送到模型中去的, 另外, 每个模型的定义又是怎样的. 这些信息我会在后面的文章里一一解读.