diff --git a/.github/workflows/pr.yaml b/.github/workflows/pr.yaml index 96a1065..9849064 100644 --- a/.github/workflows/pr.yaml +++ b/.github/workflows/pr.yaml @@ -13,6 +13,7 @@ jobs: pr-builder: needs: - telemetry-setup + - checks - docs-build secrets: inherit uses: rapidsai/shared-workflows/.github/workflows/pr-builder.yaml@branch-25.02 @@ -27,8 +28,15 @@ jobs: steps: - name: Telemetry setup uses: rapidsai/shared-actions/telemetry-dispatch-stash-base-env-vars@main - docs-build: + checks: + secrets: inherit needs: telemetry-setup + uses: rapidsai/shared-workflows/.github/workflows/checks.yaml@branch-25.02 + with: + enable_check_generated_files: false + ignored_pr_jobs: "telemetry-summarize" + docs-build: + needs: checks secrets: inherit uses: rapidsai/shared-workflows/.github/workflows/custom-job.yaml@branch-25.02 with: diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 850c16a..c762e26 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -2,11 +2,11 @@ repos: - repo: https://github.com/rapidsai/pre-commit-hooks - rev: v0.2.0 + rev: v0.4.0 hooks: - id: verify-copyright - repo: https://github.com/rapidsai/dependency-file-generator - rev: v1.14.0 + rev: v1.17.0 hooks: - id: rapids-dependency-file-generator args: ["--clean"] diff --git a/build.sh b/build.sh index 67ed406..cc9bf60 100755 --- a/build.sh +++ b/build.sh @@ -101,14 +101,8 @@ if hasArg docs || buildDefault; then rm -rf "${XML_DIR}" mkdir -p "${XML_DIR}" export XML_DIR_${PROJECT^^}="$XML_DIR" - - if [[ $PROJECT == "libcugraph" ]]; then - echo "TMP (FIXME) downloading xml for ${PROJECT} into ${XML_DIR}. Environment variable XML_DIR_${PROJECT^^} is set to ${XML_DIR}" - curl -O "https://raw.githubusercontent.com/BradReesWork/data/main/xml.tar.gz" - else - echo "downloading xml for ${PROJECT} into ${XML_DIR}. Environment variable XML_DIR_${PROJECT^^} is set to ${XML_DIR}" - curl -O "https://d1664dvumjb44w.cloudfront.net/${PROJECT}/xml_tar/${RAPIDS_VERSION}/xml.tar.gz" - fi + echo "Pulling https://d1664dvumjb44w.cloudfront.net/${PROJECT}/xml_tar/${RAPIDS_VERSION}/xml.tar.gz" + curl -O "https://d1664dvumjb44w.cloudfront.net/${PROJECT}/xml_tar/${RAPIDS_VERSION}/xml.tar.gz" tar -xzf xml.tar.gz -C "${XML_DIR}" rm "./xml.tar.gz" diff --git a/ci/build_docs.sh b/ci/build_docs.sh index 1823cfb..427c01e 100755 --- a/ci/build_docs.sh +++ b/ci/build_docs.sh @@ -49,6 +49,7 @@ for PROJECT in ${PROJ_LIST}; do rapids-logger "Download ${PROJECT} xml_tar" TMP_DIR=$(mktemp -d) export XML_DIR_${PROJECT^^}="$TMP_DIR" + curl "https://d1664dvumjb44w.cloudfront.net/${PROJECT}/xml_tar/${RAPIDS_VERSION_MAJOR_MINOR}/xml.tar.gz" | tar -xzf - -C "${TMP_DIR}" done diff --git a/conda/environments/all_cuda-118_arch-x86_64.yaml b/conda/environments/all_cuda-118_arch-x86_64.yaml deleted file mode 100644 index 3417abd..0000000 --- a/conda/environments/all_cuda-118_arch-x86_64.yaml +++ /dev/null @@ -1,30 +0,0 @@ -# This file is generated by `rapids-dependency-file-generator`. -# To make changes, edit ../../dependencies.yaml and run `rapids-dependency-file-generator`. -channels: -- pyg -- rapidsai -- rapidsai-nightly -- dask/label/dev -- conda-forge -- nvidia -dependencies: -- breathe -- cuda-version=11.8 -- cugraph-dgl==25.2.* -- cugraph==25.2.* -- dglteam/label/th23_cu118::dgl -- doxygen -- graphviz -- ipython -- nbsphinx -- numpydoc -- pre-commit -- pydata-sphinx-theme -- pylibcugraphops==25.2.* -- pylibwholegraph==25.2.* -- recommonmark -- sphinx-copybutton -- sphinx-markdown-tables -- sphinx<6 -- sphinxcontrib-websupport -name: all_cuda-118_arch-x86_64 diff --git a/conda/environments/all_cuda-122_arch-x86_64.yaml b/conda/environments/all_cuda-125_arch-x86_64.yaml similarity index 88% rename from conda/environments/all_cuda-122_arch-x86_64.yaml rename to conda/environments/all_cuda-125_arch-x86_64.yaml index ad58639..ddf7721 100644 --- a/conda/environments/all_cuda-122_arch-x86_64.yaml +++ b/conda/environments/all_cuda-125_arch-x86_64.yaml @@ -9,8 +9,9 @@ channels: - nvidia dependencies: - breathe -- cuda-version=12.2 +- cuda-version=12.5 - cugraph-dgl==25.2.* +- cugraph-pyg==25.2.* - cugraph==25.2.* - dglteam/label/th23_cu121::dgl - doxygen @@ -27,4 +28,4 @@ dependencies: - sphinx-markdown-tables - sphinx<6 - sphinxcontrib-websupport -name: all_cuda-122_arch-x86_64 +name: all_cuda-125_arch-x86_64 diff --git a/dependencies.yaml b/dependencies.yaml index d7ca499..395c2cf 100644 --- a/dependencies.yaml +++ b/dependencies.yaml @@ -3,7 +3,8 @@ files: all: output: [conda] matrix: - cuda: ["11.8", "12.2"] + # docs are only built on the latest CUDA version RAPIDS supports + cuda: ["12.5"] arch: [x86_64] includes: - checks @@ -12,9 +13,9 @@ files: - depends_on_cugraph - depends_on_dgl - depends_on_cugraph_dgl + - depends_on_cugraph_pyg - depends_on_pylibcugraphops - depends_on_pylibwholegraph - checks: output: none includes: @@ -27,6 +28,7 @@ files: - depends_on_cugraph - depends_on_dgl - depends_on_cugraph_dgl + - depends_on_cugraph_pyg - depends_on_pylibcugraphops - depends_on_pylibwholegraph @@ -156,6 +158,27 @@ dependencies: - cugraph-dgl-cu11==25.2.* - {matrix: null, packages: [*cugraph_dgl_conda]} + depends_on_cugraph_pyg: + common: + - output_types: conda + packages: + - &cugraph_pyg_unsuffixed cugraph-pyg==25.2.* + - output_types: requirements + packages: + # pip recognizes the index as a global option for the requirements.txt file + - --extra-index-url=https://pypi.nvidia.com + - --extra-index-url=https://pypi.anaconda.org/rapidsai-wheels-nightly/simple + specific: + - output_types: [requirements] + matrices: + - matrix: {cuda: "12.*"} + packages: + - cugraph-pyg-cu12==25.2.* + - matrix: {cuda: "11.*"} + packages: + - cugraph-pyg-cu11==25.2.* + - {matrix: null, packages: [*cugraph_pyg_unsuffixed]} + depends_on_dgl: specific: - output_types: [conda] @@ -168,8 +191,6 @@ dependencies: - 'dglteam/label/th23_cu118::dgl' - {matrix: null, packages: ['dglteam/label/th23_cu121::dgl']} - - depends_on_pylibcugraph: common: - output_types: conda diff --git a/docs/cugraph-docs/source/_static/bc_benchmark.png b/docs/cugraph-docs/source/_static/bc_benchmark.png new file mode 100644 index 0000000..9e385c9 Binary files /dev/null and b/docs/cugraph-docs/source/_static/bc_benchmark.png differ diff --git a/docs/cugraph-docs/source/_static/colab.png b/docs/cugraph-docs/source/_static/colab.png new file mode 100644 index 0000000..c4c3f5b Binary files /dev/null and b/docs/cugraph-docs/source/_static/colab.png differ diff --git a/docs/cugraph-docs/source/_static/nxcg-execution-diagram.jpg b/docs/cugraph-docs/source/_static/nxcg-execution-diagram.jpg new file mode 100644 index 0000000..4813628 Binary files /dev/null and b/docs/cugraph-docs/source/_static/nxcg-execution-diagram.jpg differ diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.Graph.add_internal_vertex_id.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.Graph.add_internal_vertex_id.rst deleted file mode 100644 index 3bd9f44..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.Graph.add_internal_vertex_id.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.Graph.add\_internal\_vertex\_id -======================================= - -.. currentmodule:: cugraph - -.. automethod:: Graph.add_internal_vertex_id \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.Graph.add_nodes_from.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.Graph.add_nodes_from.rst deleted file mode 100644 index a908f82..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.Graph.add_nodes_from.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.Graph.add\_nodes\_from -============================== - -.. currentmodule:: cugraph - -.. automethod:: Graph.add_nodes_from \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.Graph.clear.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.Graph.clear.rst deleted file mode 100644 index 8118c71..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.Graph.clear.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.Graph.clear -=================== - -.. currentmodule:: cugraph - -.. automethod:: Graph.clear \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.Graph.from_cudf_adjlist.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.Graph.from_cudf_adjlist.rst deleted file mode 100644 index f699e7f..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.Graph.from_cudf_adjlist.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.Graph.from\_cudf\_adjlist -================================= - -.. currentmodule:: cugraph - -.. automethod:: Graph.from_cudf_adjlist \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.Graph.from_cudf_edgelist.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.Graph.from_cudf_edgelist.rst deleted file mode 100644 index e440516..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.Graph.from_cudf_edgelist.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.Graph.from\_cudf\_edgelist -================================== - -.. currentmodule:: cugraph - -.. automethod:: Graph.from_cudf_edgelist \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.Graph.from_dask_cudf_edgelist.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.Graph.from_dask_cudf_edgelist.rst deleted file mode 100644 index 6e3b5e3..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.Graph.from_dask_cudf_edgelist.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.Graph.from\_dask\_cudf\_edgelist -======================================== - -.. currentmodule:: cugraph - -.. automethod:: Graph.from_dask_cudf_edgelist \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.Graph.from_numpy_array.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.Graph.from_numpy_array.rst deleted file mode 100644 index 5689f56..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.Graph.from_numpy_array.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.Graph.from\_numpy\_array -================================ - -.. currentmodule:: cugraph - -.. automethod:: Graph.from_numpy_array \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.Graph.from_numpy_matrix.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.Graph.from_numpy_matrix.rst deleted file mode 100644 index 1087557..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.Graph.from_numpy_matrix.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.Graph.from\_numpy\_matrix -================================= - -.. currentmodule:: cugraph - -.. automethod:: Graph.from_numpy_matrix \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.Graph.from_pandas_adjacency.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.Graph.from_pandas_adjacency.rst deleted file mode 100644 index f6c8869..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.Graph.from_pandas_adjacency.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.Graph.from\_pandas\_adjacency -===================================== - -.. currentmodule:: cugraph - -.. automethod:: Graph.from_pandas_adjacency \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.Graph.from_pandas_edgelist.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.Graph.from_pandas_edgelist.rst deleted file mode 100644 index 99fd10b..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.Graph.from_pandas_edgelist.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.Graph.from\_pandas\_edgelist -==================================== - -.. currentmodule:: cugraph - -.. automethod:: Graph.from_pandas_edgelist \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.Graph.has_isolated_vertices.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.Graph.has_isolated_vertices.rst deleted file mode 100644 index 9e4ffd6..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.Graph.has_isolated_vertices.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.Graph.has\_isolated\_vertices -===================================== - -.. currentmodule:: cugraph - -.. automethod:: Graph.has_isolated_vertices \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.Graph.is_bipartite.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.Graph.is_bipartite.rst deleted file mode 100644 index ece02d9..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.Graph.is_bipartite.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.Graph.is\_bipartite -=========================== - -.. currentmodule:: cugraph - -.. automethod:: Graph.is_bipartite \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.Graph.is_directed.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.Graph.is_directed.rst deleted file mode 100644 index cbc9cbf..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.Graph.is_directed.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.Graph.is\_directed -========================== - -.. currentmodule:: cugraph - -.. automethod:: Graph.is_directed \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.Graph.is_multigraph.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.Graph.is_multigraph.rst deleted file mode 100644 index 9acd209..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.Graph.is_multigraph.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.Graph.is\_multigraph -============================ - -.. currentmodule:: cugraph - -.. automethod:: Graph.is_multigraph \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.Graph.is_multipartite.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.Graph.is_multipartite.rst deleted file mode 100644 index 7117a04..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.Graph.is_multipartite.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.Graph.is\_multipartite -============================== - -.. currentmodule:: cugraph - -.. automethod:: Graph.is_multipartite \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.Graph.is_renumbered.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.Graph.is_renumbered.rst deleted file mode 100644 index ead1b05..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.Graph.is_renumbered.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.Graph.is\_renumbered -============================ - -.. currentmodule:: cugraph - -.. automethod:: Graph.is_renumbered \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.Graph.is_weighted.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.Graph.is_weighted.rst deleted file mode 100644 index ec4139d..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.Graph.is_weighted.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.Graph.is\_weighted -========================== - -.. currentmodule:: cugraph - -.. automethod:: Graph.is_weighted \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.Graph.lookup_internal_vertex_id.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.Graph.lookup_internal_vertex_id.rst deleted file mode 100644 index 8e2f9df..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.Graph.lookup_internal_vertex_id.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.Graph.lookup\_internal\_vertex\_id -========================================== - -.. currentmodule:: cugraph - -.. automethod:: Graph.lookup_internal_vertex_id \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.Graph.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.Graph.rst deleted file mode 100644 index af03981..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.Graph.rst +++ /dev/null @@ -1,46 +0,0 @@ -cugraph.Graph -============= - -.. currentmodule:: cugraph - -.. autoclass:: Graph - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~Graph.__init__ - ~Graph.add_internal_vertex_id - ~Graph.add_nodes_from - ~Graph.clear - ~Graph.density - ~Graph.from_cudf_adjlist - ~Graph.from_cudf_edgelist - ~Graph.from_dask_cudf_edgelist - ~Graph.from_numpy_array - ~Graph.from_numpy_matrix - ~Graph.from_pandas_adjacency - ~Graph.from_pandas_edgelist - ~Graph.has_isolated_vertices - ~Graph.is_bipartite - ~Graph.is_directed - ~Graph.is_multi_gpu - ~Graph.is_multigraph - ~Graph.is_multipartite - ~Graph.is_remote - ~Graph.is_renumbered - ~Graph.is_weighted - ~Graph.lookup_internal_vertex_id - ~Graph.to_directed - ~Graph.to_undirected - ~Graph.unrenumber - - - - - - \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.Graph.to_directed.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.Graph.to_directed.rst deleted file mode 100644 index 54908f1..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.Graph.to_directed.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.Graph.to\_directed -========================== - -.. currentmodule:: cugraph - -.. automethod:: Graph.to_directed \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.Graph.to_undirected.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.Graph.to_undirected.rst deleted file mode 100644 index 91d77ab..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.Graph.to_undirected.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.Graph.to\_undirected -============================ - -.. currentmodule:: cugraph - -.. automethod:: Graph.to_undirected \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.Graph.unrenumber.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.Graph.unrenumber.rst deleted file mode 100644 index ac39b33..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.Graph.unrenumber.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.Graph.unrenumber -======================== - -.. currentmodule:: cugraph - -.. automethod:: Graph.unrenumber \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.MultiGraph.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.MultiGraph.rst deleted file mode 100644 index 9536b4a..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.MultiGraph.rst +++ /dev/null @@ -1,46 +0,0 @@ -cugraph.MultiGraph -================== - -.. currentmodule:: cugraph - -.. autoclass:: MultiGraph - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~MultiGraph.__init__ - ~MultiGraph.add_internal_vertex_id - ~MultiGraph.add_nodes_from - ~MultiGraph.clear - ~MultiGraph.density - ~MultiGraph.from_cudf_adjlist - ~MultiGraph.from_cudf_edgelist - ~MultiGraph.from_dask_cudf_edgelist - ~MultiGraph.from_numpy_array - ~MultiGraph.from_numpy_matrix - ~MultiGraph.from_pandas_adjacency - ~MultiGraph.from_pandas_edgelist - ~MultiGraph.has_isolated_vertices - ~MultiGraph.is_bipartite - ~MultiGraph.is_directed - ~MultiGraph.is_multi_gpu - ~MultiGraph.is_multigraph - ~MultiGraph.is_multipartite - ~MultiGraph.is_remote - ~MultiGraph.is_renumbered - ~MultiGraph.is_weighted - ~MultiGraph.lookup_internal_vertex_id - ~MultiGraph.to_directed - ~MultiGraph.to_undirected - ~MultiGraph.unrenumber - - - - - - \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.analyzeClustering_edge_cut.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.analyzeClustering_edge_cut.rst deleted file mode 100644 index 269e1e2..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.analyzeClustering_edge_cut.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.analyzeClustering\_edge\_cut -==================================== - -.. currentmodule:: cugraph - -.. autofunction:: analyzeClustering_edge_cut \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.analyzeClustering_modularity.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.analyzeClustering_modularity.rst deleted file mode 100644 index ed1fdaa..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.analyzeClustering_modularity.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.analyzeClustering\_modularity -===================================== - -.. currentmodule:: cugraph - -.. autofunction:: analyzeClustering_modularity \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.analyzeClustering_ratio_cut.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.analyzeClustering_ratio_cut.rst deleted file mode 100644 index 54e93e3..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.analyzeClustering_ratio_cut.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.analyzeClustering\_ratio\_cut -===================================== - -.. currentmodule:: cugraph - -.. autofunction:: analyzeClustering_ratio_cut \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.batched_ego_graphs.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.batched_ego_graphs.rst deleted file mode 100644 index 6233279..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.batched_ego_graphs.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.batched\_ego\_graphs -============================ - -.. currentmodule:: cugraph - -.. autofunction:: batched_ego_graphs \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.bfs.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.bfs.rst deleted file mode 100644 index 868691c..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.bfs.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.bfs -=========== - -.. currentmodule:: cugraph - -.. autofunction:: bfs \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.bfs_edges.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.bfs_edges.rst deleted file mode 100644 index 4e530bf..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.bfs_edges.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.bfs\_edges -================== - -.. currentmodule:: cugraph - -.. autofunction:: bfs_edges \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.centrality.betweenness_centrality.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.centrality.betweenness_centrality.rst deleted file mode 100644 index f377def..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.centrality.betweenness_centrality.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.centrality.betweenness\_centrality -========================================== - -.. currentmodule:: cugraph.centrality - -.. autofunction:: betweenness_centrality \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.centrality.degree_centrality.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.centrality.degree_centrality.rst deleted file mode 100644 index c9ee46f..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.centrality.degree_centrality.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.centrality.degree\_centrality -===================================== - -.. currentmodule:: cugraph.centrality - -.. autofunction:: degree_centrality \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.centrality.edge_betweenness_centrality.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.centrality.edge_betweenness_centrality.rst deleted file mode 100644 index bccb910..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.centrality.edge_betweenness_centrality.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.centrality.edge\_betweenness\_centrality -================================================ - -.. currentmodule:: cugraph.centrality - -.. autofunction:: edge_betweenness_centrality \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.centrality.eigenvector_centrality.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.centrality.eigenvector_centrality.rst deleted file mode 100644 index f9d0823..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.centrality.eigenvector_centrality.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.centrality.eigenvector\_centrality -========================================== - -.. currentmodule:: cugraph.centrality - -.. autofunction:: eigenvector_centrality \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.centrality.katz_centrality.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.centrality.katz_centrality.rst deleted file mode 100644 index f3a8296..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.centrality.katz_centrality.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.centrality.katz\_centrality -=================================== - -.. currentmodule:: cugraph.centrality - -.. autofunction:: katz_centrality \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.connected_components.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.connected_components.rst deleted file mode 100644 index c760dfd..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.connected_components.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.connected\_components -============================= - -.. currentmodule:: cugraph - -.. autofunction:: connected_components \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.core_number.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.core_number.rst deleted file mode 100644 index 9149f4e..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.core_number.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.core\_number -==================== - -.. currentmodule:: cugraph - -.. autofunction:: core_number \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.dask.centrality.betweenness_centrality.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.dask.centrality.betweenness_centrality.rst deleted file mode 100644 index da5a127..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.dask.centrality.betweenness_centrality.rst +++ /dev/null @@ -1,31 +0,0 @@ -cugraph.dask.centrality.betweenness\_centrality -=============================================== - -.. automodule:: cugraph.dask.centrality.betweenness_centrality - - - - - - - - .. rubric:: Functions - - .. autosummary:: - - betweenness_centrality - convert_to_cudf - edge_betweenness_centrality - - - - - - - - - - - - - diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.dask.centrality.eigenvector_centrality.eigenvector_centrality.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.dask.centrality.eigenvector_centrality.eigenvector_centrality.rst deleted file mode 100644 index 68bb097..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.dask.centrality.eigenvector_centrality.eigenvector_centrality.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.dask.centrality.eigenvector\_centrality.eigenvector\_centrality -======================================================================= - -.. currentmodule:: cugraph.dask.centrality.eigenvector_centrality - -.. autofunction:: eigenvector_centrality \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.dask.centrality.katz_centrality.katz_centrality.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.dask.centrality.katz_centrality.katz_centrality.rst deleted file mode 100644 index 108b174..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.dask.centrality.katz_centrality.katz_centrality.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.dask.centrality.katz\_centrality.katz\_centrality -========================================================= - -.. currentmodule:: cugraph.dask.centrality.katz_centrality - -.. autofunction:: katz_centrality \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.dask.common.read_utils.get_chunksize.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.dask.common.read_utils.get_chunksize.rst deleted file mode 100644 index c627bd9..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.dask.common.read_utils.get_chunksize.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.dask.common.read\_utils.get\_chunksize -============================================== - -.. currentmodule:: cugraph.dask.common.read_utils - -.. autofunction:: get_chunksize \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.dask.comms.comms.destroy.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.dask.comms.comms.destroy.rst deleted file mode 100644 index aa0bf20..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.dask.comms.comms.destroy.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.dask.comms.comms.destroy -================================ - -.. currentmodule:: cugraph.dask.comms.comms - -.. autofunction:: destroy \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.dask.comms.comms.get_2D_partition.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.dask.comms.comms.get_2D_partition.rst deleted file mode 100644 index eadb010..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.dask.comms.comms.get_2D_partition.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.dask.comms.comms.get\_2D\_partition -=========================================== - -.. currentmodule:: cugraph.dask.comms.comms - -.. autofunction:: get_2D_partition \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.dask.comms.comms.get_comms.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.dask.comms.comms.get_comms.rst deleted file mode 100644 index 1d5e3ee..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.dask.comms.comms.get_comms.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.dask.comms.comms.get\_comms -=================================== - -.. currentmodule:: cugraph.dask.comms.comms - -.. autofunction:: get_comms \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.dask.comms.comms.get_default_handle.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.dask.comms.comms.get_default_handle.rst deleted file mode 100644 index 2edb4a1..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.dask.comms.comms.get_default_handle.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.dask.comms.comms.get\_default\_handle -============================================= - -.. currentmodule:: cugraph.dask.comms.comms - -.. autofunction:: get_default_handle \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.dask.comms.comms.get_handle.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.dask.comms.comms.get_handle.rst deleted file mode 100644 index 495e876..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.dask.comms.comms.get_handle.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.dask.comms.comms.get\_handle -==================================== - -.. currentmodule:: cugraph.dask.comms.comms - -.. autofunction:: get_handle \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.dask.comms.comms.get_session_id.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.dask.comms.comms.get_session_id.rst deleted file mode 100644 index 1ed28df..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.dask.comms.comms.get_session_id.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.dask.comms.comms.get\_session\_id -========================================= - -.. currentmodule:: cugraph.dask.comms.comms - -.. autofunction:: get_session_id \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.dask.comms.comms.get_worker_id.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.dask.comms.comms.get_worker_id.rst deleted file mode 100644 index 1deeeb8..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.dask.comms.comms.get_worker_id.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.dask.comms.comms.get\_worker\_id -======================================== - -.. currentmodule:: cugraph.dask.comms.comms - -.. autofunction:: get_worker_id \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.dask.comms.comms.get_workers.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.dask.comms.comms.get_workers.rst deleted file mode 100644 index 0b4def7..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.dask.comms.comms.get_workers.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.dask.comms.comms.get\_workers -===================================== - -.. currentmodule:: cugraph.dask.comms.comms - -.. autofunction:: get_workers \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.dask.comms.comms.initialize.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.dask.comms.comms.initialize.rst deleted file mode 100644 index 6d31006..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.dask.comms.comms.initialize.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.dask.comms.comms.initialize -=================================== - -.. currentmodule:: cugraph.dask.comms.comms - -.. autofunction:: initialize \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.dask.comms.comms.is_initialized.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.dask.comms.comms.is_initialized.rst deleted file mode 100644 index 312d0f1..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.dask.comms.comms.is_initialized.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.dask.comms.comms.is\_initialized -======================================== - -.. currentmodule:: cugraph.dask.comms.comms - -.. autofunction:: is_initialized \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.dask.community.louvain.louvain.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.dask.community.louvain.louvain.rst deleted file mode 100644 index 06132d4..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.dask.community.louvain.louvain.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.dask.community.louvain.louvain -====================================== - -.. currentmodule:: cugraph.dask.community.louvain - -.. autofunction:: louvain \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.dask.components.connectivity.weakly_connected_components.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.dask.components.connectivity.weakly_connected_components.rst deleted file mode 100644 index 363ee71..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.dask.components.connectivity.weakly_connected_components.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.dask.components.connectivity.weakly\_connected\_components -================================================================== - -.. currentmodule:: cugraph.dask.components.connectivity - -.. autofunction:: weakly_connected_components \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.dask.link_analysis.hits.hits.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.dask.link_analysis.hits.hits.rst deleted file mode 100644 index 7f55e46..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.dask.link_analysis.hits.hits.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.dask.link\_analysis.hits.hits -===================================== - -.. currentmodule:: cugraph.dask.link_analysis.hits - -.. autofunction:: hits \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.dask.link_analysis.pagerank.pagerank.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.dask.link_analysis.pagerank.pagerank.rst deleted file mode 100644 index 2471e6a..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.dask.link_analysis.pagerank.pagerank.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.dask.link\_analysis.pagerank.pagerank -============================================= - -.. currentmodule:: cugraph.dask.link_analysis.pagerank - -.. autofunction:: pagerank \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.dask.traversal.bfs.bfs.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.dask.traversal.bfs.bfs.rst deleted file mode 100644 index d492645..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.dask.traversal.bfs.bfs.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.dask.traversal.bfs.bfs -============================== - -.. currentmodule:: cugraph.dask.traversal.bfs - -.. autofunction:: bfs \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.dask.traversal.sssp.sssp.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.dask.traversal.sssp.sssp.rst deleted file mode 100644 index 51de28e..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.dask.traversal.sssp.sssp.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.dask.traversal.sssp.sssp -================================ - -.. currentmodule:: cugraph.dask.traversal.sssp - -.. autofunction:: sssp \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.dense_hungarian.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.dense_hungarian.rst deleted file mode 100644 index 1553ee2..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.dense_hungarian.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.dense\_hungarian -======================== - -.. currentmodule:: cugraph - -.. autofunction:: dense_hungarian \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.ecg.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.ecg.rst deleted file mode 100644 index 3f901b9..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.ecg.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.ecg -=========== - -.. currentmodule:: cugraph - -.. autofunction:: ecg \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.ego_graph.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.ego_graph.rst deleted file mode 100644 index dc1e5e4..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.ego_graph.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.ego\_graph -================== - -.. currentmodule:: cugraph - -.. autofunction:: ego_graph \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.experimental.PropertyGraph.add_edge_data.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.experimental.PropertyGraph.add_edge_data.rst deleted file mode 100644 index ec8c376..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.experimental.PropertyGraph.add_edge_data.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.experimental.PropertyGraph.add\_edge\_data -================================================== - -.. currentmodule:: cugraph.experimental - -.. automethod:: PropertyGraph.add_edge_data \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.experimental.PropertyGraph.add_vertex_data.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.experimental.PropertyGraph.add_vertex_data.rst deleted file mode 100644 index 9bcbc6a..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.experimental.PropertyGraph.add_vertex_data.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.experimental.PropertyGraph.add\_vertex\_data -==================================================== - -.. currentmodule:: cugraph.experimental - -.. automethod:: PropertyGraph.add_vertex_data \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.experimental.PropertyGraph.annotate_dataframe.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.experimental.PropertyGraph.annotate_dataframe.rst deleted file mode 100644 index c492035..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.experimental.PropertyGraph.annotate_dataframe.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.experimental.PropertyGraph.annotate\_dataframe -====================================================== - -.. currentmodule:: cugraph.experimental - -.. automethod:: PropertyGraph.annotate_dataframe \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.experimental.PropertyGraph.edge_props_to_graph.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.experimental.PropertyGraph.edge_props_to_graph.rst deleted file mode 100644 index 12c6372..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.experimental.PropertyGraph.edge_props_to_graph.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.experimental.PropertyGraph.edge\_props\_to\_graph -========================================================= - -.. currentmodule:: cugraph.experimental - -.. automethod:: PropertyGraph.edge_props_to_graph \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.experimental.PropertyGraph.extract_subgraph.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.experimental.PropertyGraph.extract_subgraph.rst deleted file mode 100644 index de4c4b2..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.experimental.PropertyGraph.extract_subgraph.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.experimental.PropertyGraph.extract\_subgraph -==================================================== - -.. currentmodule:: cugraph.experimental - -.. automethod:: PropertyGraph.extract_subgraph \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.experimental.PropertyGraph.get_edge_data.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.experimental.PropertyGraph.get_edge_data.rst deleted file mode 100644 index c3519b8..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.experimental.PropertyGraph.get_edge_data.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.experimental.PropertyGraph.get\_edge\_data -================================================== - -.. currentmodule:: cugraph.experimental - -.. automethod:: PropertyGraph.get_edge_data \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.experimental.PropertyGraph.get_num_edges.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.experimental.PropertyGraph.get_num_edges.rst deleted file mode 100644 index f661120..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.experimental.PropertyGraph.get_num_edges.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.experimental.PropertyGraph.get\_num\_edges -================================================== - -.. currentmodule:: cugraph.experimental - -.. automethod:: PropertyGraph.get_num_edges \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.experimental.PropertyGraph.get_num_vertices.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.experimental.PropertyGraph.get_num_vertices.rst deleted file mode 100644 index a4e293f..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.experimental.PropertyGraph.get_num_vertices.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.experimental.PropertyGraph.get\_num\_vertices -===================================================== - -.. currentmodule:: cugraph.experimental - -.. automethod:: PropertyGraph.get_num_vertices \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.experimental.PropertyGraph.get_vertex_data.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.experimental.PropertyGraph.get_vertex_data.rst deleted file mode 100644 index f22254a..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.experimental.PropertyGraph.get_vertex_data.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.experimental.PropertyGraph.get\_vertex\_data -==================================================== - -.. currentmodule:: cugraph.experimental - -.. automethod:: PropertyGraph.get_vertex_data \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.experimental.PropertyGraph.get_vertices.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.experimental.PropertyGraph.get_vertices.rst deleted file mode 100644 index b6ee1d3..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.experimental.PropertyGraph.get_vertices.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.experimental.PropertyGraph.get\_vertices -================================================ - -.. currentmodule:: cugraph.experimental - -.. automethod:: PropertyGraph.get_vertices \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.experimental.PropertyGraph.has_duplicate_edges.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.experimental.PropertyGraph.has_duplicate_edges.rst deleted file mode 100644 index 5aca8ee..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.experimental.PropertyGraph.has_duplicate_edges.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.experimental.PropertyGraph.has\_duplicate\_edges -======================================================== - -.. currentmodule:: cugraph.experimental - -.. automethod:: PropertyGraph.has_duplicate_edges \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.experimental.PropertyGraph.is_multigraph.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.experimental.PropertyGraph.is_multigraph.rst deleted file mode 100644 index 41945c1..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.experimental.PropertyGraph.is_multigraph.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.experimental.PropertyGraph.is\_multigraph -================================================= - -.. currentmodule:: cugraph.experimental - -.. automethod:: PropertyGraph.is_multigraph \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.experimental.PropertyGraph.renumber_edges_by_type.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.experimental.PropertyGraph.renumber_edges_by_type.rst deleted file mode 100644 index 220dfab..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.experimental.PropertyGraph.renumber_edges_by_type.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.experimental.PropertyGraph.renumber\_edges\_by\_type -============================================================ - -.. currentmodule:: cugraph.experimental - -.. automethod:: PropertyGraph.renumber_edges_by_type \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.experimental.PropertyGraph.renumber_vertices_by_type.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.experimental.PropertyGraph.renumber_vertices_by_type.rst deleted file mode 100644 index e3c2330..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.experimental.PropertyGraph.renumber_vertices_by_type.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.experimental.PropertyGraph.renumber\_vertices\_by\_type -=============================================================== - -.. currentmodule:: cugraph.experimental - -.. automethod:: PropertyGraph.renumber_vertices_by_type \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.experimental.PropertyGraph.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.experimental.PropertyGraph.rst deleted file mode 100644 index d5caea0..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.experimental.PropertyGraph.rst +++ /dev/null @@ -1,62 +0,0 @@ -cugraph.experimental.PropertyGraph -================================== - -.. currentmodule:: cugraph.experimental - -.. autoclass:: PropertyGraph - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~PropertyGraph.__init__ - ~PropertyGraph.add_edge_data - ~PropertyGraph.add_vertex_data - ~PropertyGraph.annotate_dataframe - ~PropertyGraph.edge_props_to_graph - ~PropertyGraph.edge_types_from_numerals - ~PropertyGraph.edge_vector_property_to_array - ~PropertyGraph.extract_subgraph - ~PropertyGraph.fillna_edges - ~PropertyGraph.fillna_vertices - ~PropertyGraph.get_edge_data - ~PropertyGraph.get_num_edges - ~PropertyGraph.get_num_vertices - ~PropertyGraph.get_vertex_data - ~PropertyGraph.get_vertices - ~PropertyGraph.has_duplicate_edges - ~PropertyGraph.is_multi_gpu - ~PropertyGraph.is_multigraph - ~PropertyGraph.renumber_edges_by_type - ~PropertyGraph.renumber_vertices_by_type - ~PropertyGraph.select_edges - ~PropertyGraph.select_vertices - ~PropertyGraph.vertex_types_from_numerals - ~PropertyGraph.vertex_vector_property_to_array - ~PropertyGraph.vertices_ids - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~PropertyGraph.dst_col_name - ~PropertyGraph.edge_id_col_name - ~PropertyGraph.edge_property_names - ~PropertyGraph.edge_types - ~PropertyGraph.edges - ~PropertyGraph.src_col_name - ~PropertyGraph.type_col_name - ~PropertyGraph.vertex_col_name - ~PropertyGraph.vertex_property_names - ~PropertyGraph.vertex_types - ~PropertyGraph.weight_col_name - - \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.experimental.PropertyGraph.select_edges.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.experimental.PropertyGraph.select_edges.rst deleted file mode 100644 index 6a5a618..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.experimental.PropertyGraph.select_edges.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.experimental.PropertyGraph.select\_edges -================================================ - -.. currentmodule:: cugraph.experimental - -.. automethod:: PropertyGraph.select_edges \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.experimental.PropertyGraph.select_vertices.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.experimental.PropertyGraph.select_vertices.rst deleted file mode 100644 index c8c02b5..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.experimental.PropertyGraph.select_vertices.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.experimental.PropertyGraph.select\_vertices -=================================================== - -.. currentmodule:: cugraph.experimental - -.. automethod:: PropertyGraph.select_vertices \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.experimental.PropertySelection.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.experimental.PropertySelection.rst deleted file mode 100644 index cd77f88..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.experimental.PropertySelection.rst +++ /dev/null @@ -1,22 +0,0 @@ -cugraph.experimental.PropertySelection -====================================== - -.. currentmodule:: cugraph.experimental - -.. autoclass:: PropertySelection - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~PropertySelection.__init__ - - - - - - \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.filter_unreachable.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.filter_unreachable.rst deleted file mode 100644 index ddf6cf2..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.filter_unreachable.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.filter\_unreachable -=========================== - -.. currentmodule:: cugraph - -.. autofunction:: filter_unreachable \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.force_atlas2.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.force_atlas2.rst deleted file mode 100644 index 2b2905e..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.force_atlas2.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.force\_atlas2 -===================== - -.. currentmodule:: cugraph - -.. autofunction:: force_atlas2 \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.from_adjlist.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.from_adjlist.rst deleted file mode 100644 index 1c09a14..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.from_adjlist.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.from\_adjlist -===================== - -.. currentmodule:: cugraph - -.. autofunction:: from_adjlist \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.from_cudf_edgelist.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.from_cudf_edgelist.rst deleted file mode 100644 index a65b460..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.from_cudf_edgelist.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.from\_cudf\_edgelist -============================ - -.. currentmodule:: cugraph - -.. autofunction:: from_cudf_edgelist \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.from_edgelist.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.from_edgelist.rst deleted file mode 100644 index 4cbecb7..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.from_edgelist.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.from\_edgelist -====================== - -.. currentmodule:: cugraph - -.. autofunction:: from_edgelist \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.from_numpy_array.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.from_numpy_array.rst deleted file mode 100644 index fadd4a9..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.from_numpy_array.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.from\_numpy\_array -========================== - -.. currentmodule:: cugraph - -.. autofunction:: from_numpy_array \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.from_numpy_matrix.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.from_numpy_matrix.rst deleted file mode 100644 index 65ce977..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.from_numpy_matrix.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.from\_numpy\_matrix -=========================== - -.. currentmodule:: cugraph - -.. autofunction:: from_numpy_matrix \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.from_pandas_adjacency.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.from_pandas_adjacency.rst deleted file mode 100644 index 2b083d4..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.from_pandas_adjacency.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.from\_pandas\_adjacency -=============================== - -.. currentmodule:: cugraph - -.. autofunction:: from_pandas_adjacency \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.from_pandas_edgelist.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.from_pandas_edgelist.rst deleted file mode 100644 index 45217a3..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.from_pandas_edgelist.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.from\_pandas\_edgelist -============================== - -.. currentmodule:: cugraph - -.. autofunction:: from_pandas_edgelist \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.generators.rmat.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.generators.rmat.rst deleted file mode 100644 index 8796915..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.generators.rmat.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.generators.rmat -======================= - -.. currentmodule:: cugraph.generators - -.. autofunction:: rmat \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.hits.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.hits.rst deleted file mode 100644 index 35f9def..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.hits.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.hits -============ - -.. currentmodule:: cugraph - -.. autofunction:: hits \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.hungarian.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.hungarian.rst deleted file mode 100644 index fa6fc81..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.hungarian.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.hungarian -================= - -.. currentmodule:: cugraph - -.. autofunction:: hungarian \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.hypergraph.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.hypergraph.rst deleted file mode 100644 index 70c63cf..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.hypergraph.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.hypergraph -================== - -.. currentmodule:: cugraph - -.. autofunction:: hypergraph \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.jaccard.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.jaccard.rst deleted file mode 100644 index a3504d2..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.jaccard.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.jaccard -=============== - -.. currentmodule:: cugraph - -.. autofunction:: jaccard \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.jaccard_coefficient.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.jaccard_coefficient.rst deleted file mode 100644 index 25c1cc6..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.jaccard_coefficient.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.jaccard\_coefficient -============================ - -.. currentmodule:: cugraph - -.. autofunction:: jaccard_coefficient \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.k_core.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.k_core.rst deleted file mode 100644 index ede3153..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.k_core.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.k\_core -=============== - -.. currentmodule:: cugraph - -.. autofunction:: k_core \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.k_truss.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.k_truss.rst deleted file mode 100644 index 0cd7b05..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.k_truss.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.k\_truss -================ - -.. currentmodule:: cugraph - -.. autofunction:: k_truss \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.ktruss_subgraph.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.ktruss_subgraph.rst deleted file mode 100644 index e5a1f96..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.ktruss_subgraph.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.ktruss\_subgraph -======================== - -.. currentmodule:: cugraph - -.. autofunction:: ktruss_subgraph \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.leiden.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.leiden.rst deleted file mode 100644 index fdf73f8..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.leiden.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.leiden -============== - -.. currentmodule:: cugraph - -.. autofunction:: leiden \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.louvain.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.louvain.rst deleted file mode 100644 index 8392bd5..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.louvain.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.louvain -=============== - -.. currentmodule:: cugraph - -.. autofunction:: louvain \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.node2vec.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.node2vec.rst deleted file mode 100644 index 58948a1..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.node2vec.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.node2vec -================ - -.. currentmodule:: cugraph - -.. autofunction:: node2vec \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.overlap.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.overlap.rst deleted file mode 100644 index f64bd13..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.overlap.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.overlap -=============== - -.. currentmodule:: cugraph - -.. autofunction:: overlap \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.overlap_coefficient.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.overlap_coefficient.rst deleted file mode 100644 index cd65568..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.overlap_coefficient.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.overlap\_coefficient -============================ - -.. currentmodule:: cugraph - -.. autofunction:: overlap_coefficient \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.pagerank.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.pagerank.rst deleted file mode 100644 index dcbf729..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.pagerank.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.pagerank -================ - -.. currentmodule:: cugraph - -.. autofunction:: pagerank \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.random_walks.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.random_walks.rst deleted file mode 100644 index 706dd04..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.random_walks.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.random\_walks -===================== - -.. currentmodule:: cugraph - -.. autofunction:: random_walks \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.shortest_path.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.shortest_path.rst deleted file mode 100644 index a15c77b..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.shortest_path.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.shortest\_path -====================== - -.. currentmodule:: cugraph - -.. autofunction:: shortest_path \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.shortest_path_length.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.shortest_path_length.rst deleted file mode 100644 index 25e3247..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.shortest_path_length.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.shortest\_path\_length -============================== - -.. currentmodule:: cugraph - -.. autofunction:: shortest_path_length \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.sorensen.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.sorensen.rst deleted file mode 100644 index d951956..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.sorensen.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.sorensen -================ - -.. currentmodule:: cugraph - -.. autofunction:: sorensen \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.sorensen_coefficient.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.sorensen_coefficient.rst deleted file mode 100644 index c7a2479..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.sorensen_coefficient.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.sorensen\_coefficient -============================= - -.. currentmodule:: cugraph - -.. autofunction:: sorensen_coefficient \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.spectralBalancedCutClustering.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.spectralBalancedCutClustering.rst deleted file mode 100644 index b04611e..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.spectralBalancedCutClustering.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.spectralBalancedCutClustering -===================================== - -.. currentmodule:: cugraph - -.. autofunction:: spectralBalancedCutClustering \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.spectralModularityMaximizationClustering.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.spectralModularityMaximizationClustering.rst deleted file mode 100644 index d2630bd..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.spectralModularityMaximizationClustering.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.spectralModularityMaximizationClustering -================================================ - -.. currentmodule:: cugraph - -.. autofunction:: spectralModularityMaximizationClustering \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.sssp.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.sssp.rst deleted file mode 100644 index 4c01978..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.sssp.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.sssp -============ - -.. currentmodule:: cugraph - -.. autofunction:: sssp \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.strongly_connected_components.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.strongly_connected_components.rst deleted file mode 100644 index 61fe3ef..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.strongly_connected_components.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.strongly\_connected\_components -======================================= - -.. currentmodule:: cugraph - -.. autofunction:: strongly_connected_components \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.structure.NumberMap.add_internal_vertex_id.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.structure.NumberMap.add_internal_vertex_id.rst deleted file mode 100644 index 125da9d..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.structure.NumberMap.add_internal_vertex_id.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.structure.NumberMap.add\_internal\_vertex\_id -===================================================== - -.. currentmodule:: cugraph.structure - -.. automethod:: NumberMap.add_internal_vertex_id \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.structure.NumberMap.compute_vals.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.structure.NumberMap.compute_vals.rst deleted file mode 100644 index 3f095e4..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.structure.NumberMap.compute_vals.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.structure.NumberMap.compute\_vals -========================================= - -.. currentmodule:: cugraph.structure - -.. automethod:: NumberMap.compute_vals \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.structure.NumberMap.compute_vals_types.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.structure.NumberMap.compute_vals_types.rst deleted file mode 100644 index 659030a..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.structure.NumberMap.compute_vals_types.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.structure.NumberMap.compute\_vals\_types -================================================ - -.. currentmodule:: cugraph.structure - -.. automethod:: NumberMap.compute_vals_types \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.structure.NumberMap.from_internal_vertex_id.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.structure.NumberMap.from_internal_vertex_id.rst deleted file mode 100644 index c87f8a4..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.structure.NumberMap.from_internal_vertex_id.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.structure.NumberMap.from\_internal\_vertex\_id -====================================================== - -.. currentmodule:: cugraph.structure - -.. automethod:: NumberMap.from_internal_vertex_id \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.structure.NumberMap.generate_unused_column_name.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.structure.NumberMap.generate_unused_column_name.rst deleted file mode 100644 index 6275e82..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.structure.NumberMap.generate_unused_column_name.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.structure.NumberMap.generate\_unused\_column\_name -========================================================== - -.. currentmodule:: cugraph.structure - -.. automethod:: NumberMap.generate_unused_column_name \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.structure.NumberMap.renumber.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.structure.NumberMap.renumber.rst deleted file mode 100644 index ebd288b..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.structure.NumberMap.renumber.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.structure.NumberMap.renumber -==================================== - -.. currentmodule:: cugraph.structure - -.. automethod:: NumberMap.renumber \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.structure.NumberMap.renumber_and_segment.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.structure.NumberMap.renumber_and_segment.rst deleted file mode 100644 index a6f9ed7..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.structure.NumberMap.renumber_and_segment.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.structure.NumberMap.renumber\_and\_segment -================================================== - -.. currentmodule:: cugraph.structure - -.. automethod:: NumberMap.renumber_and_segment \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.structure.NumberMap.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.structure.NumberMap.rst deleted file mode 100644 index 3528408..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.structure.NumberMap.rst +++ /dev/null @@ -1,33 +0,0 @@ -cugraph.structure.NumberMap -=========================== - -.. currentmodule:: cugraph.structure - -.. autoclass:: NumberMap - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~NumberMap.__init__ - ~NumberMap.add_internal_vertex_id - ~NumberMap.compute_vals - ~NumberMap.compute_vals_types - ~NumberMap.from_internal_vertex_id - ~NumberMap.generate_unused_column_name - ~NumberMap.renumber - ~NumberMap.renumber_and_segment - ~NumberMap.set_renumbered_col_names - ~NumberMap.to_internal_vertex_id - ~NumberMap.unrenumber - ~NumberMap.vertex_column_size - - - - - - \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.structure.NumberMap.set_renumbered_col_names.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.structure.NumberMap.set_renumbered_col_names.rst deleted file mode 100644 index f2b1fa8..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.structure.NumberMap.set_renumbered_col_names.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.structure.NumberMap.set\_renumbered\_col\_names -======================================================= - -.. currentmodule:: cugraph.structure - -.. automethod:: NumberMap.set_renumbered_col_names \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.structure.NumberMap.to_internal_vertex_id.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.structure.NumberMap.to_internal_vertex_id.rst deleted file mode 100644 index 688acc1..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.structure.NumberMap.to_internal_vertex_id.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.structure.NumberMap.to\_internal\_vertex\_id -==================================================== - -.. currentmodule:: cugraph.structure - -.. automethod:: NumberMap.to_internal_vertex_id \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.structure.NumberMap.unrenumber.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.structure.NumberMap.unrenumber.rst deleted file mode 100644 index 9db2159..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.structure.NumberMap.unrenumber.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.structure.NumberMap.unrenumber -====================================== - -.. currentmodule:: cugraph.structure - -.. automethod:: NumberMap.unrenumber \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.structure.NumberMap.vertex_column_size.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.structure.NumberMap.vertex_column_size.rst deleted file mode 100644 index bea4fcd..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.structure.NumberMap.vertex_column_size.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.structure.NumberMap.vertex\_column\_size -================================================ - -.. currentmodule:: cugraph.structure - -.. automethod:: NumberMap.vertex_column_size \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.structure.graph_implementation.simpleGraphImpl.degree.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.structure.graph_implementation.simpleGraphImpl.degree.rst deleted file mode 100644 index 99eb77c..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.structure.graph_implementation.simpleGraphImpl.degree.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.structure.graph\_implementation.simpleGraphImpl.degree -============================================================== - -.. currentmodule:: cugraph.structure.graph_implementation - -.. automethod:: simpleGraphImpl.degree \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.structure.graph_implementation.simpleGraphImpl.degrees.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.structure.graph_implementation.simpleGraphImpl.degrees.rst deleted file mode 100644 index 28b87a6..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.structure.graph_implementation.simpleGraphImpl.degrees.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.structure.graph\_implementation.simpleGraphImpl.degrees -=============================================================== - -.. currentmodule:: cugraph.structure.graph_implementation - -.. automethod:: simpleGraphImpl.degrees \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.structure.graph_implementation.simpleGraphImpl.delete_adj_list.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.structure.graph_implementation.simpleGraphImpl.delete_adj_list.rst deleted file mode 100644 index 533fce5..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.structure.graph_implementation.simpleGraphImpl.delete_adj_list.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.structure.graph\_implementation.simpleGraphImpl.delete\_adj\_list -========================================================================= - -.. currentmodule:: cugraph.structure.graph_implementation - -.. automethod:: simpleGraphImpl.delete_adj_list \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.structure.graph_implementation.simpleGraphImpl.delete_edge_list.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.structure.graph_implementation.simpleGraphImpl.delete_edge_list.rst deleted file mode 100644 index c097f84..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.structure.graph_implementation.simpleGraphImpl.delete_edge_list.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.structure.graph\_implementation.simpleGraphImpl.delete\_edge\_list -========================================================================== - -.. currentmodule:: cugraph.structure.graph_implementation - -.. automethod:: simpleGraphImpl.delete_edge_list \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.structure.graph_implementation.simpleGraphImpl.edges.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.structure.graph_implementation.simpleGraphImpl.edges.rst deleted file mode 100644 index 0399cf5..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.structure.graph_implementation.simpleGraphImpl.edges.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.structure.graph\_implementation.simpleGraphImpl.edges -============================================================= - -.. currentmodule:: cugraph.structure.graph_implementation - -.. automethod:: simpleGraphImpl.edges \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.structure.graph_implementation.simpleGraphImpl.enable_batch.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.structure.graph_implementation.simpleGraphImpl.enable_batch.rst deleted file mode 100644 index 7231cb3..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.structure.graph_implementation.simpleGraphImpl.enable_batch.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.structure.graph\_implementation.simpleGraphImpl.enable\_batch -===================================================================== - -.. currentmodule:: cugraph.structure.graph_implementation - -.. automethod:: simpleGraphImpl.enable_batch \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.structure.graph_implementation.simpleGraphImpl.get_two_hop_neighbors.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.structure.graph_implementation.simpleGraphImpl.get_two_hop_neighbors.rst deleted file mode 100644 index d2e05f8..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.structure.graph_implementation.simpleGraphImpl.get_two_hop_neighbors.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.structure.graph\_implementation.simpleGraphImpl.get\_two\_hop\_neighbors -================================================================================ - -.. currentmodule:: cugraph.structure.graph_implementation - -.. automethod:: simpleGraphImpl.get_two_hop_neighbors \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.structure.graph_implementation.simpleGraphImpl.has_edge.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.structure.graph_implementation.simpleGraphImpl.has_edge.rst deleted file mode 100644 index 2c0d9c3..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.structure.graph_implementation.simpleGraphImpl.has_edge.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.structure.graph\_implementation.simpleGraphImpl.has\_edge -================================================================= - -.. currentmodule:: cugraph.structure.graph_implementation - -.. automethod:: simpleGraphImpl.has_edge \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.structure.graph_implementation.simpleGraphImpl.has_node.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.structure.graph_implementation.simpleGraphImpl.has_node.rst deleted file mode 100644 index ecc7d27..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.structure.graph_implementation.simpleGraphImpl.has_node.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.structure.graph\_implementation.simpleGraphImpl.has\_node -================================================================= - -.. currentmodule:: cugraph.structure.graph_implementation - -.. automethod:: simpleGraphImpl.has_node \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.structure.graph_implementation.simpleGraphImpl.has_self_loop.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.structure.graph_implementation.simpleGraphImpl.has_self_loop.rst deleted file mode 100644 index cc1e588..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.structure.graph_implementation.simpleGraphImpl.has_self_loop.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.structure.graph\_implementation.simpleGraphImpl.has\_self\_loop -======================================================================= - -.. currentmodule:: cugraph.structure.graph_implementation - -.. automethod:: simpleGraphImpl.has_self_loop \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.structure.graph_implementation.simpleGraphImpl.in_degree.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.structure.graph_implementation.simpleGraphImpl.in_degree.rst deleted file mode 100644 index cbb92ee..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.structure.graph_implementation.simpleGraphImpl.in_degree.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.structure.graph\_implementation.simpleGraphImpl.in\_degree -================================================================== - -.. currentmodule:: cugraph.structure.graph_implementation - -.. automethod:: simpleGraphImpl.in_degree \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.structure.graph_implementation.simpleGraphImpl.neighbors.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.structure.graph_implementation.simpleGraphImpl.neighbors.rst deleted file mode 100644 index 9dab704..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.structure.graph_implementation.simpleGraphImpl.neighbors.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.structure.graph\_implementation.simpleGraphImpl.neighbors -================================================================= - -.. currentmodule:: cugraph.structure.graph_implementation - -.. automethod:: simpleGraphImpl.neighbors \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.structure.graph_implementation.simpleGraphImpl.nodes.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.structure.graph_implementation.simpleGraphImpl.nodes.rst deleted file mode 100644 index 5a87865..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.structure.graph_implementation.simpleGraphImpl.nodes.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.structure.graph\_implementation.simpleGraphImpl.nodes -============================================================= - -.. currentmodule:: cugraph.structure.graph_implementation - -.. automethod:: simpleGraphImpl.nodes \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.structure.graph_implementation.simpleGraphImpl.number_of_edges.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.structure.graph_implementation.simpleGraphImpl.number_of_edges.rst deleted file mode 100644 index e44718a..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.structure.graph_implementation.simpleGraphImpl.number_of_edges.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.structure.graph\_implementation.simpleGraphImpl.number\_of\_edges -========================================================================= - -.. currentmodule:: cugraph.structure.graph_implementation - -.. automethod:: simpleGraphImpl.number_of_edges \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.structure.graph_implementation.simpleGraphImpl.number_of_nodes.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.structure.graph_implementation.simpleGraphImpl.number_of_nodes.rst deleted file mode 100644 index 9078a40..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.structure.graph_implementation.simpleGraphImpl.number_of_nodes.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.structure.graph\_implementation.simpleGraphImpl.number\_of\_nodes -========================================================================= - -.. currentmodule:: cugraph.structure.graph_implementation - -.. automethod:: simpleGraphImpl.number_of_nodes \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.structure.graph_implementation.simpleGraphImpl.number_of_vertices.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.structure.graph_implementation.simpleGraphImpl.number_of_vertices.rst deleted file mode 100644 index 6159475..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.structure.graph_implementation.simpleGraphImpl.number_of_vertices.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.structure.graph\_implementation.simpleGraphImpl.number\_of\_vertices -============================================================================ - -.. currentmodule:: cugraph.structure.graph_implementation - -.. automethod:: simpleGraphImpl.number_of_vertices \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.structure.graph_implementation.simpleGraphImpl.out_degree.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.structure.graph_implementation.simpleGraphImpl.out_degree.rst deleted file mode 100644 index f2314bb..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.structure.graph_implementation.simpleGraphImpl.out_degree.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.structure.graph\_implementation.simpleGraphImpl.out\_degree -=================================================================== - -.. currentmodule:: cugraph.structure.graph_implementation - -.. automethod:: simpleGraphImpl.out_degree \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.structure.graph_implementation.simpleGraphImpl.vertex_column_size.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.structure.graph_implementation.simpleGraphImpl.vertex_column_size.rst deleted file mode 100644 index d6d0514..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.structure.graph_implementation.simpleGraphImpl.vertex_column_size.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.structure.graph\_implementation.simpleGraphImpl.vertex\_column\_size -============================================================================ - -.. currentmodule:: cugraph.structure.graph_implementation - -.. automethod:: simpleGraphImpl.vertex_column_size \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.structure.graph_implementation.simpleGraphImpl.view_adj_list.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.structure.graph_implementation.simpleGraphImpl.view_adj_list.rst deleted file mode 100644 index a1e55b7..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.structure.graph_implementation.simpleGraphImpl.view_adj_list.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.structure.graph\_implementation.simpleGraphImpl.view\_adj\_list -======================================================================= - -.. currentmodule:: cugraph.structure.graph_implementation - -.. automethod:: simpleGraphImpl.view_adj_list \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.structure.graph_implementation.simpleGraphImpl.view_edge_list.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.structure.graph_implementation.simpleGraphImpl.view_edge_list.rst deleted file mode 100644 index f7b18ad..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.structure.graph_implementation.simpleGraphImpl.view_edge_list.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.structure.graph\_implementation.simpleGraphImpl.view\_edge\_list -======================================================================== - -.. currentmodule:: cugraph.structure.graph_implementation - -.. automethod:: simpleGraphImpl.view_edge_list \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.structure.graph_implementation.simpleGraphImpl.view_transposed_adj_list.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.structure.graph_implementation.simpleGraphImpl.view_transposed_adj_list.rst deleted file mode 100644 index c9a06f2..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.structure.graph_implementation.simpleGraphImpl.view_transposed_adj_list.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.structure.graph\_implementation.simpleGraphImpl.view\_transposed\_adj\_list -=================================================================================== - -.. currentmodule:: cugraph.structure.graph_implementation - -.. automethod:: simpleGraphImpl.view_transposed_adj_list \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.subgraph.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.subgraph.rst deleted file mode 100644 index 7981947..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.subgraph.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.subgraph -================ - -.. currentmodule:: cugraph - -.. autofunction:: subgraph \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.symmetrize.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.symmetrize.rst deleted file mode 100644 index a4d71ff..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.symmetrize.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.symmetrize -================== - -.. currentmodule:: cugraph - -.. autofunction:: symmetrize \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.symmetrize_ddf.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.symmetrize_ddf.rst deleted file mode 100644 index 6ce6214..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.symmetrize_ddf.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.symmetrize\_ddf -======================= - -.. currentmodule:: cugraph - -.. autofunction:: symmetrize_ddf \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.symmetrize_df.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.symmetrize_df.rst deleted file mode 100644 index 70b2ec9..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.symmetrize_df.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.symmetrize\_df -====================== - -.. currentmodule:: cugraph - -.. autofunction:: symmetrize_df \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.to_numpy_array.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.to_numpy_array.rst deleted file mode 100644 index d550daa..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.to_numpy_array.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.to\_numpy\_array -======================== - -.. currentmodule:: cugraph - -.. autofunction:: to_numpy_array \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.to_numpy_matrix.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.to_numpy_matrix.rst deleted file mode 100644 index b0dd10c..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.to_numpy_matrix.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.to\_numpy\_matrix -========================= - -.. currentmodule:: cugraph - -.. autofunction:: to_numpy_matrix \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.to_pandas_adjacency.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.to_pandas_adjacency.rst deleted file mode 100644 index df82ad7..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.to_pandas_adjacency.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.to\_pandas\_adjacency -============================= - -.. currentmodule:: cugraph - -.. autofunction:: to_pandas_adjacency \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.to_pandas_edgelist.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.to_pandas_edgelist.rst deleted file mode 100644 index 4960552..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.to_pandas_edgelist.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.to\_pandas\_edgelist -============================ - -.. currentmodule:: cugraph - -.. autofunction:: to_pandas_edgelist \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.tree.minimum_spanning_tree.maximum_spanning_tree.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.tree.minimum_spanning_tree.maximum_spanning_tree.rst deleted file mode 100644 index cd5a522..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.tree.minimum_spanning_tree.maximum_spanning_tree.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.tree.minimum\_spanning\_tree.maximum\_spanning\_tree -============================================================ - -.. currentmodule:: cugraph.tree.minimum_spanning_tree - -.. autofunction:: maximum_spanning_tree \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.tree.minimum_spanning_tree.minimum_spanning_tree.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.tree.minimum_spanning_tree.minimum_spanning_tree.rst deleted file mode 100644 index 14a9d69..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.tree.minimum_spanning_tree.minimum_spanning_tree.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.tree.minimum\_spanning\_tree.minimum\_spanning\_tree -============================================================ - -.. currentmodule:: cugraph.tree.minimum_spanning_tree - -.. autofunction:: minimum_spanning_tree \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.triangle_count.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.triangle_count.rst deleted file mode 100644 index 0ef559a..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.triangle_count.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.triangle\_count -======================= - -.. currentmodule:: cugraph - -.. autofunction:: triangle_count \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.uniform_neighbor_sample.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.uniform_neighbor_sample.rst deleted file mode 100644 index 82bb1b7..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.uniform_neighbor_sample.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.uniform\_neighbor\_sample -================================= - -.. currentmodule:: cugraph - -.. autofunction:: uniform_neighbor_sample \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.weakly_connected_components.rst b/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.weakly_connected_components.rst deleted file mode 100644 index f770b1e..0000000 --- a/docs/cugraph-docs/source/api_docs/api/cugraph/cugraph.weakly_connected_components.rst +++ /dev/null @@ -1,6 +0,0 @@ -cugraph.weakly\_connected\_components -===================================== - -.. currentmodule:: cugraph - -.. autofunction:: weakly_connected_components \ No newline at end of file diff --git a/docs/cugraph-docs/source/api_docs/cugraph-dgl/cugraph_dgl.rst b/docs/cugraph-docs/source/api_docs/cugraph-dgl/cugraph_dgl.rst index 18f81b8..4ffecd8 100644 --- a/docs/cugraph-docs/source/api_docs/cugraph-dgl/cugraph_dgl.rst +++ b/docs/cugraph-docs/source/api_docs/cugraph-dgl/cugraph_dgl.rst @@ -11,5 +11,5 @@ Methods .. autosummary:: :toctree: ../api/cugraph-dgl/ - cugraph_storage_from_heterograph - CuGraphStorage + convert.cugraph_storage_from_heterograph + cugraph_storage.CuGraphStorage diff --git a/docs/cugraph-docs/source/api_docs/cugraph-pyg/cugraph_pyg.rst b/docs/cugraph-docs/source/api_docs/cugraph-pyg/cugraph_pyg.rst index a150d4d..d2b1d12 100644 --- a/docs/cugraph-docs/source/api_docs/cugraph-pyg/cugraph_pyg.rst +++ b/docs/cugraph-docs/source/api_docs/cugraph-pyg/cugraph_pyg.rst @@ -6,8 +6,38 @@ cugraph-pyg .. currentmodule:: cugraph_pyg +Graph Storage +------------- .. autosummary:: :toctree: ../api/cugraph-pyg/ -.. cugraph_pyg.data.cugraph_store.EXPERIMENTAL__CuGraphStore -.. cugraph_pyg.sampler.cugraph_sampler.EXPERIMENTAL__CuGraphSampler + cugraph_pyg.data.dask_graph_store.DaskGraphStore + cugraph_pyg.data.graph_store.GraphStore + +Feature Storage +--------------- +.. autosummary:: + :toctree: ../api/cugraph-pyg/ + + cugraph_pyg.data.feature_store.TensorDictFeatureStore + cugraph_pyg.data.feature_store.WholeFeatureStore + +Data Loaders +------------ +.. autosummary:: + :toctree: ../api/cugraph-pyg/ + + cugraph_pyg.loader.dask_node_loader.DaskNeighborLoader + cugraph_pyg.loader.dask_node_loader.BulkSampleLoader + cugraph_pyg.loader.node_loader.NodeLoader + cugraph_pyg.loader.neighbor_loader.NeighborLoader + +Samplers +-------- +.. autosummary:: + :toctree: ../api/cugraph-pyg/ + + cugraph_pyg.sampler.sampler.BaseSampler + cugraph_pyg.sampler.sampler.SampleReader + cugraph_pyg.sampler.sampler.HomogeneousSampleReader + cugraph_pyg.sampler.sampler.SampleIterator diff --git a/docs/cugraph-docs/source/api_docs/index.rst b/docs/cugraph-docs/source/api_docs/index.rst index d769027..ccb7aac 100644 --- a/docs/cugraph-docs/source/api_docs/index.rst +++ b/docs/cugraph-docs/source/api_docs/index.rst @@ -20,12 +20,11 @@ Graph Neural Networks API Documentation .. toctree:: :maxdepth: 3 - :caption: Graph Nerual Networks API Documentation + :caption: Graph Neural Networks API Documentation cugraph-dgl/cugraph_dgl.rst cugraph-pyg/cugraph_pyg.rst - cugraph-ops/index.rst - wholegraph/index.rst + .. wholegraph/index.rst Additional Graph Packages API Documentation ---------------------------------- diff --git a/docs/cugraph-docs/source/basics/index.md b/docs/cugraph-docs/source/basics/index.md new file mode 100644 index 0000000..36aad51 --- /dev/null +++ b/docs/cugraph-docs/source/basics/index.md @@ -0,0 +1,67 @@ +# cuGraph Introduction + +The Data Scientist has a collection of techniques within their +proverbial toolbox. Data engineering, statistical analysis, and +machine learning are among the most commonly known. However, there +are numerous cases where the focus of the analysis is on the +relationship between data elements. In those cases, the data is best +represented as a graph. Graph analysis, also called network analysis, +is a collection of algorithms for answering questions posed against +graph data. Graph analysis is not new. + +The first graph problem was posed by Euler in 1736, the [Seven Bridges of +Konigsberg](https://en.wikipedia.org/wiki/Seven_Bridges_of_K%C3%B6nigsberg), +and laid the foundation for the mathematical field of graph theory. +The application of graph analysis covers a wide variety of fields, including +marketing, biology, physics, computer science, sociology, and cyber to name a few. + +RAPIDS cuGraph is a library of graph algorithms that seamlessly integrates +into the RAPIDS data science ecosystem and allows the data scientist to easily +call graph algorithms using data stored in a GPU DataFrame, NetworkX Graphs, or even +CuPy or SciPy sparse Matrix. + +## Vision + +The vision of RAPIDS cuGraph is to ___make graph analysis ubiquitous to the +point that users just think in terms of analysis and not technologies or +frameworks___. This is a goal that many of us on the cuGraph team have been +working on for almost twenty years. Many of the early attempts focused on +solving one problem or using one technique. Those early attempts worked for +the initial goal but tended to break as the scope changed (e.g., shifting +to solving a dynamic graph problem with a static graph solution). The limiting +factors usually came down to compute power, ease-of-use, or choosing a data +structure that was not suited for all problems. NVIDIA GPUs, CUDA, and RAPIDS +have totally changed the paradigm and the goal of an accelerated unified graph +analytic library is now possible. + +The compute power of the latest NVIDIA GPUs (RAPIDS supports Pascal and later +GPU architectures) make graph analytics 1000x faster on average over NetworkX. +Moreover, the internal memory speed within a GPU allows cuGraph to rapidly +switch the data structure to best suit the needs of the analytic rather than +being restricted to a single data structure. cuGraph is working with several +frameworks for both static and dynamic graph data structures so that we always +have a solution to any graph problem. Since Python has emerged as the de facto +language for data science, allowing interactivity and the ability to run graph +analytics in Python makes cuGraph familiar and approachable. RAPIDS wraps all +the graph analytic goodness mentioned above with the ability to perform +high-speed ETL, statistics, and machine learning. To make things even better, +RAPIDS and DASK allows cuGraph to scale to multiple GPUs to support +multi-billion edge graphs. + +## Terminology + +cuGraph is a collection of GPU accelerated graph algorithms and graph utility +functions. The application of graph analysis covers a lot of areas. +For Example: +* [Network Science](https://en.wikipedia.org/wiki/Network_science) +* [Complex Network](https://en.wikipedia.org/wiki/Complex_network) +* [Graph Theory](https://en.wikipedia.org/wiki/Graph_theory) +* [Social Network Analysis](https://en.wikipedia.org/wiki/Social_network_analysis) + +cuGraph does not favor one field over another. Our developers span the +breadth of fields with the focus being to produce the best graph library +possible. However, each field has its own argot (jargon) for describing the +graph (or network). In our documentation, we try to be consistent. In Python +documentation we will mostly use the terms __Node__ and __Edge__ to better +match NetworkX preferred term use, as well as other Python-based tools. At +the CUDA/C layer, we favor the mathematical terms of __Vertex__ and __Edge__. diff --git a/docs/cugraph-docs/source/basics/index.rst b/docs/cugraph-docs/source/basics/index.rst index 7bba301..7d6b600 100644 --- a/docs/cugraph-docs/source/basics/index.rst +++ b/docs/cugraph-docs/source/basics/index.rst @@ -7,5 +7,4 @@ Basics :maxdepth: 2 cugraph_intro - nx_transition cugraph_cascading diff --git a/docs/cugraph-docs/source/basics/nx_transition.rst b/docs/cugraph-docs/source/basics/nx_transition.rst deleted file mode 100644 index 07c2ad2..0000000 --- a/docs/cugraph-docs/source/basics/nx_transition.rst +++ /dev/null @@ -1,183 +0,0 @@ -************************************** -NetworkX by calling cuGraph Algorithms -************************************** - - -*Note: this is a work in progress and will be updatred and changed as we better flesh out -compatibility issues* - -Latest Update -############# - -Last Update: March 7th, 2024 -Release: 24.04 - -**CuGraph is now a registered backend for networkX. This is described in the following blog: -`Accelerating NetworkX on NVIDIA GPUs for High Performance Graph Analytics -`_ - - -Easy Path – Use NetworkX Graph Objects, Accelerated Algorithms -############################################################## - -Rather than updating all of your existing code, simply update the calls to -graph algorithms by replacing the module name. This allows all the complicated -ETL code to be unchanged while still seeing significate performance -improvements. Again this will be deprecated since networkX dispatching to nx_cugraph -has many advantages. - -improvements. - - -.. image:: ../images/Nx_Cg_1.png - :width: 600 - -It is that easy. All algorithms in cuGraph support a NetworkX graph object as -input and match the NetworkX API list of arguments. - -Currently, cuGraph accepts both NetworkX Graph and DiGraph objects. We will be -adding support for Bipartite graph and Multigraph over the next few releases. - -Differences in Algorithms -########################## - -Since cuGraph currently does not support attribute rich graphs, those -algorithms that return simple scores (centrality, clustering, etc.) best match -the NetworkX process. Algorithms that return a subgraph will do so without -any additional attributes on the nodes or edges. - -Algorithms that exactly match -***************************** - -+-------------------------------+------------------------+ -| Algorithm | Differences | -+===============================+========================+ -| Core Number | None | -+-------------------------------+------------------------+ -| HITS | None | -+-------------------------------+------------------------+ -| PageRank | None | -+-------------------------------+------------------------+ -| Personal PageRank | None | -+-------------------------------+------------------------+ -| Strongly Connected Components | None | -+-------------------------------+------------------------+ -| Weakly Connected Components | None | -+-------------------------------+------------------------+ - -| - - - -Algorithms that do not copy over additional attributes -************************************************************************ - -+-------------------------------+-------------------------------------+ -| Algorithm | Differences | -+===============================+=====================================+ -| K-Truss | Does not copy over attributes | -+-------------------------------+-------------------------------------+ -| K-Core | Does not copy over attributes | -+-------------------------------+-------------------------------------+ -| Subgraph Extraction | Does not copy over attributes | -+-------------------------------+-------------------------------------+ - -| - - -Algorithms not in NetworkX -************************** - -+--------------------------------------+----------------------------+ -| Algorithm | Differences | -+======================================+============================+ -| Ensemble Clustering for Graphs (ECG) | Currently not in NetworkX | -+--------------------------------------+----------------------------+ -| Force Atlas 2 | Currently not in NetworkX | -+--------------------------------------+----------------------------+ -| Leiden | Currently not in NetworkX | -+--------------------------------------+----------------------------+ -| Louvain | Currently not in NetworkX | -+--------------------------------------+----------------------------+ -| Overlap coefficient | Currently not in NetworkX | -+--------------------------------------+----------------------------+ -| Spectral Clustering | Currently not in NetworkX | -+--------------------------------------+----------------------------+ - -| - - -Algorithm where not all arguments are supported -*********************************************** - -+----------------------------+-------------------------------------------------+ -| Algorithm | Differences | -+============================+=================================================+ -|Betweenness Centrality | weight is currently not supported – ignored | -| | endpoints is currently not supported – ignored | -+----------------------------+-------------------------------------------------+ -|Edge Betweenness Centrality | weight is currently not supported – ignored | -+----------------------------+-------------------------------------------------+ -| Katz Centrality | beta is currently not supported – ignored | -| | max_iter defaults to 100 versus 1000 | -+----------------------------+-------------------------------------------------+ - -| - -Algorithms where the results are different -****************************************** - - -For example, the NetworkX traversal algorithms typically return a generator -rather than a dictionary. - - -+----------------------------+-------------------------------------------------+ -| Algorithm | Differences | -+============================+=================================================+ -| Triangle Counting | this algorithm simply returns the total number | -| | of triangle and not the number per vertex | -| | (on roadmap to update) | -+----------------------------+-------------------------------------------------+ -| Jaccard coefficient | Currently we only do a 1-hop computation rather | -| | than an all-pairs. Fix is on roadmap | -+----------------------------+-------------------------------------------------+ -| Breadth First Search (BFS) | Returns a Pandas DataFrame with: | -| | [vertex][distance][predecessor] | -+----------------------------+-------------------------------------------------+ -| Single Source | Returns a Pandas DataFrame with: | -| Shortest Path (SSSP) | [vertex][distance][predecessor] | -+----------------------------+-------------------------------------------------+ - -| - -Graph Building -############## - -The biggest difference between NetworkX and cuGraph is with how Graph objects -are built. NetworkX, for the most part, stores graph data in a dictionary. -That structure allows easy insertion of new records. Consider the following -code for building a NetworkX Graph:: - - # Read the node data - df = pd.read_csv( data_file) - - # Construct graph from edge list. - G = nx.DiGraph() - - for row in df.iterrows(): - G.add_edge( - row[1]["1"], row[1]["2"], count=row[1]["3"] - ) - - -The code block is perfectly fine for NetworkX. However, the process of iterating over the dataframe and adding one node at a time is problematic for GPUs and something that we try and avoid. cuGraph stores data in columns (i.e. arrays). Resizing an array requires allocating a new array one element larger, copying the data, and adding the new value. That is not very efficient. - -If your code follows the above model of inserting one element at a time, the we suggest either rewriting that code or using it as is within NetworkX and just accelerating the algorithms with cuGraph. - -Now, if your code bulk loads the data from Pandas, then RAPIDS can accelerate that process by orders of magnitude. - -.. image:: ../images/Nx_Cg_2.png - :width: 600 - -The above cuGraph code will create cuGraph.Graph object and not a NetworkX.Graph object. 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 new file mode 100644 index 0000000..b3f7ac1 --- /dev/null +++ b/docs/cugraph-docs/source/graph_support/algorithms/cpp_algorithms/centrality_cpp.md @@ -0,0 +1,81 @@ +# Centrality algorithms +cuGraph Pagerank is implemented using our graph primitive library + +## Pagerank + +The unit test code is the best place to search for examples on calling pagerank. + + * [SG Implementation](https://github.com/rapidsai/cugraph/blob/main/cpp/tests/link_analysis/pagerank_test.cpp) + * [MG Implementation](https://github.com/rapidsai/cugraph/blob/main/cpp/tests/link_analysis/mg_pagerank_test.cpp) + +## Simple pagerank + +The example assumes that you create an SG or MG graph somehow. The caller must create the pageranks vector in device memory and pass in the raw pointer to that vector into the pagerank function. + +```cpp +#include +... +using vertex_t = int32_t; // or int64_t, whichever is appropriate +using weight_t = float; // or double, whichever is appropriate +using result_t = weight_t; // could specify float or double also +raft::handle_t handle; // Must be configured if MG +auto graph_view = graph.view(); // assumes you have created a graph somehow + +result_t constexpr alpha{0.85}; +result_t constexpr epsilon{1e-6}; + +rmm::device_uvector pageranks_v(graph_view.number_of_vertices(), handle.get_stream()); + +// pagerank optionally supports three additional parameters: +// max_iterations - maximum number of iterations, if pagerank doesn't coverge by +// then we abort +// has_initial_guess - if true, values in the pagerank array when the call is initiated +// will be used as the initial pagerank values. These values will +// be normalized before use. If false (the default), the values +// in the pagerank array will be set to 1/num_vertices before +// starting the computation. +// do_expensive_check - perform extensive validation of the input data before +// executing algorithm. Off by default. Note: turning this on +// is expensive +cugraph::pagerank(handle, graph_view, nullptr, nullptr, nullptr, vertex_t{0}, + pageranks_v.data(), alpha, epsilon); +``` + +## Personalized Pagerank + +The example assumes that you create an SG or MG graph somehow. The caller must create the pageranks vector in device memory and pass in the raw pointer to that vector into the pagerank function. Additionally, the caller must create personalization_vertices and personalized_values vectors in device memory, populate them and pass in the raw pointers to those vectors. + +```cpp +#include +... +using vertex_t = int32_t; // or int64_t, whichever is appropriate +using weight_t = float; // or double, whichever is appropriate +using result_t = weight_t; // could specify float or double also +raft::handle_t handle; // Must be configured if MG +auto graph_view = graph.view(); // assumes you have created a graph somehow +vertex_t number_of_personalization_vertices; // Provided by caller + +result_t constexpr alpha{0.85}; +result_t constexpr epsilon{1e-6}; + +rmm::device_uvector pageranks_v(graph_view.number_of_vertices(), handle.get_stream()); +rmm::device_uvector personalization_vertices(number_of_personalization_vertices, handle.get_stream()); +rmm::device_uvector personalization_values(number_of_personalization_vertices, handle.get_stream()); + +// Populate personalization_vertices, personalization_values with user provided data + +// pagerank optionally supports three additional parameters: +// max_iterations - maximum number of iterations, if pagerank doesn't coverge by +// then we abort +// has_initial_guess - if true, values in the pagerank array when the call is initiated +// will be used as the initial pagerank values. These values will +// be normalized before use. If false (the default), the values +// in the pagerank array will be set to 1/num_vertices before +// starting the computation. +// do_expensive_check - perform extensive validation of the input data before +// executing algorithm. Off by default. Note: turning this on +// is expensive +cugraph::pagerank(handle, graph_view, nullptr, personalization_vertices.data(), + personalization_values.data(), number_of_personalization_vertices, + pageranks_v.data(), alpha, epsilon); +``` diff --git a/docs/cugraph-docs/source/graph_support/algorithms/cpp_algorithms/linear_cpp.md b/docs/cugraph-docs/source/graph_support/algorithms/cpp_algorithms/linear_cpp.md new file mode 100644 index 0000000..8af4a50 --- /dev/null +++ b/docs/cugraph-docs/source/graph_support/algorithms/cpp_algorithms/linear_cpp.md @@ -0,0 +1,37 @@ +# LAP + +Implementation of ***O(n^3) Alternating Tree Variant*** of Hungarian Algorithm on NVIDIA CUDA-enabled GPU. + +This implementation solves a batch of ***k*** **Linear Assignment Problems (LAP)**, each with ***nxn*** matrix of single floating point cost values. At optimality, the algorithm produces an assignment with ***minimum*** cost. + +The API can be used to query optimal primal and dual costs, optimal assignment vector, and optimal row/column dual vectors for each subproblem in the batch. + +cuGraph exposes the Hungarian algorithm, the actual implementation is contained in the RAFT library which contains some common tools and kernels shared between cuGraph and cuML. + +Following parameters can be used to tune the performance of algorithm: + +1. epsilon: (in raft/lap/lap_kernels.cuh) This parameter controls the tolerance on the floating point precision. Setting this too small will result in increased solution time because the algorithm will search for precise solutions. Setting it too high may cause some inaccuracies. + +2. BLOCKDIMX, BLOCKDIMY: (in raft/lap/lap_functions.cuh) These parameters control threads_per_block to be used along the given dimension. Set these according to the device specifications and occupancy calculation. + +***This library is licensed under Apache License 2.0. Please cite our paper, if this library helps you in your research.*** + +- Harvard citation style + + Date, K. and Nagi, R., 2016. GPU-accelerated Hungarian algorithms for the Linear Assignment Problem. Parallel Computing, 57, pp.52-72. + +- BibTeX Citation block to be used in LaTeX bibliography file: + +``` +@article{date2016gpu, + title={GPU-accelerated Hungarian algorithms for the Linear Assignment Problem}, + author={Date, Ketan and Nagi, Rakesh}, + journal={Parallel Computing}, + volume={57}, + pages={52--72}, + year={2016}, + publisher={Elsevier} +} +``` + +The paper is available online on [ScienceDirect](https://www.sciencedirect.com/science/article/abs/pii/S016781911630045X). diff --git a/docs/cugraph-docs/source/graph_support/algorithms/cpp_algorithms/traversal_cpp.md b/docs/cugraph-docs/source/graph_support/algorithms/cpp_algorithms/traversal_cpp.md new file mode 100644 index 0000000..6480d88 --- /dev/null +++ b/docs/cugraph-docs/source/graph_support/algorithms/cpp_algorithms/traversal_cpp.md @@ -0,0 +1,56 @@ +# Traversal +cuGraph traversal algorithms are contained in this directory + +## SSSP + +The unit test code is the best place to search for examples on calling SSSP. + + * [SG Implementation](https://github.com/rapidsai/cugraph/blob/main/cpp/tests/traversal/sssp_test.cpp) + * [MG Implementation](https://github.com/rapidsai/cugraph/blob/main/cpp/tests/traversal/mg_sssp_test.cpp) + +## Simple SSSP + +The example assumes that you create an SG or MG graph somehow. The caller must create the distances and predecessors vectors in device memory and pass in the raw pointers to those vectors into the SSSP function. + +```cpp +#include +... +using vertex_t = int32_t; // or int64_t, whichever is appropriate +using weight_t = float; // or double, whichever is appropriate +using result_t = weight_t; // could specify float or double also +raft::handle_t handle; // Must be configured if MG +auto graph_view = graph.view(); // assumes you have created a graph somehow +vertex_t source; // Initialized by user + +rmm::device_uvector distances_v(graph_view.number_of_vertices(), handle.get_stream()); +rmm::device_uvector predecessors_v(graph_view.number_of_vertices(), handle.get_stream()); + +cugraph::sssp(handle, graph_view, distances_v.begin(), predecessors_v.begin(), source, std::numeric_limits::max(), false); +``` + +## BFS + +The unit test code is the best place to search for examples on calling BFS. + + * [SG Implementation](https://github.com/rapidsai/cugraph/blob/main/cpp/tests/traversal/bfs_test.cpp) + * [MG Implementation](https://github.com/rapidsai/cugraph/blob/main/cpp/tests/traversal/mg_bfs_test.cpp) + +## Simple BFS + +The example assumes that you create an SG or MG graph somehow. The caller must create the distances and predecessors vectors in device memory and pass in the raw pointers to those vectors into the BFS function. + +```cpp +#include +... +using vertex_t = int32_t; // or int64_t, whichever is appropriate +using weight_t = float; // or double, whichever is appropriate +using result_t = weight_t; // could specify float or double also +raft::handle_t handle; // Must be configured if MG +auto graph_view = graph.view(); // assumes you have created a graph somehow +vertex_t source; // Initialized by user + +rmm::device_uvector distances_v(graph_view.number_of_vertices(), handle.get_stream()); +rmm::device_uvector predecessors_v(graph_view.number_of_vertices(), handle.get_stream()); + +cugraph::bfs(handle, graph_view, d_distances.begin(), d_predecessors.begin(), source, false, std::numeric_limits::max(), false); +``` diff --git a/docs/cugraph-docs/source/index.rst b/docs/cugraph-docs/source/index.rst index 5bb819f..0db1860 100644 --- a/docs/cugraph-docs/source/index.rst +++ b/docs/cugraph-docs/source/index.rst @@ -10,21 +10,33 @@ Introduction ~~~~~~~~~~~~ cuGraph is a library of graph algorithms that seamlessly integrates into the RAPIDS data science ecosystem and allows the data scientist to easily call -graph algorithms using data stored in GPU DataFrames, NetworkX Graphs, or -even CuPy or SciPy sparse Matrices. Our major integration effort with NetworkX allows -**zero code change** use of nx-cuGraph as a backend for NetworkX calls. This offers a near seamless -transition to GPU accelerated graph analytics to NetworkX users with access to a supported GPU. +graph algorithms using data stored in cuDF/Pandas DataFrames or CuPy/SciPy +sparse matrices. +--------------------------- +cuGraph Using NetworkX Code +--------------------------- + +cuGraph is now available as a NetworkX backend using `nx-cugraph `_. +Our major integration effort with NetworkX offers NetworkX users a **zero code change** option to accelerate +their existing NetworkX code using an NVIDIA GPU and cuGraph. + +Check out `zero code change accelerated NetworkX `_. If you would like to continue using standard cuGraph, then continue down below. + +---------------------------- Getting started with cuGraph +---------------------------- Required hardware/software for cuGraph and `RAPIDS `_ - * NVIDIA GPU, Volta architecture or later, with `compute capability `_ 7.0+ + * NVIDIA GPU, Volta architecture or later, with `compute capability 7.0+ `_ * CUDA 11.2-11.8, 12.0-12.5 * Python version 3.10, 3.11, or 3.12 - * NetworkX version 3.0 or newer in order to use use the nx-cuGraph backend. Version 3.3 is required to use `NetworkX Configs `_ `see below <#cugraph-using-networkx-code>`_. +++++++++++++ Installation -The latest RAPIDS System Requirements documentation is located `here `_. +++++++++++++ + +Please see the latest `RAPIDS System Requirements documentation `_. This includes several ways to set up cuGraph @@ -37,30 +49,19 @@ This includes several ways to set up cuGraph **Note: Windows use of RAPIDS depends on prior installation of** `WSL2 `_. -* From windows - - * `Conda `_ - * `Docker `_ - * `pip `_ - +* From Windows -Build From Source - -To build from source, check each RAPIDS GitHub README for set up and build instructions. Further links are provided in the `selector tool `_. -If additional help is needed reach out on our `Slack Channel `_. - -CuGraph Using NetworkX Code -While the steps above are required to use the full suite of cuGraph graph analytics, cuGraph is now supported as a NetworkX backend using `nx-cugraph `_. -Nx-cugraph offers those with existing NetworkX code, a **zero code change** option with a growing list of supported algorithms. + * `Conda `_ + * `Docker `_ + * `pip `_ Cugraph API Example .. code-block:: python - # Import needed libraries import cugraph import cudf - + # Create an instance of the popular Zachary Karate Club graph from cugraph.datasets import karate G = karate.get_graph() @@ -68,27 +69,32 @@ Nx-cugraph offers those with existing NetworkX code, a **zero code change** opti # Call cugraph.degree_centrality vertex_bc = cugraph.degree_centrality(G) + There are several resources containing cuGraph examples, the cuGraph `notebook repository `_ has many examples of loading graph data and running algorithms in Jupyter notebooks. + The cuGraph `test code `_ contains script examples of setting up and calling cuGraph algorithms. -There are several resources containing cuGraph examples, `the cuGraph notebook repository `_ -has many examples of loading graph data and running algorithms in Jupyter notebooks. -The `cuGraph test code `_ contains python scripts setting up and calling cuGraph algorithms. -A simple example of `testing the degree centrality algorithm `_ -is a good place to start. Some of these show `multi-GPU tests/examples `_ with larger data sets as well + A simple example of `testing the degree centrality algorithm `_ is a good place to start. There are also `multi-GPU examples `_ with larger data sets as well. + +---- + +~~~~~~~~~~~~~~~~~ +Table of Contents +~~~~~~~~~~~~~~~~~ .. toctree:: :maxdepth: 2 - basics/index - nx_cugraph/index - installation/index - tutorials/index - graph_support/index - wholegraph/index - references/index - api_docs/index - + basics/index + nx_cugraph/index + installation/index + tutorials/index + graph_support/index + wholegraph/index + references/index + api_docs/index + +~~~~~~~~~~~~~~~~~~ Indices and tables -================== +~~~~~~~~~~~~~~~~~~ * :ref:`genindex` * :ref:`search` diff --git a/docs/cugraph-docs/source/installation/getting_cugraph.md b/docs/cugraph-docs/source/installation/getting_cugraph.md index 68197ef..7de87c9 100644 --- a/docs/cugraph-docs/source/installation/getting_cugraph.md +++ b/docs/cugraph-docs/source/installation/getting_cugraph.md @@ -1,9 +1,4 @@ - -.. toctree:: - :maxdepth: 3 - - # Getting cuGraph Packages Start by reading the [RAPIDS Instalation guide](https://docs.rapids.ai/install) @@ -26,7 +21,8 @@ The RAPIDS Docker containers contain all RAPIDS packages, including all from cuG ## Conda -It is easy to install cuGraph using conda. We recommend using [Miniforge](https://github.com/conda-forge/miniforge). + +It is easy to install cuGraph using conda. You can get a minimal conda installation with [miniforge](https://github.com/conda-forge/miniforge). cuGraph Conda packages * cugraph - this will also import: @@ -36,7 +32,6 @@ cuGraph Conda packages * cugraph-service-server * cugraph-dgl * cugraph-pyg - * cugraph-equivariant * nx-cugraph Replace the package name in the example below to the one you want to install. @@ -50,7 +45,7 @@ conda install -c rapidsai -c conda-forge -c nvidia cugraph cuda-version=12.0 Alternatively, use `cuda-version=11.8` for packages supporting CUDA 11. -Note: This conda installation only applies to Linux and Python versions 3.9/3.10/3.11. +Note: This conda installation only applies to Linux and Python versions 3.10/3.11/3.12.
@@ -66,7 +61,6 @@ Replace `-cu12` with `-cu11` for packages supporting CUDA 11. Also available: * cugraph-dgl-cu12 * cugraph-pyg-cu12 - * cugraph-equivariant-cu12 * nx-cugraph-cu12
diff --git a/docs/cugraph-docs/source/installation/source_build.md b/docs/cugraph-docs/source/installation/source_build.md index 49af137..243a62e 100644 --- a/docs/cugraph-docs/source/installation/source_build.md +++ b/docs/cugraph-docs/source/installation/source_build.md @@ -12,8 +12,7 @@ __Compilers:__ * `nvcc` version 11.5+ __CUDA:__ -* CUDA 11.2+ -* NVIDIA driver 470.42.01 or newer +* CUDA 11.8+ * NVIDIA GPU, Volta architecture or later, with [compute capability](https://developer.nvidia.com/cuda-gpus) 7.0+ Further details and download links for these prerequisites are available on the @@ -43,7 +42,7 @@ files](https://github.com/rapidsai/cugraph/blob/main/conda/environments). conda env create --name cugraph_dev --file $CUGRAPH_HOME/conda/environments/all_cuda-118_arch-x86_64.yaml # for CUDA 12.x -conda env create --name cugraph_dev --file $CUGRAPH_HOME/conda/environments/all_cuda-12.2_arch-x86_64.yaml +conda env create --name cugraph_dev --file $CUGRAPH_HOME/conda/environments/all_cuda-125_arch-x86_64.yaml # activate the environment @@ -61,7 +60,7 @@ conda env update --name cugraph_dev --file $CUGRAPH_HOME/conda/environments/all_ conda activate cugraph_dev # for CUDA 12.x -conda env update --name cugraph_dev --file $CUGRAPH_HOME/conda/environments/all_cuda-122_arch-x86_64.yaml +conda env update --name cugraph_dev --file $CUGRAPH_HOME/conda/environments/all_cuda-125_arch-x86_64.yaml conda activate cugraph_dev @@ -178,7 +177,7 @@ Run either the C++ or the Python tests with datasets make test ``` -Note: This conda installation only applies to Linux and Python versions 3.8/3.11. +Note: This conda installation only applies to Linux and Python versions 3.10, 3.11, and 3.12. ### (OPTIONAL) Set environment variable on activation diff --git a/docs/cugraph-docs/source/nx_cugraph/benchmarks.md b/docs/cugraph-docs/source/nx_cugraph/benchmarks.md new file mode 100644 index 0000000..9e07181 --- /dev/null +++ b/docs/cugraph-docs/source/nx_cugraph/benchmarks.md @@ -0,0 +1,26 @@ +# Benchmarks + +## NetworkX vs. nx-cugraph +We ran several commonly used graph algorithms on both `networkx` and `nx-cugraph`. Here are the results + + +
+ +![bench-image](../_static/bc_benchmark.png) + +
Results from running this Benchmark
+
+ +## Reproducing Benchmarks + +Below are the steps to reproduce the results on your own. + +1. Clone the latest + +2. Follow the instructions to build and activate an environment + +4. Install the latest `nx-cugraph` by following the [Installation Guide](installation.md) + +5. Follow the instructions written in the README [here](https://github.com/rapidsai/nx-cugraph/blob/HEAD/benchmarks/nx-cugraph/pytest-based/README.md) diff --git a/docs/cugraph-docs/source/nx_cugraph/how-it-works.md b/docs/cugraph-docs/source/nx_cugraph/how-it-works.md new file mode 100644 index 0000000..0061b04 --- /dev/null +++ b/docs/cugraph-docs/source/nx_cugraph/how-it-works.md @@ -0,0 +1,113 @@ +# How it Works + +NetworkX has the ability to **dispatch function calls to separately-installed third-party backends**. + +NetworkX backends let users experience improved performance and/or additional functionality without changing their NetworkX Python code. Examples include backends that provide algorithm acceleration using GPUs, parallel processing, graph database integration, and more. + +While NetworkX is a pure-Python implementation, backends may be written to use other libraries and even specialized hardware. `nx-cugraph` is a NetworkX backend that uses RAPIDS cuGraph and NVIDIA GPUs to significantly improve NetworkX performance. + +![nxcg-execution-flow](../_static/nxcg-execution-diagram.jpg) + +## Enabling nx-cugraph + +It is recommended to use `networkx>=3.4` for optimal zero code change performance, but `nx-cugraph` will also work with `networkx 3.2+`. + +NetworkX will use `nx-cugraph` as the backend if any of the following are used: + +### `NX_CUGRAPH_AUTOCONFIG` environment variable. + +The `NX_CUGRAPH_AUTOCONFIG` environment variable can be used to configure NetworkX for full zero code change acceleration using `nx-cugraph`. If a NetworkX function is called that `nx-cugraph` supports, NetworkX will redirect the function call to `nx-cugraph` automatically, or fall back to either another backend if enabled or the default NetworkX implementation. See the [NetworkX documentation on backends](https://networkx.org/documentation/stable/reference/backends.html) for configuring NetworkX manually. + +``` +bash> NX_CUGRAPH_AUTOCONFIG=True python my_networkx_script.py +``` + +### `backend=` keyword argument + +To explicitly specify a particular backend for an API, use the `backend=` +keyword argument. This argument takes precedence over the +`NX_CUGRAPH_AUTOCONFIG` environment variable. This requires anyone +running code that uses the `backend=` keyword argument to have the specified +backend installed. + +Example: +```python +nx.betweenness_centrality(cit_patents_graph, k=k, backend="cugraph") +``` + +### Type-based dispatching + +NetworkX also supports automatically dispatching to backends associated with +specific graph types. Like the `backend=` keyword argument example above, this +requires the user to write code for a specific backend, and therefore requires +the backend to be installed, but has the advantage of ensuring a particular +behavior without the potential for runtime conversions. + +To use type-based dispatching with `nx-cugraph`, the user must import the backend +directly in their code to access the utilities provided to create a Graph +instance specifically for the `nx-cugraph` backend. + +Example: +```python +import networkx as nx +import nx_cugraph as nxcg + +G = nx.Graph() + +# populate the graph +# ... + +nxcg_G = nxcg.from_networkx(G) # conversion happens once here +nx.betweenness_centrality(nxcg_G, k=1000) # nxcg Graph type causes cugraph backend + # to be used, no conversion necessary +``` + +## Command Line Example + +--- + +Create `bc_demo.ipy` and paste the code below. + +```python +import pandas as pd +import networkx as nx + +url = "https://data.rapids.ai/cugraph/datasets/cit-Patents.csv" +df = pd.read_csv(url, sep=" ", names=["src", "dst"], dtype="int32") +G = nx.from_pandas_edgelist(df, source="src", target="dst") + +%time result = nx.betweenness_centrality(G, k=10) +``` +Run the command: +``` +user@machine:/# ipython bc_demo.ipy + +CPU times: user 7min 36s, sys: 5.22 s, total: 7min 41s +Wall time: 7min 41s +``` + +You will observe a run time of approximately 7 minutes...more or less depending on your CPU. + +Run the command again, this time specifying cugraph as the NetworkX backend. +```bash +user@machine:/# NX_CUGRAPH_AUTOCONFIG=True ipython bc_demo.ipy + +CPU times: user 4.14 s, sys: 1.13 s, total: 5.27 s +Wall time: 5.32 s +``` +This run will be much faster, typically around 5 seconds depending on your GPU. + +
+ +*Note, the examples above were run using the following specs*: + +    *NetworkX 3.4*
+    *nx-cugraph 24.10*
+    *CPU: Intel(R) Xeon(R) Gold 6128 CPU @ 3.40GHz 45GB RAM*
+    *GPU: NVIDIA Quadro RTX 8000 80GB RAM*
+ +
+ +--- + +The latest list of algorithms supported by `nx-cugraph` can be found in [GitHub](https://github.com/rapidsai/nx-cugraph/blob/HEAD/README.md#supported-algorithms), or in the [Supported Algorithms Section](supported-algorithms.md). diff --git a/docs/cugraph-docs/source/nx_cugraph/index.rst b/docs/cugraph-docs/source/nx_cugraph/index.rst index ef6f516..0eb8907 100644 --- a/docs/cugraph-docs/source/nx_cugraph/index.rst +++ b/docs/cugraph-docs/source/nx_cugraph/index.rst @@ -1,9 +1,66 @@ -=============================== -nxCugraph as a NetworkX Backend -=============================== +nx-cugraph +----------- +``nx-cugraph`` is a NetworkX backend that provides **GPU acceleration** to many popular NetworkX algorithms. + +By simply `installing and enabling nx-cugraph `_, users can see significant speedup on workflows where performance is hindered by the default NetworkX implementation. + +Users can have GPU-based, large-scale performance **without** changing their familiar and easy-to-use NetworkX code. + +.. centered:: Timed result from running the following code snippet (called ``demo.ipy``, showing NetworkX with vs. without ``nx-cugraph``) + +.. code-block:: python + + import pandas as pd + import networkx as nx + + url = "https://data.rapids.ai/cugraph/datasets/cit-Patents.csv" + df = pd.read_csv(url, sep=" ", names=["src", "dst"], dtype="int32") + G = nx.from_pandas_edgelist(df, source="src", target="dst") + + %time result = nx.betweenness_centrality(G, k=10) + + +:: + + user@machine:/# ipython demo.ipy + CPU times: user 7min 36s, sys: 5.22 s, total: 7min 41s + Wall time: 7min 41s + + +:: + + user@machine:/# NX_CUGRAPH_AUTOCONFIG=True ipython demo.ipy + CPU times: user 4.14 s, sys: 1.13 s, total: 5.27 s + Wall time: 5.32 s + + +.. figure:: ../_static/colab.png + :width: 200px + :target: https://nvda.ws/4drM4re + + Try it on Google Colab! + + ++--------------------------------------------------------------------------------------------------------+ +| **Zero Code Change Acceleration** | +| | +| Just set the environment variable ``NX_CUGRAPH_AUTOCONFIG=True`` to enable ``nx-cugraph`` in NetworkX. | ++--------------------------------------------------------------------------------------------------------+ +| **Run the same code on CPU or GPU** | +| | +| Nothing changes, not even your ``import`` statements, when going from CPU to GPU. | ++--------------------------------------------------------------------------------------------------------+ + + +``nx-cugraph`` is now Generally Available (GA) as part of the ``RAPIDS`` package. See `RAPIDS +Quick Start `_ to get up-and-running with ``nx-cugraph``. .. toctree:: - :maxdepth: 2 + :maxdepth: 1 + :caption: Contents: - nx_cugraph.md + how-it-works + installation + supported-algorithms + benchmarks diff --git a/docs/cugraph-docs/source/nx_cugraph/installation.md b/docs/cugraph-docs/source/nx_cugraph/installation.md new file mode 100644 index 0000000..9675306 --- /dev/null +++ b/docs/cugraph-docs/source/nx_cugraph/installation.md @@ -0,0 +1,50 @@ +# Installing nx-cugraph + +This guide describes how to install ``nx-cugraph`` and use it in your workflows. + + +## System Requirements + +`nx-cugraph` requires the following: + + - **Volta architecture or later NVIDIA GPU, with [compute capability](https://developer.nvidia.com/cuda-gpus) 7.0+** + - **[CUDA](https://docs.nvidia.com/cuda/index.html) 11.2, 11.4, 11.5, 11.8, 12.0, 12.2, or 12.5** + - **Python >= 3.10** + - **[NetworkX](https://networkx.org/documentation/stable/install.html#) >= 3.2 (version 3.4 or higher recommended)** + +More details about system requirements can be found in the [RAPIDS System Requirements Documentation](https://docs.rapids.ai/install#system-req). + +## Installing Packages + +Read the [RAPIDS Quick Start Guide](https://docs.rapids.ai/install) to learn more about installing all RAPIDS libraries. + +`nx-cugraph` can be installed using conda or pip. It is included in the RAPIDS metapackage, or can be installed separately. + +### Conda +**Nightly version** +```bash +conda install -c rapidsai-nightly -c conda-forge -c nvidia nx-cugraph +``` + +**Stable version** +```bash +conda install -c rapidsai -c conda-forge -c nvidia nx-cugraph +``` + +### pip +**Nightly version** +```bash +pip install nx-cugraph-cu11 --extra-index-url https://pypi.anaconda.org/rapidsai-wheels-nightly/simple +``` + +**Stable version** +```bash +pip install nx-cugraph-cu11 --extra-index-url https://pypi.nvidia.com +``` + +
+ +**Note:** + - The `pip install` examples above are for CUDA 11. To install for CUDA 12, replace `-cu11` with `-cu12` + +
diff --git a/docs/cugraph-docs/source/nx_cugraph/nx_cugraph.md b/docs/cugraph-docs/source/nx_cugraph/nx_cugraph.md index ab0d057..900362a 100644 --- a/docs/cugraph-docs/source/nx_cugraph/nx_cugraph.md +++ b/docs/cugraph-docs/source/nx_cugraph/nx_cugraph.md @@ -1,20 +1,11 @@ ### nx_cugraph -Whereas previous versions of cuGraph have included mechanisms to make it -trivial to plug in cuGraph algorithm calls. Beginning with version 24.02, nx-cuGraph -is now a [networkX backend](). -The user now need only [install nx-cugraph]() -to experience GPU speedups. +`nx-cugraph` is a [networkX backend]() that accelerates many popular NetworkX functions using cuGraph and NVIDIA GPUs. +Users simply [install and enable nx-cugraph](installation.md) to experience GPU speedups. Lets look at some examples of algorithm speedups comparing CPU based NetworkX to dispatched versions run on GPU with nx_cugraph. -Each chart has three measurements. -* NX - running the algorithm natively with networkX on CPU. -* nx-cugraph - running with GPU accelerated networkX achieved by simply calling the cugraph backend. This pays the overhead of building the GPU resident object for each algorithm called. This achieves significant improvement but stil isn't compleltely optimum. -* nx-cugraph (preconvert) - This is a bit more complicated since it involves building (precomputing) the GPU resident graph ahead and reusing it for each algorithm. - - ![Ancestors](../images/ancestors.png) ![BFS Tree](../images/bfs_tree.png) ![Connected Components](../images/conn_component.png) @@ -23,143 +14,3 @@ Each chart has three measurements. ![Pagerank](../images/pagerank.png) ![Single Source Shortest Path](../images/sssp.png) ![Weakly Connected Components](../images/wcc.png) - - -The following algorithms are supported and automatically dispatched to nx-cuGraph for acceleration. - -#### Algorithms -``` -bipartite - ├─ basic - │ └─ is_bipartite - └─ generators - └─ complete_bipartite_graph -centrality - ├─ betweenness - │ ├─ betweenness_centrality - │ └─ edge_betweenness_centrality - ├─ degree_alg - │ ├─ degree_centrality - │ ├─ in_degree_centrality - │ └─ out_degree_centrality - ├─ eigenvector - │ └─ eigenvector_centrality - └─ katz - └─ katz_centrality -cluster - ├─ average_clustering - ├─ clustering - ├─ transitivity - └─ triangles -community - └─ louvain - └─ louvain_communities -components - ├─ connected - │ ├─ connected_components - │ ├─ is_connected - │ ├─ node_connected_component - │ └─ number_connected_components - └─ weakly_connected - ├─ is_weakly_connected - ├─ number_weakly_connected_components - └─ weakly_connected_components -core - ├─ core_number - └─ k_truss -dag - ├─ ancestors - └─ descendants -isolate - ├─ is_isolate - ├─ isolates - └─ number_of_isolates -link_analysis - ├─ hits_alg - │ └─ hits - └─ pagerank_alg - └─ pagerank -operators - └─ unary - ├─ complement - └─ reverse -reciprocity - ├─ overall_reciprocity - └─ reciprocity -shortest_paths - └─ unweighted - ├─ single_source_shortest_path_length - └─ single_target_shortest_path_length -traversal - └─ breadth_first_search - ├─ bfs_edges - ├─ bfs_layers - ├─ bfs_predecessors - ├─ bfs_successors - ├─ bfs_tree - ├─ descendants_at_distance - └─ generic_bfs_edges -tree - └─ recognition - ├─ is_arborescence - ├─ is_branching - ├─ is_forest - └─ is_tree -``` - -#### Generators -``` -classic - ├─ barbell_graph - ├─ circular_ladder_graph - ├─ complete_graph - ├─ complete_multipartite_graph - ├─ cycle_graph - ├─ empty_graph - ├─ ladder_graph - ├─ lollipop_graph - ├─ null_graph - ├─ path_graph - ├─ star_graph - ├─ tadpole_graph - ├─ trivial_graph - ├─ turan_graph - └─ wheel_graph -community - └─ caveman_graph -small - ├─ bull_graph - ├─ chvatal_graph - ├─ cubical_graph - ├─ desargues_graph - ├─ diamond_graph - ├─ dodecahedral_graph - ├─ frucht_graph - ├─ heawood_graph - ├─ house_graph - ├─ house_x_graph - ├─ icosahedral_graph - ├─ krackhardt_kite_graph - ├─ moebius_kantor_graph - ├─ octahedral_graph - ├─ pappus_graph - ├─ petersen_graph - ├─ sedgewick_maze_graph - ├─ tetrahedral_graph - ├─ truncated_cube_graph - ├─ truncated_tetrahedron_graph - └─ tutte_graph -social - ├─ davis_southern_women_graph - ├─ florentine_families_graph - ├─ karate_club_graph - └─ les_miserables_graph -``` - -#### Other - -``` -convert_matrix - ├─ from_pandas_edgelist - └─ from_scipy_sparse_array -``` diff --git a/docs/cugraph-docs/source/nx_cugraph/supported-algorithms.rst b/docs/cugraph-docs/source/nx_cugraph/supported-algorithms.rst new file mode 100644 index 0000000..8dc3c5b --- /dev/null +++ b/docs/cugraph-docs/source/nx_cugraph/supported-algorithms.rst @@ -0,0 +1,356 @@ +Supported Algorithms +===================== + +The nx-cugraph backend to NetworkX connects +`pylibcugraph `_ (cuGraph's low-level Python +interface to its CUDA-based graph analytics library) and +`CuPy `_ (a GPU-accelerated array library) to NetworkX's +familiar and easy-to-use API. + +Below is the list of algorithms that are currently supported in nx-cugraph. + + +Algorithms +---------- + ++-----------------------------+ +| **Centrality** | ++=============================+ +| betweenness_centrality | ++-----------------------------+ +| edge_betweenness_centrality | ++-----------------------------+ +| degree_centrality | ++-----------------------------+ +| in_degree_centrality | ++-----------------------------+ +| out_degree_centrality | ++-----------------------------+ +| eigenvector_centrality | ++-----------------------------+ +| katz_centrality | ++-----------------------------+ + ++---------------------+ +| **Cluster** | ++=====================+ +| average_clustering | ++---------------------+ +| clustering | ++---------------------+ +| transitivity | ++---------------------+ +| triangles | ++---------------------+ + ++--------------------------+ +| **Community** | ++==========================+ +| louvain_communities | ++--------------------------+ + ++--------------------------+ +| **Bipartite** | ++==========================+ +| betweenness_centrality | +| complete_bipartite_graph | ++--------------------------+ + ++------------------------------------+ +| **Components** | ++====================================+ +| connected_components | ++------------------------------------+ +| is_connected | ++------------------------------------+ +| node_connected_component | ++------------------------------------+ +| number_connected_components | ++------------------------------------+ +| weakly_connected | ++------------------------------------+ +| is_weakly_connected | ++------------------------------------+ +| number_weakly_connected_components | ++------------------------------------+ +| weakly_connected_components | ++------------------------------------+ + ++-------------+ +| **Core** | ++=============+ +| core_number | ++-------------+ +| k_truss | ++-------------+ + ++-------------+ +| **DAG** | ++=============+ +| ancestors | ++-------------+ +| descendants | ++-------------+ + ++--------------------+ +| **Isolate** | ++====================+ +| is_isolate | ++--------------------+ +| isolates | ++--------------------+ +| number_of_isolates | ++--------------------+ + ++-------------------+ +| **Link analysis** | ++===================+ +| hits | ++-------------------+ +| pagerank | ++-------------------+ + ++----------------+ +| **Operators** | ++================+ +| complement | ++----------------+ +| reverse | ++----------------+ + ++----------------------+ +| **Reciprocity** | ++======================+ +| overall_reciprocity | ++----------------------+ +| reciprocity | ++----------------------+ + ++---------------------------------------+ +| **Shortest Paths** | ++=======================================+ +| has_path | ++---------------------------------------+ +| shortest_path | ++---------------------------------------+ +| shortest_path_length | ++---------------------------------------+ +| all_pairs_shortest_path | ++---------------------------------------+ +| all_pairs_shortest_path_length | ++---------------------------------------+ +| bidirectional_shortest_path | ++---------------------------------------+ +| single_source_shortest_path | ++---------------------------------------+ +| single_source_shortest_path_length | ++---------------------------------------+ +| single_target_shortest_path | ++---------------------------------------+ +| single_target_shortest_path_length | ++---------------------------------------+ +| all_pairs_bellman_ford_path | ++---------------------------------------+ +| all_pairs_bellman_ford_path_length | ++---------------------------------------+ +| all_pairs_dijkstra | ++---------------------------------------+ +| all_pairs_dijkstra_path | ++---------------------------------------+ +| all_pairs_dijkstra_path_length | ++---------------------------------------+ +| bellman_ford_path | ++---------------------------------------+ +| bellman_ford_path_length | ++---------------------------------------+ +| dijkstra_path | ++---------------------------------------+ +| dijkstra_path_length | ++---------------------------------------+ +| single_source_bellman_ford | ++---------------------------------------+ +| single_source_bellman_ford_path | ++---------------------------------------+ +| single_source_bellman_ford_path_length| ++---------------------------------------+ +| single_source_dijkstra | ++---------------------------------------+ +| single_source_dijkstra_path | ++---------------------------------------+ +| single_source_dijkstra_path_length | ++---------------------------------------+ + ++---------------------------+ +| **Traversal** | ++===========================+ +| bfs_edges | ++---------------------------+ +| bfs_layers | ++---------------------------+ +| bfs_predecessors | ++---------------------------+ +| bfs_successors | ++---------------------------+ +| bfs_tree | ++---------------------------+ +| descendants_at_distance | ++---------------------------+ +| generic_bfs_edges | ++---------------------------+ + ++---------------------+ +| **Tree** | ++=====================+ +| is_arborescence | ++---------------------+ +| is_branching | ++---------------------+ +| is_forest | ++---------------------+ +| is_tree | ++---------------------+ + + +Utilities +------- + ++-------------------------+ +| **Classes** | ++=========================+ +| is_negatively_weighted | ++-------------------------+ + ++----------------------+ +| **Convert** | ++======================+ +| from_dict_of_lists | ++----------------------+ +| to_dict_of_lists | ++----------------------+ + ++--------------------------+ +| **Convert Matrix** | ++==========================+ +| from_pandas_edgelist | ++--------------------------+ +| from_scipy_sparse_array | ++--------------------------+ + ++-----------------------------------+ +| **Relabel** | ++===================================+ +| convert_node_labels_to_integers | ++-----------------------------------+ +| relabel_nodes | ++-----------------------------------+ + +Generators +------------ + ++-------------------------------+ +| **Classic** | ++===============================+ +| barbell_graph | ++-------------------------------+ +| circular_ladder_graph | ++-------------------------------+ +| complete_graph | ++-------------------------------+ +| complete_multipartite_graph | ++-------------------------------+ +| cycle_graph | ++-------------------------------+ +| empty_graph | ++-------------------------------+ +| ladder_graph | ++-------------------------------+ +| lollipop_graph | ++-------------------------------+ +| null_graph | ++-------------------------------+ +| path_graph | ++-------------------------------+ +| star_graph | ++-------------------------------+ +| tadpole_graph | ++-------------------------------+ +| trivial_graph | ++-------------------------------+ +| turan_graph | ++-------------------------------+ +| wheel_graph | ++-------------------------------+ + ++-----------------+ +| **Classic** | ++=================+ +| caveman_graph | ++-----------------+ + ++------------+ +| **Ego** | ++============+ +| ego_graph | ++------------+ + ++------------------------------+ +| **small** | ++==============================+ +| bull_graph | ++------------------------------+ +| chvatal_graph | ++------------------------------+ +| cubical_graph | ++------------------------------+ +| desargues_graph | ++------------------------------+ +| diamond_graph | ++------------------------------+ +| dodecahedral_graph | ++------------------------------+ +| frucht_graph | ++------------------------------+ +| heawood_graph | ++------------------------------+ +| house_graph | ++------------------------------+ +| house_x_graph | ++------------------------------+ +| icosahedral_graph | ++------------------------------+ +| krackhardt_kite_graph | ++------------------------------+ +| moebius_kantor_graph | ++------------------------------+ +| octahedral_graph | ++------------------------------+ +| pappus_graph | ++------------------------------+ +| petersen_graph | ++------------------------------+ +| sedgewick_maze_graph | ++------------------------------+ +| tetrahedral_graph | ++------------------------------+ +| truncated_cube_graph | ++------------------------------+ +| truncated_tetrahedron_graph | ++------------------------------+ +| tutte_graph | ++------------------------------+ + ++-------------------------------+ +| **Social** | ++===============================+ +| davis_southern_women_graph | ++-------------------------------+ +| florentine_families_graph | ++-------------------------------+ +| karate_club_graph | ++-------------------------------+ +| les_miserables_graph | ++-------------------------------+ + + +To request nx-cugraph backend support for a NetworkX API that is not listed +above, visit the `nx-cugraph GitHub repo `_. diff --git a/docs/cugraph-docs/source/top_toc.rst b/docs/cugraph-docs/source/top_toc.rst deleted file mode 100644 index aa06962..0000000 --- a/docs/cugraph-docs/source/top_toc.rst +++ /dev/null @@ -1,13 +0,0 @@ -.. toctree:: - :maxdepth: 2 - :caption: cuGraph documentation Contents: - :name: top_toc - - basics/index - nx_cugraph/index - installation/index - tutorials/index - graph_support/index - wholegraph/index - references/index - api_docs/index \ No newline at end of file diff --git a/docs/cugraph-docs/source/tutorials/basic_cugraph.md b/docs/cugraph-docs/source/tutorials/basic_cugraph.md new file mode 100644 index 0000000..a0c9ad5 --- /dev/null +++ b/docs/cugraph-docs/source/tutorials/basic_cugraph.md @@ -0,0 +1,38 @@ +# Getting started with cuGraph + +## Required hardware/software + +CuGraph is part of [Rapids](https://docs.rapids.ai/user-guide) and has the following system requirements: + * NVIDIA GPU, Volta architecture or later, with [compute capability](https://developer.nvidia.com/cuda-gpus) 7.0+ + * CUDA 11.2, 11.4, 11.5, 11.8, 12.0, 12.2, or 12.5 + * Python version 3.10, 3.11, or 3.12 + * NetworkX >= version 3.3 or newer in order to use use [NetworkX Configs](https://networkx.org/documentation/stable/reference/backends.html#module-networkx.utils.configs) **This is required for use of nx-cuGraph, [see below](#cugraph-using-networkx-code).** + +## Installation +The latest RAPIDS System Requirements documentation is located [here](https://docs.rapids.ai/install#system-req). + +This includes several ways to set up cuGraph +* From Unix + * [Conda](https://docs.rapids.ai/install#wsl-conda) + * [Docker](https://docs.rapids.ai/install#wsl-docker) + * [pip](https://docs.rapids.ai/install#wsl-pip) + +* In windows you must install [WSL2](https://learn.microsoft.com/en-us/windows/wsl/install) and then choose one of the following: + * [Conda](https://docs.rapids.ai/install#wsl-conda) + * [Docker](https://docs.rapids.ai/install#wsl-docker) + * [pip](https://docs.rapids.ai/install#wsl-pip) + +* Build From Source + +To build from source, check each RAPIDS GitHub README for set up and build instructions. Further links are provided in the [selector tool](https://docs.rapids.ai/install#selector). If additional help is needed reach out on our [Slack Channel](https://rapids-goai.slack.com/archives/C5E06F4DC). + +## CuGraph Using NetworkX Code +While the steps above are required to use the full suite of cuGraph graph analytics, cuGraph is now supported as a NetworkX backend using [nx-cugraph](https://docs.rapids.ai/api/cugraph/nightly/nx_cugraph/nx_cugraph/). +Nx-cugraph offers those with existing NetworkX code, a **zero code change** option with a growing list of supported algorithms. + + +## Cugraph API Example +Coming soon ! + + +Until then, [the cuGraph notebook repository](https://github.com/rapidsai/cugraph/blob/main/notebooks/README.md) has many examples of loading graph data and running algorithms in Jupyter notebooks. The [cuGraph test code](https://github.com/rapidsai/cugraph/tree/main/python/cugraph/cugraph/tests) gives examples of python scripts settng up and calling cuGraph algorithms. A simple example of [testing the degree centrality algorithm](https://github.com/rapidsai/cugraph/blob/main/python/cugraph/cugraph/tests/centrality/test_degree_centrality.py) is a good place to start. Some of these examples show [multi-GPU tests/examples with larger data sets](https://github.com/rapidsai/cugraph/blob/main/python/cugraph/cugraph/tests/centrality/test_degree_centrality_mg.py) as well. diff --git a/docs/cugraph-docs/source/tutorials/cugraph_blogs.rst b/docs/cugraph-docs/source/tutorials/cugraph_blogs.rst index 3665f42..57fa011 100644 --- a/docs/cugraph-docs/source/tutorials/cugraph_blogs.rst +++ b/docs/cugraph-docs/source/tutorials/cugraph_blogs.rst @@ -65,9 +65,9 @@ Academic Papers * Alex Fender, Brad Rees, Joe Eaton (2022) `Massive Graph Analytics `_ Bader, D. (Editor) CRC Press - * S Kang, A. Fender, J. Eaton, B. Rees:`Computing PageRank Scores of Web Crawl Data Using DGX A100 Clusters`. In IEEE HPEC, Sep. 2020 + * S Kang, A. Fender, J. Eaton, B. Rees. `Computing PageRank Scores of Web Crawl Data Using DGX A100 Clusters `_. In IEEE HPEC, Sep. 2020 - * Hricik, T., Bader, D., & Green, O. (2020, September). `Using RAPIDS AI to accelerate graph data science workflows`. In 2020 IEEE High Performance Extreme Computing Conference (HPEC) (pp. 1-4). IEEE. + * Hricik, T., Bader, D., & Green, O. (2020, September). `Using RAPIDS AI to accelerate graph data science workflows `_. In 2020 IEEE High Performance Extreme Computing Conference (HPEC) (pp. 1-4). IEEE. * Richardson, B., Rees, B., Drabas, T., Oldridge, E., Bader, D. A., & Allen, R. (2020, August). Accelerating and Expanding End-to-End Data Science Workflows with DL/ML Interoperability Using RAPIDS. In Proceedings of the 26th ACM SIGKDD International Conference on Knowledge Discovery & Data Mining (pp. 3503-3504). diff --git a/docs/cugraph-docs/source/tutorials/cugraph_notebooks.md b/docs/cugraph-docs/source/tutorials/cugraph_notebooks.md index 559ba36..6d7840d 100644 --- a/docs/cugraph-docs/source/tutorials/cugraph_notebooks.md +++ b/docs/cugraph-docs/source/tutorials/cugraph_notebooks.md @@ -55,10 +55,9 @@ Running the example in these notebooks requires: * Download via Docker, Conda (See [__Getting Started__](https://rapids.ai/start.html)) * cuGraph is dependent on the latest version of cuDF. Please install all components of RAPIDS -* Python 3.8+ -* A system with an NVIDIA GPU: Pascal architecture or better +* Python 3.10+ +* A system with an NVIDIA GPU: Volta architecture or newer * CUDA 11.4+ -* NVIDIA driver 450.51+ ## Copyright diff --git a/docs/cugraph-docs/source/tutorials/how_to_guides.md b/docs/cugraph-docs/source/tutorials/how_to_guides.md index 80be5b4..998957a 100644 --- a/docs/cugraph-docs/source/tutorials/how_to_guides.md +++ b/docs/cugraph-docs/source/tutorials/how_to_guides.md @@ -1,5 +1,5 @@ # How To Guides -- Basic use of cuGraph, on the page +- [Basic use of cuGraph](./basic_cugraph.md) - Property graph with analytic flow - GNN – model building - cuGraph Service – client/server setup and use (ucx) diff --git a/docs/cugraph-docs/source/wholegraph/installation/container.md b/docs/cugraph-docs/source/wholegraph/installation/container.md index 3a2c627..4068ead 100644 --- a/docs/cugraph-docs/source/wholegraph/installation/container.md +++ b/docs/cugraph-docs/source/wholegraph/installation/container.md @@ -21,9 +21,10 @@ RUN pip3 install -U py RUN pip3 install Cython setuputils3 scikit-build nanobind pytest-forked pytest ``` -To run GNN applications, you may also need cuGraphOps, DGL and/or PyG libraries to run the GNN layers. +To run GNN applications, you may also need DGL and/or PyG libraries to run the GNN layers. You may refer to [DGL](https://www.dgl.ai/pages/start.html) or [PyG](https://pytorch-geometric.readthedocs.io/en/latest/notes/installation.html) For example, to install DGL, you may need to add: + ```dockerfile -RUN pip3 install dgl -f https://data.dgl.ai/wheels/cu118/repo.html +RUN pip3 install dgl -f https://data.dgl.ai/wheels/torch-2.3/cu118/repo.html ``` diff --git a/docs/cugraph-docs/source/wholegraph/installation/getting_wholegraph.md b/docs/cugraph-docs/source/wholegraph/installation/getting_wholegraph.md index e2c5b3a..c93dae1 100644 --- a/docs/cugraph-docs/source/wholegraph/installation/getting_wholegraph.md +++ b/docs/cugraph-docs/source/wholegraph/installation/getting_wholegraph.md @@ -21,7 +21,8 @@ The RAPIDS Docker containers (as of Release 23.10) contain all RAPIDS packages, ## Conda -It is easy to install WholeGraph using conda. We recommend using [Miniforge](https://github.com/conda-forge/miniforge). + +It is easy to install WholeGraph using conda. You can get a minimal conda installation with [miniforge](https://github.com/conda-forge/miniforge). WholeGraph conda packages * libwholegraph diff --git a/docs/cugraph-docs/source/wholegraph/installation/source_build.md b/docs/cugraph-docs/source/wholegraph/installation/source_build.md index a7727ac..7213cbf 100644 --- a/docs/cugraph-docs/source/wholegraph/installation/source_build.md +++ b/docs/cugraph-docs/source/wholegraph/installation/source_build.md @@ -16,8 +16,7 @@ __Compiler__: __CUDA__: * CUDA 11.8+ -* NVIDIA driver 450.80.02+ -* Pascal architecture or better +* Volta architecture or better You can obtain CUDA from [https://developer.nvidia.com/cuda-downloads](https://developer.nvidia.com/cuda-downloads). @@ -177,7 +176,7 @@ Run either the C++ or the Python tests with datasets ``` -Note: This conda installation only applies to Linux and Python versions 3.8/3.10. +Note: This conda installation only applies to Linux and Python versions 3.10, 3.11, and 3.12. ## Creating documentation