Skip to content

docs(readme): refresh architecture diagram to current stack #36

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sagar-develop merged 1 commit into from
Jun 8, 2026
Merged

docs(readme): refresh architecture diagram to current stack #36

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 16 additions & 18 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -348,26 +348,24 @@ The download URLs + per-model metadata live in

## Architecture at a glance

```
┌─────────────────────────────────────────┐
│ Your app (Compose / SwiftUI / …) │
└─────────────────────────────────────────┘
│
┌─────────────────▼─────────────────────────┐
│ EngineRegistry ← HardwareProvider │
│ (picks LiteRT vs MediaPipe vs fallback │
│ based on device RAM tier) │
└─────────────────┬─────────────────────────┘
│
┌──────────────────────┼────────────────────────┐
▼ ▼ ▼
LocalAiEngine EmbeddingEngine ModelManager
(LiteRT-LM / (MediaPipe Tasks (Ktor download
Gemma 4) Text Embedder) + SHA-256 +
atomic move)
```mermaid
flowchart TB
app["Your app (Compose / SwiftUI / …)"]
sel["RAM-tier selection · HardwareProvider<br/>picks LLM + embedder + reranker for the device"]
lae["LocalAiEngine<br/>LiteRT-LM / Gemma 4"]
ee["EmbeddingEngine<br/>EmbeddingGemma / USE-Lite (ONNX, telemetry-free)"]
ret["DocumentRetriever<br/>vector + BM25 + rerank (RAG)"]
mm["ModelManager<br/>resumable download + SHA-256"]
app --> sel
sel --> lae
sel --> ee --> ret
sel --> mm

classDef n fill:#f5f3ef,stroke:#7FA980,color:#1C1B1A;
class app,sel,lae,ee,ret,mm n;
```

See [`ARCHITECTURE.md`](ARCHITECTURE.md) for the full design rationale, including how the RAM-tier policy works and why the OEM RAM-expansion detection is necessary.
See [`ARCHITECTURE.md`](ARCHITECTURE.md) for the full design — Mermaid diagrams of the engine/product split and the RAG pipeline, the device-tier policy, and why OEM RAM-expansion detection is necessary.

## Enterprise support, custom implementations & architectural advising

Expand Down
Loading