# evitanrelta/ml-bound-solver architecture

> Architecture diagram of the GitHub repository evitanrelta/ml-bound-solver, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-01-18). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/evitanrelta/ml-bound-solver
- Repository: https://github.com/evitanrelta/ml-bound-solver

## Overview

##### Main Components

a) Input Processing Layer:
- Input handlers for different model types (ONNX, PyTorch)
- Preprocessing pipeline from src/preprocessing/
- Conversion utilities (hwc_to_chw, linearize_conv2d)

b) Core Solver Component:
- Main solver architecture from src/modules/
- Solver layers hierarchy (input, intermediate, output layers)
- AdversarialCheckModel component

c) Training System:
- Training infrastructure from src/training/
- EarlyStopHandler and TrainingConfig components

d) Comparison System:
- Gurobi comparison functionality
- Result validation components

**Level 1: Input Layer (Model & Configuration Intake)**
**Level 2: Preprocessing Layer**
**Level 3: Core Solver Components**
**Level 4: Training & Optimization Layer**
**Level 5: Output & Validation Layer**

##### Component Relationships

- Model input → Preprocessing → Solver
- Solver → Training system
- Results → Gurobi comparison
- Configuration files → Various components

##### Specific Implementation Details

**Input Handlers:**
- ONNX Model Loader
- PyTorch Model Loader
- Configuration Parser

**Preprocessing:**
- Linearization Module
- Conversion Utilities
- Solver Input Builder

**Core Solver:**
- SolverSequential
- Layer Handlers (Input/Intermediate/Output)
- AdversarialCheckModel

**Training:**
- Training Configuration
- Early Stop Handler
- Training Loop

**Validation:**
- Gurobi Comparator
- Results Analyzer

##### Technical Details

Annotations for:
- GPU/CPU computation support
- PyTorch integration points
- ONNX model handling
- Gurobi interface points

##### Additional Elements

Include:
- Configuration flow (YAML files)
- Device management (CPU/GPU)
- Data structure transformations
- Optimization paths

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Styles and classes
    classDef input fill:#b3d9ff,stroke:#333
    classDef preprocessing fill:#99ccff,stroke:#333
    classDef core fill:#99ff99,stroke:#333
    classDef training fill:#ffcc99,stroke:#333
    classDef validation fill:#cc99ff,stroke:#333
    classDef utility fill:#f2f2f2,stroke:#333

    %% Input Processing Layer
    subgraph InputLayer["Input Processing Layer"]
        ModelInput["Model Input Handlers"]:::input
        ONNXLoader["ONNX Loader"]:::input
        PyTorchLoader["PyTorch Loader"]:::input
        ConfigParser["Configuration Parser"]:::input
    end
    click ModelInput "https://github.com/EvitanRelta/ml-bound-solver/tree/master/src/inputs/"

    %% Preprocessing Layer
    subgraph PreprocessingLayer["Preprocessing Layer"]
        PreProc["Preprocessing Pipeline"]:::preprocessing
        ConvUtils["Conversion Utilities"]:::preprocessing
        InputBuilder["Solver Input Builder"]:::preprocessing
        LinearizeMod["Linearization Module"]:::preprocessing
    end
    click PreProc "https://github.com/EvitanRelta/ml-bound-solver/tree/master/src/preprocessing/"
    click ConvUtils "https://github.com/EvitanRelta/ml-bound-solver/blob/master/src/preprocessing/hwc_to_chw.py"
    click InputBuilder "https://github.com/EvitanRelta/ml-bound-solver/blob/master/src/preprocessing/build.py"
    click LinearizeMod "https://github.com/EvitanRelta/ml-bound-solver/blob/master/src/preprocessing/linearize_conv2d.py"

    %% Core Solver Components
    subgraph CoreSolver["Core Solver Components"]
        MainSolver["Main Solver"]:::core
        SolverSeq["SolverSequential"]:::core
        AdvCheck["AdversarialCheckModel"]:::core
        
        subgraph LayerHandlers["Layer Handlers"]
            InputLayer["Input Layer"]:::core
            IntermLayer["Intermediate Layer"]:::core
            OutputLayer["Output Layer"]:::core
            BaseLayer["Base Layer"]:::core
        end
    end
    click MainSolver "https://github.com/EvitanRelta/ml-bound-solver/blob/master/src/modules/Solver.py"
    click SolverSeq "https://github.com/EvitanRelta/ml-bound-solver/blob/master/src/modules/solver_layers/SolverSequential.py"
    click AdvCheck "https://github.com/EvitanRelta/ml-bound-solver/blob/master/src/modules/AdversarialCheckModel.py"
    click InputLayer "https://github.com/EvitanRelta/ml-bound-solver/blob/master/src/modules/solver_layers/input_layer.py"
    click IntermLayer "https://github.com/EvitanRelta/ml-bound-solver/blob/master/src/modules/solver_layers/intermediate_layer.py"
    click OutputLayer "https://github.com/EvitanRelta/ml-bound-solver/blob/master/src/modules/solver_layers/output_layer.py"
    click BaseLayer "https://github.com/EvitanRelta/ml-bound-solver/blob/master/src/modules/solver_layers/base_class.py"

    %% Training System
    subgraph TrainingSystem["Training System"]
        TrainConfig["Training Configuration"]:::training
        EarlyStop["Early Stop Handler"]:::training
        TrainLoop["Training Loop"]:::training
        TrainCore["Training Core"]:::training
    end
    click TrainConfig "https://github.com/EvitanRelta/ml-bound-solver/blob/master/src/training/TrainingConfig.py"
    click EarlyStop "https://github.com/EvitanRelta/ml-bound-solver/blob/master/src/training/EarlyStopHandler.py"
    click TrainCore "https://github.com/EvitanRelta/ml-bound-solver/blob/master/src/training/train.py"
    click TrainingSystem "https://github.com/EvitanRelta/ml-bound-solver/tree/master/src/training/"

    %% Validation System
    subgraph ValidationSystem["Validation System"]
        GurobiComp["Gurobi Comparator"]:::validation
        ResultsAnalyzer["Results Analyzer"]:::validation
        GurobiResults["Gurobi Results"]:::validation
    end
    click GurobiComp "https://github.com/EvitanRelta/ml-bound-solver/blob/master/src/compare_against_gurobi.py"
    click GurobiResults "https://github.com/EvitanRelta/ml-bound-solver/blob/master/src/inputs/*_gurobi_results.pth"

    %% Connections
    ModelInput --> ONNXLoader & PyTorchLoader
    ONNXLoader & PyTorchLoader --> PreProc
    ConfigParser --> PreProc
    PreProc --> ConvUtils
    ConvUtils --> InputBuilder
    LinearizeMod --> InputBuilder
    InputBuilder --> MainSolver
    MainSolver --> SolverSeq
    SolverSeq --> LayerHandlers
    BaseLayer --> InputLayer & IntermLayer & OutputLayer
    MainSolver --> AdvCheck
    AdvCheck --> TrainingSystem
    TrainConfig --> TrainLoop
    EarlyStop --> TrainLoop
    TrainCore --> TrainLoop
    MainSolver --> ValidationSystem
    GurobiResults --> GurobiComp
    
    %% Legend
    subgraph Legend
        L1["Input Components"]:::input
        L2["Preprocessing Components"]:::preprocessing
        L3["Core Components"]:::core
        L4["Training Components"]:::training
        L5["Validation Components"]:::validation
    end
```
