# mirapurkrabek/bboxmaskpose architecture

> Architecture diagram of the GitHub repository mirapurkrabek/bboxmaskpose, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-05-20). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/mirapurkrabek/bboxmaskpose
- Repository: https://github.com/mirapurkrabek/bboxmaskpose

## Overview

##### Project Type and Purpose
- This repository is an open-source research codebase, extending the MMPose 2.0 framework to implement BBox-Mask-Pose: a seamless loop of detection, segmentation, and pose estimation. It provides training and inference pipelines, model definitions, data loaders, and utilities to reproduce the MaskPose and RTMDet results from the paper.

##### File Structure
- Top-level package “mmpose”: core code implemented in subpackages (apis, codecs, configs, datasets, engine, evaluation, models, structures, utils, visualization).
- Configs: user-facing directory of model, dataset, and runtime configurations.
- Requirements & setup: external dependencies and installation helpers.
- Patterns: registry-driven builders, hook-based engine, modular data pipeline (datasets + transforms), plugin architecture for models/losses/heads.

##### README for Additional Insights
- Extensions over MMPose: multi-dataset ViTPose training, `MaskBackground` augmentation, integration of RTMDet from MMDetection.
- External dependencies: mmengine, mmcv, mmdet.
- Two primary workflows: training (config → engine → datasets/models → hooks/optimizers → evaluation) and inference (inferencer APIs → pre/post-processing → visualization).

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Configuration Manager
    subgraph "Configuration Manager"
        direction TB
        ConfigBase["configs/_base_"]:::config
        MaskPoseConfig["configs/MaskPose"]:::config
        DefaultRuntime["default_runtime.py"]:::config
    end

    %% Data Pipeline
    subgraph "Data Pipeline"
        direction TB
        DatasetBuilder["builder.py"]:::data
        Datasets["datasets/"]:::data
        Samplers["samplers.py"]:::data
        Transforms["transforms/"]:::data
        Codecs["codecs/"]:::data
        CodecsUtils["codecs/utils/"]:::data
    end

    %% Model Zoo
    subgraph "Model Zoo"
        direction TB
        ModelBuilder["builder.py & registry.py"]:::core
        Backbones["backbones/"]:::core
        Necks["necks/"]:::core
        Heads["heads/"]:::core
        Losses["losses/"]:::core
        TaskModules["task_modules/"]:::core
        PoseEstimators["pose_estimators/"]:::core
    end

    %% Training Engine
    subgraph "Training Engine"
        direction TB
        EngineCore["engine/ & engine/hooks/"]:::engine
        OptimWrappers["optim_wrappers/"]:::engine
        Schedulers["schedulers/"]:::engine
    end

    %% Evaluation Module
    subgraph "Evaluation Module"
        direction TB
        Evaluators["evaluators/"]:::core
        Functional["functional/"]:::core
        Metrics["metrics/"]:::core
    end

    %% Inference & Visualization
    subgraph "Inference & Visualization"
        direction TB
        InferenceAPIs["inference.py / inference_3d.py / inference_tracking.py"]:::inference
        Inferencers["inferencers/"]:::inference
        InferencerUtils["inferencers/utils/"]:::inference
        VisualizationAPIs["visualization.py"]:::inference
        VisualizationBackends["visualization/"]:::inference
    end

    %% External Dependencies
    subgraph "External Dependencies"
        direction TB
        MMEngine("mmengine"):::external
        MMCV("mmcv"):::external
        MMDet("mmdet"):::external
    end

    %% Connections
    ConfigBase -->|provides configs| DatasetBuilder
    ConfigBase -->|provides configs| ModelBuilder
    ConfigBase -->|provides configs| EngineCore
    ConfigBase -->|provides configs| Evaluators
    ConfigBase -->|provides configs| InferenceAPIs

    DatasetBuilder -->|builds| Datasets
    DatasetBuilder -->|registers| Transforms
    DatasetBuilder -->|registers| Samplers
    Datasets -->|data| Codecs
    Transforms -->|applies| CodecsUtils

    Datasets -->|feeds| ModelBuilder
    ModelBuilder -->|constructs| Backbones
    ModelBuilder -->|constructs| Necks
    ModelBuilder -->|constructs| Heads
    ModelBuilder -->|constructs| TaskModules
    ModelBuilder -->|constructs| PoseEstimators
    ModelBuilder -->|registers| Losses

    ModelBuilder -->|used by| EngineCore
    EngineCore -->|trains via| OptimWrappers
    EngineCore -->|schedules via| Schedulers
    EngineCore -->|invokes| Hooks

    EngineCore -->|outputs checkpoints| Evaluators
    Evaluators -->|calculates metrics| Metrics
    Evaluators -->|runs| Functional

    InferenceAPIs -->|loads model| Inferencers
    Inferencers -->|uses| MMDet
    Inferencers -->|uses| MMCV
    Inferencers -->|wraps| PoseEstimators
    InferenceAPIs -->|visualizes via| VisualizationAPIs
    VisualizationAPIs -->|renders| VisualizationBackends

    %% Click Events
    click ConfigBase "https://github.com/mirapurkrabek/bboxmaskpose/tree/main/configs/_base_"
    click MaskPoseConfig "https://github.com/mirapurkrabek/bboxmaskpose/tree/main/configs/MaskPose"
    click DefaultRuntime "https://github.com/mirapurkrabek/bboxmaskpose/blob/main/mmpose/configs/_base_/default_runtime.py"
    click DatasetBuilder "https://github.com/mirapurkrabek/bboxmaskpose/blob/main/mmpose/datasets/builder.py"
    click Datasets "https://github.com/mirapurkrabek/bboxmaskpose/tree/main/mmpose/datasets/datasets/"
    click Samplers "https://github.com/mirapurkrabek/bboxmaskpose/blob/main/mmpose/datasets/samplers.py"
    click Transforms "https://github.com/mirapurkrabek/bboxmaskpose/tree/main/mmpose/datasets/transforms/"
    click Codecs "https://github.com/mirapurkrabek/bboxmaskpose/tree/main/mmpose/codecs/"
    click CodecsUtils "https://github.com/mirapurkrabek/bboxmaskpose/tree/main/mmpose/codecs/utils/"
    click ModelBuilder "https://github.com/mirapurkrabek/bboxmaskpose/blob/main/mmpose/models/builder.py"
    click ModelBuilder "https://github.com/mirapurkrabek/bboxmaskpose/blob/main/mmpose/registry.py"
    click Backbones "https://github.com/mirapurkrabek/bboxmaskpose/tree/main/mmpose/models/backbones/"
    click Necks "https://github.com/mirapurkrabek/bboxmaskpose/tree/main/mmpose/models/necks/"
    click Heads "https://github.com/mirapurkrabek/bboxmaskpose/tree/main/mmpose/models/heads/"
    click Losses "https://github.com/mirapurkrabek/bboxmaskpose/tree/main/mmpose/models/losses/"
    click TaskModules "https://github.com/mirapurkrabek/bboxmaskpose/tree/main/mmpose/models/task_modules/"
    click PoseEstimators "https://github.com/mirapurkrabek/bboxmaskpose/tree/main/mmpose/models/pose_estimators/"
    click EngineCore "https://github.com/mirapurkrabek/bboxmaskpose/tree/main/mmpose/engine/"
    click EngineCore "https://github.com/mirapurkrabek/bboxmaskpose/tree/main/mmpose/engine/hooks/"
    click OptimWrappers "https://github.com/mirapurkrabek/bboxmaskpose/tree/main/mmpose/engine/optim_wrappers/"
    click Schedulers "https://github.com/mirapurkrabek/bboxmaskpose/tree/main/mmpose/engine/schedulers/"
    click Evaluators "https://github.com/mirapurkrabek/bboxmaskpose/tree/main/mmpose/evaluation/evaluators/"
    click Functional "https://github.com/mirapurkrabek/bboxmaskpose/tree/main/mmpose/evaluation/functional/"
    click Metrics "https://github.com/mirapurkrabek/bboxmaskpose/tree/main/mmpose/evaluation/metrics/"
    click InferenceAPIs "https://github.com/mirapurkrabek/bboxmaskpose/blob/main/mmpose/apis/inference.py"
    click InferenceAPIs "https://github.com/mirapurkrabek/bboxmaskpose/blob/main/mmpose/apis/inference_3d.py"
    click InferenceAPIs "https://github.com/mirapurkrabek/bboxmaskpose/blob/main/mmpose/apis/inference_tracking.py"
    click Inferencers "https://github.com/mirapurkrabek/bboxmaskpose/tree/main/mmpose/apis/inferencers/"
    click InferencerUtils "https://github.com/mirapurkrabek/bboxmaskpose/tree/main/mmpose/apis/inferencers/utils/"
    click VisualizationAPIs "https://github.com/mirapurkrabek/bboxmaskpose/blob/main/mmpose/apis/visualization.py"
    click VisualizationBackends "https://github.com/mirapurkrabek/bboxmaskpose/tree/main/mmpose/visualization/"

    %% Styles
    classDef config fill:#f9f,stroke:#333,stroke-width:1px;
    classDef core fill:#aaf,stroke:#333,stroke-width:1px;
    classDef data fill:#afa,stroke:#333,stroke-width:1px;
    classDef engine fill:#fea,stroke:#333,stroke-width:1px;
    classDef inference fill:#fda,stroke:#333,stroke-width:1px;
    classDef external fill:#ddd,stroke:#333,stroke-width:1px;
```
