cugraph.dask.link_prediction.sorensen.sorensen#
- cugraph.dask.link_prediction.sorensen.sorensen(input_graph, vertex_pair=None, use_weight=False)[source]#
Compute the Sorensen coefficient between each pair of vertices connected by an edge, or between arbitrary pairs of vertices specified by the user. Sorensen coefficient is defined between two sets as the ratio of twice the volume of their intersection over the volume of each set. If first is specified but second is not, or vice versa, an exception will be thrown.
cugraph.dask.sorensen, in the absence of a specified vertex pair list, will compute the two_hop_neighbors of the entire graph to construct a vertex pair list and will return the sorensen coefficient for those vertex pairs. This is not advisable as the vertex_pairs can grow exponentially with respect to the size of the datasets
- Parameters:
- input_graphcugraph.Graph
cuGraph Graph instance, should contain the connectivity information as an edge list (edge weights are not supported yet for this algorithm). The graph should be undirected where an undirected edge is represented by a directed edge in both direction. The adjacency list will be computed if not already present.
This implementation only supports undirected, non-multi Graphs.
- vertex_paircudf.DataFrame, optional (default=None)
A GPU dataframe consisting of two columns representing pairs of vertices. If provided, the sorensen coefficient is computed for the given vertex pairs. If the vertex_pair is not provided then the current implementation computes the sorensen coefficient for all vertices that are two hops apart in the graph.
- use_weightbool, optional (default=False)
Flag to indicate whether to compute weighted sorensen (if use_weight==True) or un-weighted sorensen (if use_weight==False). ‘input_graph’ must be weighted if ‘use_weight=True’.
- Returns:
- resultdask_cudf.DataFrame
GPU distributed data frame containing 3 dask_cudf.Series
- ddf[‘first’]: dask_cudf.Series
The first vertex ID of each pair(will be identical to first if specified).
- ddf[‘second’]: dask_cudf.Series
The second vertex ID of each pair(will be identical to second if specified).
- ddf[‘sorensen_coeff’]: dask_cudf.Series
The computed sorensen coefficient between the first and the second vertex ID.