API Reference

Complete API documentation for HoloVec.

Main API

The primary interface for creating and using VSA models.

• VSA - Main API

Models

All VSA model implementations.

• Models

Encoders

Encoders for different data types.

• Encoders

Retrieval & Memory

Cleanup, retrieval, and associative storage.

• Retrieval & Memory

Backends

Backend implementations for different hardware.

• Backends

Vector Spaces

Vector space definitions and operations.

• Vector Spaces

Utilities

Helper functions and utilities.

• Utilities

Quick Links

Most Common:

• VSA - Factory for creating models

• create() - Create a VSA model

• VSAModel - Base class for all models

• FractionalPowerEncoder - Continuous value encoding

• ItemStore - Associative memory

Models:

• MAPModel - Multiply-Add-Permute

• FHRRModel - Fourier HRR

• HRRModel - Holographic Reduced Representations

• BSCModel - Binary Spatter Codes

• BSDCModel - Block-Structured Distributed Codes

• GHRRModel - Generalized HRR

• VTBModel - Vector-derived Transformation Binding

Encoders:

• FractionalPowerEncoder - Smooth scalar encoding

• ThermometerEncoder - Ordinal encoding

• LevelEncoder - Discrete bins

• PositionBindingEncoder - Sequence encoding

• NGramEncoder - N-gram text encoding

• TrajectoryEncoder - Motion path encoding

• ImageEncoder - 2D spatial encoding

• VectorEncoder - Multivariate encoding

Backends:

• get_backend() - Get a backend by name

• Backend - Backend interface

• NumPyBackend - NumPy (CPU) backend

• TorchBackend - PyTorch (GPU) backend

• JAXBackend - JAX (JIT/TPU) backend

Retrieval:

• Codebook - Simple lookup table

• ItemStore - Similarity-based retrieval

• AssocStore - Associative memory

• BruteForceCleanup - Nearest-neighbor cleanup

• ResonatorCleanup - Iterative cleanup

See Also

• User Guide - User guide and tutorials

• HoloVec Examples - Example gallery

• Theory & Foundations - Theoretical foundations