mirror of
https://github.com/ruvnet/RuVector.git
synced 2026-05-24 13:54:31 +00:00
6b6fb0e02a
* Add ADR-117: pseudo-deterministic canonical minimum cut Introduces source-anchored canonical min-cut based on Kenneth-Mordoch 2026, with lexicographic tie-breaking (λ, first_separable_vertex, |S|, π(S)) for unique reproducible cuts. Three-tier plan: exact engine now, O(m log²n) fast path, then dynamic maintenance via sparsifiers. Integrates with RVF witness hashing for cut receipts. https://claude.ai/code/session_01UrVLJpxq8itzVxycy5sjNw * Implement ADR-117: source-anchored pseudo-deterministic canonical min-cut Full Tier 1 implementation of the Kenneth-Mordoch 2026 canonical min-cut algorithm with lexicographic tie-breaking (λ, first_separable_vertex, |S|, π(S)). Core implementation (source_anchored/mod.rs): - AdjSnapshot for deterministic computation on FixedWeight (32.32) - Stoer-Wagner global min-cut on fixed-point weights - Dinic's max-flow for exact s-t cuts - SHA-256 (FIPS 180-4, self-contained, no_std compatible) - SourceAnchoredMinCut stateful wrapper with cache invalidation - CanonicalMinCutResult repr(C) struct for FFI WASM bindings (wasm/canonical.rs): - Thread-safe Mutex-guarded global state (no static mut) - 8 extern "C" functions: init, add_edge, compute, get_result, get_hash, get_side, get_cut_edges, free, hashes_equal - Constant-time hash comparison for timing side-channel prevention - Null pointer validation on all FFI entry points - Graph size limit (10,000 vertices) to prevent OOM Tests (40 total): - 33 source_anchored tests: SHA-256 NIST vectors, determinism (100+1000 iterations), symmetric graphs (K4, K5, cycles, ladders, barbells), custom source/priorities, disconnected rejection, FFI conversion - 7 WASM tests: init/compute lifecycle, null safety, hash comparison, self-loop rejection, size limit enforcement Benchmarks (canonical_bench.rs): - Random connected graphs (10-100 vertices) - Cycle and complete graph families - Hash stability measurement Security hardening: - No static mut (Mutex for thread safety) - Integer-exact FixedWeight arithmetic (no floats in comparisons) - Checked capacity perturbation bounds - Source-side orientation invariant enforced - NIST-validated SHA-256 for witness hashes ADR-117 updated to production-quality spec with explicit vertex-splitting requirement for capacity perturbation, WASM FFI documentation, and Phase 1 completion status. https://claude.ai/code/session_01UrVLJpxq8itzVxycy5sjNw * Integrate ADR-117 canonical min-cut into pi.ruv.io brain server - Enable `canonical` feature on ruvector-mincut dependency - Add `partition_canonical_full()` to KnowledgeGraph using source-anchored canonical min-cut for deterministic, hashable partitions - Add `canonical` query parameter to `/v1/partition` endpoint - Add `cut_hash` (hex SHA-256) and `first_separable_vertex` fields to PartitionResult and PartitionResultCompact types - Backward compatible: canonical fields are skip_serializing_if None, only populated when `?canonical=true` is passed https://claude.ai/code/session_01UrVLJpxq8itzVxycy5sjNw --------- Co-authored-by: Claude <noreply@anthropic.com> |
||
|---|---|---|
| .. | ||
| 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 | ||
| 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: 170+ comprehensive documents across 25+ 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