Skip to content
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.md with latest algos #4135

Conversation

rlratzel
Copy link
Contributor

@rlratzel rlratzel commented Feb 1, 2024

closes #4079

  • Updates nx-cugraph README.md with latest algos
  • Adds script to auto-update README.md from nx_cugraph metadata directly

@rlratzel rlratzel added doc Documentation improvement Improvement / enhancement to an existing function non-breaking Non-breaking change labels Feb 1, 2024
@rlratzel rlratzel self-assigned this Feb 1, 2024
@rlratzel rlratzel requested a review from a team as a code owner February 1, 2024 08:52
@github-actions github-actions bot added the python label Feb 1, 2024
@rlratzel rlratzel removed the improvement Improvement / enhancement to an existing function label Feb 1, 2024
python/nx-cugraph/README.md Outdated Show resolved Hide resolved
python/nx-cugraph/README.md Outdated Show resolved Hide resolved
@eriknw
Copy link
Contributor

eriknw commented Feb 1, 2024

I'm not sure I like the table view as is. It feels and looks like a raw data dump and is awkward to navigate and read. Ideally, if we want a table, I would want it to be interactive--sortable, filterable, etc. (but I don't know how to do this). Multiple "simple" tables would be better than a single table, such as three tables: 1. algorithms, 2. generators, 3. other/misc. I don't like mixing these if there's no way to unmix them.

Did you try the tree view? What do you think of it?

@eriknw
Copy link
Contributor

eriknw commented Feb 1, 2024

update_readme.py feels misplaced. It probably doesn't belong in nx_cugraph/scripts like other scripts that could be useful for users, so maybe it ought to go in a new directory such as scripts/update_readme.py.

@eriknw
Copy link
Contributor

eriknw commented Feb 1, 2024

I don't know if we ever create and distribute Python source distributions (sdists), but I think we ought to allow sdists to be created correctly. To me, this means including more files such as update_readme.py.

This can be done by creating MANIFEST.in such as:

include Makefile
include conftest.py
include lint.yaml
include run_nx_tests.sh
include update_readme.py

This does not change the contents of wheels.

Copy link
Contributor

@acostadon acostadon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great idea to automate this.

@rlratzel rlratzel added this to the 24.02 milestone Feb 2, 2024
@rlratzel
Copy link
Contributor Author

rlratzel commented Feb 2, 2024

@eriknw I pushed changes based on your suggestions here and resolved a merge conflict.

We discussed bigger changes you wanted to make, which all seem good to me, but if you're not able to get them done in time we can now merge this as-is so the README is at least accurate for 24.02.

@rlratzel
Copy link
Contributor Author

rlratzel commented Feb 2, 2024

/merge

@rapids-bot rapids-bot bot merged commit f64df60 into rapidsai:branch-24.02 Feb 2, 2024
114 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Documentation non-breaking Non-breaking change python
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update nx-cugraph README/docs for 24.02
4 participants