Updates nx-cugraph README
for latest h/w, CUDA, python, NX requirements, moves updater to pre-commit
#4225
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.
README
for latest h/w, CUDA, python, NX requirementsREADME
check and auto-updater script from the python CI test script to a pre-commit hook alongside the other codegen calls/checks. The pre-commit checks are run by the dev at commit-time and by CI as part of the style check job. This check will only run for changes to files under thenx-cugraph
subdir.update_readme.py
script to optionally download the NXobjects.inv
file itself so callingmake
is not required as part of the pre-commit hook.bash
in order to set thePYTHONPATH
env var to use the local version of theupdate_readme.py
script, which is what I was trying to avoid in the first place. This still has some advantages in making theupdate_readme.py
script more usable if the user isn't aware of how to obtain aobjects.inv
file, but feedback is welcome. The hook could also be changed to just callmake
if that ends up being preferred, in which case we'd have to consider if we still want the updates toupdate_readme.py
to download theobjects.inv
file itself or not.Here's the check running as part of the style-check job for this PR: