Skip to content

Commit df49ad7

Browse files
authored
API Doc Namespace Edits + SimpleGraphImpl methods (#2086)
Increases consistency between the API docs and the namespace in which the method can be called from, reducing potential confusion. Ex: cugraph.centrality.betweenness_centrality.betweenness_centrality can now be found as cugraph.betweenness_centrality. Note: both are valid ways of calling the same method. Includes methods and attributes of a graph object once data is loaded (from SimpleGraphImpl), such as number_of_vertices, has_edge, get_two_hops_neighbors, etc. Ready for review. Authors: - https://github.com/betochimas Approvers: - Brad Rees (https://github.com/BradReesWork) URL: #2086
1 parent d947fb9 commit df49ad7

File tree

24 files changed

+217
-105
lines changed

24 files changed

+217
-105
lines changed

docs/cugraph/source/api_docs/centrality.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,15 +10,15 @@ Betweenness Centrality
1010
.. autosummary::
1111
:toctree: api/
1212

13-
cugraph.centrality.betweenness_centrality.betweenness_centrality
14-
cugraph.centrality.betweenness_centrality.edge_betweenness_centrality
13+
cugraph.betweenness_centrality
14+
cugraph.edge_betweenness_centrality
1515

1616
Katz Centrality
1717
---------------
1818
.. autosummary::
1919
:toctree: api/
2020

21-
cugraph.centrality.katz_centrality.katz_centrality
21+
cugraph.katz_centrality
2222

2323
Katz Centrality (MG)
2424
--------------------

docs/cugraph/source/api_docs/community.rst

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -10,39 +10,39 @@ EgoNet
1010
.. autosummary::
1111
:toctree: api/
1212

13-
cugraph.community.egonet.batched_ego_graphs
14-
cugraph.community.egonet.ego_graph
13+
cugraph.batched_ego_graphs
14+
cugraph.ego_graph
1515

1616
Ensemble clustering for graphs (ECG)
1717
------------------------------------
1818
.. autosummary::
1919
:toctree: api/
2020

21-
cugraph.community.ecg.ecg
21+
cugraph.ecg
2222

2323

2424
K-Truss
2525
-------
2626
.. autosummary::
2727
:toctree: api/
2828

29-
cugraph.community.ktruss_subgraph.k_truss
30-
cugraph.community.ktruss_subgraph.ktruss_subgraph
29+
cugraph.k_truss
30+
cugraph.ktruss_subgraph
3131

3232
Leiden
3333
------
3434
.. autosummary::
3535
:toctree: api/
3636

37-
cugraph.community.leiden.leiden
37+
cugraph.leiden
3838

3939

4040
Louvain
4141
-------
4242
.. autosummary::
4343
:toctree: api/
4444

45-
cugraph.community.louvain.louvain
45+
cugraph.louvain
4646

4747

4848
Louvain (MG)
@@ -58,24 +58,24 @@ Spectral Clustering
5858
.. autosummary::
5959
:toctree: api/
6060

61-
cugraph.community.spectral_clustering.analyzeClustering_edge_cut
62-
cugraph.community.spectral_clustering.analyzeClustering_modularity
63-
cugraph.community.spectral_clustering.analyzeClustering_ratio_cut
64-
cugraph.community.spectral_clustering.spectralBalancedCutClustering
65-
cugraph.community.spectral_clustering.spectralModularityMaximizationClustering
61+
cugraph.analyzeClustering_edge_cut
62+
cugraph.analyzeClustering_modularity
63+
cugraph.analyzeClustering_ratio_cut
64+
cugraph.spectralBalancedCutClustering
65+
cugraph.spectralModularityMaximizationClustering
6666

6767

6868
Subgraph Extraction
6969
-------------------
7070
.. autosummary::
7171
:toctree: api/
7272

73-
cugraph.community.subgraph_extraction.subgraph
73+
cugraph.subgraph
7474

7575

7676
Triangle Counting
7777
-----------------
7878
.. autosummary::
7979
:toctree: api/
8080

81-
cugraph.community.triangle_count.triangles
81+
cugraph.triangles

docs/cugraph/source/api_docs/components.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,9 @@ Connected Components
1010
.. autosummary::
1111
:toctree: api/
1212

13-
cugraph.components.connectivity.connected_components
14-
cugraph.components.connectivity.strongly_connected_components
15-
cugraph.components.connectivity.weakly_connected_components
13+
cugraph.connected_components
14+
cugraph.strongly_connected_components
15+
cugraph.weakly_connected_components
1616

1717

1818
Connected Components (MG)

docs/cugraph/source/api_docs/cores.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,12 @@ Core Number
1010
.. autosummary::
1111
:toctree: api/
1212

13-
cugraph.cores.core_number.core_number
13+
cugraph.core_number
1414

1515

1616
K-Core
1717
------
1818
.. autosummary::
1919
:toctree: api/
2020

21-
cugraph.cores.k_core.k_core
21+
cugraph.k_core
Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
====================
2+
Graph Implementation
3+
====================
4+
.. currentmodule:: cugraph.structure.graph_implementation.simpleGraphImpl
5+
6+
7+
Graph Implementation
8+
-------------------------
9+
.. autosummary::
10+
:toctree: api/
11+
12+
view_edge_list
13+
delete_edge_list
14+
view_adj_list
15+
view_transposed_adj_list
16+
delete_adj_list
17+
18+
enable_batch
19+
batch_adjlists
20+
batch_edgelists
21+
batch_enabled
22+
batch_transposed_adjlists
23+
24+
get_two_hop_neighbors
25+
number_of_vertices
26+
number_of_nodes
27+
number_of_edges
28+
in_degree
29+
out_degree
30+
degree
31+
degrees
32+
has_edge
33+
has_node
34+
has_self_loop
35+
edges
36+
nodes
37+
neighbors
38+
vertex_column_size

docs/cugraph/source/api_docs/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ This page provides a list of all publicly accessible modules, methods and classe
1010
:caption: API Documentation
1111

1212
structure
13+
graph_implementation
1314
centrality
1415
community
1516
components

docs/cugraph/source/api_docs/layout.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,5 +10,5 @@ Force Atlas 2
1010
.. autosummary::
1111
:toctree: api/
1212

13-
cugraph.layout.force_atlas2.force_atlas2
13+
cugraph.force_atlas2
1414

docs/cugraph/source/api_docs/linear_assignment.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,4 +10,5 @@ Hungarian
1010
.. autosummary::
1111
:toctree: api/
1212

13-
cugraph.linear_assignment.hungarian
13+
cugraph.hungarian
14+
cugraph.dense_hungarian

docs/cugraph/source/api_docs/link_analysis.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,15 +10,15 @@ HITS
1010
.. autosummary::
1111
:toctree: api/
1212

13-
cugraph.link_analysis.hits.hits
13+
cugraph.hits
1414

1515

1616
Pagerank
1717
--------
1818
.. autosummary::
1919
:toctree: api/
2020

21-
cugraph.link_analysis.pagerank.pagerank
21+
cugraph.pagerank
2222

2323
Pagerank (MG)
2424
-------------

docs/cugraph/source/api_docs/link_prediction.rst

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,17 +10,26 @@ Jaccard Coefficient
1010
.. autosummary::
1111
:toctree: api/
1212

13-
cugraph.link_prediction.jaccard.jaccard
14-
cugraph.link_prediction.jaccard.jaccard_coefficient
15-
cugraph.link_prediction.wjaccard.jaccard_w
13+
cugraph.jaccard
14+
cugraph.jaccard_coefficient
15+
cugraph.jaccard_w
1616

1717

1818
Overlap Coefficient
1919
-------------------
2020
.. autosummary::
2121
:toctree: api/
2222

23-
cugraph.link_prediction.overlap.overlap
24-
cugraph.link_prediction.overlap.overlap_coefficient
25-
cugraph.link_prediction.woverlap.overlap_w
23+
cugraph.overlap
24+
cugraph.overlap_coefficient
25+
cugraph.overlap_w
2626

27+
28+
Sorensen Coefficient
29+
--------------------
30+
.. autosummary::
31+
:toctree: api/
32+
33+
cugraph.sorensen
34+
cugraph.sorensen_coefficient
35+
cugraph.sorensen_w

0 commit comments

Comments
 (0)