Skip to content

Install

HMS is a Rust library with surfaces for other runtimes. Pick the one you use. Nothing on this page downloads a model or contacts a service: installing and running HMS is local.

Requirements

You need For
Rust 1.89 or newer (the MSRV) the Rust crate, the HTTP server and the Node build
Node 22 or newer the Node bindings; Node 24 for the quickstart, which uses node:sqlite
Python 3.10 or newer the Python SDK (holographic-vsa needs 3.9)

Install for your runtime

cargo add holographic-memory

default = []: nothing is on unless you ask. Turn on what you need, for example cargo add holographic-memory --features security for AES-256-GCM stores and signed audit logs. Every feature, what it turns on and whether it is experimental: Cargo features.

The Python SDK is an HTTP client for hms-server, which holds the engine and stores the vectors you supply:

pip install holographic-sdk

Build and start the server from a checkout, then point the client at it:

cargo build --release --features server --bin hms-server
HMS_API_KEY=change-me target/release/hms-server --input-dim 384

The holographic-vsa wheel is a different package: the quantized-phase vector substrate, imported as holographic_memory. It does not include document search.

pip install holographic-vsa

The native module is built from source, which needs a Rust toolchain:

npm ci --omit=optional && npm run build

The npm package is deprecated until the next release; use the source build until then.

Check that it works

cargo run --release --manifest-path examples/quickstart/rust/Cargo.toml

python -c "import holographic_memory as hm; print(hm.PhaseHVec.random(1024, 256, 1))"

node -e "const { HolographicMemorySystem } = require('./index.js'); console.log(typeof HolographicMemorySystem)"

The quickstart runs a full ingest and search against the same checkout.

Next steps