简单理解mmdetection中的registry（注册类）类【转载整理】

简单理解mmdetection中的registry（注册类）类【转载整理】

原文地址：简单理解mmdetection中的registry类

         在mmdetection中使用registry类构建九个注册类实例，其实就是对类做一个划分管理，其中的每一个实例都用于存放属于这一簇的类，将来通过get_key方式获取，key 来自于config文件。

          比如，backbone 作为一簇其中包括vgg、resnet等。九个注册类实例如下所示：

# 【1】文件：mmdet\models\registry.py #
BACKBONES = Registry('backbone')
NECKS = Registry('neck')
ROI_EXTRACTORS = Registry('roi_extractor')
SHARED_HEADS = Registry('shared_head')
HEADS = Registry('head')
LOSSES = Registry('loss')
DETECTORS = Registry('detector')


# 【2】文件：mmdet\datasets\registry.py #
DATASETS = Registry('dataset')
PIPELINES = Registry('pipeline')

          Registry 类的代码如下所示：

#!/usr/bin/python3
# -*- coding: utf-8 -*-
import inspect

class Registry(object):
    # 【1】
    def __init__(self, name):
        self._name = name
        self._module_dict = dict()

    # 【2】
    def __repr__(self):
        format_str = self.__class__.__name__ + '(name={}, items={})'.format(
            self._name, list(self._module_dict.keys()))
        return format_str

    # 【3】
    @property
    def name(self):
        return self._name

    # 【4】
    @property
    def module_dict(self):
        return self._module_dict

    # 【5】
    def get(self, key):
        return self._module_dict.get(key, None)

    # 【6】
    def _register_module(self, module_class):
        """
        Register a module.
        Args:
            module (:obj:`nn.Module`): Module to be registered.
        """
        if not inspect.isclass(module_class):
            raise TypeError('module must be a class, but got {}'.format(
                type(module_class)))
        module_name = module_class.__name__
        if module_name in self._module_dict:
            raise KeyError('{} is already registered in {}'.format(
                module_name, self.name))
        self._module_dict[module_name] = module_class

    # 【7】
    def register_module(self, cls):
        self._register_module(cls)
        return cls

          mmdetection在构建模型的过程中一直通过key在注册类中查找对应的类，找到对应的类后将其实例化，最终将配置描述的模型构建出来，查找类的过程如以下代码所示：

key = 'vgg'
VGG = BACKBONES.get(key)

key = 'bce'
BCE = LOSSES .get(key)

          在mmdetection的代码中，将一个类注册到一个注册器中，可以直接将装饰器的语法糖写在类的声明上方，关于装饰器的内容参考上一篇博客。

ANIMAL = Registry('animal')

@ANIMAL.register_module
class Dog(object):
    def __init__(self):
        pass

    def run(self):
        print('running dog')

dog = ANIMAL.get('Dog')

d = dog()
d.run()

          等价写法为：

ANIMAL = Registry('animal')

class Dog(object):
    def __init__(self):
        pass

    def run(self):
        print('running dog')

ANIMAL.register_module(Dog)
dog = ANIMAL.get('Dog')

d = dog()
d.run(）

          两者输出结果皆为：

running dog