Documentation and testing improvements

[betochimas]

In 22.02, this began as a list of documentation/example/testing-related issues, and in 22.06, was updated to include issues found in releases 22.02 and 22.04.

It's now an epic, and previous issues listed will have been moved to more digestable issues.

Examples

Broken examples / Examples to revisit

• cugraph.structure.symmetrize.symmetrize_ddf
• cugraph.tree.minimum_spanning.tree.minimum_spanning_tree (PR 2256 will resolve this)
• cugraph.tree.minimum_spanning.tree.maximum_spanning_tree (PR 2256 will resolve this)

Documentation

MNMG Client Helper

• Multiple helper callables are used for MNMG algorithms, including rmat, bfs, sssp, wcc, katz_centrality, nbr_sampling. They are all labeled as 'call_xxx', where xxx could be rmat, hits, etc. All except rmat, hits, nbr_sampling are on the html docs, so would they rather be on there, or removed and hidden like it is for rmat?
• Include remaining MNMG 'call' helpers, akak rmat, hits, nbr_sampling, pagerank to docs
  OR
• Remove existing MNMG 'call' helpers, aka bfs, sssp, wcc, katz_centrality from docs (PR 2194)

Methods missing from html docs

• Methods from cugraph.structure.number_map.NumberMap (to_internal_vertex_id, add_internal_vertex_id, from_internal_vertex_id, renumber_and_segment, renumber) (PR 2194)
• Methods from cugraph.structure.property_graph.PropertyGraph (can be put in experimental section when ready)
• Methods from cugraph.structure.graph_implementation.simpleGraph.simpleGraphImpl (to_pandas_edgelist, to_pandas_adjacency, to_numpy_array, to_numpy_matrix, view_edge_list, delete_edge_list, view_adj_list, view_transposed_adj_list, get_two_hop_neighbors, number_of_vertices, number_of_nodes, number_of_edges, in_degree, out_degree, degree, degrees, has_node, has_edge, has_self_loop, edges, nodes, neighbors, vertex_column_size) (PR 2086)

Not implemented/supported

Arguments currented not supported

• centrality/betweenness_centrality.py
  • weight from betweenness_centrality
  • endpoint from betweenness_centrality
  • weight from edge_betweenness_centrality
• centrality/katz_centrality.py
  • beta from katz_centrality
• community/egonet.py
  • center=False (True is supported) from batched_ego_graphs
  • undirected=True (False is supported) from batched_ego_graphs
  • distance from batched_ego_graphs
• dask/centrality/katz_centrality.py
  • beta from katz_centrality
• link_analysis/hits.py
  • nstart from hits
  • normalized from hits
• traversal/bfs.py
  • reverse from bfs_edges
  • sort_neighbors from bfs_edges

Methods currently not supported

• concurrent_bfs from traversal/ms_bfs.py
• multi_source_bfs from traversal/ms_bfs.py

FIXMEs

Design/implementation orientated FIXMEs

• cugraph.comms.comms.get_n_workers ln:212
• cugraph.community.ktruss_subgraph.k_truss ln:80
• Multiple from cugraph.structure.graph_implementation.simpleGraph.simpleGraphImpl

[betochimas]

This issue will shift into an epic-style issue for 22.06 release, starting back from the 22.02 cycle. Resolved bullets will have a PR issue attached to it, and if continued into 22.08, then unresolved bullets could be moved into next cycle's issue

[betochimas]

This EPIC lists some algorithms are missing support for certain parameters/methods, as well as some design-oriented FIXMEs. Overall, this EPIC is quite disjoint, and could be better broken apart into a few issues. Some progress was made on this EPIC but still incomplete.

[github-actions]

This issue has been labeled inactive-30d due to no recent activity in the past 30 days. Please close this issue if no further response or action is needed. Otherwise, please respond with a comment indicating any updates or changes to the original issue and/or confirm this issue still needs to be addressed. This issue will be labeled inactive-90d if there is no activity in the next 60 days.