docs: enhance AGENTS with project context and performance guardrails#277
Open
napetrov wants to merge 1 commit intointel:mainfrom
Open
docs: enhance AGENTS with project context and performance guardrails#277napetrov wants to merge 1 commit intointel:mainfrom
napetrov wants to merge 1 commit intointel:mainfrom
Conversation
Based on multi-agent review (architect, pragmatist, prompt-specialist, perf-expert): Root AGENTS.md: - Add project description, tech stack (C++20, MKL, OpenMP, pybind11) - Add core principle: performance over simplicity - Add quick start commands (build/test/Python) - Add directory map .github/copilot-instructions.md: - Add concrete authoring rules (no full-file refactors for 2-line changes) - Add contribution expectations (backward compat, pre-commit, regression tests) - Expand source-of-truth: explicitly list mkl.cmake, multi-arch.cmake, numa.cmake, pyproject.toml - Add negative constraint: no std::iostream in perf-critical headers include/svs/AGENTS.md: - Add performance-critical constraints: memory alignment, SIMD dispatch, hot path rules - Add failure modes: template instantiation impact, ABI compat bindings/python/AGENTS.md: - Add pybind11 integration rules: GIL release, type validation, memory ownership - Add common failure modes: wrapper sync, edge case testing, lifetime management - Explicitly list source-of-truth files cmake/AGENTS.md: - Add Intel-specific module docs: mkl.cmake (threading), multi-arch.cmake (ISA dispatch), numa.cmake, openmp.cmake - Add guardrails: no flag removal without benchmark validation benchmark/AGENTS.md: - Add constraints: warmup/iteration stability, dataset provenance, baseline comparisons - Add reporting requirements: median/min/max/stddev include/svs/quantization/AGENTS.md (new): - Add quantization guardrails: type safety, precision bounds, SIMD alignment, codec compat - Add common failure modes: float in hot paths, misaligned access, codebook sync
mihaic
approved these changes
Feb 19, 2026
Member
mihaic
left a comment
There was a problem hiding this comment.
Looks good. Please remove LVQ references according to suggestions.
|
|
||
| This file is for AGENTS-aware tools. | ||
| ## What this project is | ||
| High-performance C++ library for vector similarity search at billion scale. Uses Intel MKL, AVX-512/multi-arch SIMD dispatch, LVQ quantization, NUMA-aware memory, OpenMP threading. Python bindings via pybind11. Archetype: **C++** (with Python bindings). |
Member
There was a problem hiding this comment.
No LVQ in this repo.
Suggested change
| High-performance C++ library for vector similarity search at billion scale. Uses Intel MKL, AVX-512/multi-arch SIMD dispatch, LVQ quantization, NUMA-aware memory, OpenMP threading. Python bindings via pybind11. Archetype: **C++** (with Python bindings). | |
| High-performance C++ library for vector similarity search at billion scale. Uses Intel MKL, AVX-512/multi-arch SIMD dispatch, quantization, NUMA-aware memory, OpenMP threading. Python bindings via pybind11. Archetype: **C++** (with Python bindings). |
| @@ -0,0 +1,13 @@ | |||
| # AGENTS.md — include/svs/quantization/ | |||
|
|
|||
| Quantization algorithms and data types (LVQ, scalar quantization). | |||
Member
There was a problem hiding this comment.
Suggested change
| Quantization algorithms and data types (LVQ, scalar quantization). | |
| Quantization algorithms and data types (scalar quantization). |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Follow-up to #276 — adds Intel-specific technical detail and performance guardrails based on code review.
Changes
Root AGENTS.md
.github/copilot-instructions.mdmkl.cmake,multi-arch.cmake,numa.cmake,pyproject.tomlstd::iostreamin perf-critical headersinclude/svs/AGENTS.mdbindings/python/AGENTS.mdcmake/AGENTS.mdmkl.cmake(threading),multi-arch.cmake(ISA dispatch),numa.cmake,openmp.cmakebenchmark/AGENTS.mdinclude/svs/quantization/AGENTS.md(new)Notes