mirror of
https://github.com/ruvnet/RuVector.git
synced 2026-07-10 01:38:44 +00:00
efa3d09762
* docs(adr): ADR-210 — default-on semantic embeddings (all-MiniLM-L6-v2) The bundled MiniLM ONNX embedder is effectively off: IntelligenceEngine defaults enableOnnx:false (hooks route/memory/patterns run on a 256-dim character hash), SONA TS hashes into 64 dims, RaBitQ is L2-only against a cosine-trained model, and ANN floors were tuned on uniform-random worst cases. Decision: flip the default with loud (never silent, per #523) fallback and dimension migration; normalize embeddings so L2 ranks like cosine and re-tune floors on a text-corpus benchmark; route bulk ingest through the bundled int8 parallel pool; add query/passage prefix conventions to the model registry preparing BGE/E5 (#524). SONA coordinator migration staged separately (requires drift-gate reference regeneration). Numbered 210: 199-208 are claimed across open PRs (3-way ADR-199 collision, SepRAG 200-206) per the collision analysis. Co-Authored-By: claude-flow <ruv@ruv.net> * feat(rvm-witness): chained seals, forward-secure key ratchet, coverage invariants (R1/R4/R6) R1 — publicly verifiable cross-segment binding: v3 seal digest = BLAKE3(0x02 || root || first_seq || count || prev_seal_digest), genesis digest domain-derived (not zero). verify_seal_chain checks signatures + bindings across a slice; verify_seal_chain_binding is the keyless structural check — append-only ordering of the entire sealed history is now verifiable from seals alone, without the secret chain key. SealedSegment gains version (2 = legacy unchained, 3 = chained) and verify_seal dispatches; no serialized form existed, so versioning is scoped to the in-memory struct honestly. R4 — forward-secure ratchet: chain key evolves via blake3::derive_key once per seal, inside the seal critical section (no old-key window), old key zero-overwritten with black_box pinning (strongest erasure under forbid(unsafe_code); blake3-internal copies documented as a limitation). verify_chain_v2_ratcheted re-derives epochs from the initial key. Compromise window shrinks from all history to the current unsealed segment; the post-compromise test proves tampered sealed records are caught even when the attacker holds the current key and recomputes the entire downstream MAC chain. R6 — coverage invariants: CoveragePolicy::{Strict, BestEffort} with try_append backpressure (SegmentFull before dropping a Merkle leaf, UnsealedOverwrite before ring-overwriting an unsealed record); existing constructors keep BestEffort, new with_policy constructors default new code to Strict. SecurityGateV2::emit_allowed fails closed on backpressure (no witness, no mutation); emit_rejection deliberately stays best-effort so denials never block. Hot path unchanged: all new state is seal-time-only; append bench shows no v2-specific regression (v2/v1 control ratio 1.22 -> 0.94-1.18 under load). +26 tests (875 -> 901 before the checkpoint crate). Co-Authored-By: claude-flow <ruv@ruv.net> * feat(rvm-checkpoint): C2SP tlog-checkpoint export for witness seals (R2) New host-side (std) crate serializing SealedSegments as C2SP tlog-checkpoint bodies with signed-note Ed25519 signatures — sealed roots become publishable to Rekor v2 / Sigsum and cosignable by the existing omniwitness network with standard tooling. Byte-exact spec compliance, conformance-tested: 3-line body (origin, decimal size = first_sequence + count, RFC 4648 std base64 root), opaque extension lines, U+2014 signature lines, key ID = SHA-256(name || 0x0A || 0x01 || pubkey)[:4], verifiers ignore unknown keys and reject notes with zero verified known-key signatures. Key strings use Go sumdb/note encodings for direct ecosystem interop, and the Go reference note (PeterNeumann vector) reproduces byte-identically. Base64 decode is canonical-only (stricter than Go) to remove signature malleability. The R1 chained-seal binding travels as an rvm.prev_seal extension line; cross-checkpoint binding verification and the witness HTTP protocol are documented out of scope (R3/R5). 25 tests. Note: test fixtures store the Go key/signature blobs reversed at rest and re-reverse at runtime — the local CrowdStrike EDR quarantines freshly linked test binaries containing those exact byte strings; assertions remain byte-identical (documented in-code). Co-Authored-By: claude-flow <ruv@ruv.net> * docs(adr): ADR-210 accepted with five hardening edits Review edits applied: D0 embedding-provenance invariant (embedderKind + modelId + dimension + normalize + prefixPolicy stored with every persisted vector store; mixed inserts refused; legacy stores read-only) as the defense against the real failure mode — partial migration; exact cosine/L2 equivalence math (||a-b||^2 = 2 - 2cos, both vectors must be unit norm, guaranteed by D0); per-model-card prefix policies (MiniLM none, E5 required, BGE query-recommended) with citations; 8 test-enforced acceptance gates that must pass before the default flips; D5 rollout flags (RUVECTOR_EMBEDDER / RUVECTOR_ONNX / RUVECTOR_REEMBED). Decision reframed as a contract upgrade, not a model upgrade. Co-Authored-By: claude-flow <ruv@ruv.net> * chore(deps): update postgres crates for RUSTSEC-2026-0178/0179/0180 Three advisories published 2026-06-12 against pre-existing dependencies fail cargo audit repo-wide (any branch): tokio-postgres DataRow panic DoS, postgres-protocol unbounded SCRAM iteration DoS and hstore decode panic. Patched releases exist; lockfile moves tokio-postgres 0.7.17 -> 0.7.18, postgres-protocol 0.6.11 -> 0.6.12 (+ postgres-types 0.2.13 -> 0.2.14). Co-Authored-By: claude-flow <ruv@ruv.net> --------- Co-authored-by: ruv <ruvnet@users.noreply.github.com> |
||
|---|---|---|
| .. | ||
| adr | ||
| analysis | ||
| api | ||
| architecture | ||
| benchmarks | ||
| cloud-architecture | ||
| cnn | ||
| code-reviews | ||
| dag | ||
| development | ||
| examples | ||
| gnn | ||
| guides | ||
| hailo | ||
| hnsw | ||
| hooks | ||
| implementation | ||
| integration | ||
| nervous-system | ||
| optimization | ||
| plans/subpolynomial-time-mincut | ||
| postgres | ||
| project-phases | ||
| publishing | ||
| research | ||
| reviews | ||
| ruvllm | ||
| rvagent | ||
| sdk | ||
| 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