# krishnazyala/facerecognition architecture

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

- Interactive diagram: https://gitdiagram.com/krishnazyala/facerecognition
- Repository: https://github.com/krishnazyala/facerecognition

## Overview

##### Project type and purpose
- This is a native Android mobile application whose primary function is real-time face detection and recognition using on-device ML models and a local database.
- The README confirms it’s built in Kotlin with Jetpack Compose for UI, ML Kit for detection, TensorFlow Lite (Mobile FaceNet) for recognition, and Room for persistence.

##### File structure
- Top-level “app” module contains:
- src/main/kotlin/com/krishnaZyala/faceRecognition/app – application entry point (MAIN.kt) and DI setup (Module.kt)
- data – Repository, Room database (MainDatabase.kt), DAO, type converters, and data models (AppState, FaceInfo, etc.)
- lib – utility wrappers around TFLite (AiModel), file/media utilities, logging, string utils
- ui – Jetpack Compose components:
– navigation (AppHost, Routes)
– composables (FaceView, FrameView, FaceAnalytics)
– screens with MVVM (HomeScreen, RecogniseFaceScreen, AddFaceScreen, etc.) each paired with a ViewModel
- assets – TFLite model files (.tflite)
- androidTest / test – instrumentation and unit tests
- Build and config files: Gradle scripts, AndroidManifest, ProGuard rules, resource XMLs.

##### README for additional insights
- Confirms features: real-time detection, name display, add/delete faces.
- Lists tech stack: Mobile FaceNet, ML Kit, TFLite, Jetpack Compose, Kotlin.

##### Main components and interactions
a. Components
- Camera Input (Android CameraX / system)
- Face Detection Engine (ML Kit)
- Face Recognition Engine (TensorFlow Lite via AiModel)
- Repository (Repository.kt)
- Local Database (Room: MainDatabase + MainDao)
- UI Layer (Jetpack Compose screens & composables)
- ViewModel Layer (per-screen ViewModel)
- DI Container (Module.kt)
- Assets (TFLite model files)
- Utility Library (FileUtils, MediaUtils, etc.)
b. Relationships & data flows
1. Camera → frames → Face Detection (ML Kit)
2. Face Detection → crop → Face Recognition (AiModel + .tflite)
3. Recognition result (embedding) → Repository
4. Repository ↔ Room Database (store/retrieve face embeddings & metadata)
5. ViewModel requests data from Repository; receives recognition results and/or stored faces
7. UI actions (Add/Delete) → ViewModel → Repository → Database
8. DI Container wires all dependencies (ViewModels, Repository, AiModel, Database) at application start (MAIN.kt)
c. Architectural patterns
- MVVM: separation of UI (Compose) from business logic (ViewModels) and data (Repository/Room)
- Dependency Injection: Module.kt defines singletons for AiModel, Repository, Database, etc.
- Modular layers: UI, domain (ViewModel/Repository), storage (Room), ML inference
d. Key technologies
- Jetpack Compose (UI)
- Android CameraX or Camera API
- ML Kit (face detection)
- TensorFlow Lite (recognition)
- Room (persistence)
- Kotlin Coroutines / Flow (async data streams)

##### Final checklist
- Clearly separate layers: Presentation (UI), ViewModel, Domain/Repository, Persistence, ML
- Interactions and data formats (camera frames, embeddings, metadata)
- Major libraries and frameworks
- Flow for both “recognize face” and “add/delete face” user journeys are captured

## Diagram (Mermaid)

```mermaid
flowchart TB
    subgraph "External Dependencies"
        Camera["Android CameraX"]:::external
        Assets["TFLite Models (assets)"]:::external
    end

    subgraph "DI & App Init"
        DI["DI Container\nModule.kt & MAIN.kt"]:::di
    end

    subgraph "UI Layer (Jetpack Compose)"
        subgraph "Screens"
            HomeScreen["HomeScreen"]:::ui
            RecogniseScreen["RecogniseFaceScreen"]:::ui
            AddFaceScreen["AddFaceScreen"]:::ui
            FacesScreen["FacesScreen"]:::ui
            WelcomeScreen["WelcomeScreen"]:::ui
            PermissionDialog["PermissionDialog"]:::ui
            PermissionProvider["PermissionProvider"]:::ui
        end
        subgraph "Composables"
            FaceView["FaceView"]:::ui
            FrameView["FrameView"]:::ui
            FaceAnalytics["FaceAnalytics"]:::ui
        end
        subgraph "Navigation"
            AppHost["AppHost"]:::ui
            Routes["Routes"]:::ui
        end
    end

    subgraph "ViewModel Layer"
        HomeVM["HomeViewModel"]:::vm
        RecogniseVM["RecogniseFaceViewModel"]:::vm
        AddVM["AddFaceViewModel"]:::vm
        FacesVM["FaceViewModel"]:::vm
        WelcomeVM["WelcomeViewModel"]:::vm
    end

    subgraph "Domain & Utilities"
        Repo["Repository"]:::domain
        Utils["FileUtils, MediaUtils, LOG, StringUtils"]:::util
    end

    subgraph "ML Components"
        Detector["ML Kit Face Detector"]:::ml
        Recognizer["AiModel (TFLite)"]:::ml
    end

    subgraph "Persistence (Room)"
        MainDatabase["MainDatabase"]:::db
        MainDao["MainDao"]:::db
        ListConverter["ListConverter"]:::db
        Models["Data Models\n(AppState, FaceInfo, ProcessedImage)"]:::db
    end

    %% Data Flows
    Camera -->|"frames"| Detector
    Detector -->|"cropped face"| Recognizer
    Recognizer -->|"embedding"| Repo
    Repo -->|"store/retrieve"| MainDatabase
    MainDatabase --> MainDao
    MainDao --> Models
    Repo --> Models

    %% UI Interactions
    HomeVM -->|requests data| Repo
    RecogniseVM -->|recognize face| Repo
    AddVM -->|add/delete face| Repo
    FacesVM -->|fetch faces| Repo
    WelcomeVM -->|initialization| Repo

    HomeScreen --> HomeVM
    RecogniseScreen --> RecogniseVM
    AddFaceScreen --> AddVM
    FacesScreen --> FacesVM
    WelcomeScreen --> WelcomeVM

    FaceView --> RecogniseVM
    FrameView --> RecogniseVM
    FaceAnalytics --> RecogniseVM

    AppHost --> HomeScreen
    AppHost --> RecogniseScreen
    AppHost --> AddFaceScreen
    AppHost --> FacesScreen
    AppHost --> WelcomeScreen

    DI --> Repo
    DI --> Recognizer
    DI --> MainDatabase
    DI --> MainDao
    DI --> Utils
    DI --> HomeVM
    DI --> RecogniseVM
    DI --> AddVM
    DI --> FacesVM
    DI --> WelcomeVM

    Assets --> Recognizer

    %% Click Events
    click RecogniseFaceScreen "https://github.com/krishnazyala/facerecognition/blob/main/app/src/main/kotlin/com/krishnaZyala/faceRecognition/ui/screen/recogniseFace/RecogniseFaceScreen.kt"
    click RecogniseFaceViewModel "https://github.com/krishnazyala/facerecognition/blob/main/app/src/main/kotlin/com/krishnaZyala/faceRecognition/ui/screen/recogniseFace/RecogniseFaceViewModel.kt"
    click AiModel "https://github.com/krishnazyala/facerecognition/blob/main/app/src/main/kotlin/com/krishnaZyala/faceRecognition/lib/AiModel.kt"
    click Repository "https://github.com/krishnazyala/facerecognition/blob/main/app/src/main/kotlin/com/krishnaZyala/faceRecognition/data/Repository.kt"
    click MainDatabase "https://github.com/krishnazyala/facerecognition/blob/main/app/src/main/kotlin/com/krishnaZyala/faceRecognition/data/database/MainDatabase.kt"
    click MainDao "https://github.com/krishnazyala/facerecognition/blob/main/app/src/main/kotlin/com/krishnaZyala/faceRecognition/data/database/MainDao.kt"
    click ListConverter "https://github.com/krishnazyala/facerecognition/blob/main/app/src/main/kotlin/com/krishnaZyala/faceRecognition/data/database/ListConverter.kt"
    click AppState "https://github.com/krishnazyala/facerecognition/blob/main/app/src/main/kotlin/com/krishnaZyala/faceRecognition/data/model/AppState.kt"
    click FaceInfo "https://github.com/krishnazyala/facerecognition/blob/main/app/src/main/kotlin/com/krishnaZyala/faceRecognition/data/model/FaceInfo.kt"
    click ProcessedImage "https://github.com/krishnazyala/facerecognition/blob/main/app/src/main/kotlin/com/krishnaZyala/faceRecognition/data/model/ProcessedImage.kt"
    click FaceView "https://github.com/krishnazyala/facerecognition/blob/main/app/src/main/kotlin/com/krishnaZyala/faceRecognition/ui/composable/FaceView.kt"
    click FrameView "https://github.com/krishnazyala/facerecognition/blob/main/app/src/main/kotlin/com/krishnaZyala/faceRecognition/ui/composable/FrameView.kt"
    click FaceAnalytics "https://github.com/krishnazyala/facerecognition/blob/main/app/src/main/kotlin/com/krishnaZyala/faceRecognition/ui/composable/FaceAnalytics.kt"
    click Module "https://github.com/krishnazyala/facerecognition/blob/main/app/src/main/kotlin/com/krishnaZyala/faceRecognition/app/Module.kt"
    click MAIN "https://github.com/krishnazyala/facerecognition/blob/main/app/src/main/kotlin/com/krishnaZyala/faceRecognition/app/MAIN.kt"
    click FileUtils "https://github.com/krishnazyala/facerecognition/blob/main/app/src/main/kotlin/com/krishnaZyala/faceRecognition/lib/FileUtils.kt"
    click MediaUtils "https://github.com/krishnazyala/facerecognition/blob/main/app/src/main/kotlin/com/krishnaZyala/faceRecognition/lib/MediaUtils.kt"
    click LOG "https://github.com/krishnazyala/facerecognition/blob/main/app/src/main/kotlin/com/krishnaZyala/faceRecognition/lib/LOG.kt"
    click StringUtils "https://github.com/krishnazyala/facerecognition/blob/main/app/src/main/kotlin/com/krishnaZyala/faceRecognition/lib/StringUtils.kt"

    %% Styles
    classDef external fill:#f0f4c3,stroke:#333,stroke-width:1px
    classDef ui fill:#bbdefb,stroke:#333,stroke-width:1px
    classDef vm fill:#c8e6c9,stroke:#333,stroke-width:1px
    classDef ml fill:#ffe0b2,stroke:#333,stroke-width:1px
    classDef domain fill:#fff9c4,stroke:#333,stroke-width:1px
    classDef db fill:#ffcc80,stroke:#333,stroke-width:1px
    classDef util fill:#e0e0e0,stroke:#333,stroke-width:1px
    classDef di fill:#d1c4e9,stroke:#333,stroke-width:1px
```
