欢迎来到 MMEngine 的中文文档！

您可以在页面左下角切换中英文文档。

开始你的第一步

• 介绍
• 安装
• 15 分钟上手 MMEngine

示例

• 训练生成对抗网络
• 训练语义分割模型

常用功能

• 恢复训练
• 分布式训练
• 加速训练
• 节省显存
• 大模型训练
• 性能更优的优化器
• 可视化训练日志
• 设置随机种子
• 调试技巧
• 统计模型计算量和参数量
• 设置日志、权重保存、验证的频率
• 从 EpochBased 切换至 IterBased

入门教程

• 执行器（Runner）
  • 执行器示例
    • 面向初学者的示例代码
    • 示例代码讲解
  • 执行器最佳实践——配置文件
  • 基本数据流
  • 为什么使用执行器（可选）
  • 下一步的建议
• 数据集（Dataset）与数据加载器（DataLoader）
  • 数据加载器详解
    • sampler 与 shuffle
    • DefaultSampler
    • 不起眼的 collate_fn
  • 数据集详解
    • 使用 torchvision 数据集
    • 自定义数据集
    • 使用 MMEngine 的数据集基类
• 模型（Model）
  • Runner 与 model
  • 接口约定
  • 数据预处理器（DataPreprocessor）
• 模型精度评测（Evaluation）
  • 在模型训练或测试中进行评测
    • 使用单个评测指标
    • 使用多个评测指标
    • 自定义评测指标
  • 使用离线结果进行评测
• 优化器封装（OptimWrapper）
  • 优化器封装 vs 优化器
    • 训练模型
    • 获取学习率/动量
    • 导出/加载状态字典
    • 使用多个优化器
    • 在执行器中配置优化器封装
  • 进阶配置
    • 为不同类型的参数设置不同的超参系数
    • 为模型不同部分的参数设置不同的超参系数
    • 自定义优化器构造策略
    • 在训练过程中调整超参
• 优化器参数调整策略（Parameter Scheduler）
  • 参数调度器的使用
    • 使用单一的学习率调度器
    • 组合多个学习率调度器（以学习率预热为例）
  • 如何调整其他参数
    • 动量
    • 通用的参数调度器
• 钩子（Hook）
  • 内置钩子
    • CheckpointHook
    • LoggerHook
    • ParamSchedulerHook
    • IterTimerHook
    • DistSamplerSeedHook
    • RuntimeInfoHook
    • EMAHook
    • EmptyCacheHook
    • SyncBuffersHook
    • ProfilerHook
  • 自定义钩子

进阶教程

• 注册器（Registry）
• 配置（Config）
• 数据集基类（BaseDataset）
• 数据变换 (Data Transform)
• 权重初始化
• 可视化
• 抽象数据接口
• 分布式通信原语
• 记录日志
• 文件读写
• 全局管理器（ManagerMixin）
• 跨库调用模块
• 测试时增强（Test time augmentation）
• 模型复杂度分析

架构设计

• 钩子
• 执行器
• 模型精度评测
• 可视化
• 日志系统
• 推理接口

迁移指南

• 迁移 MMCV 执行器到 MMEngine
• 迁移 MMCV 钩子到 MMEngine
• 迁移 MMCV 模型到 MMEngine
• 迁移 MMCV 参数调度器到 MMEngine
• 数据变换类的迁移

API 文档

• mmengine.analysis
  • ActivationAnalyzer
  • FlopAnalyzer
  • mmengine.analysis.activation_count
  • mmengine.analysis.flop_count
  • mmengine.analysis.parameter_count
  • mmengine.analysis.parameter_count_table
  • mmengine.analysis.get_model_complexity_info
• mmengine.registry
  • Registry
  • DefaultScope
  • mmengine.registry.build_from_cfg
  • mmengine.registry.build_model_from_cfg
  • mmengine.registry.build_runner_from_cfg
  • mmengine.registry.build_scheduler_from_cfg
  • mmengine.registry.count_registered_modules
  • mmengine.registry.traverse_registry_tree
  • mmengine.registry.init_default_scope
• mmengine.config
  • Config
  • ConfigDict
  • DictAction
  • read_base
• mmengine.runner
  • Runner
  • Loop
  • Checkpoints
  • AMP
  • Miscellaneous
• mmengine._strategy
  • BaseStrategy
  • SingleDeviceStrategy
  • DDPStrategy
  • DeepSpeedStrategy
  • FSDPStrategy
  • ColossalAIStrategy
  • MMDeepSpeedEngineWrapper
  • DeepSpeedOptimWrapper
  • ColossalAIOptimWrapper
• mmengine.hooks
  • Hook
  • CheckpointHook
  • EMAHook
  • LoggerHook
  • NaiveVisualizationHook
  • ParamSchedulerHook
  • RuntimeInfoHook
  • DistSamplerSeedHook
  • IterTimerHook
  • SyncBuffersHook
  • EmptyCacheHook
  • ProfilerHook
  • NPUProfilerHook
  • PrepareTTAHook
  • EarlyStoppingHook
• mmengine.model
  • Module
  • Model
  • EMA
  • Model Wrapper
  • Weight Initialization
  • Utils
• mmengine.optim
  • Optimizer
  • Scheduler
• mmengine.evaluator
  • Evaluator
  • Metric
  • Utils
• mmengine.structures
  • BaseDataElement
  • InstanceData
  • LabelData
  • PixelData
• mmengine.dataset
  • Dataset
  • Dataset Wrapper
  • Sampler
  • Utils
• mmengine.infer
  • BaseInferencer
• mmengine.device
  • mmengine.device.get_device
  • mmengine.device.get_max_cuda_memory
  • mmengine.device.is_cuda_available
  • mmengine.device.is_npu_available
  • mmengine.device.is_mlu_available
  • mmengine.device.is_mps_available
• mmengine.hub
  • mmengine.hub.get_config
  • mmengine.hub.get_model
• mmengine.logging
  • MMLogger
  • MessageHub
  • HistoryBuffer
  • mmengine.logging.print_log
• mmengine.visualization
  • Visualizer
  • visualization Backend
• mmengine.fileio
  • File Backend
  • File Handler
  • File IO
  • Parse File
• mmengine.dist
  • dist
  • utils
• mmengine.utils
  • Manager
  • Path
  • Package
  • Version
  • Progress Bar
  • Miscellaneous
• mmengine.utils.dl_utils
  • TimeCounter
  • mmengine.utils.dl_utils.collect_env
  • mmengine.utils.dl_utils.load_url
  • mmengine.utils.dl_utils.has_batch_norm
  • mmengine.utils.dl_utils.is_norm
  • mmengine.utils.dl_utils.mmcv_full_available
  • mmengine.utils.dl_utils.tensor2imgs
  • mmengine.utils.dl_utils.TORCH_VERSION
  • mmengine.utils.dl_utils.set_multi_processing
  • mmengine.utils.dl_utils.torch_meshgrid
  • mmengine.utils.dl_utils.is_jit_tracing

说明

• Changelog of v0.x
  • v0.10.5 (11/9/2024)
  • v0.10.4 (23/4/2024)
  • v0.10.3 (24/1/2024)
  • v0.10.2 (26/12/2023)
  • v0.10.1 (22/11/2023)
  • v0.10.0 (21/11/2023)
  • v0.9.1 (03/11/2023)
  • v0.9.0 (10/10/2023)
  • v0.8.4 (03/08/2023)
  • v0.8.3 (31/07/2023)
  • v0.8.2 (07/12/2023)
  • v0.8.1 (07/05/2023)
  • v0.8.0 (06/30/2023)
  • v0.7.4 (06/03/2023)
  • v0.7.3 (04/28/2023)
  • v0.7.2 (04/06/2023)
  • v0.7.1 (04/03/2023)
  • v0.7.0 (03/16/2023)
  • v0.6.0 (02/24/2023)
  • v0.5.0 (01/20/2023)
  • v0.4.0 (12/28/2022)
  • v0.3.2 (11/24/2022)
  • v0.3.1 (11/09/2022)
  • v0.3.0 (11/02/2022)
  • v0.2.0 (10/11/2022)
• 贡献代码
  • 拉取请求工作流
  • 指引
  • Python 代码风格
  • 拉取请求规范
• 代码规范
  • 代码规范标准
  • 命名规范
  • docstring 规范
  • 注释规范
  • 类型注解
• VS Code 调试程序
  • 调试多卡程序

语言切换

• English
• 简体中文

Indices and tables

• 索引

• 模块索引

• 搜索页面