mirror of
https://github.com/open-mmlab/mmengine.git
synced 2025-06-03 21:54:44 +08:00
[Doc]: update root registries in docs (#316)
This commit is contained in:
parent
45f5859b50
commit
d09af9ead4
@ -224,7 +224,7 @@ conv = MODELS.build(cfg)
|
|||||||
|
|
||||||
MMEngine 的注册器支持跨项目调用,即可以在一个项目中使用另一个项目的模块。虽然跨项目调用也有其他方法的可以实现,但 MMEngine 注册器提供了更为简便的方法。
|
MMEngine 的注册器支持跨项目调用,即可以在一个项目中使用另一个项目的模块。虽然跨项目调用也有其他方法的可以实现,但 MMEngine 注册器提供了更为简便的方法。
|
||||||
|
|
||||||
为了方便跨库调用,MMEngine 提供了 18 个根注册器:
|
为了方便跨库调用,MMEngine 提供了 20 个根注册器:
|
||||||
|
|
||||||
- RUNNERS: Runner 的注册器
|
- RUNNERS: Runner 的注册器
|
||||||
- RUNNER_CONSTRUCTORS: Runner 的构造器
|
- RUNNER_CONSTRUCTORS: Runner 的构造器
|
||||||
@ -232,17 +232,19 @@ MMEngine 的注册器支持跨项目调用,即可以在一个项目中使用
|
|||||||
- HOOKS: 钩子,如 `CheckpointHook`, `ProfilerHook`
|
- HOOKS: 钩子,如 `CheckpointHook`, `ProfilerHook`
|
||||||
- DATASETS: 数据集
|
- DATASETS: 数据集
|
||||||
- DATA_SAMPLERS: `Dataloader` 的 `sampler`,用于采样数据
|
- DATA_SAMPLERS: `Dataloader` 的 `sampler`,用于采样数据
|
||||||
- PIPELINES: 各种数据预处理,如 `Resize`, `Reshape`
|
- TRANSFORMS: 各种数据预处理,如 `Resize`, `Reshape`
|
||||||
- MODELS: 模型的各种模块
|
- MODELS: 模型的各种模块
|
||||||
- MODEL_WRAPPERS: 模型的包装器,如 `MMDistributedDataParallel`,用于对分布式数据并行
|
- MODEL_WRAPPERS: 模型的包装器,如 `MMDistributedDataParallel`,用于对分布式数据并行
|
||||||
- WEIGHT_INITIALIZERS: 权重初始化的工具
|
- WEIGHT_INITIALIZERS: 权重初始化的工具
|
||||||
- OPTIMIZERS: 注册了 PyTorch 中所有的 `optimizer` 以及自定义的 `optimizer`
|
- OPTIMIZERS: 注册了 PyTorch 中所有的 `optimizer` 以及自定义的 `optimizer`
|
||||||
- OPTIMIZER_CONSTRUCTORS: optimizer 的构造器
|
- OPTIM_WRAPPER: 对 Optimizer 相关操作的封装,如 `OptimWrapper`,`AmpOptimWrapper`
|
||||||
|
- OPTIM_WRAPPER_CONSTRUCTORS: optimizer wrapper 的构造器
|
||||||
- PARAM_SCHEDULERS: 各种参数调度器,如 `MultiStepLR`
|
- PARAM_SCHEDULERS: 各种参数调度器,如 `MultiStepLR`
|
||||||
- METRICS: 用于验证模型精度的评估指标
|
- METRICS: 用于计算模型精度的评估指标,如 `Accuracy`
|
||||||
|
- EVALUATOR: 用于计算模型精度的一个或多个评估指标
|
||||||
- TASK_UTILS: 任务强相关的一些组件,如 `AnchorGenerator`, `BboxCoder`
|
- TASK_UTILS: 任务强相关的一些组件,如 `AnchorGenerator`, `BboxCoder`
|
||||||
- VISUALIZERS: 管理绘制模块,如 `DetVisualizer` 可在图片上绘制预测框
|
- VISUALIZERS: 管理绘制模块,如 `DetVisualizer` 可在图片上绘制预测框
|
||||||
- WRITERS: 存储训练日志的后端,如 `LocalWriter`, `TensorboardWriter`
|
- VISBACKENDS: 存储训练日志的后端,如 `LocalVisBackend`, `TensorboardVisBackend`
|
||||||
- LOG_PROCESSORS: 控制日志的统计窗口和统计方法,默认使用 `LogProcessor`,如有特殊需求可自定义 `LogProcessor`
|
- LOG_PROCESSORS: 控制日志的统计窗口和统计方法,默认使用 `LogProcessor`,如有特殊需求可自定义 `LogProcessor`
|
||||||
|
|
||||||
下面我们以 OpenMMLab 开源项目为例介绍如何跨项目调用模块。
|
下面我们以 OpenMMLab 开源项目为例介绍如何跨项目调用模块。
|
||||||
|
@ -1,5 +1,5 @@
|
|||||||
# Copyright (c) OpenMMLab. All rights reserved.
|
# Copyright (c) OpenMMLab. All rights reserved.
|
||||||
"""MMEngine provides 11 root registries to support using modules across
|
"""MMEngine provides 20 root registries to support using modules across
|
||||||
projects.
|
projects.
|
||||||
|
|
||||||
More datails can be found at
|
More datails can be found at
|
||||||
@ -31,12 +31,17 @@ WEIGHT_INITIALIZERS = Registry('weight initializer')
|
|||||||
|
|
||||||
# mangage all kinds of optimizers like `SGD` and `Adam`
|
# mangage all kinds of optimizers like `SGD` and `Adam`
|
||||||
OPTIMIZERS = Registry('optimizer')
|
OPTIMIZERS = Registry('optimizer')
|
||||||
|
# manage optimizer wrapper
|
||||||
|
OPTIM_WRAPPERS = Registry('optim_wrapper')
|
||||||
# manage constructors that customize the optimization hyperparameters.
|
# manage constructors that customize the optimization hyperparameters.
|
||||||
OPTIM_WRAPPER_CONSTRUCTORS = Registry('optimizer wrapper constructor')
|
OPTIM_WRAPPER_CONSTRUCTORS = Registry('optimizer wrapper constructor')
|
||||||
# mangage all kinds of parameter schedulers like `MultiStepLR`
|
# mangage all kinds of parameter schedulers like `MultiStepLR`
|
||||||
PARAM_SCHEDULERS = Registry('parameter scheduler')
|
PARAM_SCHEDULERS = Registry('parameter scheduler')
|
||||||
|
|
||||||
# manage all kinds of metrics
|
# manage all kinds of metrics
|
||||||
METRICS = Registry('metric')
|
METRICS = Registry('metric')
|
||||||
|
# manage evaluator
|
||||||
|
EVALUATOR = Registry('evaluator')
|
||||||
|
|
||||||
# manage task-specific modules like anchor generators and box coders
|
# manage task-specific modules like anchor generators and box coders
|
||||||
TASK_UTILS = Registry('task util')
|
TASK_UTILS = Registry('task util')
|
||||||
@ -48,9 +53,3 @@ VISBACKENDS = Registry('vis_backend')
|
|||||||
|
|
||||||
# manage logprocessor
|
# manage logprocessor
|
||||||
LOG_PROCESSORS = Registry('log_processor')
|
LOG_PROCESSORS = Registry('log_processor')
|
||||||
|
|
||||||
# manage optimizer wrapper
|
|
||||||
OPTIM_WRAPPERS = Registry('optim_wrapper')
|
|
||||||
|
|
||||||
# manage evaluator
|
|
||||||
EVALUATOR = Registry('evaluator')
|
|
||||||
|
Loading…
x
Reference in New Issue
Block a user