SamplingGraph

class dgl.graphbolt.SamplingGraph

Bases: object

Class for sampling graph.

copy_to_shared_memory(shared_memory_name: str) → SamplingGraph

Copy the graph to shared memory.

Parameters:

shared_memory_name (str) – Name of the shared memory.

Returns:

The copied SamplingGraph object on shared memory.

Return type:

SamplingGraph

to(device: device) → SamplingGraph

Copy graph to the specified device.

Parameters:

device (torch.device) – The destination device.

Returns:

The graph on the specified device.

Return type:

SamplingGraph

property num_edges: int | Dict[str, int]

The number of edges in the graph. - If the graph is homogenous, returns an integer. - If the graph is heterogenous, returns a dictionary.

Returns:

The number of edges. Integer indicates the total edges number of a homogenous graph; dict indicates edges number per edge types of a heterogenous graph.

Return type:

Union[int, Dict[str, int]]

property num_nodes: int | Dict[str, int]

The number of nodes in the graph. - If the graph is homogenous, returns an integer. - If the graph is heterogenous, returns a dictionary.

Returns:

The number of nodes. Integer indicates the total nodes number of a homogenous graph; dict indicates nodes number per node types of a heterogenous graph.

Return type:

Union[int, Dict[str, int]]