mirror of
https://github.com/ruvnet/RuVector.git
synced 2026-05-28 01:44:41 +00:00
AC-3a now publishes full-partition ARI alongside the 2-way
coarsening. Measured on the default N=1024 SBM:
2-way coarsened ARI (inherited, backward-compat):
mincut : -0.001 greedy : 0.174
louvain : 0.000 leiden : 0.089
**Full-partition ARI (new, correct metric):**
greedy full_ari : **0.308** ← surprising
louvain full_ari : 0.000 (collapses)
leiden full_ari : 0.107
cpm@γ=2.25 : **0.425** ← still best
**20th discovery: Leiden's aggregation+refinement actively HURTS
full-partition ARI vs greedy level-1 on this substrate.** Greedy
modularity (one pass of local moves, no aggregation) scores 0.308;
adding the aggregation + Traag refinement steps drops that to
0.107 — a 2.9× regression from the more sophisticated algorithm.
The refinement preserves well-connectedness (leiden_refinement.rs
tests still pass) but does so at the cost of merging structurally-
distinct communities from the level-1 output.
This flips the expected order: on hub-heavy SBMs, *more algorithm
is worse* when the objective is modularity and the target is
module recovery. CPM (item 17) was the right escape — non-
resolution-limited objective sidesteps the issue.
Final ranking on default SBM, full-partition ARI:
CPM @ γ=2.25 : 0.425 (non-modularity objective)
greedy L1 : 0.308 (minimal-algorithm modularity)
Leiden : 0.107 (maximal-algorithm modularity)
Louvain : 0.000 (aggregation collapses)
The pattern echoes item 11 (multi-level Louvain collapse on
hub-heavy SBMs) but at a finer granularity: item 11 said
'aggregation breaks', item 20 says 'even Leiden's refinement
can't fully repair it because the underlying modularity
objective has the resolution-limit issue'. The fix (item 17)
was a different objective, not a better algorithm.
Engineering implication: **for AC-3a on this substrate, level-1
greedy modularity is a stronger baseline than multi-level
Leiden.** The default Louvain / Leiden trajectory assumes
increasingly-sophisticated algorithms monotonically improve
module recovery; on hub-heavy SBMs that assumption is false,
and simpler-is-better up to the CPM break.
Files:
- tests/acceptance_partition.rs: full_partition_ari helper,
new eprintln publishing four full-ARI values against ground-
truth module labels. No assertion change (ADR §14 threshold
discipline: coarsening choices are decisions, not knobs).
- docs/adr/ADR-154: §17 item 20 added with the surprising
level-1 vs Leiden inversion and the 'more algorithm is
worse' framing on this substrate.
All 95 prior tests unchanged.
Co-Authored-By: claude-flow <ruv@ruv.net>
EOF
)
|
||
|---|---|---|
| .. | ||
| 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