pylibcugraph.MGGraph

class pylibcugraph.MGGraph

RAII-stye Graph class for use with multi-GPU APIs that manages the individual create/free calls and the corresponding cugraph_graph_t pointer.

Parameters:

resource_handleResourceHandle

Handle to the underlying device resources needed for referencing data and running algorithms.

graph_propertiesGraphProperties

Object defining intended properties for the graph.

src_arraydevice array type

Device array containing the vertex identifiers of the source of each directed edge. The order of the array corresponds to the ordering of the dst_array, where the ith item in src_array and the ith item in dst_array define the ith edge of the graph.

dst_arraydevice array type

Device array containing the vertex identifiers of the destination of each directed edge. The order of the array corresponds to the ordering of the src_array, where the ith item in src_array and the ith item in dst_array define the ith edge of the graph.

vertices_arraydevice array type

Device array containing the isolated vertices of the graph.

weight_arraydevice array type

Device array containing the weight values of each directed edge. The order of the array corresponds to the ordering of the src_array and dst_array arrays, where the ith item in weight_array is the weight value of the ith edge of the graph.

store_transposedbool

Set to True if the graph should be transposed. This is required for some algorithms, such as pagerank.

num_arrayssize_t

Number of arrays.

If provided, all list of device arrays should be of the same size.

do_expensive_checkbool

If True, performs more extensive tests on the inputs to ensure validitity, at the expense of increased run time.

edge_id_arraydevice array type

Device array containing the edge ids of each directed edge. Must match the ordering of the src/dst arrays. Optional (may be null). If provided, edge_type_array must also be provided.

edge_type_arraydevice array type

Device array containing the edge types of each directed edge. Must match the ordering of the src/dst/edge_id arrays. Optional (may be null). If provided, edge_id_array must be provided.

edge_start_time_arraydevice array type

Device array containing the edge start times of each directed edge. Must match the ordering of the src/dst/edge_id arrays. Optional (may be null).

edge_end_time_arraydevice array type

Device array containing the edge end times of each directed edge. Must match the ordering of the src/dst/edge_id arrays. Optional (may be null).

drop_self_loopsbool, optional (default=’False’)

If true, drop any self loops that exist in the provided edge list.

drop_multi_edges: bool, optional (default=’False’)

If true, drop any multi edges that exist in the provided edge list

symmetrize: bool, optional (default=’False’)

If true, symmetrize the edge list

__init__(*args, **kwargs)

Methods

__init__(*args, **kwargs)