-
Notifications
You must be signed in to change notification settings - Fork 309
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
Add nx-cugraph
Docs Pages
#4669
Conversation
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.
Found some small things but looks good. Still reviewing.
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 good
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, Ralph. This is a great start. I have a few requests below.
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.
This is a huge improvement, thank you!
I left a few questions and suggestions, and I have a few questions below.
Should we update the "url" in the get_info
function? This controls the link to nx-cugraph from the NetworkX docs
"url": f"https://github.com/rapidsai/cugraph/tree/branch-{_version_major:0>2}.{_version_minor:0>2}/python/nx-cugraph", |
Is the algorithm list in supported-algorithms.rst automated? Is it complete? Should we (eventually) try to automate it in a similar way that we update the README using scripts/update_readme.py
? Or, can we add a test to ensure it's complete?
Can we link to the official NetworkX docs for backends again in how-it-works.md? I know we already link to NetworkX in index.rst.
Yes, I was just going to open a PR to update that. We'll have our proper landing in place by next week and (I think) a temporary redirect in place even sooner, so lets update it to: https://rapids.ai/nx-cugraph (this is the nx-cugraph equivalent of the cudf-pandas landing page) |
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.
How is nxcg-execution-diagram.jpg
created? Is it from code, and, if so, is this code available somewhere?
Co-authored-by: Erik Welch <[email protected]>
Co-authored-by: Erik Welch <[email protected]>
@eriknw it is not code. It was created by Rick for the SciPy talk and it was borrowed from the presentation. |
/merge |
Closes https://github.com/rapidsai/graph_dl/issues/606 and [another issue]
Proposed Changes
In preparation for GA release, this PR adds a landing page for
nx-cugraph
in the cugraph API documentation site. The new pages can be viewed by clickingnx-cugraph
in the navigation bar at the top of the page.New pages
nx-cugraph
└─ How it works
└─ Supported Algorithms
└─ Getting Started
└─ Benchmarks
└─ FAQ
Notes for Reviewers
build.sh
file to usesphinx-autobuild
.build.sh
in order to host the webserver locally..