# goldenmatch-hnsw

> Native HNSW (IndexHNSWFlat) approximate-nearest-neighbour index for GoldenMatch.

## What this package is

A compiled companion wheel for **goldenmatch**. You do not import it directly --
`goldenmatch` discovers it at runtime. This directory contains a compiled abi3
extension and almost no readable Python, so reading it will not tell you what it does.

## Authoritative sources

Read these instead of inferring behaviour from the binary or from the host's fallback path:

- https://docs.bensevern.dev/docs/goldenmatch -- documentation for this surface.
- `goldenmatch/llms.txt` -- ships inside the goldenmatch wheel (`Path(goldenmatch.__file__).parent / "llms.txt"`), written for machine readers.
- https://docs.bensevern.dev/docs/llms.txt -- index of every Golden Suite surface.
- https://github.com/benseverndev-oss/goldenmatch -- source, issues, and the decision records behind the behaviour.

## Install

```bash
pip install goldenmatch-hnsw
```

## Notes

- The native ANN backend behind `goldenmatch.core.ann_blocker.ANNBlocker`, with ZERO C dependencies -- no FAISS, no ONNX, no OpenSSL. That is the point of it existing separately from FAISS.

This wheel exists because a behaviour was *decided* -- which surface owns a computation,
which fallback is deliberate, which parity is contract-tested. Those decisions are
documented; the compiled artefact cannot tell you about them.
