Skip to content

farmountain/HipCortex

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

253 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

HipCortex

Persistent causal memory for AI agents β€” 0.48 ms p50 writes, 59% token savings in steady-state.

CI License PyPI VS Code

HipCortex is not a vector database, RAG pipeline, or chat history store.
It is a recursive causal world-model memory engine β€” the cognitive substrate AI agents need to remember, reason, and improve over time.

πŸ†• Copilot billing crisis? HipCortex fixes it.

GitHub switched to token-based AI Credits billing on June 1, 2026. Teams are exhausting their monthly Copilot budget in a single day because Copilot injects full conversation history into every request.

HipCortex replaces full-history injection with selective memory retrieval β€” only the most relevant context per query:

Context approach Input tokens / query vs Full History
Full history injection 923 tok (turn 20) β†’ 2,308 tok (turn 50) baseline
Rolling-10 window βˆ’17% slightly better
HipCortex Top-5 ~280 tok (flat) βˆ’59% steady-state Β· βˆ’84% at 50 turns
HipCortex Top-3 ~200 tok (flat) βˆ’70% / βˆ’88%

Net result: same Copilot Business budget β†’ 2Γ— more sessions (20-turn benchmark) β†’ 6–8Γ— more sessions in long enterprise sessions.

Full methodology: benchmarks/README.md Β· BENCHMARK.md

Performance vs alternatives

HipCortex Mem0 cloud In-process dict
Write p50 0.48 ms 142 ms 0.002 ms
Write p95 1.2 ms 310 ms 0.005 ms
Token reduction (steady-state) 59% ❌ no retrieval ❌
Temporal decay βœ… native ❌ ❌
Causal world model βœ… ❌ ❌
GDPR right-to-forget βœ… REST endpoint βœ… ❌
Merkle-chained audit log βœ… ❌ ❌
Self-hosted, zero deps βœ… 4 MB binary ❌ βœ…
VS Code / Copilot LM Tool βœ… hipcortex_search ❌ ❌

Install

pip install hipcortex
hipcortex install   # interactive wizard β€” picks your IDEs and frameworks

60-second quickstart

Option A β€” Live demo (no install)

curl https://hipcortex.fly.dev/health          # β†’ ok
curl https://hipcortex.fly.dev/stats           # β†’ {"total_records":0,...}
curl https://hipcortex.fly.dev/openapi.json    # β†’ OpenAPI 3.0 spec

⚑ Start the server first (required for Options B, C, D):

# Fastest: use the managed free tier (always running)
# Set HIPCORTEX_URL=https://hipcortex.fly.dev in your code

# Or download + run locally (no Rust needed):
curl -L https://github.com/farmountain/HipCortex/releases/latest/download/hipcortex-linux-amd64 \
  -o hipcortex && chmod +x hipcortex && ./hipcortex
# macOS ARM64: use hipcortex-macos-arm64 instead

Server starts on http://localhost:3030 Β· Verify: curl http://localhost:3030/health β†’ ok

Option B β€” Python (interactive setup wizard)

pip install hipcortex
hipcortex install

An interactive wizard appears β€” use Space to select, Enter to confirm:

  β–ˆβ–ˆβ•—  β–ˆβ–ˆβ•—β–ˆβ–ˆβ•—β–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ•—  β–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ•— β–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ•— β–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ•— β–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ•—β–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ•—β–ˆβ–ˆβ•—  β–ˆβ–ˆβ•—
  ...
  Persistent causal memory for AI agents Β· hipcortex.fly.dev

  Select what to configure:  (Space toggle Β· Enter confirm Β· q quit)

  ── Coding Assistants ──────────────────────────────────────
 β€Ί ● Claude Code        Anthropic Β· SKILL.md native, no MCP process
   ● Cursor             Anysphere Β· MCP tools in AI panel
   β—‹ Windsurf           Codeium Β· global MCP settings
   β—‹ VS Code            Microsoft Β· MCP via settings.json
   β—‹ Cline              saoudrizwan Β· .cline/mcp.json
   β—‹ RooCode            RooVeterinary Β· .roo/mcp.json
   β—‹ Continue           continuedev Β· /remember /recall         [guide]
   β—‹ GitHub Copilot     GitHub Β· OpenAPI tool registration      [guide]
   ...

  ── Agent Frameworks ───────────────────────────────────────
   ● LangChain [detected]  drop-in ConversationBufferMemory  [starter file]
   β—‹ CrewAI             RememberTool + RecallTool             [starter file]
   β—‹ AutoGen            AutoGen 0.4 Memory protocol           [starter file]
   β—‹ LlamaIndex         SimpleChatStore-compatible            [starter file]
   β—‹ Pydantic AI        tool-use memory via REST              [starter file]
   β—‹ n8n / Make.com     workflow Β· HTTP Request node          [starter file]
   β—‹ DSPy               trace storage for compilation         [starter file]

  3 selected

Coding assistants β†’ writes MCP config / SKILL.md automatically.
Agent frameworks β†’ writes a ready-to-import starter file in your project (hipcortex_langchain.py, hipcortex_crewai.py, etc.). The wizard auto-detects which frameworks are in your requirements.txt.

hipcortex start          # download binary + start server on :3030
hipcortex install --yes  # non-interactive: configure all supported agents
hipcortex install --url https://hipcortex.fly.dev  # use managed tier instead
from hipcortex import HipCortexClient, AsyncHipCortexClient

# Sync
client = HipCortexClient("http://localhost:3030")
client.add_memory(actor="alice", action="said", target="The meeting is at 3pm")
client.bulk_add([                                       # add multiple at once
    {"actor": "alice", "action": "noted", "target": "Budget approved"},
    {"actor": "alice", "action": "noted", "target": "Q3 deadline is Sep 30",
     "ttl_seconds": 7776000},                          # auto-expire in 90 days
])
results = client.search("meeting time", limit=5)       # keyword or cosine sim
print(client.stats())
client.forget("alice")                                 # GDPR right-to-forget

# Async (LangChain 0.3+, FastAPI, Django async)
async with AsyncHipCortexClient("http://localhost:3030") as aclient:
    await aclient.add_memory(actor="bob", action="said", target="Hello")
    results = await aclient.search("Hello")

# Jupyter notebook users β€” add this before using async methods:
# import nest_asyncio; nest_asyncio.apply()

Option C β€” TypeScript / JavaScript

# From GitHub (npm publish coming soon)
npm install github:farmountain/HipCortex#main --prefix sdk/typescript
# Or clone and build:
# git clone https://github.com/farmountain/HipCortex && cd HipCortex/sdk/typescript && npm install && npm run build
import { HipCortexClient } from "hipcortex";

const client = new HipCortexClient({ baseUrl: "http://localhost:3030" });
await client.addMemory({ actor: "alice", action: "said", target: "Hello!" });
const { results } = await client.search({ query: "Hello", limit: 5 });
await client.forget("alice");

Option D β€” Pre-built binary (no Rust needed)

# Linux ARM64 (Raspberry Pi 4/5, Jetson, AWS Graviton)
curl -L https://github.com/farmountain/HipCortex/releases/latest/download/hipcortex-linux-arm64 \
  -o hipcortex && chmod +x hipcortex && PORT=3030 ./hipcortex

# macOS ARM64 (M1/M2/M3/M4)
curl -L https://github.com/farmountain/HipCortex/releases/latest/download/hipcortex-macos-arm64 \
  -o hipcortex && chmod +x hipcortex && PORT=3030 ./hipcortex

# Linux AMD64
curl -L https://github.com/farmountain/HipCortex/releases/latest/download/hipcortex-linux-amd64 \
  -o hipcortex && chmod +x hipcortex && PORT=3030 ./hipcortex

Option E β€” Build from source (Rust)

cargo run --bin webserver --no-default-features --features "web-server,petgraph_backend"

Option F β€” Docker

docker run -p 3030:3030 -v hipcortex_data:/app/data hipcortex:latest

Option H β€” VS Code Extension (GitHub Copilot integration)

Reduces Copilot credit burn by registering HipCortex as a Language Model Tool β€” Copilot calls hipcortex_search automatically during reasoning instead of injecting full conversation history.

# Download hipcortex-memory-0.1.6.vsix from:
# https://github.com/farmountain/HipCortex/tree/main/vscode-extension
code --install-extension hipcortex-memory-0.1.6.vsix

What it does:

  • @hipcortex query <topic> β€” search memories in Copilot Chat
  • @hipcortex add <text> β€” store a memory
  • hipcortex_search tool β€” Copilot calls this automatically when it needs context (VS Code 1.90+)
  • Auto-capture β€” stores file saves as temporal memories (silent, best-effort)
  • Status bar β€” $(database) HipCortex: ~1,200 tok saved shows session savings
  • Token savings footer β€” each @hipcortex response shows Used ~80 tokens (vs ~2,000 full history = 96% savings)

VS Code marketplace publish coming after 500 stars.

Option G β€” Cursor / Claude Code / Windsurf / Cline (MCP server)

Give your AI coding assistant persistent memory across sessions.

Fastest path β€” the hipcortex install wizard (Option B) handles this automatically: select your coding assistants, and it writes the MCP config for you.

Manual install (if you prefer):

curl -fsSL https://raw.githubusercontent.com/farmountain/HipCortex/main/sdk/mcp/install.sh | bash

The script installs the MCP server and prints exact config snippets for your IDE.

Supported assistants via MCP: Cursor Β· Windsurf Β· VS Code Β· Cline Β· RooCode
Via SKILL.md (no MCP process): Claude Code β€” select it in the wizard for native /hipcortex slash commands.

Tools available: add_memory Β· search_memory Β· forget_actor Β· get_stats

Full guide: sdk/mcp/README.md


Auto-embedding (Ollama / OpenAI)

# Store with auto-generated embedding:
curl -X POST http://localhost:3030/memory/embed \
  -H "Content-Type: application/json" \
  -d '{"actor":"alice","action":"noted","target":"Budget approved","embedding_model":"ollama/nomic-embed-text"}'

# Unified search β€” server generates query embedding automatically:
curl -X POST http://localhost:3030/memory/search \
  -H "Content-Type: application/json" \
  -d '{"query":"financial decisions","embedding_model":"ollama/nomic-embed-text","limit":5}'

# Or keyword-only search (no embedding_model needed):
curl -X POST http://localhost:3030/memory/search \
  -H "Content-Type: application/json" \
  -d '{"query":"financial decisions","limit":5}'

Full deploy guide: DEPLOY.md Β· Benchmark: BENCHMARK.md Β· API spec: /openapi.json


Framework integrations

# LangChain β€” sync drop-in for ConversationBufferMemory
from hipcortex.langchain_memory import HipCortexMemory
memory = HipCortexMemory(session_id="user-42", url="http://localhost:3030")
chain  = ConversationChain(llm=ChatOpenAI(), memory=memory)

# LangChain β€” async (FastAPI, Django async, LangChain 0.2+)
from hipcortex import AsyncHipCortexClient
from hipcortex.langchain_memory import AsyncHipCortexMemory
async_client = AsyncHipCortexClient("http://localhost:3030")
async_memory = AsyncHipCortexMemory(client=async_client, session_id="user-42")
history = await async_memory.aload_memory_variables({})
await async_memory.asave_context({"input": "Hello"}, {"output": "Hi!"})

# LlamaIndex β€” SimpleChatStore-compatible
from hipcortex.llamaindex_storage import HipCortexChatStore
store = HipCortexChatStore(client=client)

# AutoGen 0.4 β€” Memory protocol
from hipcortex.adapters.autogen import HipCortexAutoGenMemory
mem   = HipCortexAutoGenMemory(client=client, agent_id="researcher")
# AutoGen 0.4 (recommended):
agent = AssistantAgent(name="researcher", model_client=..., memory=[mem])
# AutoGen 0.3 (legacy):
# agent.register_hook("process_message_before_send", mem.on_message_sent_v03)

# CrewAI β€” BaseTool subclasses
from hipcortex.adapters.crewai import HipCortexRememberTool, HipCortexRecallTool
tools = [HipCortexRememberTool(client=client), HipCortexRecallTool(client=client)]

REST API (45+ endpoints)

Memory

Method Path Description
POST /memory/ingest Zero-config β€” plain text, auto-classifies type/priority/tags
POST /memory/add Full-control store (confidence, source, priority, tags, ttl_seconds)
POST /memory/bulk Add multiple records in one request
GET /memory/query Filter records β€” returns all 15 fields incl. confidence/priority/tags
POST /memory/search Keyword or cosine search; add embedding_model to auto-embed
GET /memory/search-flat Plain string array β€” for no-code tools (n8n, Flowise)
POST /memory/context LLM-ready formatted context block (inject directly into prompts)
GET /memory/latest Most recent fact per actor+action (no stale returns)
POST /memory/reflect AureusBridge Bayesian reflexion over memory context
PATCH /memory/update/:id In-place correction, version++
POST /memory/quarantine/:id Move to quarantine β€” excluded from search
POST /memory/corroborate/:id Boost confidence (+0.10)
POST /memory/contradict/:id Reduce confidence (βˆ’0.15); auto-quarantines below 0.30
DELETE /memory/forget/:actor GDPR right-to-forget (temporal + symbolic + audit)
POST /memory/consolidate Keyword dedup report
GET /memory/export Full data portability export

World Model (Dirichlet + Kalman + Causal DAG)

Method Path Description
POST /worldmodel/observe Feed state transition β†’ Dirichlet update
GET /worldmodel/predict P(s'|s,a) distribution + entropy
GET /worldmodel/states All observed states + actions
GET /worldmodel/transitions Transitions from a given state
GET /worldmodel/uncertainty Bulk entropy for all (state, action) pairs
GET /worldmodel/entities List Kalman-tracked entities
POST /worldmodel/entity Register entity with initial Kalman state
GET /worldmodel/causal Dump causal DAG edges
POST /worldmodel/causal/edge Add causal edge (cycle prevention enforced)
POST /worldmodel/causal/intervention P(Y|do(X=x)) do-calculus
POST /worldmodel/causal/counterfactual "what if X had been x instead?"

Self-Model + Coherence

Method Path Description
GET /self/health System health score + module breakdown
GET /self/capabilities Registered capability descriptors
POST /self/capabilities Register capability at runtime
GET /self/can-execute Decision engine β€” should I run this operation?
GET /coherence/status Cross-module coherence metrics (persistent checker)
GET /coherence/inconsistencies Active inconsistency reports

Other

Method Path Description
GET /health Health check (public)
GET /stats Live record counts + metering
GET /metrics Prometheus metrics
POST /webhooks/register Register webhook (post-write events)
GET /audit/verify Merkle chain tamper detection
POST /regulatory/hold MiFID II hold β€” blocks GDPR forget
GET /openapi.json OpenAPI 3.0 spec (public)

Authentication: set HIPCORTEX_API_KEYS=sk-mykey:pro β†’ send X-Api-Key: sk-mykey.
Unset = open mode (self-hosted / dev).

Every GET /memory/query and GET /memory/search response now includes all 15 fields:
id Β· record_type Β· timestamp Β· actor Β· action Β· target Β· metadata Β· integrity Β· confidence Β· source Β· priority Β· tags Β· version Β· status Β· expires_at


Deploy

Three paths β€” see DEPLOY.md:

# Fly.io (5 min, EU-first)
fly launch && fly deploy

# Docker
docker run -p 3030:3030 -v hipcortex_data:/app/data hipcortex:latest

# Binary (4 MB, edge / offline)
cargo build --release --bin webserver --no-default-features --features "web-server,petgraph_backend"

Why not just use Mem0 / Zep / Pinecone?

Those systems optimize for retrieval (cosine similarity over embeddings).
HipCortex optimizes for cognition:

  • Temporal decay β€” memories fade at configurable rates; important ones persist
  • Causal world model β€” Dirichlet-Multinomial transitions, Kalman entity tracking, do-calculus interventions
  • Coherence checking β€” cross-module consistency validation catches temporal-symbolic mismatches
  • Self-model β€” EWMA performance tracking, expected utility decision engine
  • Merkle-chained audit log β€” every write is tamper-evident; AuditLog::verify() detects tampering
  • Safety guardrail β€” every mutation goes through SafetyGuardrail::check_precondition before hitting state

This makes HipCortex the right foundation for AGI-grade agents, not just chatbot memory.
See docs/architecture.md and docs/whitepaper.md.


✨ Features

HipCortex is built from modular building blocks so you can mix and match memory and reasoning components.

  • AuditLog: Hash-chained entries provide tamper-evident persistence for all memory writes.
  • Temporal Indexer: Segmented ring buffer with per-trace decay factors and LRU pruning for short/long-term memory.
  • Procedural FSM Cache: Regenerative memory driven by finite state logic for workflows and actions. Supports batch advancement of traces.
  • TemporalFSMBackend: optional in-memory backend storing FSM traces with rollback and batch transitions.
  • Symbolic Store: Graph-based concept store with semantic key/value pairs. Caches recent label lookups with an LRU cache. Backed by a pluggable GraphDatabase trait for in-memory or persistent graphs.
  • PetGraph Backend: In-memory graph backend (default) - no external dependencies required.
  • Sled Backend: Embedded key-value database - compile with --features rocksdb-backend.
  • Neo4j/Postgres Backends: External database support - enable neo4j_backend or postgres_backend features to store graphs in Neo4j or Postgres (requires external libraries).
  • Perception Adapter: Multimodal input handler (text, embeddings, agent messages, vision). Includes a simple VisionEncoder for image embeddings.
  • Semantic Compression: Reduce embedding dimensionality with semantic_compression::compress_embedding for efficient storage.
  • Semantic Cache: in-memory LRU store with embedding similarity lookups.
  • Aureus Bridge: Reflexion and reasoning hook for chain-of-thought engines.
  • Integration Layer: bridges OpenManus and MCP protocols to REST/gRPC endpoints.
  • MCP Server: run both REST and gRPC endpoints to orchestrate symbolic context for multiple agents.
  • Math & Logic Guarantees: memory operations validated with formal proofs and symbolic checks.
  • Fully Test-Driven: Extensive unit tests and Criterion benchmarks.
  • Optional Web Server: compile with --features "web-server,petgraph_backend" for an Axum REST API.
  • Optional GUI: compile with --features "gui,petgraph_backend" to launch a Tauri desktop client.
  • Database Backends:
    • --features "petgraph_backend" for in-memory graphs (no external deps)
    • --features "sqlite_backend" for SQLite support (requires SQLite libraries)
    • --features "postgres_backend" for PostgreSQL support (requires PostgreSQL libraries)
    • --features "neo4j_backend" for Neo4j support (requires Neo4j server)
  • RocksDB Backend: compile with --features rocksdb-backend and use MemoryStore::new_rocksdb for an embedded key-value database.
  • WASM Plugin Host: compile with --features "plugin,petgraph_backend" to run custom WebAssembly extensions via PluginHost.
  • Effort Evaluator & Confidence Regulator: monitor reasoning effort and confidence to avoid collapse.
  • Hypothesis Manager: maintain multiple reasoning paths and a quantized state tree for backtracking.
  • Latent Map World Model: learned latent maps are stored as versioned world models with safety guardrails.
  • Enhancement Advisor: analyze module metrics and recommend improvements for human review.
  • Puzzle Benchmark Suite: validates complex planning algorithms like Tower of Hanoi and 8-puzzle.

Component Usage Examples

GraphDatabase Backends (Neo4j/Postgres)

use hipcortex::backends::{Neo4jBackend, PostgresGraphBackend};
// enable with --features neo4j_backend or postgres_backend

TemporalFSMBackend

use hipcortex::backends::temporal_backend::TemporalFSMBackend;
let mut backend = TemporalFSMBackend::new();

IntegrationLayer Bridges

use hipcortex::modules::integration_layer::IntegrationLayer;
let mut layer = IntegrationLayer::new();
layer.handle_openmanus("key", "{\"text\":\"hi\"}");

SemanticCache

use hipcortex::semantic_cache::SemanticCache;
let mut cache = SemanticCache::new(4);
cache.put_embedding("foo".into(), vec![0.1,0.2]);

MonitoringService

cargo run --example mcp_server --features web-server
# visit /metrics for JSON or open the GUI for HTML dashboard

LLM connectors (Mistral/Falcon/DeepSeek)

cargo run -- llm-generate --model mistral "Hello"

Safety & Guardrail

HipCortex enforces runtime policies through the SafetyGuardrail module. Operations across the graph store, FSM backend and LLM connectors call check_precondition before mutating state. Violations are logged and can trigger rollbacks. Use the CLI below to view recent audit snapshots:

cargo run -- safety-audit

πŸ—οΈ Project Structure

Path/Module Purpose
src/lib.rs Main library module, re-exports others
src/main.rs CLI/demo entry (optional)
src/temporal_indexer.rs STM/LTM temporal buffer
src/procedural_cache.rs FSM-based procedural cache
src/symbolic_store.rs Symbolic graph & key-value memory
src/perception_adapter.rs Multimodal input
src/integration_layer.rs Agentic/REST/gRPC stubs
src/mcp_server.rs Combined REST + gRPC MCP server
src/aureus_bridge.rs Reflexion/reasoning loop
src/vision_encoder.rs Simple image to embedding converter
tests/ Integration and property tests
benches/ Criterion benchmarks
examples/ Minimal runnable example
docs/ Architecture, usage, integration, roadmap
.github/ PR/Issue templates for collaboration
.vscode/ VS Code developer environment

πŸš€ Building from source (Rust contributors)

# Minimal build (no external deps)
git clone https://github.com/farmountain/HipCortex.git && cd HipCortex
cargo build --no-default-features --features "petgraph_backend"
cargo test  --no-default-features --features "petgraph_backend" --lib

# Web server
cargo build --features "web-server,petgraph_backend"

# All features (requires external DB libraries)
cargo build --all-features

See DEVELOPMENT.md for full feature-flag matrix and per-OS setup. See CLAUDE.md for codebase conventions (module wiring rules, safety rules, etc.).

LLM & World Model Connectors

HipCortex ships with lightweight connectors for popular open-source models.

  • Mistral, Falcon, DeepSeek and custom local LLMs
  • World Model connector (JEPA style or mock implementation)

Example usage:

cargo run -- llm-generate "Tell me a story"
cargo run -- worldmodel-predict '{"state":"robot","action":"move"}'

πŸ› οΈ Use Cases

  • Agentic AI via OpenManus: manage conversation context and reasoning traces for single or multi-agent systems.
  • AUREUS Reflexion loops: integrate chain-of-thought feedback for deeper reasoning.
  • Edge Workflow Execution: run on resource-constrained hardware thanks to Rust's performance and small footprint.
  • Multimodal learning or smart glasses: use the PerceptionAdapter to capture images and text.
  • Real-Time Automation: expose REST/gRPC APIs and upcoming CLI/web dashboards via the IntegrationLayer.
  • Knowledge Export: use rag_adapter with PdfExporter or NotionExporter for long-term persistence.

πŸ‘₯ Key User Roles

  • AI Agent – stores traces and retrieves context.
  • Developer – integrates the engine via REST/gRPC or protocol adapters.
  • Architect – designs workflows and multi-agent systems using the modules.
  • Researcher – experiments with new memory types or reasoning loops.

πŸ—ΊοΈ Use Case Map

  1. Store reasoning trace through the PerceptionAdapter and TemporalIndexer.
  2. Query symbols from the SymbolicStore.
  3. Update state via the ProceduralCache or AureusBridge.
  4. Visualize world model using real-time CLI and web dashboards.

πŸ§ͺ Test & Automation

  • Run all tests:
    cargo test

  • Run benchmarks:
    cargo bench

  • Test suite:

    • Unit and integration tests: /tests/integration_tests.rs
    • Property-based/fuzz tests: integrated using proptest
    • Add new test files to /tests/ as needed
    • Additional examples cover multimodal smart-glasses and humanoid robotics perception traces
    • Recent perception tests: multimodal_perception_tests.rs, smart_glasses_sit.rs, humanoid_perception_uat.rs
  • CI/CD Ready:
    You can use GitHub Actions or any CI providerβ€”add .github/workflows/ci.yml (see Rust starter templates) to run on every PR or push.

  • VS Code Integration:
    Open with VS Code. Test & bench tasks are already available via .vscode/tasks.json (Ctrl+Shift+B).

  • Best Practices:

    • Always write failing tests first (TDD)
    • Ensure all modules have coverage before merge
    • Add benchmarks for any new algorithm or data structure

πŸ† Project Success Criteria

HipCortex aims to remain stable and extensible as the ecosystem grows. The core success criteria include:

  • Technical Architecture – all modules compile cleanly and interoperate as described in the architecture diagram.
  • Data Integrity & Consistency – no reasoning traces or symbolic graphs are lost or corrupted across sessions.
  • Scalability & Performance – memory usage and runtime must support edge constraints while scaling horizontally on servers.
  • Extensibility – pluggable perception encoders, symbolic stores and caches should be swappable without modifying core logic.
  • Observability & Debugging – real-time logging and dashboards provide a clear view of every state transition.
  • Math & Statistical Soundness – temporal indexes, concept graphs and FSM transitions follow well-defined models validated by tests or simulation.
  • Integration with LLMs – connectors and protocols handle context without hallucination drift.
  • Documentation & Community – README, architecture docs and examples remain up to date for contributors.

πŸ“Š Critical Data & Math Foundation

Each value stream collects metrics that align with solid statistical models. Examples include:

  • PerceptionAdapter – input token entropy and PCA/ICA statistics.
  • TemporalIndexer – trace lifetimes modeled with Markov chains.
  • SymbolicStore – graph degree variance and clustering coefficients.
  • ProceduralCache – FSM state transition matrices and ergodicity checks.
  • AureusBridge – Bayesian inference metrics for reasoning loops.
  • IntegrationLayer – API latency and queuing statistics.

See docs/architecture.md for the complete mapping of | docs/memory_design.md | Math, logic and symbolic reasoning extension | value stream activities to data collection targets and mathematical foundations.

\ud83d\udccb Roadmap

The roadmap document lists completed modules and upcoming work. Highlights include semantic compression, RAG adapters, persistent world memory, real-time CLI/web tools, and expanded LLM connectors.

Summary Table

Doc Purpose
README.md Project overview, structure, TDD, quickstart, roadmap
src/lib.rs Library entry (export modules)
docs/architecture.md System design, extensibility, diagram
docs/memory_design.md Math, logic and symbolic reasoning extension
docs/business_context.md Business requirements and use cases
docs/data_model.md MemoryRecord schema and API notes
docs/usage.md Build, test, bench, example, import
docs/integration.md Protocol/API plans, extension points
docs/roadmap.md Completed, active, planned modules
docs/contributing.md Contribution guide, code/test policy
docs/agent.md Codex agent workflow and contribution guide
LICENSE Apache License 2.0