Skip to main content
Ctrl+K

cugraph 23.12.00 documentation

Site Navigation

  • Basics
  • Installation
  • Tutorials
  • Graph Support
  • WholeGraph
    • References
    • API Reference
  • GitHub
  • Twitter

Site Navigation

  • Basics
  • Installation
  • Tutorials
  • Graph Support
  • WholeGraph
    • References
    • API Reference
  • GitHub
  • Twitter

Section Navigation

Core Graph API Documentation

  • cugraph API Reference
    • Graph Classes
      • cugraph.Graph
      • cugraph.MultiGraph
      • cugraph.Graph.from_cudf_adjlist
      • cugraph.Graph.from_cudf_edgelist
      • cugraph.Graph.from_dask_cudf_edgelist
      • cugraph.Graph.from_pandas_adjacency
      • cugraph.Graph.from_pandas_edgelist
      • cugraph.Graph.from_numpy_array
      • cugraph.Graph.from_numpy_matrix
      • cugraph.Graph.add_internal_vertex_id
      • cugraph.Graph.add_nodes_from
      • cugraph.Graph.clear
      • cugraph.Graph.unrenumber
      • cugraph.symmetrize
      • cugraph.symmetrize_ddf
      • cugraph.symmetrize_df
      • cugraph.from_adjlist
      • cugraph.from_cudf_edgelist
      • cugraph.from_edgelist
      • cugraph.from_numpy_array
      • cugraph.from_numpy_matrix
      • cugraph.from_pandas_adjacency
      • cugraph.from_pandas_edgelist
      • cugraph.to_numpy_array
      • cugraph.to_numpy_matrix
      • cugraph.to_pandas_adjacency
      • cugraph.to_pandas_edgelist
      • cugraph.structure.NumberMap
      • cugraph.structure.NumberMap.from_internal_vertex_id
      • cugraph.structure.NumberMap.to_internal_vertex_id
      • cugraph.structure.NumberMap.add_internal_vertex_id
      • cugraph.structure.NumberMap.compute_vals
      • cugraph.structure.NumberMap.compute_vals_types
      • cugraph.structure.NumberMap.generate_unused_column_name
      • cugraph.structure.NumberMap.renumber
      • cugraph.structure.NumberMap.renumber_and_segment
      • cugraph.structure.NumberMap.set_renumbered_col_names
      • cugraph.structure.NumberMap.unrenumber
      • cugraph.structure.NumberMap.vertex_column_size
      • cugraph.hypergraph
    • Graph Implementation
      • cugraph.structure.graph_implementation.simpleGraphImpl.view_edge_list
      • cugraph.structure.graph_implementation.simpleGraphImpl.delete_edge_list
      • cugraph.structure.graph_implementation.simpleGraphImpl.view_adj_list
      • cugraph.structure.graph_implementation.simpleGraphImpl.view_transposed_adj_list
      • cugraph.structure.graph_implementation.simpleGraphImpl.delete_adj_list
      • cugraph.structure.graph_implementation.simpleGraphImpl.enable_batch
      • cugraph.structure.graph_implementation.simpleGraphImpl.get_two_hop_neighbors
      • cugraph.structure.graph_implementation.simpleGraphImpl.number_of_vertices
      • cugraph.structure.graph_implementation.simpleGraphImpl.number_of_nodes
      • cugraph.structure.graph_implementation.simpleGraphImpl.number_of_edges
      • cugraph.structure.graph_implementation.simpleGraphImpl.in_degree
      • cugraph.structure.graph_implementation.simpleGraphImpl.out_degree
      • cugraph.structure.graph_implementation.simpleGraphImpl.degree
      • cugraph.structure.graph_implementation.simpleGraphImpl.degrees
      • cugraph.structure.graph_implementation.simpleGraphImpl.has_edge
      • cugraph.structure.graph_implementation.simpleGraphImpl.has_node
      • cugraph.structure.graph_implementation.simpleGraphImpl.has_self_loop
      • cugraph.structure.graph_implementation.simpleGraphImpl.edges
      • cugraph.structure.graph_implementation.simpleGraphImpl.nodes
      • cugraph.structure.graph_implementation.simpleGraphImpl.neighbors
      • cugraph.structure.graph_implementation.simpleGraphImpl.vertex_column_size
    • Property Graph
      • cugraph.experimental.PropertySelection
      • cugraph.experimental.PropertyGraph
      • cugraph.experimental.PropertyGraph.add_edge_data
      • cugraph.experimental.PropertyGraph.add_vertex_data
      • cugraph.experimental.PropertyGraph.annotate_dataframe
      • cugraph.experimental.PropertyGraph.edge_props_to_graph
      • cugraph.experimental.PropertyGraph.extract_subgraph
      • cugraph.experimental.PropertyGraph.get_edge_data
      • cugraph.experimental.PropertyGraph.get_num_edges
      • cugraph.experimental.PropertyGraph.get_num_vertices
      • cugraph.experimental.PropertyGraph.get_vertex_data
      • cugraph.experimental.PropertyGraph.get_vertices
      • cugraph.experimental.PropertyGraph.has_duplicate_edges
      • cugraph.experimental.PropertyGraph.is_multigraph
      • cugraph.experimental.PropertyGraph.renumber_edges_by_type
      • cugraph.experimental.PropertyGraph.renumber_vertices_by_type
      • cugraph.experimental.PropertyGraph.select_edges
      • cugraph.experimental.PropertyGraph.select_vertices
    • Centrality
      • cugraph.centrality.betweenness_centrality
      • cugraph.centrality.edge_betweenness_centrality
      • cugraph.dask.centrality.betweenness_centrality
      • cugraph.centrality.katz_centrality
      • cugraph.dask.centrality.katz_centrality.katz_centrality
      • cugraph.centrality.degree_centrality
      • cugraph.centrality.eigenvector_centrality
      • cugraph.dask.centrality.eigenvector_centrality.eigenvector_centrality
    • Community
      • cugraph.batched_ego_graphs
      • cugraph.ego_graph
      • cugraph.ecg
      • cugraph.k_truss
      • cugraph.ktruss_subgraph
      • cugraph.leiden
      • cugraph.louvain
      • cugraph.dask.community.louvain.louvain
      • cugraph.analyzeClustering_edge_cut
      • cugraph.analyzeClustering_modularity
      • cugraph.analyzeClustering_ratio_cut
      • cugraph.spectralBalancedCutClustering
      • cugraph.spectralModularityMaximizationClustering
      • cugraph.subgraph
      • cugraph.triangle_count
    • Components
      • cugraph.connected_components
      • cugraph.strongly_connected_components
      • cugraph.weakly_connected_components
      • cugraph.dask.components.connectivity.weakly_connected_components
    • Cores
      • cugraph.core_number
      • cugraph.k_core
    • Layout
      • cugraph.force_atlas2
    • Linear Assignment
      • cugraph.hungarian
      • cugraph.dense_hungarian
    • Link Analysis
      • cugraph.hits
      • cugraph.dask.link_analysis.hits.hits
      • cugraph.pagerank
      • cugraph.dask.link_analysis.pagerank.pagerank
    • Link Prediction
      • cugraph.jaccard
      • cugraph.jaccard_coefficient
      • cugraph.jaccard_w
      • cugraph.overlap
      • cugraph.overlap_coefficient
      • cugraph.overlap_w
      • cugraph.sorensen
      • cugraph.sorensen_coefficient
      • cugraph.sorensen_w
    • Sampling
      • cugraph.random_walks
      • cugraph.ego_graph
      • cugraph.uniform_neighbor_sample
      • cugraph.node2vec
    • Traversal
      • cugraph.bfs
      • cugraph.bfs_edges
      • cugraph.dask.traversal.bfs.bfs
      • cugraph.filter_unreachable
      • cugraph.shortest_path
      • cugraph.shortest_path_length
      • cugraph.sssp
      • cugraph.dask.traversal.sssp.sssp
    • Tree
      • cugraph.tree.minimum_spanning_tree.minimum_spanning_tree
      • cugraph.tree.minimum_spanning_tree.maximum_spanning_tree
    • Generators
      • cugraph.generators.rmat
    • DASK MG Helper functions
      • cugraph.dask.comms.comms.initialize
      • cugraph.dask.comms.comms.destroy
      • cugraph.dask.comms.comms.is_initialized
      • cugraph.dask.comms.comms.get_comms
      • cugraph.dask.comms.comms.get_workers
      • cugraph.dask.comms.comms.get_session_id
      • cugraph.dask.comms.comms.get_2D_partition
      • cugraph.dask.comms.comms.get_default_handle
      • cugraph.dask.comms.comms.get_handle
      • cugraph.dask.comms.comms.get_worker_id
      • cugraph.dask.common.read_utils.get_chunksize
    • Multi-GPU with cuGraph
  • pylibcugraph API reference
    • pylibcugraph.eigenvector_centrality
    • pylibcugraph.katz_centrality
    • pylibcugraph.strongly_connected_components
    • pylibcugraph.weakly_connected_components
    • pylibcugraph.pagerank
    • pylibcugraph.hits
    • pylibcugraph.node2vec
    • pylibcugraph.bfs
    • pylibcugraph.sssp
  • cuGraph C API documentation
    • Centrality
    • Community
    • Core
    • Components
    • Sampling
    • Similarity
    • Traversal

Graph Nerual Networks API Documentation

  • cugraph-dgl API Reference
    • cugraph_dgl.convert.cugraph_storage_from_heterograph
    • cugraph_dgl.cugraph_storage.CuGraphStorage
  • cugraph-pyg API Reference
  • cugraph-ops API reference
    • cugraph-ops Python API reference
      • Graph types
        • pylibcugraphops.make_csc
        • pylibcugraphops.make_csc_hg
        • pylibcugraphops.make_bipartite_csc
        • pylibcugraphops.make_bipartite_csc_hg
      • Operators for Message-Passing
        • pylibcugraphops.operators.agg_simple_n2n_fwd
        • pylibcugraphops.operators.agg_simple_n2n_bwd
        • pylibcugraphops.operators.agg_simple_e2n_fwd
        • pylibcugraphops.operators.agg_simple_e2n_bwd
        • pylibcugraphops.operators.agg_simple_n2n_e2n_fwd
        • pylibcugraphops.operators.agg_simple_n2n_e2n_bwd
        • pylibcugraphops.operators.agg_concat_n2n_fwd
        • pylibcugraphops.operators.agg_concat_n2n_bwd
        • pylibcugraphops.operators.agg_concat_e2n_fwd
        • pylibcugraphops.operators.agg_concat_e2n_bwd
        • pylibcugraphops.operators.agg_concat_n2n_e2n_fwd
        • pylibcugraphops.operators.agg_concat_n2n_e2n_bwd
        • pylibcugraphops.operators.agg_weighted_n2n_fwd
        • pylibcugraphops.operators.agg_weighted_n2n_bwd
        • pylibcugraphops.operators.agg_concat_weighted_n2n_fwd
        • pylibcugraphops.operators.agg_concat_weighted_n2n_bwd
        • pylibcugraphops.operators.agg_hg_basis_n2n_post_fwd
        • pylibcugraphops.operators.agg_hg_basis_n2n_post_bwd
        • pylibcugraphops.operators.mha_gat_n2n_fwd
        • pylibcugraphops.operators.mha_gat_n2n_bwd
        • pylibcugraphops.operators.mha_gat_n2n_efeat_fwd
        • pylibcugraphops.operators.mha_gat_n2n_efeat_bwd
        • pylibcugraphops.operators.mha_gat_v2_n2n_fwd
        • pylibcugraphops.operators.mha_gat_v2_n2n_bwd
        • pylibcugraphops.operators.mha_gat_v2_n2n_efeat_fwd
        • pylibcugraphops.operators.mha_gat_v2_n2n_efeat_bwd
        • pylibcugraphops.operators.mha_gat_v2_n2n_fwd
        • pylibcugraphops.operators.mha_gat_v2_n2n_bwd
        • pylibcugraphops.operators.mha_gat_v2_n2n_efeat_fwd
        • pylibcugraphops.operators.mha_gat_v2_n2n_efeat_bwd
        • pylibcugraphops.operators.agg_dmpnn_e2e_fwd
        • pylibcugraphops.operators.agg_dmpnn_e2e_bwd
        • pylibcugraphops.operators.update_efeat_e2e_concat_fwd
        • pylibcugraphops.operators.update_efeat_e2e_concat_bwd
        • pylibcugraphops.operators.update_efeat_e2e_sum_fwd
        • pylibcugraphops.operators.update_efeat_e2e_sum_bwd
        • pylibcugraphops.operators.update_efeat_e2e_concat_fwd
        • pylibcugraphops.operators.update_efeat_e2e_concat_bwd
        • pylibcugraphops.operators.update_efeat_e2e_sum_fwd
        • pylibcugraphops.operators.update_efeat_e2e_sum_bwd
      • Dimenet operators
        • pylibcugraphops.dimenet.radial_basis_fwd
        • pylibcugraphops.dimenet.radial_basis_bwd
        • pylibcugraphops.dimenet.radial_basis_bwd_bwd
        • pylibcugraphops.dimenet.agg_edge_to_edge_fwd
        • pylibcugraphops.dimenet.agg_edge_to_edge_bwd
        • pylibcugraphops.dimenet.agg_edge_to_edge_bwd2_grad
        • pylibcugraphops.dimenet.agg_edge_to_edge_bwd2_main
      • PyTorch Autograd Wrappers
        • pylibcugraphops.pytorch.operators.agg_concat_n2n
        • pylibcugraphops.pytorch.operators.mha_gat_n2n
        • pylibcugraphops.pytorch.operators.mha_gat_v2_n2n
        • pylibcugraphops.pytorch.operators.agg_hg_basis_n2n_post
        • pylibcugraphops.pytorch.operators.update_efeat_e2e
        • pylibcugraphops.pytorch.operators.update_efeat_e2e
    • cugraph-ops C++ API Reference
  • WholeGraph API reference
    • libwholegraph API doc
    • pylibwholegraph API doc
      • pylibwholegraph.torch.initialize.init_torch_env
      • pylibwholegraph.torch.initialize.init_torch_env_and_create_wm_comm
      • pylibwholegraph.torch.initialize.finalize
      • pylibwholegraph.torch.comm.WholeMemoryCommunicator
      • pylibwholegraph.torch.comm.set_world_info
      • pylibwholegraph.torch.comm.create_group_communicator
      • pylibwholegraph.torch.comm.destroy_communicator
      • pylibwholegraph.torch.comm.get_global_communicator
      • pylibwholegraph.torch.comm.get_local_node_communicator
      • pylibwholegraph.torch.comm.get_local_device_communicator
      • pylibwholegraph.torch.tensor.WholeMemoryTensor
      • pylibwholegraph.torch.tensor.create_wholememory_tensor
      • pylibwholegraph.torch.tensor.create_wholememory_tensor_from_filelist
      • pylibwholegraph.torch.tensor.destroy_wholememory_tensor
      • pylibwholegraph.torch.embedding.WholeMemoryOptimizer
      • pylibwholegraph.torch.embedding.create_wholememory_optimizer
      • pylibwholegraph.torch.embedding.destroy_wholememory_optimizer
      • pylibwholegraph.torch.embedding.WholeMemoryCachePolicy
      • pylibwholegraph.torch.embedding.create_wholememory_cache_policy
      • pylibwholegraph.torch.embedding.create_builtin_cache_policy
      • pylibwholegraph.torch.embedding.destroy_wholememory_cache_policy
      • pylibwholegraph.torch.embedding.WholeMemoryEmbedding
      • pylibwholegraph.torch.embedding.create_embedding
      • pylibwholegraph.torch.embedding.create_embedding_from_filelist
      • pylibwholegraph.torch.embedding.destroy_embedding
      • pylibwholegraph.torch.embedding.WholeMemoryEmbeddingModule
      • pylibwholegraph.torch.graph_structure.GraphStructure

Additional Graph Packages API Documentation

  • cugraph-service API Reference
    • cugraph-service-client API Reference
    • cugraph-service-server API Reference
  • API Reference
  • WholeGraph...

WholeGraph API reference#

This page provides WholeGraph API reference

WholeGraph API Documentation

  • libwholegraph API doc
    • Doxygen WholeGraph C API documentation
    • WholeGraph C API documentation
  • pylibwholegraph API doc
    • APIs

previous

cugraph-ops C++ API Reference

next

libwholegraph API doc
Show Source

© Copyright 2019-2023, NVIDIA Corporation.

Created using Sphinx 5.3.0.

Built with the PyData Sphinx Theme 0.14.4.