# mrinaljain17/ct-image-segmentation architecture

> Architecture diagram of the GitHub repository mrinaljain17/ct-image-segmentation, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-03-30). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/mrinaljain17/ct-image-segmentation
- Repository: https://github.com/mrinaljain17/ct-image-segmentation

## Overview

##### Main Components
- Data Ingestion & Processing: Represent components like the “capstone/data” and “capstone/volumetric/data_module.py”, “datasets.py”, “download.py”, “process_miccai.py”, and utility functions from “capstone/data/utils.py”. Emphasize the process that downloads, extracts, and splits the MICCAI dataset.
- Data Transformation: Include the “capstone/transforms” and “capstone/volumetric/predefined.py”/“transforms.py” modules. These components manage data augmentation and preprocessing (using Albumentations and MONAI).
- Model Building & Metrics: Capture the “capstone/models” and corresponding “losses.py”, “metrics.py”, and even any prototypical implementations (like “temp.py”), which combine domain-specific functions for segmentation.
- Training & Experimentation: Illustrate the training frameworks through “capstone/training” (with distinct trainers such as “base_trainer.py” and “mixup_trainer.py”) and parallel volumetric training modules in “capstone/volumetric”. Also include how experiment tracking might be integrated (via Weights and Biases) with PyTorch-Lightning.
- Notebooks for Analysis: Represent the notebooks in “capstone/notebooks” as exploratory tools or prototyping environments that interact with the core modules.
- Environment & Configuration: Optionally include the “paths.py” for configuration and project-level scripts (setup.py, .gitignore, LICENSE).

##### Relationships and Interactions
- Data Flow: Start from data download and preprocessing (Data Ingestion & Processing) → data augmentation and transformation (Data Transformation) → Model Input.
- Training Pipeline: Flow from the transformed data into the Trainer modules (training strategies) which utilize models, losses, and metrics. Indicate how training routines integrate with experiment logging.
- Feedback Loops: Show that evaluation and interpretability modules support the training module by providing analysis outputs and visualizations.
- Notebook Interfaces: Show notebooks interfacing with multiple components (data, training, visualization) to facilitate experimentation and understanding.

##### Architectural Patterns & Design Principles
- Modular Separation: Demonstrate how the project separates concerns into discrete modules (data handling, transforms, model definitions, training routines, etc.).
- Reusable Components: Emphasize reusability through shared utility functions (in capstone/utils) and abstraction in training (base_trainer vs. mixup_trainer).
- Domain-Specific Customization: Note the use of MONAI and custom transforms for handling medical imaging data which dictates certain patterns.
- Two Parallel Pipelines: Differentiate components dealing with typical 2D segmentation (in “capstone”) and volumetric 3D segmentation (in “capstone/volumetric”).

##### Relevant Technologies
- Python (3.7)
- PyTorch and PyTorch-Lightning for training and model management.
- MONAI for domain-specific operations.
- Albumentations for augmentations.
- Weights and Biases for experiment tracking.
- Additional libraries: Tqdm for progress indication, pynrrd for dataset loading.

## Diagram (Mermaid)

```mermaid
graph TD
    Paths["capstone/paths.py"]:::config
    Setup["setup.py"]:::config

    subgraph "2D Pipeline"
        Data["capstone/data"]:::data
        Transforms["capstone/transforms"]:::transforms
        Training["capstone/training"]:::training
        Models["capstone/models"]:::models
        Interp["capstone/interpretability.py"]:::interpret
        Visualize["capstone/utils/visualize.py"]:::visualize
        Weights["Weights&Biases"]:::exp
    end

    subgraph "Volumetric Pipeline"
        V_Data["capstone/volumetric"]:::data_vol
        V_Training["capstone/volumetric"]:::training_vol
    end

    Notebooks["capstone/notebooks"]:::notebooks

    %% Data Flow - 2D Pipeline
    Paths --> Data
    Data --> Transforms
    Transforms --> Training
    Training --> Models
    Models --> Interp
    Models --> Visualize
    Weights --> Training

    %% Notebooks Interface
    Notebooks --- Data
    Notebooks --- Training
    Notebooks --- Models
    Notebooks --- Interp

    %% Data Flow - Volumetric Pipeline
    Paths --> V_Data
    V_Data --> V_Training
    Weights --- V_Training

    %% Styles
    classDef data fill:#FFDDC1,stroke:#D2691E,stroke-width:2px;
    classDef transforms fill:#F9E79F,stroke:#B7950B,stroke-width:2px;
    classDef training fill:#AED6F1,stroke:#2874A6,stroke-width:2px;
    classDef models fill:#D2B4DE,stroke:#7D3C98,stroke-width:2px;
    classDef interpret fill:#F5B7B1,stroke:#C0392B,stroke-width:2px;
    classDef visualize fill:#A9DFBF,stroke:#239B56,stroke-width:2px;
    classDef config fill:#D5F5E3,stroke:#28B463,stroke-width:2px;
    classDef exp fill:#FAD7A0,stroke:#F39C12,stroke-width:2px;
    classDef notebooks fill:#D6EAF8,stroke:#2471A3,stroke-width:2px;
    classDef data_vol fill:#FDEBD0,stroke:#E59866,stroke-width:2px;
    classDef training_vol fill:#D6EAF8,stroke:#3498DB,stroke-width:2px;

    %% Click Events
    click Data "https://github.com/mrinaljain17/ct-image-segmentation/tree/master/capstone/data/"
    click Transforms "https://github.com/mrinaljain17/ct-image-segmentation/tree/master/capstone/transforms/"
    click Models "https://github.com/mrinaljain17/ct-image-segmentation/tree/master/capstone/models/"
    click Training "https://github.com/mrinaljain17/ct-image-segmentation/tree/master/capstone/training/"
    click V_Data "https://github.com/mrinaljain17/ct-image-segmentation/tree/master/capstone/volumetric/"
    click V_Training "https://github.com/mrinaljain17/ct-image-segmentation/tree/master/capstone/volumetric/"
    click Interp "https://github.com/mrinaljain17/ct-image-segmentation/blob/master/capstone/interpretability.py"
    click Visualize "https://github.com/mrinaljain17/ct-image-segmentation/blob/master/capstone/utils/visualize.py"
    click Notebooks "https://github.com/mrinaljain17/ct-image-segmentation/tree/master/capstone/notebooks/"
    click Paths "https://github.com/mrinaljain17/ct-image-segmentation/blob/master/capstone/paths.py"
    click Setup "https://github.com/mrinaljain17/ct-image-segmentation/blob/master/setup.py"
```
