ik_llama_opt/docs
Andrew Moryakov 418d60a909
docs : add AVX-512 build flags reference for Zen4 / Sapphire Rapids+ (#1729)
The IQK quantized GEMM kernels (ggml/src/iqk/iqk_gemm_*.cpp) are gated
by HAVE_FANCY_SIMD in iqk_config.h, which requires five AVX-512 macros
to be defined: __AVX512F__, __AVX512VNNI__, __AVX512VL__, __AVX512BW__,
__AVX512DQ__. If they are not defined, the AVX-512 quantized matmul
path is skipped silently — no build warning, no runtime symptom, just
lower performance than the hardware can deliver. Surprises users on
Windows/MSVC where -march=native semantics are not propagated.

Adds a docs/build.md section that documents:
- Which macros gate which path (HAVE_FANCY_SIMD for quant GEMM,
  __AVX512F__ alone for f16/f32, __AVX512BF16__ for bf16, __AVXVNNI__
  for AVX2+VNNI-only CPUs).
- Linux/GCC: GGML_NATIVE=ON (default) handles this automatically on
  Zen4 / Sapphire Rapids; just verify with objdump.
- Windows/MSVC and cross-compile: explicit GGML_ARCH_FLAGS with
  -D__AVX512* defines is required.
- Note on Zen4 implementing AVX-512 as 256-bit double-pumped.

Documentation only — no code changes, no behavioural changes, no
new CMake options introduced.
2026-05-03 17:35:01 +03:00
..
backend Merge mainline - Aug 12 2024 (#17) 2024-08-12 15:14:32 +02:00
development Autoparser - complete refactoring of parser architecture (#1376) 2026-04-22 10:04:13 +02:00
android.md Merge mainline llama.cpp (#3) 2024-07-27 07:55:01 +02:00
autoparser.md Autoparser - complete refactoring of parser architecture (#1376) 2026-04-22 10:04:13 +02:00
build.md docs : add AVX-512 build flags reference for Zen4 / Sapphire Rapids+ (#1729) 2026-05-03 17:35:01 +03:00
docker.md Update Docker documentation with important notice 2026-03-15 12:35:04 +01:00
function-calling.md common : introduce composable PEG parser combinators for chat parsing and new jinja template engine (#1369) 2026-03-09 11:03:33 +01:00
install.md Merge mainline llama.cpp (#3) 2024-07-27 07:55:01 +02:00
llguidance.md Tool calls support from mainline (#723) 2025-09-01 08:38:49 +03:00
parameters.md Update docs (#1606) 2026-04-10 18:20:28 +02:00
speculative.md spec : add self speculative decoding, ngram and refactor (#1261) 2026-02-13 19:04:55 +01:00