-
Notifications
You must be signed in to change notification settings - Fork 310
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Updates nx-cugraph README
for latest h/w, CUDA, python, NX requirements, moves updater to pre-commit
#4225
Updates nx-cugraph README
for latest h/w, CUDA, python, NX requirements, moves updater to pre-commit
#4225
Conversation
…moves README updater check from CI test script to pre-commit.
…4-nx_cugraph_readme_update
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks Rick. It's nice to move what we can into pre-commit.
Any appetite for updating linting in pre-commit to better match what we have in nx-cugraph
?
Overall looks good, but I shared a few minor comments and nits.
…dds NX>=3.2 to pre-commit python environment for nx-cugraph hooks, adds markdown as a type for nx-cugraph README updater, stubs out nx-cugraph runtime deps to allow import without installing them for nx-cugraph pre-commit hooks.
…b.com/rlratzel/cugraph into branch-24.04-nx_cugraph_readme_update
…dds function to produce a string repr with a quoting preference compatible with black, re-generates the _nx_cugraph/__init__.py modified with the wrong quoting preference from the prior commit.
…4-nx_cugraph_readme_update
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks great.
/merge |
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: