SUMMARY.md

Summary

Introduction

Tutorials

• Quick Start
• Five-Minute Tutorial
• Use Cases
• Python SDK
• TypeScript SDK
• Building a Knowledge Graph
• Vector Search with Filtering
• Deploying a Three-Node Cluster
• Securing Secrets with Vault
• Caching LLM Responses

How-to Guides

• Installation
• Building from Source
• Storage and Data
  • Configure Tiered Storage
  • Use Bloom Filters
  • Tune HNSW Parameters
  • Use Delta Embeddings
  • Snapshots and Shared Storage
  • Store and Retrieve Blobs
  • Compression
  • Create and Restore Checkpoints
• Relational Engine
  • Create and Manage Tables
  • Indexes
  • Columnar SIMD Queries
  • Streaming Cursors
  • Constraints
  • Batch Insert
• Graph Engine
  • Create Nodes and Edges
  • Run Traversals and Shortest Path
  • Use Property Indexes
• Vector Engine
  • Store and Search Embeddings
  • Use Filtered Search
  • Manage Collections
• Security
  • Manage Vault Secrets
  • Set Up Access Control
• Caching
  • Configure Semantic Cache
• Distributed Operations
  • Deploy a Cluster
  • Configure Raft
  • Configure 2PC
  • Set Up Monitoring
  • Handle Transaction Conflicts
  • Unified Entity Operations
• Troubleshooting
• Runbooks
  • Node Management
  • Cluster Upgrade
  • Leader Election
  • Split-Brain Recovery
  • Node Recovery
  • Backup and Restore
  • Capacity Planning
  • Deadlock Resolution

Architecture

• Tensor Store
• Relational Engine
  • Transactions
• Graph Engine
• Vector Engine
• Tensor Spatial
• Tensor Compress
• Tensor Vault
• Tensor Cache
• Tensor Blob
• Tensor Checkpoint
• Tensor Unified
• Tensor Chain
• Neumann Parser
• Query Router
• Neumann Shell
• Neumann Server
• Neumann Client
• TypeScript SDK
• Python SDK

Reference

• Query Language
• Data Types
• Functions and Operators
• Configuration
• Metrics
• Example Configurations
• Error Types
• Storage Key Patterns
• Crate APIs
  • tensor_store
  • relational_engine
  • graph_engine
  • vector_engine
  • tensor_chain
  • tensor_vault
  • tensor_cache
  • tensor_blob
  • tensor_compress
  • tensor_spatial
  • tensor_checkpoint
  • tensor_unified
  • neumann_parser
  • query_router
  • neumann_shell
  • neumann_server
  • neumann_client
  • TypeScript SDK
  • Python SDK
• Rustdoc
• Benchmarks
  • tensor_store
  • relational_engine
  • graph_engine
  • vector_engine
  • tensor_compress
  • tensor_vault
  • tensor_cache
  • tensor_blob
  • tensor_chain
  • neumann_parser
  • query_router
  • neumann_shell
  • neumann_server
  • tensor_unified
  • tensor_checkpoint
  • tensor_spatial
• Stress Tests
  • HNSW Stress
  • TieredStore Stress
  • Mixed Workload
• Integration Tests

Explanation

• System Architecture
• Tensor Data Model
• Storage Internals
  • SlabRouter Architecture
  • HNSW Algorithm
  • Sparse Vectors
  • Delta Vectors
  • Tiered Storage
  • Bloom Filter
• Relational Engine Internals
  • Columnar Architecture and SIMD
  • Hash Join Algorithm
  • B-Tree Index Design
  • Transaction Workspace
• Graph Engine Internals
• Vector Engine Internals
  • Search Modes
  • Filtered Search Design
• Distributed Systems
  • Consensus Protocols
  • Distributed Transactions
  • TCP Transport
  • Snapshot Streaming
  • Semantic Conflict Detection
• Security and Access Control
• Caching
  • Semantic Caching Design
  • Semantic Operations
  • Embedding State Machine
  • Codebook Manager
• Formal Verification
• Compression Algorithms
• Checkpoint Design
• Blob Storage
• Unified Entity Model
• Parser Design
• Query Routing
• Shell Design

Contributing

• Code Style
• Testing
• Documentation
• Fuzzing

---