Skip to content

🎨 Palette: [UX improvement] Enhance documentation DX with architecture diagram and status clarity #24

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

Open
Igor Holt (igor-holt) wants to merge 1 commit into
base: main
Choose a base branch
from
Open

🎨 Palette: [UX improvement] Enhance documentation DX with architecture diagram and status clarity #24

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
36 changes: 34 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
# ⚖️ arbiter

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
![Status: Experimental](https://img.shields.io/badge/Status-Experimental-orange)
[![License: MIT - Open source software license](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

> [!CAUTION]
> This project is experimental and not recommended for production use. It involves bare-metal hardware management and quantum-accelerated scheduling which are currently in active development.

Dual nature—combining bare-metal virtualized hardware management (aSHARD VRAM pinning) with quantum-accelerated Kubernetes scheduling.

Expand All @@ -16,6 +18,36 @@ Dual nature—combining bare-metal virtualized hardware management (aSHARD VRAM
- ⚛️ **Next-Gen Scheduling**: Leverages quantum-accelerated algorithms for complex Kubernetes workloads.
- ⚖️ **Unified Orchestration**: A single control plane for both hardware and cluster-level operations.

## 🏗️ Architecture

```mermaid
graph TD
subgraph Cloud_Native [Cloud Native Layer]
K8S[Kubernetes Cluster]
Workloads[AI/ML Workloads]
end

subgraph Orchestration [Orchestration Layer]
Arbiter((Arbiter Core))
Scheduler[Quantum-Accelerated Scheduler]
end

subgraph Infrastructure [Infrastructure Layer]
Metal[Bare-Metal Hardware]
GPU[GPU Resources]
vRAM[aSHARD VRAM Pinning]
end

Workloads --> K8S
K8S <--> Scheduler
Scheduler --- Arbiter
Arbiter <--> vRAM
vRAM --- GPU
GPU --- Metal
Comment on lines +43 to +46
Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist Bot Apr 30, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The architecture diagram uses a mix of directed (-->), bidirectional (<-->), and undirected (---) links. For better clarity and to ensure a consistent top-down flow in the graph TD layout, consider using directed or bidirectional arrows for all component interactions. This explicitly shows the dependency or communication flow between the layers.

Suggested change
Scheduler --- Arbiter
Arbiter <--> vRAM
vRAM --- GPU
GPU --- Metal
Scheduler <--> Arbiter
Arbiter <--> vRAM
vRAM --> GPU
GPU --> Metal


style Arbiter fill:#f96,stroke:#333,stroke-width:4px
```

## ⚖️ License

This project is licensed under the [MIT License](LICENSE).