[Docs] Fix build-from-source env prerequisites in README#645
Merged
Conversation
Clarify that nanobind/numpy/pybind11 are only installed by build_llvm.sh (not build.sh), and document the pytest/pandas/ROCm-torch deps needed to run tests and examples.
sjfeng1999
approved these changes
Jun 4, 2026
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
2 participants
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.
Clarify that nanobind/numpy/pybind11 are only installed by build_llvm.sh (not build.sh), and document the pytest/pandas/ROCm-torch deps needed to run tests and examples.
Motivation
The README's "Build from source" / "Run tests" instructions are missing a few environment-prep steps, so following them top-to-bottom in a clean environment fails. This PR makes the prerequisites accurate.
Technical Details
No code changes.
What was wrong
Misleading build-deps note. The prerequisites claim
nanobind,numpy,pybind11are "installed by the build scripts", but onlyscripts/build.shdoes not.torch,pytestandpandasundocumented. They are prerequisites to run the testsbash scripts/run_tests.shbut are not documented.Submission Checklist