embeddenator-core 0.22.0

Sparse ternary VSA implementation for holographic data encoding - umbrella crate re-exporting all embeddenator components
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109

//! Embeddenator - Holographic Computing Substrate
//!
//! Copyright (c) 2025 Embeddenator Contributors
//! Licensed under MIT License
//!
//! Rust implementation of sparse ternary VSA (Vector Symbolic Architecture)
//! for holographic data encoding.
//!
//! Embeddenator is an encoding method and data model. It is not a security
//! implementation.
//!
//! # Overview
//!
//! Embeddenator encodes filesystems into holographic "engrams" using
//! sparse ternary vectors, enabling:
//! - Reconstruction of files from encoded engrams
//! - Holographic superposition of multiple data sources
//! - Algebraic operations (bundle, bind) on encoded data
//! - Hierarchical chunked encoding for larger datasets
//!
//! # Quick Start
//!
//! ```no_run
//! use embeddenator::{EmbrFS, SparseVec};
//! use std::path::Path;
//!
//! // Create a new holographic filesystem
//! let mut fs = EmbrFS::new();
//!
//! // Ingest a directory (would require actual directory)
//! // fs.ingest_directory("./input", false)?;
//!
//! // Save the engram and manifest
//! // fs.save_engram("root.engram")?;
//! // fs.save_manifest("manifest.json")?;
//! # Ok::<(), std::io::Error>(())
//! ```
//!
//! # Core Concepts
//!
//! ## Vector Symbolic Architecture (VSA)
//!
//! The foundation of Embeddenator is VSA with three key operations:
//!
//! - **Bundle**: Associative superposition - combine multiple vectors
//! - **Bind**: Non-commutative composition - encode associations
//! - **Cosine Similarity**: Retrieve similar patterns
//!
//! ## Engrams
//!
//! An engram is a holographic encoding containing:
//! - Root vector: superposition of all data chunks
//! - Codebook: mapping of chunk IDs to encoded data
//! - Manifest: file structure and metadata
//!
//! # Modules
//!
//! - [`vsa`]: Vector Symbolic Architecture implementation
//! - [`embrfs`]: Holographic filesystem layer
//! - [`cli`]: Command-line interface

pub mod cli;

// Re-export embeddenator-vsa as a public module for backward compatibility
pub use embeddenator_vsa as vsa;
pub use embeddenator_vsa::ternary;
pub use embeddenator_vsa::ternary_vec;
// Re-export embeddenator-retrieval types
pub use embeddenator_retrieval as retrieval;
pub use embeddenator_retrieval::core::resonator;
// Re-export embeddenator-fs types
pub use embeddenator_fs as fs;
pub use embeddenator_fs::correction;
pub use embeddenator_fs::embrfs;
pub use embeddenator_fs::fuse_shim;
// Re-export embeddenator-interop types
pub use embeddenator_interop as interop;
// Re-export embeddenator-io types
pub use embeddenator_io as io;
// Re-export embeddenator-obs types
pub use embeddenator_obs as obs;
// VSA types from embeddenator-vsa component
pub use embeddenator_vsa::{
    BalancedTernaryWord, Codebook, CorrectionEntry, DifferentialEncoder, DifferentialEncoding,
    DimensionalConfig, HyperVec, PackedTritVec, ParityTrit, ProjectionResult, ReversibleVSAConfig,
    SemanticOutlier, SparseVec, Trit, Trit as DimTrit, TritDepthConfig, Tryte, Tryte3, Word6,
    WordMetadata, DIM,
};
// Retrieval types from embeddenator-retrieval component
pub use embeddenator_retrieval::resonator::Resonator;
pub use embeddenator_retrieval::{RerankedResult, SearchResult, TernaryInvertedIndex};
// Filesystem types from embeddenator-fs component
pub use embeddenator_fs::{
    load_hierarchical_manifest, query_hierarchical_codebook,
    query_hierarchical_codebook_with_store, save_hierarchical_manifest, save_sub_engrams_dir,
    ChunkCorrection, CorrectionStats, CorrectionStore, CorrectionType, DirectorySubEngramStore,
    EmbrFS, Engram, EngramFS, EngramFSBuilder, FileAttr, FileEntry, FileKind, HierarchicalChunkHit,
    HierarchicalManifest, HierarchicalQueryBounds, Manifest, ReconstructionVerifier, SubEngram,
    SubEngramStore, UnifiedManifest, DEFAULT_CHUNK_SIZE,
};
// Interop types from embeddenator-interop component
pub use embeddenator_interop::{
    rerank_top_k_by_cosine, CandidateGenerator, KernelInteropError, SparseVecBackend, VectorStore,
    VsaBackend,
};
// I/O types from embeddenator-io component
pub use embeddenator_io::{
    unwrap_auto, wrap_or_legacy, BinaryWriteOptions, CompressionCodec, PayloadKind,
};