rapidsai / docs

RAPIDS Documentation Site
https://docs.rapids.ai
37 stars 52 forks source link

Adding `nx-cugraph` to RAPIDS Install Selector Tool #536

Closed nv-rliu closed 2 months ago

nv-rliu commented 2 months ago

Closes https://github.com/rapidsai/graph_dl/issues/604 & closes https://github.com/rapidsai/graph_dl/issues/609

In preparation for its stable release, this PR adds NetworkX + nx-cugraph as an option to the RAPIDS Install Selector Tool > Additional Packages.

Proposed changes:

image

image

Notes for Reviewers

netlify[bot] commented 2 months ago

Deploy Preview for docs-rapids-ai ready!

Built without sensitive environment variables

Name Link
Latest commit 9bcbfe6101902b8d978817f68db4984a44229346
Latest deploy log https://app.netlify.com/sites/docs-rapids-ai/deploys/66eb2014a6a96900083e053f
Deploy Preview https://deploy-preview-536--docs-rapids-ai.netlify.app
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

nv-rliu commented 2 months ago

Thanks @bdice I'll make those changes and push and update shortly

rlratzel commented 2 months ago

I would propose editing the cuGraph button to say cuGraph / nx-cugraph if that is a sufficient solution.

We discussed that, but decided that might not be desired since installing cugraph with nx-cugraph brings along a lot of extra dependencies that nx-cugraph does not use and users may not want (dask, cudf, etc.).

nx-cugraph is not in the RAPIDS meta-package at the moment either, so we're planning on adding it there too. That will help and seems correct for a RAPIDS install, but it's not as noticeable as a dedicated button and doesn't help users that just want Accelerated NetworkX.

@bdice if nx-cugraph isn't button-worthy, is there an alternative we can discuss?

rlratzel commented 2 months ago

@bdice if nx-cugraph isn't button-worthy, is there an alternative we can discuss?

cc @beckernick for any additional suggestions.

bdice commented 2 months ago

We could revisit the entire UX of the package selector. Maybe there’s a multi-row interface or something that uses a list with checkboxes that would still be visually appealing and provide more flexibility.

bdice commented 2 months ago

Also, I don’t want to be a deciding voice here against adding a button. I just raise that concern because we have hesitated on similar changes in the past.

rlratzel commented 2 months ago

Discussed offline with @bdice @beckernick @nv-rliu @aravenel @quasiben and decided that the best option would be to add a button to "Additional Packages" named "NetworkX + nx-cugraph" (or just "NetworkX" with a pop-up note indicating nx-cugraph is installed too?) which installs NetworkX and nx-cugraph.

nv-rliu commented 2 months ago

Let’s merge this. But it is missing a key feature: people who select “pip” and choose specific packages do not have an option to pick nx-cugraph.

@bdice Do you think that I could add an "Additional Packages" bar for pip installation?

PS. Is there a reason why this isn't included for pip when it was added to conda?

bdice commented 2 months ago

We've just never implemented a pip "additional packages". I think we could open discussion for that with the team internally and decide how to proceed. In the short term we probably only need a solution for adding nx-cugraph.