// Use when exploring codebase structure, understanding index implementations (HNSW, IVF, DISKANN, Sparse, MinHash), working with third-party libraries (faiss, hnswlib, DiskANN, Cardinal), or locating specific functionality
Use when building knowhere from source, configuring build options (CPU/GPU/DISKANN/ASAN), or troubleshooting compilation errors
Use when checking code style, running pre-commit hooks, or before committing changes to ensure compliance with Google style guide
Use when committing and pushing code changes, ensures DCO compliance and pre-commit validation
Use when running unit tests, debugging test failures, or adding new test cases using Catch2 framework
| name | architecture |
| description | Use when exploring codebase structure, understanding index implementations (HNSW, IVF, DISKANN, Sparse, MinHash), working with third-party libraries (faiss, hnswlib, DiskANN, Cardinal), or locating specific functionality |
| Directory | Purpose |
|---|---|
include/knowhere/ | Public headers |
src/index/ | Index implementations (flat/, hnsw/, ivf/, gpu/, diskann/, sparse/, minhash/) |
src/common/ | Threading, tracing, metrics utilities |
src/cluster/ | Clustering algorithms (KMeans) |
tests/ut/ | Unit tests |
thirdparty/ | Forked third-party libraries |
Index Factory (include/knowhere/index/index_factory.h)
KNOWHERE_SIMPLE_REGISTER_GLOBAL)Index Interface (include/knowhere/index/index.h)
Index<IndexNode> wrapperConfiguration (include/knowhere/config.h)
Data Types (include/knowhere/operands.h)
Error Handling (include/knowhere/expected.h)
expected<T> type with Status enumL2, IP (Inner Product), COSINE, Jaccard, Hamming, BM25