ruvector/docs
ruvnet d5e3019b62 feat: ruvllm-bridge — JSONL stdin/stdout adapter (iter 124, ADR-173 seam)
Iter 123 closed the ruview side (CSI UDP → cluster). This iter closes
the ruvllm side without waiting for the HEF compile pipeline: a thin
host-side bin that any ruvllm process can spawn as a subprocess and
talk to via line-delimited JSON, no gRPC client library required.

When the HEF lands later (vendor-tool blocker), the cluster's
HailoEmbedder serves real semantic vectors instead of FNV-1a placeholders;
this bridge's input/output contract doesn't change.

New crates/ruvector-hailo-cluster/src/bin/ruvllm-bridge.rs (~260 LOC):

  Input  (one JSON object per stdin line):
    {"text": "input string to embed"}
    {"text": "another", "request_id": "01HRZK..."}     # optional ID
                                                         # (propagated as
                                                         #  the cluster's
                                                         #  ULID; iter 109)

  Output (one JSON object per stdout line, matches input order):
    {"dim": 384, "latency_us": 8147, "vector": [0.012, -0.045, ...]}
    {"dim": 384, "latency_us": 5432, "request_id": "01HRZK...",
     "vector": [...]}
    {"error": "cluster unreachable: ..."}

  Closing stdin = clean exit 0. Errors per request don't kill the bin —
  every failure surfaces as a `{"error":"..."}` line and the loop
  continues. Lets long-running ruvllm sessions ride out transient
  cluster hiccups.

  Same flag set as the other two bridges:
    --workers <csv>            REQUIRED (--workers without --fingerprint
                               refused by the §2a gate unless
                               --allow-empty-fingerprint is set)
    --fingerprint --dim --allow-empty-fingerprint --quiet
    --tls-ca --tls-domain --tls-client-cert --tls-client-key
                               (§1a / §1b parity, gated on --features tls)

  Hand-rolled JSON parser + emitter for the request/response shape
  (avoids pulling serde_json's mid-line reader into stdin handling
  and keeps the bin's link surface small). Handles \", \\, \n, \t
  and \uXXXX escapes; passthrough for everything else. Sufficient
  for real prompt content.

Live verification (3 cases against fakeworker on ephemeral port):
  $ echo '{"text":"hello world from ruvllm"}' | \
        ruvllm-bridge --workers 127.0.0.1:NNN --dim 4 --fingerprint fp:llm-demo --quiet
    {"dim":4,"latency_us":1358,"vector":[-0.873,-0.923,0.427,-0.220]}

  $ printf '{"text":"first"}\n{"text":"second","request_id":"01HRZK..."}\n' | \
        ruvllm-bridge ...
    {"dim":4,"latency_us":1000,"vector":[...]}
    {"dim":4,"latency_us":485,"request_id":"01HRZK...","vector":[...]}

  Multi-line + request_id propagation both work; vectors come back
  with stable Debug-formatted float precision so the wire bytes
  round-trip exactly.

Cargo.toml: new [[bin]] entry; ADR-168 updated to list 8th bin.

Validation:
  - cargo build --bin ruvllm-bridge: clean (default + tls)
  - clippy --all-targets -D warnings: clean for both feature configs
    (Duration import only used under feature = "tls", correctly cfg-gated)
  - cargo test --features tls: 20 test groups all green

Bridge ecosystem after iter 124:
  ruvector-mmwave-bridge   60 GHz radar UART → cluster (iter 116)
  ruview-csi-bridge        WiFi CSI UDP     → cluster (iter 123)
  ruvllm-bridge            JSONL stdin/RPC  → cluster (iter 124)

Three sensor-modality entry points sharing one cluster, all hardened
under §1b mTLS / §2a fp+cache / §3b rate-limit. ADR-171 and ADR-173
seam implementations both shipped.

Co-Authored-By: claude-flow <ruv@ruv.net>
2026-05-02 15:10:45 -04:00
..
adr feat: ruvllm-bridge — JSONL stdin/stdout adapter (iter 124, ADR-173 seam) 2026-05-02 15:10:45 -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