pylibcugraph.cosine_coefficients#

pylibcugraph.cosine_coefficients(
ResourceHandle resource_handle,
_GPUGraph graph,
first,
second,
bool_t use_weight,
bool_t do_expensive_check,
)[source]#

Compute the Cosine coefficients for the specified vertex_pairs.

Note that Cosine similarity must run on a symmetric graph.

Parameters:
resource_handleResourceHandle

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

graphSGGraph or MGGraph

The input graph, for either Single or Multi-GPU operations.

first

Source of the vertex pair.

second

Destination of the vertex pair.

use_weightbool, optional
If set to True, the compute weighted cosine_coefficients(

the input graph must be weighted in that case).

Otherwise, computed un-weighted cosine_coefficients

do_expensive_checkbool

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

Returns:
A tuple of device arrays containing the vertex pairs with
their corresponding Cosine coefficient scores.

Examples

# FIXME: No example yet