Skip to content

Commit

Permalink
more granularity in the cpp api
Browse files Browse the repository at this point in the history
  • Loading branch information
acostadon committed Jan 17, 2025
1 parent 2154e4b commit dc5153c
Show file tree
Hide file tree
Showing 12 changed files with 55 additions and 24 deletions.
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Component
=========
Components
==========

.. doxygengroup:: component_cpp
.. doxygengroup:: components_cpp
:project: libcugraph
:members:
:content-only:

This file was deleted.

Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Centrality
==========
Utility Functions
=================

.. doxygengroup:: utility_cpp
:project: libcugraph
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@ Algorithmns
algorithms/sampling_cpp.rst
algorithms/similarity_cpp.rst
algorithms/traversal_cpp.rst
algorithms/labeling_cpp.rst
algorithms/linear_cpp.rst
algorithms/link_analysis_cpp.rst
algorithms/layout_cpp.rst
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
Collection Wrappers
===============

.. doxygengroup:: collect_comm_wrapper_cpp
:project: libcugraph
:members:
:content-only:
6 changes: 3 additions & 3 deletions docs/cugraph-docs/source/api_docs/cugraph_cpp/full_api.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
====================
Full cuGraph C++ API
====================
=========================
Low Level cuGraph C++ API
=========================

.. doxygennamespace:: cugraph
:members:
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
Graph Functions
===============

.. doxygengroup:: graph_functions_cpp
:project: libcugraph
:members:
:content-only:
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
Graph Generators
================

.. doxygengroup:: graph_generators_cpp
:project: libcugraph
:members:
:content-only:
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
Sampling Functions
==================

.. doxygengroup:: sampling_functions_cpp
:project: libcugraph
:members:
:content-only:
10 changes: 7 additions & 3 deletions docs/cugraph-docs/source/api_docs/cugraph_cpp/index.rst
Original file line number Diff line number Diff line change
@@ -1,11 +1,15 @@
=============================
cuGraph C++ API documentation
=============================
===============
cuGraph C++ API
===============


.. toctree::
:maxdepth: 2
:caption: API Documentation

algorithms_cpp.rst
graph_functions_cpp.rst
graph_generators_cpp.rst
graph_sampling_cpp.rst
collect_comm_wrapper_cpp.rst
full_api.rst
10 changes: 5 additions & 5 deletions docs/cugraph-docs/source/graph_support/algorithms/Centrality.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,11 @@ But which vertices are most important? The answer depends on which measure/algor

|Algorithm |Notebooks Containing |Description |
| --------------- | ------------------------------------------------------------ | ------------------------------------------------------------ |
|[Degree Centrality](./degree_centrality.md)| [Centrality](https://github.com/rapidsai/cugraph/blob/main/notebooks/algorithms/centrality/Centrality.ipynb), [Degree](https://github.com/rapidsai/cugraph/blob/main/notebooks/algorithms/centrality/Degree.ipynb) |Measure based on counting direct connections for each vertex|
|[Betweenness Centrality](./betweenness_centrality.md)| [Centrality](https://github.com/rapidsai/cugraph/blob/main/notebooks/algorithms/centrality/Centrality.ipynb), [Betweenness](https://github.com/rapidsai/cugraph/blob/main/notebooks/algorithms/centrality/Betweenness.ipynb) |Number of shortest paths through the vertex|
|[Eigenvector Centrality](./eigenvector_centrality.md)|[Centrality](https://github.com/rapidsai/cugraph/blob/main/notebooks/algorithms/centrality/Centrality.ipynb), [Eigenvector](https://github.com/rapidsai/cugraph/blob/main/notebooks/algorithms/centrality/Eigenvector.ipynb)|Measure of connectivity to other important vertices (which also have high connectivity) often referred to as the influence measure of a vertex|
|[Katz Centrality](./katz_centrality.md)|[Centrality](https://github.com/rapidsai/cugraph/blob/main/notebooks/algorithms/centrality/Centrality.ipynb), [Katz](https://github.com/rapidsai/cugraph/blob/main/notebooks/algorithms/centrality/Katz.ipynb) |Similar to Eigenvector but has tweaks to measure more weakly connected graph |
|Pagerank|[Centrality](https://github.com/rapidsai/cugraph/blob/main/notebooks/algorithms/centrality/Centrality.ipynb), [Pagerank](https://github.com/rapidsai/cugraph/blob/main/notebooks/algorithms/link_analysis/Pagerank.ipynb) |Classified as both a link analysis and centrality measure by quantifying incoming links from central vertices. |
|[Degree Centrality](./degree_centrality.html)| [Centrality](https://github.com/rapidsai/cugraph/blob/main/notebooks/algorithms/centrality/Centrality.ipynb), [Degree](https://github.com/rapidsai/cugraph/blob/main/notebooks/algorithms/centrality/Degree.ipynb) |Measure based on counting direct connections for each vertex|
|[Betweenness Centrality](./betweenness_centrality.html)| [Centrality](https://github.com/rapidsai/cugraph/blob/main/notebooks/algorithms/centrality/Centrality.ipynb), [Betweenness](https://github.com/rapidsai/cugraph/blob/main/notebooks/algorithms/centrality/Betweenness.ipynb) |Number of shortest paths through the vertex|
|[Eigenvector Centrality](./eigenvector_centrality.html)|[Centrality](https://github.com/rapidsai/cugraph/blob/main/notebooks/algorithms/centrality/Centrality.ipynb), [Eigenvector](https://github.com/rapidsai/cugraph/blob/main/notebooks/algorithms/centrality/Eigenvector.ipynb)|Measure of connectivity to other important vertices (which also have high connectivity) often referred to as the influence measure of a vertex|
|[Katz Centrality](./katz_centrality.html)|[Centrality](https://github.com/rapidsai/cugraph/blob/main/notebooks/algorithms/centrality/Centrality.ipynb), [Katz](https://github.com/rapidsai/cugraph/blob/main/notebooks/algorithms/centrality/Katz.ipynb) |Similar to Eigenvector but has tweaks to measure more weakly connected graph |
|Pagerank| [Pagerank](https://github.com/rapidsai/cugraph/blob/main/notebooks/algorithms/link_analysis/Pagerank.ipynb) |Classified as both a link analysis and centrality measure by quantifying incoming links from central vertices. |

[System Requirements](https://github.com/rapidsai/cugraph/blob/main/notebooks/README.md#requirements)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -79,3 +79,10 @@ cugraph::pagerank(handle, graph_view, nullptr, personalization_vertices.data(),
personalization_values.data(), number_of_personalization_vertices,
pageranks_v.data(), alpha, epsilon);
```
___
Copyright (c) 2019 - 2025, NVIDIA CORPORATION.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
___

0 comments on commit dc5153c

Please sign in to comment.