Glyph Overview
Glyph turns text into glyphs (fixed-size MinHash signatures). You can compare two glyphs, build an in-memory index and query it for ranked matches, use spotlight to rank chunks inside a document, or use completions for glyph-guided next-word suggestions.
Key Guides
Section titled “Key Guides”| Guide | Purpose |
|---|---|
| Getting started | Install, first compare, and mental model |
| Building an index | Populate an in-memory index and run ranked queries |
| Demo CLI | Compare, search, complete, and spotlight from the terminal |
| API surface | Full export list for Core, Query, Collections, Completions, and Spotlight |
| Migration 0.4 → 1.0 | PascalCase API, @koda.oss/glyph package, and query.New changes |
Modules & Features
Section titled “Modules & Features”- Core: Fingerprinting (
Create), similarity (Compare), tokenization, serialization, and index storage (index.New). - Query: Fast ranked searches over index stores with
query.New(idx).Search(). - Collections: Pre-aggregated labeled example glyphs into a single probe fingerprint.
- Completions: Markov next-word candidates guided and ranked by glyph similarity.
- Spotlight: Document chunking, ranking, and snippet queries.
Current Limits
Section titled “Current Limits”| Feature | Status |
|---|---|
| In-memory index | Implemented |
| LSH banding index (default) | Implemented |
Direct (exact) scan via mode: "direct" |
Implemented |
| Collections (slot-wise glyph aggregate) | Implemented |
| Glyph completions (Markov + rank) | Implemented |
| Spotlight (document chunk rank/query) | Implemented |
| Disk persistence | Planned post-1.0 |
| Chain persistence | Planned post-1.0 |
License
Section titled “License”Mozilla Public License 2.0 — see LICENSE.