fastreid.utils.registry.Registry Class Reference

Inheritance diagram for fastreid.utils.registry.Registry:

Public Member Functions
None	__init__ (self, str name)
Optional[object]	register (self, object obj=None)
object	get (self, str name)

Protected Member Functions
None	_do_register (self, str name, object obj)

Detailed Description

The registry that provides name -> object mapping, to support third-party
users' custom modules.
To create a registry (e.g. a backbone registry):
.. code-block:: python
    BACKBONE_REGISTRY = Registry('BACKBONE')
To register an object:
.. code-block:: python
    @BACKBONE_REGISTRY.register()
    class MyBackbone():
        ...
Or:
.. code-block:: python
    BACKBONE_REGISTRY.register(MyBackbone)

Definition at line 7 of file registry.py.

Constructor & Destructor Documentation

__init__()

None fastreid.utils.registry.Registry.__init__	(		self,
		str	name )

Args:
    name (str): the name of this registry

Definition at line 24 of file registry.py.

    def __init__(self, name: str) -> None:
        """
        Args:
            name (str): the name of this registry
        """
        self._name: str = name
        self._obj_map: Dict[str, object] = {}
 

Member Function Documentation

_do_register()

None fastreid.utils.registry.Registry._do_register ( self, str name, object obj )

protected

Definition at line 32 of file registry.py.

    def _do_register(self, name: str, obj: object) -> None:
        assert (
                name not in self._obj_map
        ), "An object named '{}' was already registered in '{}' registry!".format(
            name, self._name
        )
        self._obj_map[name] = obj
 

get()

object fastreid.utils.registry.Registry.get	(		self,
		str	name )

Definition at line 58 of file registry.py.

    def get(self, name: str) -> object:
        ret = self._obj_map.get(name)
        if ret is None:
            raise KeyError(
                "No object named '{}' found in '{}' registry!".format(
                    name, self._name
                )
            )
        return ret

register()

Optional[object] fastreid.utils.registry.Registry.register	(		self,
		object	obj = None )

Register the given object under the the name `obj.__name__`.
Can be used as either a decorator or not. See docstring of this class for usage.

Definition at line 40 of file registry.py.

    def register(self, obj: object = None) -> Optional[object]:
        """
        Register the given object under the the name `obj.__name__`.
        Can be used as either a decorator or not. See docstring of this class for usage.
        """
        if obj is None:
            # used as a decorator
            def deco(func_or_class: object) -> object:
                name = func_or_class.__name__  # pyre-ignore
                self._do_register(name, func_or_class)
                return func_or_class
 
            return deco
 
        # used as a function call
        name = obj.__name__  # pyre-ignore
        self._do_register(name, obj)
 

---

The documentation for this class was generated from the following file:

• smreid/fastreid/utils/registry.py