OBBDetection 项目安装与使用教程

1. 项目目录结构及介绍

OBBDetection 是一个基于 MMDetection 的面向遥感图像的目标检测工具箱，支持多种定向目标检测算法。以下是项目的目录结构及其介绍：

OBBDetection/
├── BboxToolkit/
├── configs/
├── demo/
├── docker/
├── docs/
├── mmdet/
├── requirements/
├── tests/
├── tools/
├── .gitignore
├── .gitmodules
├── isort.cfg
├── pre-commit-config.yaml
├── readthedocs.yml
├── style.yapf
├── LICENSE
├── README.md
├── pytest.ini
├── requirements.txt
└── setup.py

目录介绍

• BboxToolkit/: 包含用于处理定向边界框（OBB）的工具。
• configs/: 存放各种配置文件，用于定义模型和训练参数。
• demo/: 包含一些示例代码和演示脚本。
• docker/: 存放 Docker 相关的文件，用于构建容器化环境。
• docs/: 存放项目的文档文件。
• mmdet/: 包含 MMDetection 的核心代码。
• requirements/: 存放项目的依赖文件。
• tests/: 存放测试代码。
• tools/: 包含一些实用工具脚本。
• .gitignore: Git 忽略文件配置。
• .gitmodules: Git 子模块配置。
• isort.cfg: isort 配置文件。
• pre-commit-config.yaml: pre-commit 配置文件。
• readthedocs.yml: ReadTheDocs 配置文件。
• style.yapf: yapf 代码格式化配置文件。
• LICENSE: 项目许可证文件。
• README.md: 项目介绍和使用说明。
• pytest.ini: pytest 配置文件。
• requirements.txt: 项目依赖文件。
• setup.py: 项目安装脚本。

2. 项目启动文件介绍

OBBDetection 项目的启动文件主要集中在 tools/ 目录下，以下是一些常用的启动文件及其功能介绍：

• tools/train.py: 用于训练模型的脚本。
• tools/test.py: 用于测试模型的脚本。
• tools/demo.py: 用于运行演示脚本的工具。

启动示例

# 训练模型
python tools/train.py configs/your_config.py

# 测试模型
python tools/test.py configs/your_config.py

# 运行演示
python tools/demo.py

3. 项目的配置文件介绍

OBBDetection 的配置文件主要存放在 configs/ 目录下，配置文件用于定义模型的结构、训练参数、数据集路径等。以下是一个典型的配置文件结构及其介绍：

# 配置文件示例
_base_ = [
    '../_base_/models/faster_rcnn_r50_fpn.py',
    '../_base_/datasets/coco_detection.py',
    '../_base_/schedules/schedule_1x.py',
    '../_base_/default_runtime.py'
]

model = dict(
    roi_head=dict(
        bbox_head=dict(
            type='Shared2FCBBoxHead',
            num_classes=80
        )
    )
)

data = dict(
    samples_per_gpu=2,
    workers_per_gpu=2
)

optimizer = dict(type='SGD', lr=0.02, momentum=0.9, weight_decay=0.0001)
lr_config = dict(
    policy='step',
    warmup='linear',
    warmup_iters=500,
    warmup_ratio=0.001,
    step=[8, 11]
)

runner = dict(type='EpochBasedRunner', max_epochs=12)

配置文件结构介绍

• base: 引用基础配置文件，通常包括模型、数据集、训练计划和默认运行时配置。
• model: 定义模型的结构，包括主干网络、RPN、ROI 头等。
• data: 定义数据集的配置，包括批量大小、数据加载器等。
• optimizer: 定义优化器及其参数。
• lr_config: 定义学习率调度策略。
• runner: 定义训练的运行器及其参数。

通过修改这些配置文件，用户可以自定义模型的训练和测试过程。