# aayushakumar/skinguardian architecture

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

- Interactive diagram: https://gitdiagram.com/aayushakumar/skinguardian
- Repository: https://github.com/aayushakumar/skinguardian

## Overview

##### Project Type and Purpose
- SkinGuardian is a desktop application with a local web interface (Flask). It packages a fine‑tuned BEIT model (ONNX) for on‑device skin cancer detection.
- There is no external database or cloud dependency—everything runs locally via a Flask server and ONNX Runtime.

##### File Structure
- Top‑level:
- MobileApp/ – (future mobile version scaffold)
- SkinGuardian/ – core Python app + templates + model + packaging files
- extras/ – scripts and notebooks for downloading and fine‑tuning the model
- SkinGuardian/ contains:
- app.py – Flask application (controller)
- beit_finetuned_model.onnx – ML model (inference engine)
- /templates – HTML views (index, result, about, contact)
- PyInstaller artifacts (app.spec, dist/app.exe)
- requirements.txt, environment.yml, runtime.txt – environment/config
- extras/ holds development tools (download_model.py, finetune_model.ipynb) and test images.

##### README for Additional Insights
- Confirms a Flask‐based UI on port 5000.
- Explains on‑device inference via ONNX Runtime, packaged as a single EXE using PyInstaller.
- No database; input is user‐uploaded images, output is classification result.

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% User Interface
    subgraph "User Interface" 
        Browser["Web Browser UI"]:::ui
    end

    %% Server Layer
    subgraph "Flask Backend" 
        FlaskApp["Flask Server<br/>(app.py)"]:::server
        Templates["HTML Templates"]:::server
    end

    %% Inference Engine
    subgraph "Inference Engine"
        ONNXRuntime["ONNX Runtime"]:::inference
        ModelFile["beit_finetuned_model.onnx"]:::inference
    end

    %% Packaging Layer
    subgraph "Packaging" 
        Spec["PyInstaller Spec<br/>(app.spec)"]:::packaging
        EXE["Packaged EXE<br/>(app.exe)"]:::packaging
        Launcher["Startup Script<br/>(start.bat)"]:::packaging
        Procfile["Procfile"]:::packaging
    end

    %% Configuration
    subgraph "Configuration"
        Requirements["requirements.txt"]:::config
        EnvYML["environment.yml"]:::config
        RuntimeTXT["runtime.txt"]:::config
    end

    %% Development Tools
    subgraph "Development Tools" 
        Download["download_model.py"]:::dev
        Finetune["finetune_model.ipynb"]:::dev
        TestImages["test-images Dataset"]:::dev
    end

    %% Documentation
    subgraph "Documentation"
        Overview["README.md"]:::docs
        AppReadme["SkinGuardian/readme.md"]:::docs
    end

    %% Future Module
    subgraph "Future Module"
        MobileApp["MobileApp Scaffold"]:::future
    end

    %% Data Flow
    Browser -->|"GET /"| FlaskApp
    Browser -->|"POST /predict"| FlaskApp
    FlaskApp -->|loads image| ONNXRuntime
    ONNXRuntime -->|uses model| ModelFile
    ONNXRuntime -->|returns scores| FlaskApp
    FlaskApp -->|renders| Templates
    Templates -->|HTML response| Browser

    %% Supporting Relationships
    FlaskApp --> Spec
    Spec --> EXE
    EXE --> Launcher
    EXE --> Procfile

    FlaskApp --> Requirements
    FlaskApp --> EnvYML
    FlaskApp --> RuntimeTXT

    DevDocs["Extras Folder"]:::dev --> Download
    DevDocs --> Finetune
    DevDocs --> TestImages

    %% Documentation Links
    Overview -.-> FlaskApp
    AppReadme -.-> FlaskApp

    %% Future Link
    MobileApp -.-> Browser

    %% Click Events
    click FlaskApp "https://github.com/aayushakumar/skinguardian/blob/main/SkinGuardian/app.py"
    click Templates "https://github.com/aayushakumar/skinguardian/tree/main/SkinGuardian/templates/"
    click ModelFile "https://github.com/aayushakumar/skinguardian/blob/main/SkinGuardian/beit_finetuned_model.onnx"
    click Spec "https://github.com/aayushakumar/skinguardian/blob/main/SkinGuardian/app.spec"
    click EXE "https://github.com/aayushakumar/skinguardian/blob/main/SkinGuardian/dist/app.exe"
    click Launcher "https://github.com/aayushakumar/skinguardian/blob/main/SkinGuardian/start.bat"
    click Procfile "https://github.com/aayushakumar/skinguardian/tree/main/SkinGuardian/Procfile"
    click Requirements "https://github.com/aayushakumar/skinguardian/blob/main/SkinGuardian/requirements.txt"
    click EnvYML "https://github.com/aayushakumar/skinguardian/blob/main/SkinGuardian/environment.yml"
    click RuntimeTXT "https://github.com/aayushakumar/skinguardian/blob/main/SkinGuardian/runtime.txt"
    click Download "https://github.com/aayushakumar/skinguardian/blob/main/extras/download_model.py"
    click Finetune "https://github.com/aayushakumar/skinguardian/blob/main/extras/finetune_model.ipynb"
    click TestImages "https://github.com/aayushakumar/skinguardian/blob/main/extras/test-images/image_data.csv"
    click MobileApp "https://github.com/aayushakumar/skinguardian/blob/main/MobileApp/init.md"
    click Overview "https://github.com/aayushakumar/skinguardian/blob/main/README.md"
    click AppReadme "https://github.com/aayushakumar/skinguardian/blob/main/SkinGuardian/readme.md"

    %% Styles
    classDef ui fill:#D0E1FF,stroke:#0366D6,color:#0366D6
    classDef server fill:#E0F7E9,stroke:#28A745,color:#28A745
    classDef inference fill:#E6F4F1,stroke:#17A2B8,color:#17A2B8
    classDef packaging fill:#F0F0F0,stroke:#6C757D,color:#6C757D
    classDef config fill:#FFF5E6,stroke:#D39E00,color:#D39E00
    classDef dev fill:#FFF0F6,stroke:#E83E8C,color:#E83E8C
    classDef docs fill:#F8EAEF,stroke:#6F42C1,color:#6F42C1
    classDef future fill:#F3E5AB,stroke:#795548,color:#795548
```
