注释！！

MMDetection注释已更新至最新1.0版本。我将继续更新，但可能不会紧跟最新版本的升级。

mmdetection-annotated

简介

参考此处出色的实现：https://github.com/open-mmlab/mmdetection，感谢作者[Kai Chen](https://github.com/hellock)。
Open-mmlab项目包含多种模型及最新论文的实现，在检测/分割任务中取得了优异的成绩，对计算机视觉领域的初学者也非常友好。

入门

关于安装或预训练模型下载的更多信息，请参阅mmdetection官方仓库或此博客

• 在图像上测试
  您可以通过运行脚本demo.py来测试Faster RCNN演示。我刚刚重写了该演示文件，使其能够对单张图片或一个文件夹进行检测，如下所示：

import os
from mmdet.apis import init_detector, inference_detector, show_result

if __name__ == '__main__':
	config_file = 'configs/faster_rcnn_r50_fpn_1x.py'
	checkpoint_file = 'weights/faster_rcnn_r50_fpn_1x_20181010-3d1b3351.pth'
	# checkpoint_file = 'tools/work_dirs/mask_rcnn_r101_fpn_1x/epoch_1200.pth'
	img_path = '/home/bit/下载/n07753592'
	model = init_detector(config_file, checkpoint_file, device='cuda:0')
	# print(model)
	# 输入可以为文件夹或者图片
	if os.path.isdir(img_path):
		imgs= os.listdir(img_path)
		for i in range(len(imgs)):
			imgs[i]=os.path.join(img_path,imgs[i])
		for i, result in enumerate(inference_detector(model, imgs)):	# 支持可迭代输入imgs
			print(i, imgs[i])
			show_result(imgs[i], result, model.CLASSES, out_file='output/result_{}.jpg'.format(i))

	elif os.path.isfile(img_path):
		result = inference_detector(model, img_path)
		show_result(img_path, result, model.CLASSES)

• 调试
  您可以通过添加ipdb.set_trace()方法设置断点来进行调试。在此之前，请确保已成功安装并导入了ipdb包。
• Hook
  如果您想检查中间变量，hook.py可以作为参考供您使用。

注释

代码中随处可见注释（当然，仅限于我阅读过的一部分，未完成的部分将尽快补充）。此外，annotation文件夹中还包含一些解释性文档。

• 数据集示例
  提供了一个简单的小型数据集用于测试（分割&&检测）。更多详情请参阅此处

• CUDA相关代码
  我删除了mmdet/ops文件夹中的文件，因为其中没有附带注释。不过好消息是，关于RoIAlign有专门的说明这里 。

• 模型可视化
  以Mask-RCNN为例，模型可以如下方式可视化：（更多详情请参阅model-structure-png)

• 笔记

• 配置文件
  对配置文件进行了详细说明，以Mask RCNN为例，请参阅mask_rcnn_r101_fpn_1x.py

• MMCV&MMDET
  对mmcv库以及部分mmdet内容进行了说明（关于各种模型的更多细节将在后续更新）。
  

检测结果

使用Mask RCNN模型进行测试：

训练

数据集

• 您可以直接使用COCO数据集，详情请参阅此处。
  
• 如果您想使用labelme标注的自定义数据集进行训练，需要先将JSON文件转换为COCO格式，这个工具箱可能会帮到您；
  
• 如果您想使用labelImg标注的自定义数据集进行训练，也需要先将XML文件转换为COCO格式，这个工具箱同样可以帮助您。
  
• 我最近对这些工具进行了测试，确认它们仍然有效。如果仍有问题，请在issue中描述或与我联系，谢谢。
  

学习率

请务必根据您的GPU数量在配置文件中设置学习率！！！（例如，对于1个GPU，使用默认学习率的1/8）

MMDetection-Annotated 快速上手指南

环境准备

在开始之前，请确保您的开发环境满足以下要求：

• 操作系统: Linux (推荐 Ubuntu 16.04+)
• Python: 3.7+
• CUDA: 建议 CUDA 9.2 或更高版本（需与 PyTorch 版本匹配）
• PyTorch: 1.5+
• 前置依赖:
  • mmcv: OpenMMLab 计算机视觉基础库
  • ipdb: 用于代码调试（可选，但推荐安装以便使用断点调试功能）

注意：本项目是对 MMDetection 的代码注释版，核心依赖与原版一致。国内用户建议使用清华源或阿里源加速 Python 包和模型权重的下载。

安装步骤

1. 安装 PyTorch 和 MMCV

请根据您的 CUDA 版本选择对应的安装命令。以下以 CUDA 10.2 为例（国内推荐使用清华镜像）：

pip install torch torchvision torchaudio --index-url https://download.pytorch.org/whl/cu102
pip install mmcv-full -f https://download.openmmlab.com/mmcv/dist/cu102/torch1.7/index.html

2. 克隆项目并安装 MMDetection-Annotated

git clone https://github.com/ming71/mmdetection-annotated.git
cd mmdetection-annotated
pip install -r requirements.txt
python setup.py develop

3. 下载预训练模型

本项目示例默认使用 Faster RCNN 模型。您需要手动下载权重文件并放置于 weights/ 目录下（若目录不存在请新建）：

• 模型文件：faster_rcnn_r50_fpn_1x_20181010-3d1b3351.pth
• 下载地址参考：MMDetection 官方模型库 或相关博客提供的国内镜像链接。

基本使用

本项目重写了 demo.py 脚本，支持对单张图片或整个文件夹进行推理检测。

运行检测脚本

在项目根目录下运行以下命令（请根据实际路径修改 img_path）：

python demo.py

代码逻辑说明

脚本内部逻辑如下，支持自动判断输入是文件还是文件夹：

import os
from mmdet.apis import init_detector, inference_detector, show_result

if __name__ == '__main__':
    # 配置文件路径
    config_file = 'configs/faster_rcnn_r50_fpn_1x.py'
    # 权重文件路径
    checkpoint_file = 'weights/faster_rcnn_r50_fpn_1x_20181010-3d1b3351.pth'
    
    # 待检测图片路径（可以是单个文件或文件夹）
    img_path = '/home/bit/下载/n07753592'
    
    # 初始化模型
    model = init_detector(config_file, checkpoint_file, device='cuda:0')
    
    # 输入可以为文件夹或者图片
    if os.path.isdir(img_path):
        imgs = os.listdir(img_path)
        for i in range(len(imgs)):
            imgs[i] = os.path.join(img_path, imgs[i])
        # 支持可迭代输入 imgs
        for i, result in enumerate(inference_detector(model, imgs)):	
            print(i, imgs[i])
            show_result(imgs[i], result, model.CLASSES, out_file='output/result_{}.jpg'.format(i))

    elif os.path.isfile(img_path):
        result = inference_detector(model, img_path)
        show_result(img_path, result, model.CLASSES)

调试与可视化

• 断点调试: 代码中已预留 ipdb.set_trace() 接口。如需调试中间变量，请先确保安装了 ipdb (pip install ipdb)，然后在相应位置取消注释即可。
• 结果查看: 检测完成后，结果图片将保存在 output/ 目录下。

自定义数据集训练提示

若需使用自己的数据集（如 labelme 或 labelImg 标注），请先将其转换为 COCO 格式。作者提供了转换工具箱：ming71/toolbox。

• 重要: 训练前请务必根据您的 GPU 数量 调整配置文件中的学习率（lr）。例如，若默认配置基于 8 卡，单卡训练时需将 lr 设为默认的 1/8。