Skip to content

docs(readme): the NPU layer kernel and lm-head decode from source - #325

Merged
bong-water-water-bong merged 1 commit into
mainfrom
docs/npu-from-source
Oct 5, 2026
Merged

bong-water-water-bong merged 1 commit into
mainfrom
docs/npu-from-source

Conversation

@bong-water-water-bong

Copy link
Copy Markdown
Collaborator

What

One stale sentence in the README, corrected.

The README said the NPU engine's "layer kernel is not yet built from source". docs/npu.md Step 3d — on the same main — documents the opposite: both the dense layer kernel and lm-head run from source, ELF to ELF, with no xclbin at any point, one compiled program covering every context position, verified on Qwen3-0.6B, 1.7B and 4B against an fp64 reference (cosine similarity ≥ 0.9999 at every tested position, greedy decode exact end to end).

The README now says that, and keeps the two qualifiers that are still true: the kernel sources stay private per CONTRIBUTING, and the work is not yet merged here.

Where it came from

Recovered from the unreported docs-hrx-status branch (12 commits). Only this one commit was still additive. The rest is a pre-RFC-#213-stage-3 snapshot: applied as-is it would re-document the Vulkan, ROCm, ZINC, ROCmFPX lean and ComfyUI routes this repository has removed, and it edits docs/zinc.md, which #306 deleted. docs/serve.md and docs/hrx.md were the worst of it — its lead-sentence rewrite re-asserts "one llama.cpp build with two GPU backends, ggml-hrx and ggml-vulkan".

So the branch is superseded; this single fix is not.

Verified

  • The stale phrase appears 0 times in the README after the change.
  • tools/copyright.py --check passes.
  • README and docs/npu.md Step 3d now agree.

Not to be merged: the release is on hold indefinitely.

@github-actions

github-actions Bot commented Oct 5, 2026 •

Copy link
Copy Markdown

PR Reviewer Guide 🔍

(Review updated until commit b129a88)

Here are some key observations to aid the review process:

⏱️ Estimated effort to review: 1 🔵⚪⚪⚪⚪
🧪 No relevant tests
🔒 No security concerns identified
⚡ Recommended focus areas for review

Documentation Update

The README has been updated to reflect that the NPU engine's layer kernel and lm-head now decode from source, which was previously stated as not yet built from source. This change aligns the documentation with the actual implementation described in docs/npu.md, and ensures consistency in the project's documentation.

> upstream XDNA stack pinned ([docs/npu.md](docs/npu.md); its layer kernel and lm-head now decode from
> source, ELF to ELF, with no xclbin at any point, verified on Qwen3-0.6B/1.7B/4B against an fp64
> reference — the kernel sources stay private and are not yet merged here, docs/npu.md Step 3d) and
> MLX ([docs/apple.md](docs/apple.md)). ZAYA1-8B (Zyphra)

The README still said the NPU layer kernel "is not yet built from source", while
docs/npu.md Step 3d on the same main documents the opposite: both the dense layer
kernel and lm-head run from source, ELF to ELF, with no xclbin at any point, one
compiled program covering every context position, verified on Qwen3-0.6B, 1.7B and
4B against an fp64 reference (cosine >= 0.9999, greedy decode exact).

Point the README at that, and keep the two qualifiers that are still true: the
kernel sources stay private per CONTRIBUTING, and the work is not yet merged here.

Recovered from the unreported docs-hrx-status branch, which is otherwise a
pre-RFC-#213-stage-3 snapshot (it would re-document the Vulkan, ROCm, ZINC, lean and
ComfyUI routes this repository removed, and it names docs/zinc.md, which #306 deleted).
This one commit was the only part still additive.
@github-actions

github-actions Bot commented Oct 5, 2026

Copy link
Copy Markdown

Persistent review updated to latest commit b129a88

@bong-water-water-bong
bong-water-water-bong merged commit 91391c7 into main Oct 5, 2026
7 checks passed
@bong-water-water-bong
bong-water-water-bong deleted the docs/npu-from-source branch October 5, 2026 21:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant