[Docs] Update registry documentation (#133)

pull/140/head
Zaida Zhou 2022-03-25 11:29:34 +08:00 committed by GitHub
parent aee6d7a769
commit e4859030af
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 6 additions and 4 deletions

View File

@ -210,7 +210,7 @@ conv = MODELS.build(cfg)
MMEngine 的注册器支持跨项目调用,即可以在一个项目中使用另一个项目的模块。虽然跨项目调用也有其他方法的可以实现,但 MMEngine 注册器提供了更为简便的方法。
为了方便跨库调用MMEngine 提供了 15 个根注册器:
为了方便跨库调用MMEngine 提供了 17 个根注册器:
- RUNNERS: Runner 的注册器
- RUNNER_CONSTRUCTORS: Runner 的构造器
@ -225,8 +225,10 @@ MMEngine 的注册器支持跨项目调用,即可以在一个项目中使用
- OPTIMIZERS: 注册了 PyTorch 中所有的 `optimizer` 以及自定义的 `optimizer`
- OPTIMIZER_CONSTRUCTORS: optimizer 的构造器
- PARAM_SCHEDULERS: 各种参数调度器, 如 `MultiStepLR`
- TASK_UTILS: 任务强相关的一些组件,如 `AnchorGenerator`, `BboxCoder`
- EVALUATORS: 用于验证模型精度的评估器
- TASK_UTILS: 任务强相关的一些组件,如 `AnchorGenerator`, `BboxCoder`
- VISUALIZERS: 管理绘制模块,如 `DetVisualizer` 可在图片上绘制预测框
- WRITERS: 存储训练日志的后端,如 `LocalWriter`, `TensorboardWriter`
下面我们以 OpenMMLab 开源项目为例介绍如何跨项目调用模块。

View File

@ -35,12 +35,12 @@ OPTIMIZERS = Registry('optimizer')
OPTIMIZER_CONSTRUCTORS = Registry('optimizer constructor')
# mangage all kinds of parameter schedulers like `MultiStepLR`
PARAM_SCHEDULERS = Registry('parameter scheduler')
# manage all kinds of evaluators for computing metrics
EVALUATORS = Registry('evaluator')
# manage task-specific modules like anchor generators and box coders
TASK_UTILS = Registry('task util')
# manage all kinds of evaluators for computing metrics
EVALUATORS = Registry('evaluator')
# manage visualizer
VISUALIZERS = Registry('visualizer')
# manage writer