mirror of
https://github.com/ruvnet/RuVector.git
synced 2026-05-24 22:15:18 +00:00
## 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>
9.4 KiB
9.4 KiB
Ruvector Documentation Index
Complete index of all Ruvector documentation.
Quick Links
- Getting Started - Start here!
- Installation - Platform-specific installation
- API Reference - Complete API documentation
- Examples - Working code examples
- Contributing - How to contribute
Documentation Structure
docs/
├── api/ # API references
├── architecture/ # System design docs
├── benchmarks/ # Performance benchmarks
├── cloud-architecture/ # Cloud deployment
├── development/ # Developer guides
├── getting-started/ # Quick start guides
├── gnn/ # GNN/Graph implementation
├── guide/ # User guides
├── implementation/ # Implementation details
├── integration/ # Integration guides
├── latent-space/ # Research & advanced features
├── optimization/ # Performance optimization
├── project-phases/ # Development phases
├── publishing/ # NPM publishing guides
├── research/ # Research documentation
├── status/ # Build & deployment status
└── testing/ # Testing documentation
User Guides
Getting Started
- Getting Started Guide - Quick introduction to Ruvector
- Installation Guide - Installation for Rust, Node.js, WASM, CLI
- Basic Tutorial - Step-by-step tutorial with examples
- Advanced Features Guide - Hybrid search, quantization, MMR, filtering
Migration
- Migration from AgenticDB - Complete migration guide with examples
Architecture Documentation
- System Overview - High-level architecture and design
- NPM Package Architecture - Package structure
- Repository Structure - Codebase organization
Cloud Architecture
- Architecture Overview - Cloud design
- Deployment Guide - Deployment instructions
- Infrastructure Design - Infrastructure details
- Scaling Strategy - Scaling approaches
- Performance Optimization - Cloud performance
API Reference
Platform APIs
- Rust API - Complete Rust API reference
- Node.js API - Complete Node.js API reference
- Cypher Reference - Cypher query language
Feature-Specific APIs
- AgenticDB API - Detailed AgenticDB API documentation
- AgenticDB Quickstart - Quick start guide
- WASM API - Browser WASM API
- WASM Build Guide - Building for WASM
GNN & Graph Documentation
- Graph Integration Summary - Overview of graph features
- Graph Validation Checklist - Validation guide
- GNN Layer Implementation - Layer details
- Graph Attention Implementation - Attention mechanisms
- Hyperbolic Attention - Hyperbolic embeddings
- Cypher Parser - Query parser
- CLI Graph Commands - CLI usage
- Graph WASM Setup - WASM bindings
- Node Bindings - Node.js bindings
- Training Utilities - Training tools
Integration Guides
- Integration Summary - Integration overview
- Psycho-Symbolic Integration - Symbolic AI integration
- Psycho-Synth Quick Start - Quick start guide
Performance & Benchmarks
- Benchmarking Guide - How to run and interpret benchmarks
- Benchmark Comparison - Performance comparisons
Optimization Guides
- Performance Tuning Guide - Detailed optimization guide
- Build Optimization - Compilation optimizations
- Optimization Results - Benchmark results
- Implementation Summary - Optimization implementation
Implementation Documentation
Implementation Details
- Implementation Summary - Overall implementation
- Improvement Roadmap - Future plans
- Security Fixes Summary - Security improvements
- Overflow Fixes - Bug fixes
Phase Summaries
- Phase 2: HNSW - HNSW integration
- Phase 3: AgenticDB - AgenticDB layer
- Phase 4: Advanced Features - Product quantization, hybrid search
- Phase 5: Multi-Platform - Node.js, WASM, CLI
- Phase 6: Advanced - Future features
Publishing & Deployment
- Publishing Guide - How to publish packages
- NPM Publishing - NPM-specific guide
- NPM Token Setup - Authentication setup
- Package Validation - Validation report
- Publishing Status - Current status
Status Reports
- All Packages Status - Package overview
- Build Process - Build documentation
- Build Summary - Build results
- Current Status - Project status
- Deployment Status - Deployment state
Development
- Contributing Guide - How to contribute
- Security - Security guidelines
- Migration Guide - Migration documentation
- NPM Package Review - Package review
- Fixing Compilation Errors - Troubleshooting
Testing
- Test Suite Summary - Testing strategy
- Integration Testing Report - Integration tests
Research & Advanced Features
Latent Space
- Implementation Roadmap - Development plan
- GNN Architecture Analysis - Architecture deep-dive
- Attention Mechanisms Research - Research notes
- Advanced Architectures - Advanced designs
- Optimization Strategies - Optimization approaches
GNN v2 Research
- Master Plan - GNN v2 overview
- GNN Guided Routing - Routing research
- Incremental Graph Learning - Learning approaches
- Neuro-Symbolic Query - Query processing
- Hyperbolic Embeddings - Embedding research
Project Information
- README - Documentation overview
- Technical Plan - Technical roadmap
- Project README - Project overview
- CHANGELOG - Version history
- LICENSE - MIT License
Documentation Statistics
- Total directories: 17+
- Total documentation files: 120+ markdown files
- User guides: 4 comprehensive guides
- API references: 3 platform APIs
- Code examples: 7+ working examples
- Languages covered: Rust, JavaScript/TypeScript, WASM
Getting Help
Resources
- Documentation: This index and linked guides
- Examples: ../examples/ directory
- API docs:
cargo doc --no-deps --open - Benchmarks:
cargo bench
Support Channels
- GitHub Issues: Report bugs or request features
- GitHub Discussions: Ask questions
- Pull Requests: Contribute code
Last Updated: 2025-12-01 Version: 0.1.19