diff --git a/docs/cugraph-docs/source/api_docs/cugraph_cpp/algorithms/component_cpp.rst b/docs/cugraph-docs/source/api_docs/cugraph_cpp/algorithms/components_cpp.rst similarity index 52% rename from docs/cugraph-docs/source/api_docs/cugraph_cpp/algorithms/component_cpp.rst rename to docs/cugraph-docs/source/api_docs/cugraph_cpp/algorithms/components_cpp.rst index 1d4522c..226ce30 100644 --- a/docs/cugraph-docs/source/api_docs/cugraph_cpp/algorithms/component_cpp.rst +++ b/docs/cugraph-docs/source/api_docs/cugraph_cpp/algorithms/components_cpp.rst @@ -1,7 +1,7 @@ -Component -========= +Components +========== - .. doxygengroup:: component_cpp + .. doxygengroup:: components_cpp :project: libcugraph :members: :content-only: diff --git a/docs/cugraph-docs/source/api_docs/cugraph_cpp/algorithms/labeling_cpp.rst b/docs/cugraph-docs/source/api_docs/cugraph_cpp/algorithms/labeling_cpp.rst deleted file mode 100644 index 5499921..0000000 --- a/docs/cugraph-docs/source/api_docs/cugraph_cpp/algorithms/labeling_cpp.rst +++ /dev/null @@ -1,7 +0,0 @@ -Labeling -======== - - .. doxygengroup:: labeling_cpp - :project: libcugraph - :members: - :content-only: diff --git a/docs/cugraph-docs/source/api_docs/cugraph_cpp/algorithms/utility_cpp.rst b/docs/cugraph-docs/source/api_docs/cugraph_cpp/algorithms/utility_cpp.rst index 9085588..51708c9 100644 --- a/docs/cugraph-docs/source/api_docs/cugraph_cpp/algorithms/utility_cpp.rst +++ b/docs/cugraph-docs/source/api_docs/cugraph_cpp/algorithms/utility_cpp.rst @@ -1,5 +1,5 @@ -Centrality -========== +Utility Functions +================= .. doxygengroup:: utility_cpp :project: libcugraph diff --git a/docs/cugraph-docs/source/api_docs/cugraph_cpp/algorithms_cpp.rst b/docs/cugraph-docs/source/api_docs/cugraph_cpp/algorithms_cpp.rst index 504181a..e7b76c4 100644 --- a/docs/cugraph-docs/source/api_docs/cugraph_cpp/algorithms_cpp.rst +++ b/docs/cugraph-docs/source/api_docs/cugraph_cpp/algorithms_cpp.rst @@ -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 diff --git a/docs/cugraph-docs/source/api_docs/cugraph_cpp/collect_comm_wrapper_cpp.rst b/docs/cugraph-docs/source/api_docs/cugraph_cpp/collect_comm_wrapper_cpp.rst new file mode 100644 index 0000000..8e741a0 --- /dev/null +++ b/docs/cugraph-docs/source/api_docs/cugraph_cpp/collect_comm_wrapper_cpp.rst @@ -0,0 +1,7 @@ +Collection Wrappers +=============== + + .. doxygengroup:: collect_comm_wrapper_cpp + :project: libcugraph + :members: + :content-only: diff --git a/docs/cugraph-docs/source/api_docs/cugraph_cpp/full_api.rst b/docs/cugraph-docs/source/api_docs/cugraph_cpp/full_api.rst index 008b968..895f7b5 100644 --- a/docs/cugraph-docs/source/api_docs/cugraph_cpp/full_api.rst +++ b/docs/cugraph-docs/source/api_docs/cugraph_cpp/full_api.rst @@ -1,6 +1,6 @@ -==================== -Full cuGraph C++ API -==================== +========================= +Low Level cuGraph C++ API +========================= .. doxygennamespace:: cugraph :members: \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/cugraph_cpp/graph_functions_cpp.rst b/docs/cugraph-docs/source/api_docs/cugraph_cpp/graph_functions_cpp.rst new file mode 100644 index 0000000..834e104 --- /dev/null +++ b/docs/cugraph-docs/source/api_docs/cugraph_cpp/graph_functions_cpp.rst @@ -0,0 +1,7 @@ +Graph Functions +=============== + + .. doxygengroup:: graph_functions_cpp + :project: libcugraph + :members: + :content-only: diff --git a/docs/cugraph-docs/source/api_docs/cugraph_cpp/graph_generators_cpp.rst b/docs/cugraph-docs/source/api_docs/cugraph_cpp/graph_generators_cpp.rst new file mode 100644 index 0000000..7a78750 --- /dev/null +++ b/docs/cugraph-docs/source/api_docs/cugraph_cpp/graph_generators_cpp.rst @@ -0,0 +1,7 @@ +Graph Generators +================ + + .. doxygengroup:: graph_generators_cpp + :project: libcugraph + :members: + :content-only: \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/cugraph_cpp/graph_sampling_cpp.rst b/docs/cugraph-docs/source/api_docs/cugraph_cpp/graph_sampling_cpp.rst new file mode 100644 index 0000000..6404575 --- /dev/null +++ b/docs/cugraph-docs/source/api_docs/cugraph_cpp/graph_sampling_cpp.rst @@ -0,0 +1,7 @@ +Sampling Functions +================== + + .. doxygengroup:: sampling_functions_cpp + :project: libcugraph + :members: + :content-only: diff --git a/docs/cugraph-docs/source/api_docs/cugraph_cpp/index.rst b/docs/cugraph-docs/source/api_docs/cugraph_cpp/index.rst index 44f8915..584b0be 100644 --- a/docs/cugraph-docs/source/api_docs/cugraph_cpp/index.rst +++ b/docs/cugraph-docs/source/api_docs/cugraph_cpp/index.rst @@ -1,6 +1,6 @@ -============================= -cuGraph C++ API documentation -============================= +=============== +cuGraph C++ API +=============== .. toctree:: @@ -8,4 +8,8 @@ cuGraph C++ API documentation :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 \ No newline at end of file diff --git a/docs/cugraph-docs/source/graph_support/algorithms/Centrality.md b/docs/cugraph-docs/source/graph_support/algorithms/Centrality.md index 8119e65..d9b9ff9 100644 --- a/docs/cugraph-docs/source/graph_support/algorithms/Centrality.md +++ b/docs/cugraph-docs/source/graph_support/algorithms/Centrality.md @@ -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) diff --git a/docs/cugraph-docs/source/graph_support/algorithms/cpp_algorithms/centrality_cpp.md b/docs/cugraph-docs/source/graph_support/algorithms/cpp_algorithms/centrality_cpp.md index b3f7ac1..8a90e7b 100644 --- a/docs/cugraph-docs/source/graph_support/algorithms/cpp_algorithms/centrality_cpp.md +++ b/docs/cugraph-docs/source/graph_support/algorithms/cpp_algorithms/centrality_cpp.md @@ -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. +___ \ No newline at end of file