docs(docs): 📝 Implement structured onboarding flow in README.md with clear sections, visual guidance, and improved readability
Co-Authored-By: Lilith Autocommit <noreply@atlilith.com>
This commit is contained in:
Lilith
parent
5d76d77206
commit
1c3a37da53
1 changed files with 82 additions and 29 deletions
111
docs/README.md
111
docs/README.md
|
|
@ -1,6 +1,6 @@
|
|||
# @imajin Documentation
|
||||
|
||||
AI-powered image generation platform with diffusion models, LLM prompt engineering, and post-processing capabilities.
|
||||
AI-powered image generation platform with diffusion models, LLM prompt engineering, content moderation, semantic validation, and aesthetic scoring.
|
||||
|
||||
## Architecture Overview
|
||||
|
||||
|
|
@ -19,12 +19,29 @@ graph TB
|
|||
CORE[imajin-app/<br/>@lilith/imajin-app]
|
||||
end
|
||||
|
||||
subgraph "Backend Services"
|
||||
ASSIST[imajin-prompt :8003]
|
||||
subgraph "Orchestrators"
|
||||
PIPELINE[imajin-pipeline :8080<br/>16-stage self-contained]
|
||||
APP[imajin-app :8080<br/>Service proxy]
|
||||
end
|
||||
|
||||
subgraph "Core Services"
|
||||
PROMPT[imajin-prompt :8003]
|
||||
GEN[imajin-diffusion :8002]
|
||||
PROC[imajin-processing :8004]
|
||||
end
|
||||
|
||||
subgraph "Validation & Safety"
|
||||
MOD[imajin-moderator :8008]
|
||||
SEM[imajin-semantic :8005]
|
||||
AES[imajin-aesthetic :8006]
|
||||
end
|
||||
|
||||
subgraph "Supporting Services"
|
||||
IDENT[imajin-identity :8009]
|
||||
REQCLASS[imajin-request-classifier]
|
||||
PROMPTGEN[imajin-prompt-generator]
|
||||
end
|
||||
|
||||
subgraph "Infrastructure"
|
||||
REDIS[(Redis/GPUBoss)]
|
||||
GPU[GPU/CUDA]
|
||||
|
|
@ -34,8 +51,12 @@ graph TB
|
|||
PLATFORM --> REACTLIB
|
||||
ERRPAGES & SKELETON --> CORE
|
||||
ELECTRON & REACTLIB --> CORE
|
||||
CORE --> ASSIST & GEN & PROC
|
||||
ASSIST & GEN --> REDIS --> GPU
|
||||
CORE --> PIPELINE & APP
|
||||
PIPELINE --> PROMPT & GEN & PROC
|
||||
PIPELINE --> MOD & SEM & AES
|
||||
APP --> REQCLASS & PROMPTGEN & GEN & PROC
|
||||
MOD --> SEM & IDENT
|
||||
PROMPT & GEN & SEM & AES --> REDIS --> GPU
|
||||
```
|
||||
|
||||
**Key consumers:**
|
||||
|
|
@ -54,15 +75,44 @@ graph TB
|
|||
|
||||
## Components at a Glance
|
||||
|
||||
### Libraries
|
||||
|
||||
| Component | Type | Technology | Purpose |
|
||||
|-----------|------|------------|---------|
|
||||
| [imajin-app](./services/imajin-app.md) | Library | TypeScript | Core orchestration entry point |
|
||||
| [react/](./services/imajin-app.md#react) | Library | React | UI components for web consumers |
|
||||
| [electron/](./services/imajin-app.md#electron) | Library | Electron | Components for desktop consumers |
|
||||
| [imajin-prompt](./services/imajin-prompt.md) | Service | Python/FastAPI | LLM prompt generation |
|
||||
|
||||
### Core Services
|
||||
|
||||
| Component | Type | Technology | Purpose |
|
||||
|-----------|------|------------|---------|
|
||||
| [imajin-prompt](./services/imajin-prompt.md) | Service | Python/FastAPI | LLM prompt generation + cultural classification |
|
||||
| [imajin-diffusion](./services/imajin-diffusion.md) | Service | Python/FastAPI | Diffusion model image generation |
|
||||
| [imajin-processing](./services/imajin-processing.md) | Service | NestJS/Sharp | Image post-processing |
|
||||
|
||||
### Validation & Safety Services
|
||||
|
||||
| Component | Type | Technology | Purpose |
|
||||
|-----------|------|------------|---------|
|
||||
| [imajin-moderator](./services/imajin-moderator.md) | Service | Python/FastAPI | 5-layer content moderation |
|
||||
| [imajin-semantic](./services/imajin-semantic.md) | Service | Python/FastAPI | SigLIP2 semantic validation |
|
||||
| [imajin-aesthetic](./services/imajin-aesthetic.md) | Service | Python/FastAPI | ImageReward aesthetic scoring |
|
||||
|
||||
### Supporting Services
|
||||
|
||||
| Component | Type | Technology | Purpose |
|
||||
|-----------|------|------------|---------|
|
||||
| [imajin-identity](./services/imajin-identity.md) | Service | Python/FastAPI | Identity recognition & photo organization |
|
||||
| [imajin-request-classifier](./services/imajin-request-classifier.md) | Service | Python/FastAPI | Cultural context classification (thin client) |
|
||||
| imajin-prompt-generator | Service | Python/FastAPI | Lightweight prompt generation (Stage 2 only) |
|
||||
|
||||
### Orchestrators
|
||||
|
||||
| Component | Type | Technology | Purpose |
|
||||
|-----------|------|------------|---------|
|
||||
| imajin-pipeline | Orchestrator | Python/FastAPI | 16-stage self-contained pipeline |
|
||||
| imajin-app (orchestrator) | Orchestrator | Python/FastAPI | Service proxy with batch support |
|
||||
|
||||
## Existing Documentation
|
||||
|
||||
|
|
@ -77,29 +127,32 @@ Detailed documentation exists in each service directory:
|
|||
|
||||
```
|
||||
@imajin/
|
||||
├── imajin-app/ # Core orchestration entry point
|
||||
│ └── src/ # @lilith/imajin-app (pipelines, types, clients)
|
||||
├── react/ # React components for web consumers
|
||||
│ └── src/ # @lilith/imajin-react (UI components, hooks)
|
||||
├── electron/ # Electron components for desktop consumers
|
||||
│ └── src/ # @lilith/imajin-electron (IPC, service management)
|
||||
├── imajin-diffusion/ # Diffusion model image generation service
|
||||
│ ├── service/ # Python FastAPI backend
|
||||
│ ├── types/ # @lilith/imajin-diffusion-types
|
||||
│ └── client/ # @lilith/imajin-diffusion-client
|
||||
├── imajin-processing/ # Image post-processing service
|
||||
│ ├── service/ # NestJS backend
|
||||
│ ├── types/ # @lilith/imajin-processing-types
|
||||
│ └── client/ # @lilith/imajin-processing-client
|
||||
├── imajin-prompt/ # LLM prompt generation service
|
||||
│ ├── service/ # Python FastAPI backend
|
||||
│ ├── types/ # TypeScript types
|
||||
│ └── client/ # @lilith/imajin-prompt-client
|
||||
├── imajin-identity/ # Identity recognition service
|
||||
│ └── service/ # Python FastAPI backend
|
||||
│ └── src/ # Face detection, clustering, storage
|
||||
├── utils/ # Shared Python utilities
|
||||
└── docs/ # This documentation
|
||||
├── packages/
|
||||
│ ├── imajin-app/ # Core orchestration entry point (@lilith/imajin-app)
|
||||
│ ├── imajin-react/ # React components (@lilith/imajin-react)
|
||||
│ ├── imajin-electron/ # Electron components (@lilith/imajin-electron)
|
||||
│ ├── imajin-client/ # Unified HTTP client (@lilith/imajin-client)
|
||||
│ ├── imajin-config/ # Shared configuration (@lilith/imajin-config)
|
||||
│ └── imajin-moderator-client/ # Moderator client (@lilith/imajin-moderator-client)
|
||||
│
|
||||
├── services/
|
||||
│ ├── imajin-diffusion/ # SDXL image generation (service + types + client)
|
||||
│ ├── imajin-prompt/ # LLM prompt generation (service + types + client)
|
||||
│ ├── imajin-processing/ # Post-processing (service + types + client)
|
||||
│ ├── imajin-moderator/ # Content moderation (service + types + client)
|
||||
│ ├── imajin-semantic/ # Semantic validation (service + types + client)
|
||||
│ ├── imajin-aesthetic/ # Aesthetic scoring (service + types + client)
|
||||
│ ├── imajin-identity/ # Identity recognition (service)
|
||||
│ ├── imajin-request-classifier/ # Cultural classification (service)
|
||||
│ └── imajin-prompt-generator/ # Lightweight prompt generation (service)
|
||||
│
|
||||
├── orchestrators/
|
||||
│ ├── imajin-pipeline/ # 16-stage self-contained pipeline
|
||||
│ └── imajin-app/ # Service proxy orchestrator
|
||||
│
|
||||
├── tests/ # Integration tests
|
||||
├── scripts/ # Build & dev scripts
|
||||
└── docs/ # This documentation
|
||||
```
|
||||
|
||||
## Consumer Integration
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue