# shamilemir/deit-osteoarthritis-detection architecture

> Architecture diagram of the GitHub repository shamilemir/deit-osteoarthritis-detection, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2024-12-28). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/shamilemir/deit-osteoarthritis-detection
- Repository: https://github.com/shamilemir/deit-osteoarthritis-detection

## Overview

##### Main Components

a. Data Pipeline Components:
- Raw X-ray Image Input
- Preprocessing Module (preprocessing.py)
- Data Splitting Module (datasplitting.py)

b. Model Components:
- Pre-trained DeiT Model
- Fine-tuning Module (fine-tune.py)
- Trained Model Output

##### Detailed Component Breakdown

a. Data Flow Section:
- Raw X-ray Images (input)
- Preprocessing Module
- Image normalization
- Augmentation
- Data Splitting Module
- Training set
- Validation set
- Test set

b. Model Section:
- Pre-trained DeiT Model
- Fine-tuning Module
- Training loop
- Optimization process
- Final Fine-tuned Model

##### Additional Elements

a. Technical specifications:
- Input image specifications
- Model architecture details
- Training parameters

b. Annotations for:
- Data transformations
- Key hyperparameters
- Validation metrics

##### Important Notes

- Version information for key components
- External dependencies
- Critical decision points in the pipeline

## Diagram (Mermaid)

```mermaid
flowchart TB
    subgraph Legend
        style Legend fill:#f5f5f5,stroke:#333
        L1[Processing Module]:::processing
        L2[(Data Storage)]:::data
        L3[Model Component]:::model
        L4[Validation Point]:::validation
    end

    %% Data Input Section
    RawData[(Raw X-ray Images)]:::data

    %% Preprocessing Section
    subgraph Preprocessing
        PreProc[Preprocessing Module]:::processing
        Norm[Image Normalization]:::processing
        Aug[Augmentation]:::processing
    end

    %% Data Splitting Section
    subgraph DataSplit
        Split[Data Splitting Module]:::processing
        Train[(Training Set)]:::data
        Val[(Validation Set)]:::data
        Test[(Test Set)]:::data
    end

    %% Model Section
    subgraph ModelComponents
        PreDeiT[Pre-trained DeiT]:::model
        FineTune[Fine-tuning Module]:::model
        TrainLoop[Training Loop]:::processing
        FinalModel[Fine-tuned Model]:::model
        ValPoint[Validation Check]:::validation
    end

    %% Flow Connections
    RawData --> PreProc
    PreProc --> Norm
    Norm --> Aug
    Aug --> Split
    Split --> Train
    Split --> Val
    Split --> Test
    Train --> FineTune
    Val --> ValPoint
    PreDeiT --> FineTune
    FineTune --> TrainLoop
    TrainLoop --> ValPoint
    ValPoint --> |Pass| FinalModel
    ValPoint --> |Fail| TrainLoop

    %% Styling
    classDef processing fill:#90EE90,stroke:#333
    classDef data fill:#ADD8E6,stroke:#333
    classDef model fill:#FFA500,stroke:#333
    classDef validation fill:#FF6B6B,stroke:#333

    %% Click Events
    click PreProc "https://github.com/shamilemir/DeiT-osteoarthritis-detection/blob/main/prepareKneeOsteoarthritisXray/preprocessing.py"
    click Split "https://github.com/shamilemir/DeiT-osteoarthritis-detection/blob/main/prepareKneeOsteoarthritisXray/datasplitting.py"
    click FineTune "https://github.com/shamilemir/DeiT-osteoarthritis-detection/blob/main/fine-tune.py"
    click Preprocessing "https://github.com/shamilemir/DeiT-osteoarthritis-detection/tree/main/prepareKneeOsteoarthritisXray/"
```
