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

API Doc Namespace Edits + SimpleGraphImpl methods #2086

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/cugraph/source/api_docs/centrality.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,15 @@ Betweenness Centrality
.. autosummary::
:toctree: api/

cugraph.centrality.betweenness_centrality.betweenness_centrality
cugraph.centrality.betweenness_centrality.edge_betweenness_centrality
cugraph.betweenness_centrality
cugraph.edge_betweenness_centrality

Katz Centrality
---------------
.. autosummary::
:toctree: api/

cugraph.centrality.katz_centrality.katz_centrality
cugraph.katz_centrality

Katz Centrality (MG)
--------------------
Expand Down
28 changes: 14 additions & 14 deletions docs/cugraph/source/api_docs/community.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,39 +10,39 @@ EgoNet
.. autosummary::
:toctree: api/

cugraph.community.egonet.batched_ego_graphs
cugraph.community.egonet.ego_graph
cugraph.batched_ego_graphs
cugraph.ego_graph

Ensemble clustering for graphs (ECG)
------------------------------------
.. autosummary::
:toctree: api/

cugraph.community.ecg.ecg
cugraph.ecg


K-Truss
-------
.. autosummary::
:toctree: api/

cugraph.community.ktruss_subgraph.k_truss
cugraph.community.ktruss_subgraph.ktruss_subgraph
cugraph.k_truss
cugraph.ktruss_subgraph

Leiden
------
.. autosummary::
:toctree: api/

cugraph.community.leiden.leiden
cugraph.leiden


Louvain
-------
.. autosummary::
:toctree: api/

cugraph.community.louvain.louvain
cugraph.louvain


Louvain (MG)
Expand All @@ -58,24 +58,24 @@ Spectral Clustering
.. autosummary::
:toctree: api/

cugraph.community.spectral_clustering.analyzeClustering_edge_cut
cugraph.community.spectral_clustering.analyzeClustering_modularity
cugraph.community.spectral_clustering.analyzeClustering_ratio_cut
cugraph.community.spectral_clustering.spectralBalancedCutClustering
cugraph.community.spectral_clustering.spectralModularityMaximizationClustering
cugraph.analyzeClustering_edge_cut
cugraph.analyzeClustering_modularity
cugraph.analyzeClustering_ratio_cut
cugraph.spectralBalancedCutClustering
cugraph.spectralModularityMaximizationClustering


Subgraph Extraction
-------------------
.. autosummary::
:toctree: api/

cugraph.community.subgraph_extraction.subgraph
cugraph.subgraph


Triangle Counting
-----------------
.. autosummary::
:toctree: api/

cugraph.community.triangle_count.triangles
cugraph.triangles
6 changes: 3 additions & 3 deletions docs/cugraph/source/api_docs/components.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,9 @@ Connected Components
.. autosummary::
:toctree: api/

cugraph.components.connectivity.connected_components
cugraph.components.connectivity.strongly_connected_components
cugraph.components.connectivity.weakly_connected_components
cugraph.connected_components
cugraph.strongly_connected_components
cugraph.weakly_connected_components


Connected Components (MG)
Expand Down
4 changes: 2 additions & 2 deletions docs/cugraph/source/api_docs/cores.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,12 @@ Core Number
.. autosummary::
:toctree: api/

cugraph.cores.core_number.core_number
cugraph.core_number


K-Core
------
.. autosummary::
:toctree: api/

cugraph.cores.k_core.k_core
cugraph.k_core
38 changes: 38 additions & 0 deletions docs/cugraph/source/api_docs/graph_implementation.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
====================
Graph Implementation
====================
.. currentmodule:: cugraph.structure.graph_implementation.simpleGraphImpl


Graph Implementation
-------------------------
.. autosummary::
:toctree: api/

view_edge_list
delete_edge_list
view_adj_list
view_transposed_adj_list
delete_adj_list

enable_batch
batch_adjlists
batch_edgelists
batch_enabled
batch_transposed_adjlists

get_two_hop_neighbors
number_of_vertices
number_of_nodes
number_of_edges
in_degree
out_degree
degree
degrees
has_edge
has_node
has_self_loop
edges
nodes
neighbors
vertex_column_size
1 change: 1 addition & 0 deletions docs/cugraph/source/api_docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ This page provides a list of all publicly accessible modules, methods and classe
:caption: API Documentation

structure
graph_implementation
centrality
community
components
Expand Down
2 changes: 1 addition & 1 deletion docs/cugraph/source/api_docs/layout.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,5 +10,5 @@ Force Atlas 2
.. autosummary::
:toctree: api/

cugraph.layout.force_atlas2.force_atlas2
cugraph.force_atlas2

3 changes: 2 additions & 1 deletion docs/cugraph/source/api_docs/linear_assignment.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,5 @@ Hungarian
.. autosummary::
:toctree: api/

cugraph.linear_assignment.hungarian
cugraph.hungarian
cugraph.dense_hungarian
4 changes: 2 additions & 2 deletions docs/cugraph/source/api_docs/link_analysis.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,15 @@ HITS
.. autosummary::
:toctree: api/

cugraph.link_analysis.hits.hits
cugraph.hits


Pagerank
--------
.. autosummary::
:toctree: api/

cugraph.link_analysis.pagerank.pagerank
cugraph.pagerank

Pagerank (MG)
-------------
Expand Down
21 changes: 15 additions & 6 deletions docs/cugraph/source/api_docs/link_prediction.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,17 +10,26 @@ Jaccard Coefficient
.. autosummary::
:toctree: api/

cugraph.link_prediction.jaccard.jaccard
cugraph.link_prediction.jaccard.jaccard_coefficient
cugraph.link_prediction.wjaccard.jaccard_w
cugraph.jaccard
cugraph.jaccard_coefficient
cugraph.jaccard_w


Overlap Coefficient
-------------------
.. autosummary::
:toctree: api/

cugraph.link_prediction.overlap.overlap
cugraph.link_prediction.overlap.overlap_coefficient
cugraph.link_prediction.woverlap.overlap_w
cugraph.overlap
cugraph.overlap_coefficient
cugraph.overlap_w


Sorensen Coefficient
--------------------
.. autosummary::
:toctree: api/

cugraph.sorensen
cugraph.sorensen_coefficient
cugraph.sorensen_w
4 changes: 2 additions & 2 deletions docs/cugraph/source/api_docs/pylibcugraph.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,5 +11,5 @@ Methods
.. autosummary::
:toctree: api/

pylibcugraph.components.strongly_connected_components
pylibcugraph.components.weakly_connected_components
pylibcugraph.strongly_connected_components
pylibcugraph.weakly_connected_components
2 changes: 1 addition & 1 deletion docs/cugraph/source/api_docs/sampling.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,4 @@ Random Walks
.. autosummary::
:toctree: api/

cugraph.sampling.random_walks.random_walks
cugraph.random_walks
34 changes: 18 additions & 16 deletions docs/cugraph/source/api_docs/structure.rst
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ Adding Data
Graph.add_internal_vertex_id
Graph.add_nodes_from
Graph.clear
Graph.unrenumber

Checks
------
Expand All @@ -52,32 +53,33 @@ Symmetrize
.. autosummary::
:toctree: api/

cugraph.structure.symmetrize.symmetrize
cugraph.structure.symmetrize.symmetrize_ddf
cugraph.structure.symmetrize.symmetrize_df
cugraph.symmetrize
cugraph.symmetrize_ddf
cugraph.symmetrize_df


Conversion from Other Formats
-----------------------------
.. autosummary::
:toctree: api/

cugraph.structure.convert_matrix.from_adjlist
cugraph.structure.convert_matrix.from_cudf_edgelist
cugraph.structure.convert_matrix.from_edgelist
cugraph.structure.convert_matrix.from_numpy_array
cugraph.structure.convert_matrix.from_numpy_matrix
cugraph.structure.convert_matrix.from_pandas_adjacency
cugraph.structure.convert_matrix.from_pandas_edgelist
cugraph.structure.convert_matrix.to_numpy_array
cugraph.structure.convert_matrix.to_numpy_matrix
cugraph.structure.convert_matrix.to_pandas_adjacency
cugraph.structure.convert_matrix.to_pandas_edgelist
cugraph.from_adjlist
cugraph.from_cudf_edgelist
cugraph.from_edgelist
cugraph.from_numpy_array
cugraph.from_numpy_matrix
cugraph.from_pandas_adjacency
cugraph.from_pandas_edgelist
cugraph.to_numpy_array
cugraph.to_numpy_matrix
cugraph.to_pandas_adjacency
cugraph.to_pandas_edgelist

Other
-----------------------------
.. autosummary::
:toctree: api/

Graph.unrenumber
cugraph.structure.hypergraph.hypergraph
cugraph.hypergraph
cugraph.structure.shuffle
cugraph.structure.NumberMap
12 changes: 6 additions & 6 deletions docs/cugraph/source/api_docs/traversal.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ Breadth-first-search
.. autosummary::
:toctree: api/

cugraph.traversal.bfs.bfs
cugraph.traversal.bfs.bfs_edges
cugraph.bfs
cugraph.bfs_edges

Breadth-first-search (MG)
-------------------------
Expand All @@ -26,10 +26,10 @@ Single-source-shortest-path
.. autosummary::
:toctree: api/

cugraph.traversal.sssp.filter_unreachable
cugraph.traversal.sssp.shortest_path
cugraph.traversal.sssp.shortest_path_length
cugraph.traversal.sssp.sssp
cugraph.filter_unreachable
cugraph.shortest_path
cugraph.shortest_path_length
cugraph.sssp

Single-source-shortest-path (MG)
--------------------------------
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -62,8 +62,7 @@ def betweenness_centrality(
defined as a list will be used assources for traversals inside the
algorithm.

normalized : bool, optional
Default is True.
normalized : bool, optional (default=True)
If true, the betweenness values are normalized by
__2 / ((n - 1) * (n - 2))__ for undirected Graphs, and
__1 / ((n - 1) * (n - 2))__ for directed Graphs
Expand Down Expand Up @@ -185,7 +184,6 @@ def edge_betweenness_centrality(
sources for traversals inside the algorithm.

normalized : bool, optional (default=True)
Default is True.
If true, the betweenness values are normalized by
2 / (n * (n - 1)) for undirected Graphs, and
1 / (n * (n - 1)) for directed Graphs
Expand Down
Loading