docs: call out Node 22 prerequisite in installation guide (#512)#668
Open
jbbqqf wants to merge 1 commit intointerpretml:mainfrom
Open
docs: call out Node 22 prerequisite in installation guide (#512)#668jbbqqf wants to merge 1 commit intointerpretml:mainfrom
jbbqqf wants to merge 1 commit intointerpretml:mainfrom
Conversation
…l#512) The installation guide jumps straight from "create a conda env" to "build the JS visualization bundle with `npm install`", which is the exact step that fails on older systems where the default `nodejs` package is Node 8 (issue interpretml#512). The CLAUDE.md / CI configuration already pins Node 22 for this build, but the user-facing installation-guide.ipynb did not mention any version requirement. Add a "Prerequisites" subsection between the optional conda step and the main install block. The new section: tells the reader to use Node 22 (matching CI), shows the `nvm install 22 / nvm use 22` recipe, and notes the Visual Studio 2022 / `vcvars64.bat` requirement on Windows plus the implicit "any reasonably recent g++/clang++" expectation on Linux/macOS. Nothing else in the guide changes. Co-Authored-By: Claude Code <noreply@anthropic.com> Signed-off-by: jbbqqf <jbaptiste.braun@gmail.com>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #668 +/- ##
==========================================
- Coverage 66.86% 66.84% -0.02%
==========================================
Files 77 77
Lines 11724 11724
==========================================
- Hits 7839 7837 -2
- Misses 3885 3887 +2 Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
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
The installation guide doesn't mention which Node.js version to use,
so users following it on systems with older Node (e.g. the Node 8 that
ships as the default
nodejspackage on older Ubuntu LTS releases)hit a wall on
npm installfor the visualization bundle (issue #512).Add a small "Prerequisites" subsection that calls out Node 22 (matching
CI) and shows the
nvm install 22/nvm use 22recipe.Fixes #512 — Development installation: Requirements?
Context
CI uses Node 22 for the JS bundle (see the comment in the repo's
CLAUDE.md: "Build (matches CI, Node 22):cd shared/vis && npm install && npm run build-prod"). The installation guide(
docs/interpret/installation-guide.ipynb) just instructed the user torun
npm installwith no version guidance, which is what tripped upthe user in #512: their system Node was 8, the dependency tree refused
to resolve, and there was no signpost in the docs to tell them why.
This PR is documentation-only.
Changes
docs/interpret/installation-guide.ipynb— insert a new"Prerequisites"
<h2>between the optional conda step and the maininstall block. The new section:
nvm install 22 / nvm use 22 / node --versionrecipe;vcvars64.batrequirement onWindows and the implicit
g++/clang++expectation onLinux/macOS so platform requirements live in one place rather than
being scattered through the guide.
No other content moved; the existing build steps follow unchanged.
Reproduce BEFORE/AFTER yourself (copy-paste)
To preview rendered output: open the notebook in JupyterLab, or
jupyter nbconvert --to html docs/interpret/installation-guide.ipynb.What I ran locally
python3 -c "import json; json.load(open('docs/interpret/installation-guide.ipynb'))"→parses cleanly (3 cells, nbformat 4).
git diff docs/interpret/installation-guide.ipynb→ 18 insertedlines inside the existing cell
3724ac29, no other cells touched.Edge cases tested
json.load(...)round-trip cleangit diff --statshows 1 file, 18 +/0 -cd interpret,./build.sh,cd shared/vis,npm run …,pip install -e …block is byte-identical toorigin/mainRisk / blast radius
Documentation-only. No code paths affected. The new prose only adds
recommendations; existing readers who already had Node 22 see no
behavioural change.
Release note
PR drafted with assistance from Claude Code. The change was reviewed
manually against
interpretml/interpret's source and the cited issue.The reproducer block above was used during development; it is the same
one a reviewer can paste verbatim.