Skip to content

docs: fix manual-installation.md missing batchgen_kernels build step - #278

Merged
drunkcoding merged 2 commits into
mainfrom
docs/manual-installation-fixes
Jul 4, 2026
Merged

docs: fix manual-installation.md missing batchgen_kernels build step#278
drunkcoding merged 2 commits into
mainfrom
docs/manual-installation-fixes

Conversation

@drunkcoding

Copy link
Copy Markdown
Collaborator

Description

docs/manual-installation.md had drifted from the real install flow. Four fixes:

  1. Add the missing batchgen_kernels build step. batchgen_kernels is a separate package (batchgen_kernels/setup.py, 22 AOT CUDA extensions) that the top-level pip install . does not build (main setup.py only packages batchgen/batchgen.*). The guide previously skipped it entirely, producing an install with all compiled extensions missing → runtime import failures. Added a dedicated step (matching install_deps.sh's install_batchgen_kernels), with the TORCH_CUDA_ARCH_LIST=9.0a (H20) / BUILD_ARCH=sm100 (Blackwell) notes.
  2. pip install -e . → non-editable pip install .. Aligns with INSTALL.md, which requires non-editable for ray/production and warns the source dir shadows installed packages. Added a one-line caveat + link.
  3. Add FLASH_ATTENTION_FORCE_BUILD=TRUE to the FA3 hopper build (against torch 2.9 it otherwise hangs downloading a non-existent prebuilt wheel — same as install_deps.sh:187 / INSTALL.md troubleshooting).
  4. Verification pointer to INSTALL.md's fuller snippet (kernels + flash_attn_interface/flash_mla/deep_gemm).

All cross-reference anchors and the BUILD_ARCH knob were verified against the code. The git clone --recursive for DeepGEMM is correct (DeepGEMM genuinely has submodules) and left unchanged.

Motivation

Following the manual guide verbatim currently yields a non-functional install. Resolves #277.

close #277

Type of Change

  • model
  • kernel
  • core
  • fix
  • infra
  • docs — documentation only

File changes

File Δ Note
docs/manual-installation.md mod Add batchgen_kernels build step; non-editable install + caveat; FLASH_ATTENTION_FORCE_BUILD=TRUE; verification pointer

Checklist

  • I have read the CONTRIBUTING guide and the PR Merge Policy Contract.
  • I have updated the tests (if applicable) — N/A, docs only.
  • I have updated the documentation (if applicable).

PR Merge Policy Contract — pre-merge checklist

  • git diff --stat origin/main reviewed; every change traces to the task (§3.1).
  • Exactly one Type of Change ticked (docs); only docs/** touched (§2.5).
  • File changes table matches the diff.
  • No throwaway scripts, in-package tests, env guards, stray print(), or artifacts added (§1).
  • One concern only (manual-installation.md accuracy); diff is surgical (§3).
  • Commit is clean: Angular format, no Co-Authored-By (§4; body optional for docs).
  • Cross-reference anchors (INSTALL.md#...) and BUILD_ARCH knob verified against the repo.
  • CI is green — pending run.

@github-actions github-actions Bot added the ci:run Trigger build + GPU regression on H20 label Jun 26, 2026
…ersions

Verified in a fresh Ubuntu 22.04 + CUDA 12.8 container (no SSH keys):

- the three 'git clone git@github.com:...' commands fail on a fresh server;
  switch to https:// like INSTALL.md and the Dockerfile
- unpinned FlashMLA HEAD fails to build with nvcc 12.8 (SM100 kernels need
  12.9+); pin commit 1408756a + FLASH_MLA_DISABLE_SM100=1, matching
  scripts/install_deps.sh
- unpinned DeepGEMM HEAD (54e22612) fails to build; pin v2.1.1.post3, which
  builds fine
- soften the FORCE_BUILD note: the verbatim no-env build completed in 29 min
  in the same container (the wheel-download attempt fell back), so 'hangs' is
  situational, not guaranteed

refs #277
@drunkcoding
drunkcoding merged commit 8f566a6 into main Jul 4, 2026
1 check passed
@drunkcoding
drunkcoding deleted the docs/manual-installation-fixes branch July 14, 2026 17:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ci:run Trigger build + GPU regression on H20

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[docs] manual-installation.md produces a broken install (omits batchgen_kernels) + editable/force-build issues

1 participant