# codesomethingdaily/hiragana_recognition architecture

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

- Interactive diagram: https://gitdiagram.com/codesomethingdaily/hiragana_recognition
- Repository: https://github.com/codesomethingdaily/hiragana_recognition

## Overview

##### File structure
- Top level:
- android/ – Android Runner, Gradle build files, AndroidManifest, Kotlin MainActivity
- ios/ – Xcode project, Swift AppDelegate, Info.plist, storyboard assets
- windows/ – CMake runner, native entry (main.cpp), window management
- lib/ – Dart source: main.dart (app entry) and paint.dart (drawing canvas + logic)
- test/ – Flutter widget test harness
- pubspec.yaml – Flutter dependencies (likely includes pytorch_mobile plugin or similar)
- No explicit “backend” directory: inference happens on-device via platform-specific native libs.
- The structure follows Flutter’s standard runner + Dart code pattern, with platform channels implicitly used to bridge Dart to native ML code.

##### Key README insights
- “An flutter app that recognize handwriting of Japanese Hiragana using pytorch.”
- Tells us the core components are: Flutter UI → drawing input → on-device PyTorch inference → display result.

a. Main components:
1. Flutter Presentation Layer (Widgets, Drawing Canvas)
2. Application Logic (Dart service that captures strokes, rasterizes to bitmap/tensor)
3. Platform Channel Bridge (MethodChannel or similar)
4. Native Inference Module (PyTorch Mobile library on Android, iOS, Windows)
5. OS & Device Hardware (CPU/GPU)
b. Relationships & data flow:
- User touches screen → Flutter Canvas → stroke data aggregated
- Dart logic rasterizes strokes into an image tensor → sends tensor over Platform Channel
- Native side (Kotlin/Swift/C++) receives tensor → invokes PyTorch Mobile forward pass → returns a class/probability
- Dart layer receives recognition result → updates UI with predicted Hiragana character
c. Architectural patterns & principles:
- Layered architecture (Presentation → Service → Platform Bridge → Native Module)
- Single codebase for UI + business logic (Flutter), separation of concerns via Platform Channels
- On-device ML inference for low latency (no external server calls)
d. Key technologies/frameworks:
- Flutter framework (Dart)
- PyTorch Mobile (Android AAR, iOS Pod, Windows library)
- Platform Channels (MethodChannel)
- Kotlin (Android), Swift (iOS), C++/Win32 (Windows)

##### Capturing essential elements
- Assets or model file if present (e.g., .pt or .ptl file packaged).

- Clearly separates cross-platform UI from platform-specific ML inference
- Shows all five major components and their interactions
- Labels each platform runner, the Dart entrypoints, and the ML engine
- Reflects the exact structure implied by the project’s file tree and README.

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% User Input
    User(["User"]):::external

    %% Flutter Layer
    subgraph "Flutter Presentation Layer" 
        direction TB
        Main["Main Entry\n(lib/main.dart)"]:::dart
        Canvas["Drawing Canvas\n(lib/paint.dart)"]:::dart
    end

    %% Application Logic
    Stroke["Stroke Aggregation & Rasterization\n(lib/paint.dart)"]:::dart

    %% Flutter Engine
    Engine["Flutter Engine Runtime"]:::runtime

    %% Platform Channel Bridge
    subgraph "Platform Channel Bridge" 
        direction TB
        AndroidBridge["Android Bridge\n(MainActivity.kt)"]:::bridge
        iOSBridge["iOS Bridge\n(AppDelegate.swift)"]:::bridge
        WinBridge["Windows Bridge\n(main.cpp\nflutter_window.cpp)"]:::bridge
    end

    %% Native Inference Module
    subgraph "Native Inference Module" 
        direction TB
        AndroidInfer["PyTorch Mobile AAR\n(build.gradle\nAndroidManifest.xml)"]:::native
        iOSInfer["PyTorch Mobile Pod\n(Debug.xcconfig\nRelease.xcconfig\nInfo.plist)"]:::native
        WinInfer["Windows ML Lib\n(CMakeLists.txt\ngenerated_plugin_registrant.cc)"]:::native
    end

    %% Test Harness
    Test["Widget Test Harness\n(test/widget_test.dart)"]:::test

    %% Dependency Config
    Dep["Dependencies\n(pubspec.yaml)"]:::config

    %% OS & Hardware
    OS["OS & Device Hardware\n(CPU/GPU)"]:::os

    %% Connections
    User -->|"draws stroke"| Canvas
    Canvas -->|"passes stroke"| Stroke
    Stroke -->|"bitmap tensor"| AndroidBridge
    Stroke -->|"bitmap tensor"| iOSBridge
    Stroke -->|"bitmap tensor"| WinBridge

    AndroidBridge -->|"invoke inference"| AndroidInfer
    iOSBridge -->|"invoke inference"| iOSInfer
    WinBridge -->|"invoke inference"| WinInfer

    AndroidInfer -->|"result"| AndroidBridge
    iOSInfer -->|"result"| iOSBridge
    WinInfer -->|"result"| WinBridge

    AndroidBridge -->|"return result"| Stroke
    iOSBridge -->|"return result"| Stroke
    WinBridge -->|"return result"| Stroke

    Stroke -->|"update UI"| Canvas

    Canvas --> Engine
    Engine --> OS
    AndroidInfer --> OS
    iOSInfer --> OS
    WinInfer --> OS

    Test --> Canvas
    Dep --> Main

    %% Click Events
    click Main "https://github.com/codesomethingdaily/hiragana_recognition/blob/main/lib/main.dart"
    click Canvas "https://github.com/codesomethingdaily/hiragana_recognition/blob/main/lib/paint.dart"
    click Stroke "https://github.com/codesomethingdaily/hiragana_recognition/blob/main/lib/paint.dart"
    click AndroidBridge "https://github.com/codesomethingdaily/hiragana_recognition/blob/main/android/app/src/main/kotlin/com/example/hiragana_recognition/MainActivity.kt"
    click iOSBridge "https://github.com/codesomethingdaily/hiragana_recognition/blob/main/ios/Runner/AppDelegate.swift"
    click WinBridge "https://github.com/codesomethingdaily/hiragana_recognition/blob/main/windows/runner/main.cpp"
    click WinBridge "https://github.com/codesomethingdaily/hiragana_recognition/blob/main/windows/runner/flutter_window.cpp"
    click AndroidInfer "https://github.com/codesomethingdaily/hiragana_recognition/blob/main/android/app/build.gradle"
    click AndroidInfer "https://github.com/codesomethingdaily/hiragana_recognition/blob/main/android/app/src/main/AndroidManifest.xml"
    click iOSInfer "https://github.com/codesomethingdaily/hiragana_recognition/blob/main/ios/Flutter/Debug.xcconfig"
    click iOSInfer "https://github.com/codesomethingdaily/hiragana_recognition/blob/main/ios/Flutter/Release.xcconfig"
    click iOSInfer "https://github.com/codesomethingdaily/hiragana_recognition/blob/main/ios/Runner/Info.plist"
    click WinInfer "https://github.com/codesomethingdaily/hiragana_recognition/blob/main/windows/CMakeLists.txt"
    click WinInfer "https://github.com/codesomethingdaily/hiragana_recognition/blob/main/windows/flutter/generated_plugin_registrant.cc"
    click Test "https://github.com/codesomethingdaily/hiragana_recognition/blob/main/test/widget_test.dart"
    click Dep "https://github.com/codesomethingdaily/hiragana_recognition/blob/main/pubspec.yaml"

    %% Styles
    classDef dart fill:#D0E8FF,stroke:#0366d6,color:#0366d6,stroke-width:1px
    classDef bridge fill:#FFF5D0,stroke:#DAA520,color:#DAA520,stroke-width:1px
    classDef native fill:#DFFFE0,stroke:#228B22,color:#228B22,stroke-width:1px
    classDef runtime fill:#F0F0F0,stroke:#808080,color:#808080,stroke-width:1px
    classDef os fill:#E8E8E8,stroke:#505050,color:#505050,stroke-width:1px
    classDef external fill:#FFE0E0,stroke:#D1462F,color:#D1462F,stroke-width:1px
    classDef test fill:#F5E6FF,stroke:#8A2BE2,color:#8A2BE2,stroke-width:1px
    classDef config fill:#E0F7FF,stroke:#17A2B8,color:#17A2B8,stroke-width:1px
```
