ruvector/docs/REPO_STRUCTURE.md
rUv 4d5d3bb092 feat(micro-hnsw-wasm): Add Neuromorphic HNSW v2.3 with SNN Integration (#40)
* docs: Add comprehensive GNN v2 implementation plans

Add 22 detailed planning documents for 19 advanced GNN features:

Tier 1 (Immediate - 3-6 months):
- GNN-Guided HNSW Routing (+25% QPS)
- Incremental Graph Learning/ATLAS (10-100x faster updates)
- Neuro-Symbolic Query Execution (hybrid neural + logical)

Tier 2 (Medium-Term - 6-12 months):
- Hyperbolic Embeddings (Poincaré ball model)
- Degree-Aware Adaptive Precision (2-4x memory reduction)
- Continuous-Time Dynamic GNN (concept drift detection)

Tier 3 (Research - 12+ months):
- Graph Condensation (10-100x smaller graphs)
- Native Sparse Attention (8-15x GPU speedup)
- Quantum-Inspired Attention (long-range dependencies)

Novel Innovations (10 experimental features):
- Gravitational Embedding Fields, Causal Attention Networks
- Topology-Aware Gradient Routing, Embedding Crystallization
- Semantic Holography, Entangled Subspace Attention
- Predictive Prefetch Attention, Morphological Attention
- Adversarial Robustness Layer, Consensus Attention

Includes comprehensive regression prevention strategy with:
- Feature flag system for safe rollout
- Performance baseline (186 tests + 6 search_v2 tests)
- Automated rollback mechanisms

Related to #38

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>

* feat(micro-hnsw-wasm): Add neuromorphic HNSW v2.3 with SNN integration

## New Crate: micro-hnsw-wasm v2.3.0
- Published to crates.io: https://crates.io/crates/micro-hnsw-wasm
- 11.8KB WASM binary with 58 exported functions
- Neuromorphic vector search combining HNSW + Spiking Neural Networks

### Core Features
- HNSW graph-based approximate nearest neighbor search
- Multi-distance metrics: L2, Cosine, Dot product
- GNN extensions: typed nodes, edge weights, neighbor aggregation
- Multi-core sharding: 256 cores × 32 vectors = 8K total

### Spiking Neural Network (SNN)
- LIF (Leaky Integrate-and-Fire) neurons with membrane dynamics
- STDP (Spike-Timing Dependent Plasticity) learning
- Spike propagation through graph topology
- HNSW→SNN bridge for similarity-driven neural activation

### Novel Neuromorphic Features (v2.3)
- Spike-Timing Vector Encoding (rate-to-time conversion)
- Homeostatic Plasticity (self-stabilizing thresholds)
- Oscillatory Resonance (40Hz gamma synchronization)
- Winner-Take-All Circuits (competitive selection)
- Dendritic Computation (nonlinear branch integration)
- Temporal Pattern Recognition (spike history matching)
- Combined Neuromorphic Search pipeline

### Performance Optimizations
- 5.5x faster SNN tick (2,726ns → 499ns)
- 18% faster STDP learning
- Pre-computed reciprocal constants
- Division elimination in hot paths

### Documentation & Organization
- Reorganized docs into subdirectories (gnn/, implementation/, publishing/, status/)
- Added comprehensive README with badges, SEO, citations
- Added benchmark.js and test_wasm.js test suites
- Added DEEP_REVIEW.md with performance analysis
- Added Verilog RTL for ASIC synthesis

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>

---------

Co-authored-by: Claude <noreply@anthropic.com>
2025-12-01 22:30:15 -05:00

5.7 KiB

Repository Structure

Clean and organized structure for the RuVector project.

Root Directory

ruvector/
├── README.md                 # Main project README
├── CHANGELOG.md             # Version history and changes
├── CLAUDE.md                # Claude Code configuration
├── LICENSE                  # MIT License
├── Cargo.toml              # Rust workspace configuration
├── Cargo.lock              # Rust dependency lock
├── package.json            # NPM workspace configuration
├── .gitignore              # Git ignore rules
│
├── crates/                 # Rust crates
│   ├── ruvector-core/      # Core vector database
│   ├── ruvector-node/      # Node.js bindings
│   ├── ruvector-wasm/      # WebAssembly bindings
│   ├── ruvector-cli/       # Command-line interface
│   ├── ruvector-bench/     # Benchmarking suite
│   ├── router-core/        # Neural routing
│   ├── router-cli/         # Router CLI
│   ├── router-ffi/         # FFI bindings
│   └── router-wasm/        # Router WASM
│
├── docs/                   # 📚 Documentation (organized)
│   ├── README.md           # Documentation index
│   ├── getting-started/    # Quick starts and tutorials
│   ├── api/               # API documentation
│   ├── architecture/      # System architecture
│   ├── cloud-architecture/ # Global cloud deployment
│   ├── guide/             # User guides
│   ├── benchmarks/        # Benchmarking guides
│   ├── optimization/      # Performance optimization
│   ├── development/       # Contributing and development
│   ├── testing/          # Testing documentation
│   └── project-phases/   # Historical project phases
│
├── src/                    # 🚀 Cloud deployment source
│   ├── cloud-run/         # Cloud Run services
│   ├── agentic-integration/ # Agent coordination
│   └── burst-scaling/     # Auto-scaling system
│
├── benchmarks/            # Load testing and benchmarks
│   ├── load-generator.ts
│   ├── benchmark-scenarios.ts
│   └── ...
│
├── tests/                 # Rust integration tests
├── examples/             # Example code
│   ├── rust/            # Rust examples
│   ├── nodejs/          # Node.js examples
│   └── wasm-*/         # WASM examples
│
└── .claude-flow/        # Claude Flow coordination

Documentation Organization

All documentation is now organized in /docs with clear categories:

📖 Getting Started (7 files)

  • AGENTICDB_QUICKSTART.md - Quick start guide
  • OPTIMIZATION_QUICK_START.md - Performance quick start
  • AGENTICDB_API.md - API reference
  • wasm-api.md - WebAssembly API
  • wasm-build-guide.md - WASM build guide
  • advanced-features.md - Advanced features
  • quick-fix-guide.md - Common fixes

🏗️ Architecture (11 files)

  • TECHNICAL_PLAN.md - Complete technical plan
  • architecture/ - System architecture
  • cloud-architecture/ - Global deployment
    • architecture-overview.md - 15-region design
    • scaling-strategy.md - Auto-scaling
    • infrastructure-design.md - GCP infrastructure
    • DEPLOYMENT_GUIDE.md - Deployment steps
    • PERFORMANCE_OPTIMIZATION_GUIDE.md - Tuning guide

📚 API Reference (2 files)

  • api/RUST_API.md - Rust API
  • api/NODEJS_API.md - Node.js API

📖 User Guides (4 files)

  • guide/GETTING_STARTED.md
  • guide/BASIC_TUTORIAL.md
  • guide/ADVANCED_FEATURES.md
  • guide/INSTALLATION.md

Performance (5 files)

  • optimization/ - Performance guides
  • benchmarks/ - Benchmarking documentation

👨‍💻 Development (3 files)

  • development/CONTRIBUTING.md - Contribution guidelines
  • development/MIGRATION.md - Migration guide
  • development/FIXING_COMPILATION_ERRORS.md - Troubleshooting

🧪 Testing (2 files)

  • testing/TDD_TEST_SUITE_SUMMARY.md
  • testing/integration-testing-report.md

📜 Historical (9 files)

  • project-phases/ - Project phase documentation

Source Code Organization

/src - Cloud Deployment Code

All global streaming implementation code:

  • cloud-run/ - Cloud Run streaming services
  • agentic-integration/ - Distributed agent coordination
  • burst-scaling/ - Auto-scaling and capacity management

/crates - Rust Crates

Core Rust implementation organized as workspace:

  • Core functionality in ruvector-core
  • Platform-specific bindings (Node.js, WASM, FFI)
  • CLI and benchmarking tools

/benchmarks - Load Testing

Comprehensive benchmarking suite:

  • Load generators for 25B+ concurrent connections
  • 15+ test scenarios
  • Results analysis and visualization

File Counts

  • Total Files: 48 production files
  • Documentation: 42 markdown files (organized)
  • Source Code: 28,000+ lines
  • Root Files: 8 essential files only

Clean Root Directory

Only essential files remain in root:

  • README.md - Project overview
  • CHANGELOG.md - Version history
  • CLAUDE.md - Development configuration
  • LICENSE - MIT license
  • Cargo.toml - Rust workspace
  • Cargo.lock - Dependencies
  • package.json - NPM workspace
  • .gitignore - Git rules

No test files, temporary files, or duplicate docs in root!

Navigation Tips

  1. New users: Start at docs/README.md
  2. Quick start: See docs/getting-started/
  3. Cloud deployment: Check docs/cloud-architecture/
  4. Contributing: Read docs/development/CONTRIBUTING.md
  5. API docs: Browse docs/api/

Last Updated: 2025-11-20 Status: Clean and Organized Total Documentation: 42 files properly categorized