mirror of
https://github.com/ruvnet/RuVector.git
synced 2026-07-10 01:38:44 +00:00
137a02ee9c
* research: add nightly survey for capability-gated-ann Selects capability-gated ANN search as 2026-06-25 nightly topic. Three research loop passes completed: Discover, Deepen, Critique. Topic fills the missing per-vector read access control gap in RuVector (ADR-227 already covers proof-gated writes; this adds gated reads). Co-Authored-By: claude-flow <ruv@ruv.net> Claude-Session: https://claude.ai/code/session_01Gayqu5K44VptZqJLhxX1Vb * feat: add capability-gated ANN Rust proof of concept crates/ruvector-capgated: zero-dep Rust crate implementing three capability-gated ANN search variants using 64-bit CapMask bitsets. - CapMask: 64-bit bitset for capability requirements/holdings - CapGatedIndex trait: unified API across all backends - PostFilter: O(n) scan, 100% recall, baseline - EagerMask: O(auth_frac*n*d), 100% recall, 7.9x speedup at 12.5% access - CapGraph: k-NN graph walk with ef-bounded exploration, 90.6% recall - Oracle: brute-force ground truth for recall measurement - Deterministic LCG dataset generation (no external deps) Co-Authored-By: claude-flow <ruv@ruv.net> Claude-Session: https://claude.ai/code/session_01Gayqu5K44VptZqJLhxX1Vb * test: add 22 numeric acceptance tests for capability-gated-ann Tests cover: CapMask satisfies semantics, dist_sq correctness, recall computation, Oracle filtering/ordering, PostFilter filtering/ordering/k-limit, EagerMask equivalence to Oracle, EagerMask zero-access, CapGraph authorisation enforcement, CapGraph k-limit, CapGraph empty index, CapGraph full-access, dataset determinism, pick_caps count/range, LCG reproducibility. All 22 tests pass with cargo test -p ruvector-capgated. Co-Authored-By: claude-flow <ruv@ruv.net> Claude-Session: https://claude.ai/code/session_01Gayqu5K44VptZqJLhxX1Vb * docs: add ADR-268 for capability-gated ANN search ADR-268-capability-gated-ann.md covers: - Context: gap between proof-gated writes (ADR-227) and read access control - Decision: CapGatedIndex trait, CapMask bitset, three variants - Benchmark evidence: PostFilter 2,023 QPS, EagerMask 17,548 QPS (low-access), CapGraph 3,396 QPS / 0.869 recall - Alternatives considered: post-hoc filter, per-group index, homomorphic encryption - Failure modes and security considerations - Migration path into ruvector-core Co-Authored-By: claude-flow <ruv@ruv.net> Claude-Session: https://claude.ai/code/session_01Gayqu5K44VptZqJLhxX1Vb * bench: capture capability-gated-ann benchmark results Real cargo run --release numbers on x86_64 Linux, Rust 1.94.1: High-access (37.5% authorised): PostFilter: 494 μs mean / 2,023 QPS / 1.000 recall EagerMask: 175 μs mean / 5,728 QPS / 1.000 recall (2.8x speedup) CapGraph: 289 μs mean / 3,466 QPS / 0.906 recall Low-access (12.5% authorised): PostFilter: 450 μs mean / 2,221 QPS / 1.000 recall EagerMask: 57 μs mean / 17,548 QPS / 1.000 recall (7.9x speedup) CapGraph: 295 μs mean / 3,396 QPS / 0.869 recall ACCEPTANCE RESULT: PASS -- all thresholds met. Co-Authored-By: claude-flow <ruv@ruv.net> Claude-Session: https://claude.ai/code/session_01Gayqu5K44VptZqJLhxX1Vb * docs: add SEO gist for capability-gated-ann docs/research/nightly/2026-06-25-capability-gated-ann/gist.md: - Public-facing technical article with real benchmark numbers - Comparison table vs Milvus, Qdrant, Weaviate, Pinecone, LanceDB, FAISS, pgvector, Chroma, Vespa - 8 practical applications, 8 exotic applications - Deep research notes with ACORN, filtered-ANN, Milvus citations - Usage guide, optimization guide, roadmap - SEO keywords and GitHub topic tags Co-Authored-By: claude-flow <ruv@ruv.net> Claude-Session: https://claude.ai/code/session_01Gayqu5K44VptZqJLhxX1Vb * fix(ruvector-capgated): clippy + rustfmt cleanup for clean CI Resolve the clippy warnings that were red on #604: unused VecEntry import, needless_range_loop (dataset.rs cap-mask build), useless_vec (eager_mask), and unusual_byte_groupings (benchmark SEED literal). Apply rustfmt. cargo clippy -p ruvector-capgated --all-targets -- -D warnings now clean; 22/22 tests pass. Co-Authored-By: claude-flow <ruv@ruv.net> --------- Co-authored-by: Claude <noreply@anthropic.com> Co-authored-by: ruv <ruvnet@users.noreply.github.com> |
||
|---|---|---|
| .. | ||
| adr | ||
| analysis | ||
| api | ||
| architecture | ||
| benchmarks | ||
| cloud-architecture | ||
| cnn | ||
| code-reviews | ||
| dag | ||
| decisions | ||
| development | ||
| evidence | ||
| examples | ||
| gnn | ||
| guides | ||
| hailo | ||
| hnsw | ||
| hooks | ||
| implementation | ||
| integration | ||
| nervous-system | ||
| optimization | ||
| plans | ||
| postgres | ||
| project-phases | ||
| publishing | ||
| research | ||
| reviews | ||
| ruvllm | ||
| rvagent | ||
| sdk | ||
| security | ||
| sonic-ct | ||
| 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 | ||
| METAHARNESS-ARCHITECTURE-SUMMARY.md | ||
| metaharness-implementation-plan.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