ruvector/docs
ruvnet 2f331ad3a4 feat(mmwave-bridge): cluster sink via embed RPC + ADR status updates (iter 116-117)
Iter 116 — wire `ruvector-mmwave-bridge` into the cluster's embed RPC:

  --workers <addr,…>           cluster sink (same semantics as embed/bench)
  --dim <N>                    expected vector dim (default 384)
  --fingerprint <hex>          worker-fingerprint enforcement
  --allow-empty-fingerprint    bypass the §2a empty-fp gate

Each decoded radar event is converted into a short natural-language
description ("heart rate 72 bpm at radar sensor", "person detected at
radar sensor", etc.) and posted to the cluster via the existing embed
RPC. The cluster's full security stack — §1b mTLS, §2a fp+cache gate,
§3b rate-limit interceptor — applies to this traffic with no
additional code in the bridge. Plaintext gRPC for now (Tailscale
encrypts the wire); the existing `tls` feature on the cluster crate
applies to the bridge by inheritance once the operator turns it on.

Verified end-to-end live:

  $ ruvector-hailo-fakeworker (background, port 58213, dim=4, fp:demo)
  $ ruvector-mmwave-bridge --simulator --rate 5 \
        --workers 127.0.0.1:58213 --dim 4 --fingerprint fp:demo

  ruvector-mmwave-bridge: cluster sink active — 1 worker(s), dim=4, fp="fp:demo"
  ruvector-mmwave-bridge: simulator mode @ 5 Hz (no hardware required)
  ruvector-mmwave-bridge: posted text="breathing rate 12 bpm at radar sensor" dim=4 ok
  ruvector-mmwave-bridge: posted text="heart rate 67 bpm at radar sensor" dim=4 ok
  ruvector-mmwave-bridge: posted text="nearest target distance 106 cm at radar sensor" dim=4 ok
  ruvector-mmwave-bridge: posted text="person detected at radar sensor" dim=4 ok
  …

10 successful embed RPCs in 2 seconds — full pipeline (radar event →
NL description → gRPC → fakeworker → vector returned) works.

Failures don't kill the bridge: cluster post errors get logged but
JSONL events keep flowing on stdout, so a downstream consumer that
doesn't depend on the cluster (jq pipeline, log scraper) keeps working
even when the cluster is down.

Iter 117 — ADR documentation pass:

  ADR-167 (Hailo NPU embedding backend): comprehensive iter-99-116
    status table — what shipped, what's HEF-blocked, what's deferred.
    Original iter-15 validation snapshot preserved as historical
    context.

  ADR-168 (cluster CLI surface): adds `ruvector-mmwave-bridge` as the
    sixth bin (sensor: 60 GHz mmWave radar UART → cluster embed RPC).

  ADR-172 (security review): "Implemented (modulo cross-ADR +
    HEF-blocked items)" — 2/4 HIGH ✓, 6/8 MEDIUM ✓, all 4 unshipped
    items are legitimately blocked/out-of-scope (cross-ADR §7a/§7b
    or HEF-gated §6a or doc-only §1d). Iter table 99→111 captures
    each landing commit.

  ADR-174 (thermal): partially implemented — CLI + service + install
    + 6 tests shipped iter 91-98. Per-workload Unix-socket subscriber
    deferred until the HEF compile lands and there's a real thermal
    load to manage.

Validation: 132 host tests + composition test green. Clippy
--all-targets -D warnings clean for default and tls feature configs.

Co-Authored-By: claude-flow <ruv@ruv.net>
2026-05-02 14:45:48 -04:00
..
adr feat(mmwave-bridge): cluster sink via embed RPC + ADR status updates (iter 116-117) 2026-05-02 14:45:48 -04:00
analysis fix(brain): defer sparsifier build on startup for large graphs 2026-03-24 12:29:52 +00:00
api fix(brain): defer sparsifier build on startup for large graphs 2026-03-24 12:29:52 +00:00
architecture fix(brain): defer sparsifier build on startup for large graphs 2026-03-24 12:29:52 +00:00
benchmarks fix(brain): defer sparsifier build on startup for large graphs 2026-03-24 12:29:52 +00:00
cloud-architecture fix(brain): defer sparsifier build on startup for large graphs 2026-03-24 12:29:52 +00:00
cnn feat(demo): add Self-Learning tab with 6 interactive training demos 2026-03-11 19:31:23 -04:00
code-reviews docs: reorganize into subfolders 2026-01-21 23:43:50 -05:00
dag docs(dag): add comprehensive Neural DAG Learning implementation plan 2025-12-29 22:15:55 +00:00
development feat(micro-hnsw-wasm): Add Neuromorphic HNSW v2.3 with SNN Integration (#40) 2025-12-01 22:30:15 -05:00
examples feat(musica): structure-first audio separation via dynamic mincut (#337) 2026-04-08 12:23:48 -05:00
gnn fix(brain): defer sparsifier build on startup for large graphs 2026-03-24 12:29:52 +00:00
guides docs: add missing capabilities to advanced features guide 2026-02-26 16:09:06 +00:00
hnsw fix(brain): defer sparsifier build on startup for large graphs 2026-03-24 12:29:52 +00:00
hooks feat(cli): Implement full hooks system in Rust CLI 2025-12-27 01:08:36 +00:00
implementation fix(brain): defer sparsifier build on startup for large graphs 2026-03-24 12:29:52 +00:00
integration fix(brain): defer sparsifier build on startup for large graphs 2026-03-24 12:29:52 +00:00
nervous-system docs: reorganize into subfolders 2026-01-21 23:43:50 -05:00
optimization fix(brain): defer sparsifier build on startup for large graphs 2026-03-24 12:29:52 +00:00
plans/subpolynomial-time-mincut chore(docs): Clean up and reorganize documentation structure 2025-12-25 19:39:44 +00:00
postgres fix(brain): defer sparsifier build on startup for large graphs 2026-03-24 12:29:52 +00:00
project-phases Clean up repository structure and organize documentation 2025-11-20 19:50:03 +00:00
publishing fix(brain): defer sparsifier build on startup for large graphs 2026-03-24 12:29:52 +00:00
research research(nightly): ACORN — predicate-agnostic filtered HNSW (#391) 2026-04-27 00:29:37 -04:00
reviews perf(ruvllm): optimize MoE routing with buffer reuse and optional metrics 2026-03-12 23:27:00 -04:00
ruvllm docs: reorganize into subfolders 2026-01-21 23:43:50 -05:00
rvagent feat(rvAgent): Complete DeepAgents Rust Conversion (ADR-093 → ADR-103) (#262) 2026-03-16 09:52:32 -04:00
sdk docs(sdk): add deep planning review for ruvector Python SDK 2026-04-25 20:28:54 -04:00
security feat(rvAgent): Complete DeepAgents Rust Conversion (ADR-093 → ADR-103) (#262) 2026-03-16 09:52:32 -04:00
sparse-inference feat: Add PowerInfer-style sparse inference engine with precision lanes (#106) 2026-01-04 23:40:31 -05:00
sql feat(postgres): Add ruvector-postgres extension with SIMD optimizations (#42) 2025-12-02 09:55:07 -05:00
testing Clean up repository structure and organize documentation 2025-11-20 19:50:03 +00:00
training fix(brain): defer sparsifier build on startup for large graphs 2026-03-24 12:29:52 +00:00
.gitkeep Clean up repository structure and organize documentation 2025-11-20 19:50:03 +00:00
.nojekyll fix: add .nojekyll to disable Jekyll processing 2026-03-11 17:53:19 -04:00
agi-container.md feat(rvAgent): Complete DeepAgents Rust Conversion (ADR-093 → ADR-103) (#262) 2026-03-16 09:52:32 -04:00
C2-shell-execution-hardening.md feat(rvAgent): Complete DeepAgents Rust Conversion (ADR-093 → ADR-103) (#262) 2026-03-16 09:52:32 -04:00
C8_RESULT_VALIDATION_IMPLEMENTATION.md feat(rvAgent): Complete DeepAgents Rust Conversion (ADR-093 → ADR-103) (#262) 2026-03-16 09:52:32 -04:00
consciousness-api.md feat(consciousness): SOTA IIT Φ, causal emergence, quantum collapse crate (ADR-131) 2026-03-31 16:36:25 -04:00
IMPLEMENTATION-C5.md feat(rvAgent): Complete DeepAgents Rust Conversion (ADR-093 → ADR-103) (#262) 2026-03-16 09:52:32 -04:00
index.html refactor: move CNN demo to docs/cnn/ for shorter URL 2026-03-11 17:52:13 -04:00
INDEX.md fix(brain): defer sparsifier build on startup for large graphs 2026-03-24 12:29:52 +00:00
moe-routing-optimization-analysis.md perf(ruvllm): optimize MoE routing with buffer reuse and optional metrics 2026-03-12 23:27:00 -04:00
README.md fix(brain): defer sparsifier build on startup for large graphs 2026-03-24 12:29:52 +00:00
REPO_STRUCTURE.md fix(brain): defer sparsifier build on startup for large graphs 2026-03-24 12:29:52 +00:00
research-openfang.md Add OpenFang project research document 2026-02-26 14:14:58 +00:00

RuVector Documentation

Complete documentation for RuVector, the high-performance Rust vector database with global scale capabilities.

📚 Documentation Structure

docs/
├── adr/                    # Architecture Decision Records
├── analysis/               # Research & analysis docs
├── api/                    # API references (Rust, Node.js, Cypher)
├── architecture/           # System design docs
├── benchmarks/             # Performance benchmarks & results
├── cloud-architecture/     # Cloud deployment guides
├── code-reviews/           # Code review documentation
├── dag/                    # DAG implementation
├── development/            # Developer guides
├── examples/               # SQL examples
├── gnn/                    # GNN/Graph implementation
├── guides/                 # User guides & tutorials
├── hnsw/                   # HNSW index documentation
├── hooks/                  # Hooks system documentation
├── implementation/         # Implementation details & summaries
├── integration/            # Integration guides
├── nervous-system/         # Nervous system architecture
├── optimization/           # Performance optimization guides
├── plans/                  # Implementation plans
├── postgres/               # PostgreSQL extension docs
├── project-phases/         # Development phases
├── publishing/             # NPM publishing guides
├── research/               # Research documentation
├── ruvllm/                 # RuVLLM documentation
├── security/               # Security audits & reports
├── sparse-inference/       # Sparse inference docs
├── sql/                    # SQL examples
├── testing/                # Testing documentation
└── training/               # Training & LoRA docs

Getting Started

Architecture & Design

API Reference

Performance & Benchmarks

Security

Implementation

Specialized Topics

Development

Research

  • research/ - Research documentation
    • cognitive-frontier/ - Cognitive frontier research
    • gnn-v2/ - GNN v2 research
    • latent-space/ - HNSW & attention research
    • mincut/ - MinCut algorithm research

For New Users

  1. Start with Getting Started Guide
  2. Try the Basic Tutorial
  3. Review API Documentation

For Cloud Deployment

  1. Read Architecture Overview
  2. Follow Deployment Guide
  3. Apply Performance Optimizations

For Contributors

  1. Read Contributing Guidelines
  2. Review Architecture Decisions
  3. Check Migration Guide

For Performance Tuning

  1. Review Optimization Guide
  2. Run Benchmarks
  3. Check Analysis

📊 Documentation Status

Category Directory Status
Getting Started guides/ Complete
Architecture architecture/, adr/ Complete
API Reference api/ Complete
Performance benchmarks/, optimization/, analysis/ Complete
Security security/ Complete
Implementation implementation/, integration/ Complete
Development development/, testing/ Complete
Research research/ 📚 Ongoing

Total Documentation: 460+ documents across 60+ directories


🔗 External Resources


Last Updated: 2026-02-26 | Version: 2.0.4 (core) / 0.1.100 (npm) | Status: Production Ready