From bd54c0046fff1be87850d6be09966ffb5d2703ed Mon Sep 17 00:00:00 2001 From: BradReesWork Date: Sun, 17 Sep 2023 10:27:20 -0400 Subject: [PATCH] C++ rst files --- cpp/include/cugraph/algorithms.hpp | 66 ++++++++++++++++++- .../api_docs/cugraph_cpp/centrality.rst | 45 ++----------- .../source/api_docs/cugraph_cpp/community.rst | 57 ++-------------- .../api_docs/cugraph_cpp/components.rst | 10 +++ .../source/api_docs/cugraph_cpp/core.rst | 18 +++-- .../source/api_docs/cugraph_cpp/index.rst | 5 +- .../source/api_docs/cugraph_cpp/labeling.rst | 13 ---- .../source/api_docs/cugraph_cpp/layoyt.rst | 12 ++++ .../cugraph_cpp/linear_assignment.rst | 12 ++++ .../source/api_docs/cugraph_cpp/sampling.rst | 34 ++-------- .../api_docs/cugraph_cpp/similarity.rst | 21 ++---- .../source/api_docs/cugraph_cpp/traversal.rst | 25 ++----- .../source/api_docs/cugraph_cpp/tree.rst | 10 +++ 13 files changed, 151 insertions(+), 177 deletions(-) create mode 100644 docs/cugraph/source/api_docs/cugraph_cpp/components.rst delete mode 100644 docs/cugraph/source/api_docs/cugraph_cpp/labeling.rst create mode 100644 docs/cugraph/source/api_docs/cugraph_cpp/layoyt.rst create mode 100644 docs/cugraph/source/api_docs/cugraph_cpp/linear_assignment.rst create mode 100644 docs/cugraph/source/api_docs/cugraph_cpp/tree.rst diff --git a/cpp/include/cugraph/algorithms.hpp b/cpp/include/cugraph/algorithms.hpp index 6bab7bfc2fe..cbabe4a565a 100644 --- a/cpp/include/cugraph/algorithms.hpp +++ b/cpp/include/cugraph/algorithms.hpp @@ -39,9 +39,23 @@ /** @ingroup cpp_api */ +/** + * @defgroup assignmentCPP + * @defgroup centralityCPP + * @defgroup communityCPP + * @defgroup coreCPP + * @defgroup labelingCPP + * @defgroup placementCPP + * @defgroup samplingCPP + * @defgroup similarityCPP + * @defgroup traversalCPP + * @defgroup treeCPP + */ + namespace cugraph { /** + * @ingroup similarityCPP * @brief Compute jaccard similarity coefficient for all vertices * * Computes the Jaccard similarity coefficient for every pair of vertices in the graph @@ -63,6 +77,7 @@ template void jaccard(legacy::GraphCSRView const& graph, WT const* weights, WT* result); /** + * @ingroup similarityCPP * @brief Compute jaccard similarity coefficient for selected vertex pairs * * Computes the Jaccard similarity coefficient for each pair of specified vertices. @@ -92,6 +107,7 @@ void jaccard_list(legacy::GraphCSRView const& graph, WT* result); /** + * @ingroup similarityCPP * @brief Compute overlap coefficient for all vertices in the graph * * Computes the Overlap Coefficient for every pair of vertices in the graph which are @@ -113,6 +129,7 @@ template void overlap(legacy::GraphCSRView const& graph, WT const* weights, WT* result); /** + * @ingroup similarityCPP * @brief Compute overlap coefficient for select pairs of vertices * * Computes the overlap coefficient for each pair of specified vertices. @@ -142,7 +159,7 @@ void overlap_list(legacy::GraphCSRView const& graph, WT* result); /** - * +* @defgroup placementCPP * @brief ForceAtlas2 is a continuous graph layout algorithm * for handy network visualization. * @@ -215,6 +232,7 @@ void force_atlas2(raft::handle_t const& handle, internals::GraphBasedDimRedCallback* callback = nullptr); /** + * @ingroup centralityCPP * @brief Compute betweenness centrality for a graph * * Betweenness centrality for a vertex is the sum of the fraction of @@ -262,6 +280,7 @@ void betweenness_centrality(const raft::handle_t& handle, vertex_t const* vertices = nullptr); /** + * @ingroup centralityCPP * @brief Compute edge betweenness centrality for a graph * * Betweenness centrality of an edge is the sum of the fraction of all-pairs shortest paths that @@ -305,6 +324,7 @@ void edge_betweenness_centrality(const raft::handle_t& handle, vertex_t const* vertices = nullptr); /** + * @ingroup centralityCPP * @brief Compute betweenness centrality for a graph * * Betweenness centrality for a vertex is the sum of the fraction of @@ -349,6 +369,7 @@ rmm::device_uvector betweenness_centrality( bool const do_expensive_check = false); /** + * @ingroup centralityCPP * @brief Compute edge betweenness centrality for a graph * * Betweenness centrality of an edge is the sum of the fraction of all-pairs shortest paths that @@ -395,6 +416,7 @@ enum class cugraph_cc_t { }; /** + * @defgroup labelingCPP * @brief Compute connected components. * * The weak version (for undirected graphs, only) was imported from cuML. @@ -429,6 +451,7 @@ void connected_components(legacy::GraphCSRView const& graph, VT* labels); /** + * @ingroup communityCPP * @brief Compute k truss for a graph * * K Truss is the maximal subgraph of a graph which contains at least three @@ -462,6 +485,7 @@ std::unique_ptr> k_truss_subgraph( // template uses data from VT, ET, WT from the legacy::GraphCSR View even if weights // are not considered /** + * @ingroup traversalCPP * @Synopsis Performs a breadth first search traversal of a graph starting from a vertex. * * @throws cugraph::logic_error with a custom message when an error occurs. @@ -504,6 +528,7 @@ void bfs(raft::handle_t const& handle, bool mg_batch = false); /** + * @ingroup assignmentCPP * @brief Compute Hungarian algorithm on a weighted bipartite graph * * The Hungarian algorithm computes an assigment of "jobs" to "workers". This function accepts @@ -536,6 +561,7 @@ weight_t hungarian(raft::handle_t const& handle, vertex_t* assignments); /** + * @ingroup assignmentCPP * @brief Compute Hungarian algorithm on a weighted bipartite graph * * The Hungarian algorithm computes an assigment of "jobs" to "workers". This function accepts @@ -570,6 +596,7 @@ weight_t hungarian(raft::handle_t const& handle, weight_t epsilon); /** + * @ingroup communityCPP * @brief Louvain implementation * * Compute a clustering of the graph by maximizing modularity @@ -620,6 +647,7 @@ std::pair louvain( weight_t resolution = weight_t{1}); /** + * @ingroup communityCPP * @brief Louvain implementation, returning dendrogram * * Compute a clustering of the graph by maximizing modularity @@ -658,6 +686,7 @@ std::pair>, weight_t> louvain( weight_t resolution = weight_t{1}); /** + * @ingroup communityCPP * @brief Flatten a Dendrogram at a particular level * * A Dendrogram represents a hierarchical clustering/partitioning of @@ -682,6 +711,7 @@ void flatten_dendrogram(raft::handle_t const& handle, typename graph_view_t::vertex_type* clustering); /** + * @ingroup communityCPP * @brief Leiden implementation * * Compute a clustering of the graph by maximizing modularity using the Leiden improvements @@ -734,6 +764,7 @@ std::pair>, weight_t> leiden( weight_t theta = weight_t{1}); /** + * @ingroup communityCPP * @brief Leiden implementation * * Compute a clustering of the graph by maximizing modularity using the Leiden improvements @@ -787,6 +818,7 @@ std::pair leiden( weight_t theta = weight_t{1}); /** + * @ingroup communityCPP * @brief Computes the ecg clustering of the given graph. * * ECG runs truncated Louvain on an ensemble of permutations of the input graph, @@ -819,6 +851,7 @@ void ecg(raft::handle_t const& handle, vertex_t* clustering); /** + * @ingroup treeCPP * @brief Generate edges in a minimum spanning forest of an undirected weighted graph. * * A minimum spanning tree is a subgraph of the graph (a tree) with the minimum sum of edge weights. @@ -871,6 +904,7 @@ std::unique_ptr> extract_subgraph_vertex( } // namespace subgraph /** + * @ingroup communityCPP * @brief Wrapper function for Nvgraph balanced cut clustering * * @throws cugraph::logic_error when an error occurs. @@ -904,6 +938,7 @@ void balancedCutClustering(legacy::GraphCSRView const& graph, VT* clustering); /** + * @ingroup communityCPP * @brief Wrapper function for Nvgraph spectral modularity maximization algorithm * * @throws cugraph::logic_error when an error occurs. @@ -935,6 +970,7 @@ void spectralModularityMaximization(legacy::GraphCSRView const& grap VT* clustering); /** + * @ingroup communityCPP * @brief Wrapper function for Nvgraph clustering modularity metric * * @throws cugraph::logic_error when an error occurs. @@ -979,6 +1015,7 @@ void analyzeClustering_edge_cut(legacy::GraphCSRView const& graph, WT* score); /** + * @ingroup communityCPP * @brief Wrapper function for Nvgraph clustering ratio cut metric * * @throws cugraph::logic_error when an error occurs. @@ -1004,6 +1041,7 @@ void analyzeClustering_ratio_cut(legacy::GraphCSRView const& graph, namespace dense { /** + * @ingroup assignmentCPP * @brief Compute Hungarian algorithm on a weighted bipartite graph * * The Hungarian algorithm computes an assigment of "jobs" to "workers". This function accepts @@ -1067,6 +1105,7 @@ weight_t hungarian(raft::handle_t const& handle, } // namespace dense /** + * @ingroup traversalCPP * @brief Run breadth-first search to find the distances (and predecessors) from the source * vertex. * @@ -1109,6 +1148,7 @@ void bfs(raft::handle_t const& handle, bool do_expensive_check = false); /** + * @ingroup traversalCPP * @brief Extract paths from breadth-first search output * * This function extracts paths from the BFS output. BFS outputs distances @@ -1146,6 +1186,7 @@ std::tuple, vertex_t> extract_bfs_paths( size_t n_destinations); /** + * @ingroup traversalCPP * @brief Run single-source shortest-path to compute the minimum distances (and predecessors) from * the source vertex. * @@ -1183,6 +1224,7 @@ void sssp(raft::handle_t const& handle, bool do_expensive_check = false); /* + * @ingroup traversalCPP * @brief Compute the shortest distances from the given origins to all the given destinations. * * This algorithm is designed for large diameter graphs. For small diameter graphs, running the @@ -1222,6 +1264,7 @@ rmm::device_uvector od_shortest_distances( bool do_expensive_check = false); /** + * @ingroup centralityCPP * @brief Compute PageRank scores. * * @deprecated This API will be deprecated to replaced by the new version below @@ -1283,6 +1326,7 @@ void pagerank(raft::handle_t const& handle, bool do_expensive_check = false); /** + * @ingroup centralityCPP * @brief Metadata about the execution of one of the centrality algorithms */ // FIXME: This structure should be propagated to other algorithms that converge @@ -1294,6 +1338,7 @@ struct centrality_algorithm_metadata_t { }; /** + * @ingroup centralityCPP * @brief Compute PageRank scores. * * This function computes general (if @p personalization_vertices is `nullptr`) or personalized (if @@ -1351,6 +1396,7 @@ std::tuple, centrality_algorithm_metadata_t> pager bool do_expensive_check = false); /** + * @ingroup centralityCPP * @brief Compute Eigenvector Centrality scores. * * This function computes eigenvector centrality scores using the power method. @@ -1388,6 +1434,7 @@ rmm::device_uvector eigenvector_centrality( bool do_expensive_check = false); /** + * @ingroup centralityCPP * @brief Compute HITS scores. * * This function computes HITS scores for the vertices of a graph @@ -1427,6 +1474,7 @@ std::tuple hits(raft::handle_t const& handle, bool do_expensive_check); /** + * @ingroup centralityCPP * @brief Compute Katz Centrality scores. * * This function computes Katz Centrality scores. @@ -1479,6 +1527,7 @@ void katz_centrality(raft::handle_t const& handle, bool do_expensive_check = false); /** + * @ingroup samplingCPP * @brief returns induced EgoNet subgraph(s) of neighbors centered at nodes in source_vertex within * a given radius. * @@ -1514,6 +1563,7 @@ extract_ego(raft::handle_t const& handle, vertex_t radius); /** + * @ingroup samplingCPP * @brief returns induced EgoNet subgraph(s) of neighbors centered at nodes in source_vertex within * a given radius. * @@ -1547,6 +1597,7 @@ extract_ego(raft::handle_t const& handle, bool do_expensive_check = false); /** + * @ingroup samplingCPP * @brief returns random walks (RW) from starting sources, where each path is of given maximum * length. Uniform distribution is assumed for the random engine. * @@ -1591,6 +1642,7 @@ std:: std::unique_ptr sampling_strategy = nullptr); /** + * @ingroup samplingCPP * @brief returns uniform random walks from starting sources, where each path is of given * maximum length. * @@ -1636,6 +1688,7 @@ uniform_random_walks(raft::handle_t const& handle, uint64_t seed = std::numeric_limits::max()); /** + * @ingroup samplingCPP * @brief returns biased random walks from starting sources, where each path is of given * maximum length. * @@ -1680,6 +1733,7 @@ biased_random_walks(raft::handle_t const& handle, uint64_t seed = std::numeric_limits::max()); /** + * @ingroup samplingCPP * @brief returns biased random walks with node2vec biases from starting sources, * where each path is of given maximum length. * @@ -1730,6 +1784,7 @@ node2vec_random_walks(raft::handle_t const& handle, #ifndef NO_CUGRAPH_OPS /** + * @ingroup samplingCPP * @brief generate sub-sampled graph as an adjacency list (CSR format) given input graph, * list of vertices and sample size per vertex. The output graph consists of the given * vertices with each vertex having at most `sample_size` neighbors from the original graph @@ -1760,6 +1815,7 @@ sample_neighbors_adjacency_list(raft::handle_t const& handle, ops::graph::SamplingAlgoT sampling_algo); /** + * @ingroup samplingCPP * @brief generate sub-sampled graph as an edge list (COO format) given input graph, * list of vertices and sample size per vertex. The output graph consists of the given * vertices with each vertex having at most `sample_size` neighbors from the original graph @@ -1791,6 +1847,7 @@ std::tuple, rmm::device_uvector> sample_ #endif /** + * @ingroup labelingCPP * @brief Finds (weakly-connected-)component IDs of each vertices in the input graph. * * The input graph must be symmetric. Component IDs can be arbitrary integers (they can be @@ -1819,6 +1876,7 @@ void weakly_connected_components(raft::handle_t const& handle, enum class k_core_degree_type_t { IN = 0, OUT = 1, INOUT = 2 }; /** + * @ingroup coreCPP * @brief Compute core numbers of individual vertices from K-core decomposition. * * The input graph should not have self-loops nor multi-edges. Currently, only undirected graphs are @@ -1850,6 +1908,7 @@ void core_number(raft::handle_t const& handle, bool do_expensive_check = false); /** + * @ingroup coreCPP * @brief Extract K Core of a graph * * @throws cugraph::logic_error when an error occurs. @@ -1894,6 +1953,7 @@ k_core(raft::handle_t const& handle, enum class prior_sources_behavior_t { DEFAULT = 0, CARRY_OVER, EXCLUDE }; /** + * @ingroup samplingCPP * @brief Uniform Neighborhood Sampling. * * This function traverses from a set of starting vertices, traversing outgoing edges and @@ -1992,6 +2052,7 @@ uniform_neighbor_sample( bool do_expensive_check = false); /* + * @ingroup communityCPP * @brief Compute triangle counts. * * Compute triangle counts for the entire set of vertices (if @p vertices is std::nullopt) or the @@ -2018,6 +2079,7 @@ void triangle_count(raft::handle_t const& handle, bool do_expensive_check = false); /** + * @ingroup similarityCPP * @brief Compute Jaccard similarity coefficient * * Similarity is computed for every pair of vertices specified. Note that @@ -2049,6 +2111,7 @@ rmm::device_uvector jaccard_coefficients( bool do_expensive_check = false); /** + * @ingroup similarityCPP * @brief Compute Sorensen similarity coefficient * * Similarity is computed for every pair of vertices specified. Note that @@ -2081,6 +2144,7 @@ rmm::device_uvector sorensen_coefficients( bool do_expensive_check = false); /** + * @ingroup similarityCPP * @brief Compute overlap similarity coefficient * * Similarity is computed for every pair of vertices specified. Note that diff --git a/docs/cugraph/source/api_docs/cugraph_cpp/centrality.rst b/docs/cugraph/source/api_docs/cugraph_cpp/centrality.rst index bd7933176a9..a23b7e22d43 100644 --- a/docs/cugraph/source/api_docs/cugraph_cpp/centrality.rst +++ b/docs/cugraph/source/api_docs/cugraph_cpp/centrality.rst @@ -1,45 +1,12 @@ Centrality ========== -PageRank --------- -.. doxygenfunction:: cugraph::pagerank - :project: libcugraph +Centrality Functions +-------------------- + .. doxygengroup:: centralityCPP + :project: libcugraph + :members: + :content-only: -.. doxygenfunction:: cugraph::pagerank_allow_nonconvergence - :project: libcugraph - -Personalized PageRank ---------------------- -.. doxygenfunction:: cugraph::personalized_pagerank - :project: libcugraph - -.. doxygenfunction:: cugraph::personalized_pagerank_allow_nonconvergence - :project: libcugraph - -Eigenvector Centrality ----------------------- -.. doxygenfunction:: cugraph::eigenvector_centrality - :project: libcugraph - -Katz Centrality ---------------- -.. doxygenfunction:: cugraph::katz_centrality - :project: libcugraph - -Betweenness Centrality ----------------------- -.. doxygenfunction:: cugraph::betweenness_centrality - :project: libcugraph - -Edge Betweenness Centrality ---------------------------- -.. doxygenfunction:: cugraph::edge_betweenness_centrality - :project: libcugraph - -HITS Centrality ---------------- -.. doxygenfunction:: cugraph::hits - :project: libcugraph diff --git a/docs/cugraph/source/api_docs/cugraph_cpp/community.rst b/docs/cugraph/source/api_docs/cugraph_cpp/community.rst index ea267cf0922..461ed9f94c1 100644 --- a/docs/cugraph/source/api_docs/cugraph_cpp/community.rst +++ b/docs/cugraph/source/api_docs/cugraph_cpp/community.rst @@ -1,56 +1,11 @@ Community ========= -.. role:: C++(code) - :language: cpp - :class: highlight - ``#include `` -Triangle Counting ------------------ -.. doxygenfunction:: cugraph::triangle_count - :project: libcugraph - -Louvain -------- -.. doxygenfunction:: cugraph::louvain - :project: libcugraph - -Leiden ------- -.. doxygenfunction:: cugraph::leiden - :project: libcugraph - -ECG ---- -.. doxygenfunction:: cugraph::ecg - :project: libcugraph - -Extract Egonet --------------- -.. doxygenfunction:: cugraph::extract_ego - :project: libcugraph - -Balanced Cut ------------- -.. doxygenfunction:: cugraph::balanced_cut_clustering - :project: libcugraph - -Spectral Clustering - Modularity Maximization ---------------------------------------------- -.. doxygenfunction:: cugraph::spectral_modularity_maximization - :project: libcugraph - -.. doxygenfunction:: cugraph::analyze_clustering_modularity - :project: libcugraph - -Spectral Clusteriong - Edge Cut -------------------------------- -.. doxygenfunction:: cugraph::analyze_clustering_edge_cut - :project: libcugraph - -.. doxygenfunction:: cugraph::analyze_clustering_ratio_cut - :project: libcugraph - - +Community Functions +------------------- + .. doxygengroup:: communityCPP + :project: libcugraph + :members: + :content-only: diff --git a/docs/cugraph/source/api_docs/cugraph_cpp/components.rst b/docs/cugraph/source/api_docs/cugraph_cpp/components.rst new file mode 100644 index 00000000000..3baa7cfe44a --- /dev/null +++ b/docs/cugraph/source/api_docs/cugraph_cpp/components.rst @@ -0,0 +1,10 @@ +Components +========== + + +Components Functions +-------------------- + .. doxygengroup:: labelingCPP + :project: libcugraph + :members: + :content-only: \ No newline at end of file diff --git a/docs/cugraph/source/api_docs/cugraph_cpp/core.rst b/docs/cugraph/source/api_docs/cugraph_cpp/core.rst index acd5fa1f878..f265f6e4283 100644 --- a/docs/cugraph/source/api_docs/cugraph_cpp/core.rst +++ b/docs/cugraph/source/api_docs/cugraph_cpp/core.rst @@ -1,14 +1,12 @@ Core ==== - -Core Number ------------ -.. doxygenfunction:: cugraph::core_number - :project: libcugraph - -K-Core ------- -.. doxygenfunction:: cugraph::k_core - :project: libcugraph +``#include `` + +Core Functions +-------------- + .. doxygengroup:: coreCPP + :project: libcugraph + :members: + :content-only: diff --git a/docs/cugraph/source/api_docs/cugraph_cpp/index.rst b/docs/cugraph/source/api_docs/cugraph_cpp/index.rst index 3594369ddf6..322e0da0ae9 100644 --- a/docs/cugraph/source/api_docs/cugraph_cpp/index.rst +++ b/docs/cugraph/source/api_docs/cugraph_cpp/index.rst @@ -9,8 +9,11 @@ cuGraph C++ API documentation centrality.rst community.rst + components.rst core.rst - labeling.rst + layout.rst + linear_assignment.rst sampling.rst similarity.rst traversal.rst + tree.rst diff --git a/docs/cugraph/source/api_docs/cugraph_cpp/labeling.rst b/docs/cugraph/source/api_docs/cugraph_cpp/labeling.rst deleted file mode 100644 index 9287665b4f2..00000000000 --- a/docs/cugraph/source/api_docs/cugraph_cpp/labeling.rst +++ /dev/null @@ -1,13 +0,0 @@ -Components -========== - - -Weakly Connected Components ---------------------------- -.. doxygenfunction:: cugraph::weakly_connected_components - :project: libcugraph - -Strongly Connected Components ------------------------------ -.. doxygenfunction:: cugraph::strongly_connected_components - :project: libcugraph diff --git a/docs/cugraph/source/api_docs/cugraph_cpp/layoyt.rst b/docs/cugraph/source/api_docs/cugraph_cpp/layoyt.rst new file mode 100644 index 00000000000..1df0a2b12bc --- /dev/null +++ b/docs/cugraph/source/api_docs/cugraph_cpp/layoyt.rst @@ -0,0 +1,12 @@ +Core +==== + +``#include `` + +Core Functions +-------------- + .. doxygengroup:: placementCPP + :project: libcugraph + :members: + :content-only: + diff --git a/docs/cugraph/source/api_docs/cugraph_cpp/linear_assignment.rst b/docs/cugraph/source/api_docs/cugraph_cpp/linear_assignment.rst new file mode 100644 index 00000000000..ca923135da3 --- /dev/null +++ b/docs/cugraph/source/api_docs/cugraph_cpp/linear_assignment.rst @@ -0,0 +1,12 @@ +Linear Assignment +================= + +Linear Assignment Functions +--------------------------- + .. doxygengroup:: assignmentCPP + :project: libcugraph + :members: + :content-only: + + + diff --git a/docs/cugraph/source/api_docs/cugraph_cpp/sampling.rst b/docs/cugraph/source/api_docs/cugraph_cpp/sampling.rst index 37757b8b42c..9f394d90ed6 100644 --- a/docs/cugraph/source/api_docs/cugraph_cpp/sampling.rst +++ b/docs/cugraph/source/api_docs/cugraph_cpp/sampling.rst @@ -1,31 +1,9 @@ Sampling ======== -Uniform Random Walks --------------------- -.. doxygenfunction:: cugraph::uniform_random_walks - :project: libcugraph - -Biased Random Walks --------------------- -.. doxygenfunction:: cugraph::biased_random_walks - :project: libcugraph - -Random Walks via Node2Vec -------------------------- -.. doxygenfunction:: cugraph::node2vec_random_walks - :project: libcugraph - -Node2Vec --------- -.. doxygenfunction:: cugraph::node2vec - :project: libcugraph - -Uniform Neighborhood Sampling ------------------------------ -.. doxygenfunction:: cugraph::uniform_neighbor_sample_with_edge_properties - :project: libcugraph - -.. doxygenfunction:: cugraph::uniform_neighbor_sample - :project: libcugraph - +Sampling Functions +------------------ + .. doxygengroup:: samplingCPPs + :project: libcugraph + :members: + :content-only: diff --git a/docs/cugraph/source/api_docs/cugraph_cpp/similarity.rst b/docs/cugraph/source/api_docs/cugraph_cpp/similarity.rst index 19faa14abcb..83a9d694e5e 100644 --- a/docs/cugraph/source/api_docs/cugraph_cpp/similarity.rst +++ b/docs/cugraph/source/api_docs/cugraph_cpp/similarity.rst @@ -1,18 +1,9 @@ Similarity ========== - -Jaccard -------- -.. doxygenfunction:: cugraph::jaccard_coefficients - :project: libcugraph - -Sorensen --------- -.. doxygenfunction:: cugraph::sorensen_coefficients - :project: libcugraph - -Overlap -------- -.. doxygenfunction:: cugraph::overlap_coefficients - :project: libcugraph +Similarity Functions +-------------------- + .. doxygengroup:: similarityCPP + :project: libcugraph + :members: + :content-only: diff --git a/docs/cugraph/source/api_docs/cugraph_cpp/traversal.rst b/docs/cugraph/source/api_docs/cugraph_cpp/traversal.rst index 3cec1f9a1e7..8bc3e63f26e 100644 --- a/docs/cugraph/source/api_docs/cugraph_cpp/traversal.rst +++ b/docs/cugraph/source/api_docs/cugraph_cpp/traversal.rst @@ -2,22 +2,9 @@ Traversal ========== -Breadth First Search (BFS) --------------------------- -.. doxygenfunction:: cugraph::bfs - :project: libcugraph - -Single-Source Shortest-Path (SSSP) ----------------------------------- -.. doxygenfunction:: cugraph::sssp - :project: libcugraph - -Path Extraction ---------------- -.. doxygenfunction:: cugraph::extract_paths - :project: libcugraph - -Extract Max Path Length ------------------------ -.. doxygenfunction:: cugraph::extract_paths_result_get_max_path_length - :project: libcugraph +Traversal Functions +------------------- + .. doxygengroup:: traversalCPP + :project: libcugraph + :members: + :content-only: diff --git a/docs/cugraph/source/api_docs/cugraph_cpp/tree.rst b/docs/cugraph/source/api_docs/cugraph_cpp/tree.rst new file mode 100644 index 00000000000..731bd085065 --- /dev/null +++ b/docs/cugraph/source/api_docs/cugraph_cpp/tree.rst @@ -0,0 +1,10 @@ +Tree +==== + + +Tree Functions +-------------- + .. doxygengroup:: treeCPP + :project: libcugraph + :members: + :content-only: