-
Notifications
You must be signed in to change notification settings - Fork 293
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
Doc cleanup for nx-cugraph: fixed typos, cleaned up various descriptions, renamed notebook to match naming convetion. #4478
Conversation
…ons, renamed notebook to match naming convetion.
Check out this pull request on See visual diffs & provide feedback on Jupyter Notebooks. Powered by ReviewNB |
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.
Your wording is terrific. Thanks for going over it.
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 for jumping on this @rlratzel, these changes are an improvement. I found some typos.
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
…el/cugraph into branch-24.08-nxcg_doc_fix
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.
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:
- https://networkx.org/documentation/stable/reference/algorithms/generated/networkx.algorithms.centrality.betweenness_centrality.html
- https://networkx.org/documentation/stable/reference/algorithms/generated/networkx.algorithms.traversal.breadth_first_search.bfs_tree.html
- https://networkx.org/documentation/stable/reference/algorithms/generated/networkx.algorithms.community.louvain.louvain_communities.html
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 +
.
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.
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.
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.
I'm looking forward to getting networkx/networkx#7497 in so we can make the warnings less noisy.
/merge |
closes #4466