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 |
acostadon
left a comment
acostadon
left a comment
There was a problem hiding this comment.
Your wording is terrific. Thanks for going over it.
…el/cugraph into branch-24.08-nxcg_doc_fix
eriknw
left a comment
eriknw
left a comment
There was a problem hiding this comment.
I think this is very close. I have minor formatting nits.
First, I think more things should be hyphenated:
command line->command-linerun time->run-timepreconvert->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 +.
jameslamb
left a comment
jameslamb
left a comment
There was a problem hiding this comment.
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.
eriknw
left a comment
eriknw
left a comment
There was a problem hiding this comment.
I'm looking forward to getting networkx/networkx#7497 in so we can make the warnings less noisy.
|
/merge |
Hi, thriftpy2 v0.5.2 has just been released. And I will release a beta version before every thriftpy2 release to avoid breaks in the future. And if anyone has a test environment and want to test the beta release, they can use |
#4496 introduced a ceiling on `thriftpy2`. Context: #4496 (comment) The bug that ceiling was added to avoid was fixed in v0.5.2 of `thriftpy2`, which was just released (#4478 (comment)). This removes that, adding `!=` constraints to skip the 2 versions that `cugraph` was not compatible with. ## Notes for Reviewers ### Why not a floor? I'm proposing adding `!=` constraints to skip v0.5.0 and v0.5.1 to maximize `cugraph`'s compatibility with other environments... that'd allow it to be used in environments with `thriftpy2<0.5.0` and in environments with `thriftpy2>0.5.2`. Let me know if you'd prefer the simplicity of a floor like `>=0.5.2` instead. Authors: - James Lamb (https://github.com/jameslamb) - Ralph Liu (https://github.com/nv-rliu) Approvers: - Bradley Dice (https://github.com/bdice) - Ralph Liu (https://github.com/nv-rliu) - Rick Ratzel (https://github.com/rlratzel) URL: #4521
6 participants
closes #4466