mirror of
https://github.com/ruvnet/RuVector.git
synced 2026-05-26 07:44:05 +00:00
8e574daa68
Applies the reviewer's architectural feedback (docs/research/ruLake/ chat thread): ruLake is a cache-first vector execution fabric, not a federation engine. Federation is the cache's refill mechanism. ## Perf fix — cache prime now runs lock-free `VectorCache::prime()` previously built a fresh `RabitqPlusIndex` (~400 ms at n=100k) while holding the cache mutex, serialising all other queries. Now builds entirely before touching `inner`; the lock is only taken to swap the finished entry in. No benchmark regression — intermediary tax still 1.00× on LocalBackend at n=100k. ## New: bundle sidecar (`table.rulake.json`) `ruvector_rulake::bundle` — the portable unit that defines ruLake's reproducibility + governance scope. Flagged by the reviewer as more important than the UDF because it's what travels between teams, clouds, and backups. Carries: `data_ref`, `dim`, `rotation_seed`, `rerank_factor`, `generation`, `rvf_witness` (SHAKE-256 over the preceding fields), `pii_policy`, `lineage_id`. `Generation` is a serde-untagged union of `Num(u64)` (Parquet mtime, Iceberg version, Snowflake offset) and `Opaque(String)` (UUIDs, hashes, base64 blobs) — fixes the "u64 doesn't fit an Iceberg snapshot id" open question from the M1 review. Witness fn is domain-separated, length-prefixed, and verifiable via `bundle.verify_witness()`. 6 new tests: determinism, field-change-detection, length-prefix-anti-collision, serde roundtrip, tamper-detection, format-version-downgrade-rejected. ## New: recall-vs-brute-force gate `rulake_recall_at_10_above_90pct_vs_brute_force` — the missing correctness test. Builds brute-force L2 truth over 5k clustered Gaussian vectors, asserts ruLake's top-10 hits ≥ 90% at rerank×20. Uses the same n + cluster-count + methodology as `ruvector-rabitq::BENCHMARK.md` so a regression shows up as a divergence from the known-good estimator baseline. ## ADR-155 v2 — cache-first decision explicit - Decision opens with "cache-first vector execution fabric; federation is the refill mechanism", lifts the reviewer's 5-axis decision matrix (cache-first wins 4/5 axes). - New Decision §6 declares the bundle sidecar as the portable unit (not the UDF) and documents how the witness acts as the cache-key anchor, closing the "cache invalidation drift" failure mode. ## Test + lint status ``` cargo test -p ruvector-rulake --release ✓ 14/0 cargo clippy -p ruvector-rulake --release --all-targets -- -D warnings ✓ clean cargo fmt -p ruvector-rulake -- --check ✓ clean cargo run -p ruvector-rulake --release --bin rulake-demo -- --fast ✓ no regression ``` Co-Authored-By: claude-flow <ruv@ruv.net> |
||
|---|---|---|
| .. | ||
| adr | ||
| analysis | ||
| api | ||
| architecture | ||
| benchmarks | ||
| cloud-architecture | ||
| cnn | ||
| code-reviews | ||
| dag | ||
| development | ||
| examples | ||
| gnn | ||
| guides | ||
| hnsw | ||
| hooks | ||
| implementation | ||
| integration | ||
| nervous-system | ||
| optimization | ||
| plans/subpolynomial-time-mincut | ||
| postgres | ||
| project-phases | ||
| publishing | ||
| research | ||
| reviews | ||
| ruvllm | ||
| rvagent | ||
| security | ||
| sparse-inference | ||
| sql | ||
| testing | ||
| training | ||
| .gitkeep | ||
| .nojekyll | ||
| agi-container.md | ||
| C2-shell-execution-hardening.md | ||
| C8_RESULT_VALIDATION_IMPLEMENTATION.md | ||
| consciousness-api.md | ||
| IMPLEMENTATION-C5.md | ||
| index.html | ||
| INDEX.md | ||
| moe-routing-optimization-analysis.md | ||
| README.md | ||
| REPO_STRUCTURE.md | ||
| research-openfang.md | ||
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
- guides/GETTING_STARTED.md - Getting started guide
- guides/BASIC_TUTORIAL.md - Basic tutorial
- guides/INSTALLATION.md - Installation instructions
- guides/AGENTICDB_QUICKSTART.md - AgenticDB quick start
- guides/wasm-api.md - WebAssembly API documentation
Architecture & Design
- architecture/ - System architecture details
- cloud-architecture/ - Global cloud deployment
- adr/ - Architecture Decision Records
- nervous-system/ - Nervous system architecture
API Reference
- api/RUST_API.md - Rust API reference
- api/NODEJS_API.md - Node.js API reference
- api/CYPHER_REFERENCE.md - Cypher query reference
Performance & Benchmarks
- benchmarks/ - Performance benchmarks & results
- optimization/ - Performance optimization guides
- analysis/ - Research & analysis docs
Security
- security/ - Security audits & reports
Implementation
- implementation/ - Implementation details & summaries
- integration/ - Integration guides
- code-reviews/ - Code review documentation
Specialized Topics
- gnn/ - GNN/Graph implementation
- hnsw/ - HNSW index documentation
- postgres/ - PostgreSQL extension docs
- ruvllm/ - RuVLLM documentation
- training/ - Training & LoRA docs
Development
- development/CONTRIBUTING.md - Contribution guidelines
- development/MIGRATION.md - Migration guide
- testing/ - Testing documentation
- publishing/ - NPM publishing guides
Research
- research/ - Research documentation
- cognitive-frontier/ - Cognitive frontier research
- gnn-v2/ - GNN v2 research
- latent-space/ - HNSW & attention research
- mincut/ - MinCut algorithm research
🚀 Quick Links
For New Users
- Start with Getting Started Guide
- Try the Basic Tutorial
- Review API Documentation
For Cloud Deployment
- Read Architecture Overview
- Follow Deployment Guide
- Apply Performance Optimizations
For Contributors
- Read Contributing Guidelines
- Review Architecture Decisions
- Check Migration Guide
For Performance Tuning
- Review Optimization Guide
- Run Benchmarks
- 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
- GitHub Repository: https://github.com/ruvnet/ruvector
- Main README: ../README.md
- Changelog: ../CHANGELOG.md
- License: ../LICENSE
Last Updated: 2026-02-26 | Version: 2.0.4 (core) / 0.1.100 (npm) | Status: Production Ready