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

Doc cleanup for nx-cugraph: fixed typos, cleaned up various descriptions, renamed notebook to match naming convetion. #4478

Merged
merged 11 commits into from
Jul 2, 2024

Conversation

rlratzel
Copy link
Contributor

closes #4466

  • Fixed typos
  • Changed various descriptions to match existing terminology and hopefully clarify
  • Renamed notebook to match file name conventions

…ons, renamed notebook to match naming convetion.
@rlratzel rlratzel added doc Documentation non-breaking Non-breaking change labels Jun 10, 2024
@rlratzel rlratzel added this to the 24.08 milestone Jun 10, 2024
@rlratzel rlratzel self-assigned this Jun 10, 2024
@rlratzel rlratzel requested a review from a team as a code owner June 10, 2024 18:36
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

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.

Your wording is terrific. Thanks for going over it.

Copy link
Contributor

@eriknw eriknw left a comment

Choose a reason for hiding this comment

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

Thanks for jumping on this @rlratzel, these changes are an improvement. I found some typos.

docs/cugraph/source/nx_cugraph/nx_cugraph.md Outdated Show resolved Hide resolved
docs/cugraph/source/nx_cugraph/nx_cugraph.md Outdated Show resolved Hide resolved
docs/cugraph/source/nx_cugraph/nx_cugraph.md Outdated Show resolved Hide resolved
docs/cugraph/source/nx_cugraph/nx_cugraph.md Outdated Show resolved Hide resolved
docs/cugraph/source/nx_cugraph/nx_cugraph.md Outdated Show resolved Hide resolved
notebooks/cugraph_benchmarks/nx_cugraph_benchmark.ipynb Outdated Show resolved Hide resolved
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.

Looks good

@rlratzel rlratzel requested a review from a team as a code owner July 1, 2024 17:55
@rlratzel rlratzel requested a review from jameslamb July 1, 2024 17:55
Copy link
Contributor

@eriknw eriknw left a comment

Choose a reason for hiding this comment

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

I think this is very close. I have minor formatting nits.

First, I think more things should be hyphenated:

  • command line -> command-line
  • run time -> run-time
  • preconvert -> pre-convert

Second, I think we could link to networkx algos:

Third, is the reference to GTC Spring 2024 supposed to link to something? I'm not sure why it's mentioned if not.

Fourth, why does run_algos use nx.bfs_tree but the message in the notebook says bfs_edges? Is this a typo, or is there something weird going on?

Fifth, the code in the notebook cells could be formatted more nicely. For example, adding spaces between = and +.

notebooks/cugraph_benchmarks/nx_cugraph_benchmark.ipynb Outdated Show resolved Hide resolved
Copy link
Member

@jameslamb jameslamb left a comment

Choose a reason for hiding this comment

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

Packaging changes look OK to me. Hopefully thriftpy2==0.5.2 will be release soon and you'll be able to switch this <= to a !=: Thriftpy/thriftpy2#281 (comment)

…r consistency, includes cell outputs to show benchmark comparison, rewrites explanations in markdown cells.
Copy link
Contributor

@eriknw eriknw left a comment

Choose a reason for hiding this comment

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

I'm looking forward to getting networkx/networkx#7497 in so we can make the warnings less noisy.

@rlratzel
Copy link
Contributor Author

rlratzel commented Jul 2, 2024

/merge

@rapids-bot rapids-bot bot merged commit eab0460 into rapidsai:branch-24.08 Jul 2, 2024
137 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.

[BUG]: Nx-cuGraph caching not working with documentation example
5 participants