ruvector/docs
ruvnet 3c2377f500 feat(observer): adaptive detect cadence — first ≥ 2× saturated-regime win (4.29×)
ADR-154 §16 named three observer-side levers for closing the
saturated-regime throughput gap that (a) SIMD (commit 2) and (b) Opt D
delay-sorted CSR (commit 7) left on the table. The first lever —
dropping the sparse-Fiedler dispatch threshold — was measured in
commit 9 and turned out to be a 3× regression. This commit implements
the second: adaptive detect cadence.

Logic (14 LOC addition to src/observer/core.rs): a helper
`current_detect_interval_ms(&self)` reads the co-firing-window
density per `on_spike` call. If the window holds more than
`5 × num_neurons` spikes — equivalent to ≥ 100 Hz average per
neuron over the 50 ms window — back off to a 4× cadence (20 ms
instead of 5 ms). Drop back to 5 ms as soon as density falls below
threshold. Both sides are deterministic given the spike stream, so
AC-1 repeatability is preserved.

Measured on the reference host (N=1024, 120 ms saturated, SIMD
default on Ryzen-class CPU):

  lif_throughput_n_1024/baseline  : 6.86 s → 1.70 s   (4.03× vs pre)
  lif_throughput_n_1024/optimized : 6.74 s → 1.57 s   (4.29× vs pre)

ADR-154 §3.2 saturated-regime target was ≥ 2× over scalar-opt.
**Measured: 4.29×. HIT — the first optimization on this branch to
clear that target at the top-line bench.**

Acceptance-test suite impact (proportional to detector share each
test spent in saturation):

  acceptance_causal (AC-5)     395 s → 100 s   (4.0×)
  acceptance_core  (AC-1..AC-4) 63 s →  16 s   (4.0×)
  integration                   32 s →  8.5 s  (3.8×)
  sparse_fiedler_10k            20 ms unchanged (well below threshold)

AC-4-strict guarantee preserved. The 20 ms backoff interval gives
≥ 2 detects inside any 50 ms lead window, so the precognitive claim
(≥ 50 ms lead on ≥ 70 % of 30 trials) is unaffected. Test passes
with 30/30 trials detecting the constructed-collapse marker on the
new cadence.

AC-1 bit-exactness preserved. Two repeat runs produce identical
spike traces — the adaptive interval is deterministic per
`(connectome_seed, engine_seed, stimulus_schedule)`.

Knock-on effect on Opt D (commit 7): with the detector no longer
dominating by 450:1, Opt D's ~5 ms-per-step kernel savings should
now represent ~120 ms of the new 1.57 s median. A clean paired-
sample criterion bench to isolate the Opt-D-attributable share is
named as follow-up.

Commit arc summary at head:

  Commit 2  SIMD (Opt C)                    1.013× — MISS
  Commit 7  Opt D delay-sorted CSR          1.00×  — MISS at top-line
  Commit 9  Drop sparse-Fiedler threshold   3× regression (disproven)
  Commit 10 Adaptive detect cadence         4.29×  — HIT ≥ 2× target

The lesson the full arc makes concrete: throughput gaps diagnosed
as "kernel-bound" via a pre-measurement guess can turn out to be
*detector-bound* (commit 7's surprise), and even after that
correction the right remediation is not necessarily the
structurally-obvious one (commit 9's regression). The win came
from changing *when* the detector runs, not *what* it does or *how*
it is represented.

All 58 tests pass. Positioning rubric held across all 10 commits.

Co-Authored-By: claude-flow <ruv@ruv.net>
2026-04-22 13:20:28 -04:00
..
adr feat(observer): adaptive detect cadence — first ≥ 2× saturated-regime win (4.29×) 2026-04-22 13:20:28 -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 feat(examples): connectome-fly SOTA example + ADR-154 2026-04-21 23:27:11 -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
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