Analytical App

AppAssets

class graphscope.framework.app.AppAssets(algo=None, context=None, gar=None, cmake_extra_options=None)

A class represents an app asset node in a DAG that holds the bytes of the gar resource.

Assets includes an algorithm name, and gar (for user defined algorithm), a context type (one of ‘tensor’, ‘vertex_data’, ‘vertex_property’, ‘labeled_vertex_data’, ‘dynamic_vertex_data’, ‘labeled_vertex_property’), and its type (one of cpp_pie, cpp_pregel, cython_pie, cython_pregel),

The instance of this class can be passed to init graphscope.framework.app.AppDAGNode

__init__(algo=None, context=None, gar=None, cmake_extra_options=None)

Init assets of the algorithm.

Parameters:

• algo (str) – Represent specific algo inside resource.

• context (str) – Type of context that hold the calculation results.

• None. (It will get from gar if param is None. Defaults to)

• gar (bytes or BytesIO, optional) – The bytes that encodes the application’s source code. Defaults to None.

property algo

Algorithm name, e.g. sssp, pagerank.

Returns:

Algorithm name of this asset.

Return type:

str

property context_type

Context type, e.g. vertex_property, labeled_vertex_data.

Returns:

Type of the app context.

Return type:

str

property gar

Gar resource.

Returns:

gar resource of this asset.

Return type:

bytes

is_compatible(graph)

Determine if this algorithm can run on this type of graph.

Parameters:

graph (GraphDAGNode) – A graph instance.

Raises:

• InvalidArgumentError –

  • App is not compatible with graph

• ScannerError –

  • Yaml file format is incorrect.

property signature

Generate a signature of the app assets by its algo name (and gar resources).

Used to uniquely identify a app assets.

Returns:

signature of this assets

Return type:

str

property type

Algorithm type, one of cpp_pie, cpp_pregel, cython_pie, java_pie or cython_pregel.

Returns:

Algorithm type of this asset.

Return type:

str

JavaApp

class graphscope.analytical.app.JavaApp(full_jar_path: str, java_app_class: str)

A class represents a java app assert node in a DAG that holds the jar file.

It holds necessary resources to run a java app, including java class path, the gar file which consists jar and configuration yaml, and the specified java class. On creating a JavaApp, graphscope will try to load the specified java class, and parse the Base class for your app, and the base class for your Context Class. This operation requires a java runtime environment installed in your client machine where your graphscope session is created.

To run your app, provide JavaApp with a property or projected graph and your querying args.

__call__(graph: Graph, *args, **kwargs)

Instantiate an App and do queries over it.

__init__(full_jar_path: str, java_app_class: str)

Init JavaApp with the full path of your jar file and the fully-qualified name of your app class.

Parameters:

• full_jar_path (str) – The path where the jar file exists.

• java_app_class (str) – the fully-qualified name of your app class.

is_compatible(graph)

Determine if this algorithm can run on this type of graph.

Parameters:

graph (GraphDAGNode) – A graph instance.

Raises:

• InvalidArgumentError –

  • App is not compatible with graph

• ScannerError –

  • Yaml file format is incorrect.

signature()

Generate a signature of the app assets by its algo name (and gar resources).

Used to uniquely identify a app assets.

Returns:

signature of this assets

Return type:

str

App object

class graphscope.framework.app.AppDAGNode(graph, app_assets: AppAssets)

A class represents a app node in a DAG.

In GraphScope, an app node binding a concrete graph node that query executed on.

class graphscope.framework.app.App(app_node, key)

An application that can run on graphs and produce results.

Analytical engine will build the app dynamic library when instantiate a app instance. And the dynamic library will be reused if subsequent app’s signature matches one of previous ones.

__del__()

Unload app. Both on engine side and python side. Set the key to None.

__init__(app_node, key)

property key

A unique identifier of App.

property signature

Signature is computed by all critical components of the App.

Functions

graphscope.framework.app.load_app([gar, ...])

Load an app from gar.

BuiltIn apps

graphscope.attribute_assortativity_coefficient(graph, attribute)

Compute assortativity for node attributes.

Assortativity measures the similarity of connections in the graph with respect to the given attribute.

Parameters:

• graph (graphscope.Graph) – A simple graph.

• attribute (str) – Node attribute key.

Returns:

Assortativity of graph for given attribute

Return type:

r (float)

Notes

This computes Eq. (2) in Ref. [1]_ , (trace(M)-sum(M^2))/(1-sum(M^2)), where M is the joint probability distribution (mixing matrix) of the specified attribute.

References

[1] M. E. J. Newman, Mixing patterns in networks, Physical Review E, 67 026126, 2003

Examples:

>>> import graphscope
>>> from graphscope.dataset import load_modern_graph
>>> sess = graphscope.session(cluster_type="hosts", mode="eager")
>>> g = load_modern_graph(sess)
>>> g.schema
>>> c = graphscope.attribute_assortativity_coefficient(g, attribute="name")
>>> sess.close()

graphscope.numeric_assortativity_coefficient(graph, attribute)

Compute assortativity for numerical node attributes.

Assortativity measures the similarity of connections in the graph with respect to the given numeric attribute.

Parameters:

• graph (graphscope.Graph) – A simple graph.

• attribute (str) – Node attribute key.

Returns:

Assortativity of graph for given attribute

Return type:

r (float)

Examples

>>> import graphscope
>>> from graphscope.dataset import load_modern_graph
>>> sess = graphscope.session(cluster_type="hosts", mode="eager")
>>> g = load_modern_graph(sess)
>>> g.schema
>>> c = graphscope.numeric_assortativity_coefficient(g, attribute="name")
>>> sess.close()

Notes

This computes Eq. (21) in Ref. [1]_ , for the mixing matrix of the specified attribute.

References

[1]

M. E. J. Newman, Mixing patterns in networks Physical Review E, 67 026126, 2003

graphscope.average_degree_connectivity(graph, source='in+out', target='in+out', weight=None)

Compute the average degree connectivity of graph.

The average degree connectivity is the average nearest neighbor degree of nodes with degree k. For weighted graphs, an analogous measure can be computed using the weighted average neighbors degree defined in [1]_, for a node i, as

\[k_{nn,i}^{w} =\]

rac{1}{s_i} sum_{j in N(i)} w_{ij} k_j

where s_i is the weighted degree of node i, w_{ij} is the weight of the edge that links i and j, and N(i) are the neighbors of node i.

graph : (graphscope.Graph): A simple graph.

source“in”|”out”|”in+out” (default:”in+out”)

Directed graphs only. Use “in”- or “out”-degree for source node.

target“in”|”out”|”in+out” (default:”in+out”

Directed graphs only. Use “in”- or “out”-degree for target node.

weightstring or None, optional (default=None)

The edge attribute that holds the numerical value used as a weight. If None, then each edge has weight 1.

ddict

A dictionary keyed by degree k with the value of average connectivity.

ValueError

If either source or target are not one of ‘in’, ‘out’, or ‘in+out’.

>>> import graphscope
>>> from graphscope.dataset import load_modern_graph
>>> sess = graphscope.session(cluster_type="hosts", mode="eager")
>>> g = load_modern_graph(sess)
>>> g.schema
>>> c = graphscope.average_degree_connectivity(g, weight="weight")
>>> sess.close()

[1]

A. Barrat, M. Barthélemy, R. Pastor-Satorras, and A. Vespignani, “The architecture of complex weighted networks”. PNAS 101 (11): 3747–3752 (2004).

graphscope.average_shortest_path_length(graph, weight=None)

Compute the average shortest path length.

The average shortest path length is

\[a =\sum_{s,t \in V} \frac{d(s, t)}{n(n-1)}\]

where V is the set of nodes in G, d(s, t) is the shortest path from s to t, and n is the number of nodes in G.

Parameters:

• graph ((graphscope.Graph): A simple graph.)

• weight ((str, optional): The edge data key corresponding to the edge weight.) – Note that property under multiple labels should have the consistent index. Defaults to None.

Returns:

r – The average shortest path length.

Return type:

float

Examples

>>> import graphscope
>>> from graphscope.dataset import load_modern_graph
>>> sess = graphscope.session(cluster_type="hosts", mode="eager")
>>> g = load_modern_graph(sess)
>>> g.schema
>>> c = graphscope.average_shortest_path_length(g, weight="weight")
>>> sess.close()

graphscope.bfs(graph, src=0)

Breadth first search from the src on projected simple graph.

Parameters:

• graph (graphscope.Graph) – A simple graph.

• src (optional) – Source vertex of breadth first search. The type should be consistent with the id type of the graph, that is, it’s int or str depending on the oid_type is int64_t or string of the graph. Defaults to 0.

Returns:

A context with each vertex with a distance from the source, will be evaluated in eager mode.

Return type:

graphscope.framework.context.VertexDataContextDAGNode

Examples:

>>> import graphscope
>>> from graphscope.dataset import load_p2p_network
>>> sess = graphscope.session(cluster_type="hosts", mode="eager")
>>> g = load_p2p_network(sess)
>>> # project to a simple graph (if needed)
>>> pg = g.project(vertices={"host": ["id"]}, edges={"connect": ["dist"]})
>>> c = graphscope.bfs(pg, src=6)
>>> sess.close()

graphscope.avg_clustering(graph, degree_threshold=1000000000)

Compute the average clustering coefficient for the directed graph.

Parameters:

• graph (graphscope.Graph) – A simple graph.

• degree_threshold (int, optional) – Filter super vertex which degree is greater than threshold. Default to 1e9.

Returns:

float

The average clustering coefficient.

Return type:

r

Examples:

>>> import graphscope
>>> from graphscope.dataset import load_p2p_network
>>> sess = graphscope.session(cluster_type="hosts", mode="eager")
>>> g = load_p2p_network(sess)
>>> # project to a simple graph
>>> pg = g.project(vertices={"host": ["id"]}, edges={"connect": ["dist"]})
>>> c = graphscope.avg_clustering(pg)
>>> print(c.to_numpy("r", axis=0)[0])
>>> sess.close()

graphscope.clustering(graph, degree_threshold=1000000000)

Local clustering coefficient of a node in a Graph is the fraction of pairs of the node’s neighbors that are adjacent to each other.

Parameters:

• graph (graphscope.Graph) – A simple graph.

• degree_threshold (int, optional) – Filter super vertex which degree is greater than threshold. Default to 1e9.

Returns:

A context with each vertex assigned the computed clustering value, will be evaluated in eager mode.

Return type:

graphscope.framework.context.VertexDataContextDAGNode

Examples:

>>> import graphscope
>>> from graphscope.dataset import load_p2p_network
>>> sess = graphscope.session(cluster_type="hosts", mode="eager")
>>> g = load_p2p_network(sess)
>>> # project to a simple graph (if needed)
>>> pg = g.project(vertices={"host": ["id"]}, edges={"connect": ["dist"]})
>>> c = graphscope.clustering(pg)
>>> sess.close()

graphscope.degree_assortativity_coefficient(graph, x='out', y='in', weight=None)

Compute degree assortativity of graph.

Assortativity measures the similarity of connections in the graph with respect to the node degree.

:param graph (graphscope.Graph): :type graph (graphscope.Graph): A simple graph. :param x: The degree type for source node (directed graphs only). :type x: string (‘in’,’out’) :param y: The degree type for target node (directed graphs only). :type y: string (‘in’,’out’) :param weighted: weighted graph or unweighted graph :type weighted: bool (True, False)

Returns:

• r (float) – Assortativity of graph by degree.

• Examples

• .. code:: python – >>> import graphscope >>> from graphscope.dataset import load_modern_graph >>> sess = graphscope.session(cluster_type=”hosts”, mode=”eager”) >>> g = load_modern_graph(sess) >>> g.schema >>> c = graphscope.degree_assortativity_coefficient(g, weight=”weight”) >>> sess.close()

Notes

This computes Eq. (21) in Ref. [1]_ , where e is the joint probability distribution (mixing matrix) of the degrees. If G is directed than the matrix e is the joint probability of the user-specified degree type for the source and target.

References

[1]

M. E. J. Newman, Mixing patterns in networks, Physical Review E, 67 026126, 2003

[2]

Foster, J.G., Foster, D.V., Grassberger, P. & Paczuski, M. Edge direction and the structure of networks, PNAS 107, 10815-20 (2010).

graphscope.degree_centrality(graph, centrality_type='both')

The degree centrality values are normalized by dividing by the maximum possible degree in a simple graph n-1 where n is the number of nodes in G.

Parameters:

• graph (Graph) – A simple graph.

• centrality_type (str, optional) – Available options are in/out/both. Defaults to “both”.

Returns:

A context with each vertex assigned with the computed degree centrality, evaluated in eager mode.

Return type:

graphscope.framework.context.VertexDataContextDAGNode

Examples:

>>> import graphscope
>>> from graphscope.dataset import load_p2p_network
>>> sess = graphscope.session(cluster_type="hosts", mode="eager")
>>> g = load_p2p_network(sess)
>>> # project to a simple graph (if needed)
>>> pg = g.project(vertices={"host": ["id"]}, edges={"connect": ["dist"]})
>>> c = graphscope.degree_centrality(pg, centrality_type="both")
>>> sess.close()

graphscope.eigenvector_centrality(graph, tolerance=1e-06, max_round=100, weight=None)

Compute the eigenvector centrality for the graph. See more about eigenvector centrality here: https://networkx.org/documentation/networkx-1.10/reference/generated/networkx.algorithms.centrality.eigenvector_centrality.html

Parameters:

• graph (graphscope.Graph) – A simple graph.

• tolerance (float, optional) – Defaults to 1e-06.

• max_round (int, optional) – Defaults to 100.

• weight (str, optional) – The edge data key corresponding to the edge weight. Note that property under multiple labels should have the consistent index. Defaults to None.

Returns:

A context with each vertex assigned with a gv-centrality, evaluated in eager mode.

Return type:

graphscope.framework.context.VertexDataContextDAGNode

Examples:

>>> import graphscope
>>> from graphscope.dataset import load_p2p_network
>>> sess = graphscope.session(cluster_type="hosts", mode="eager")
>>> g = load_p2p_network(sess)
>>> # project to a simple graph (if needed)
>>> pg = g.project(vertices={"host": ["id"]}, edges={"connect": ["dist"]})
>>> c = graphscope.eigenvector_centrality(pg, tolerance=1e-06, max_round=10)
>>> sess.close()

graphscope.hits(graph, tolerance=0.01, max_round=100, normalized=True)

Compute HITS on graph.

Hyperlink-Induced Topic Search (HITS; also known as hubs and authorities) is a link analysis algorithm that rates Web pages. See more here: https://en.wikipedia.org/wiki/HITS_algorithm

Parameters:

• graph (graphscope.Graph) – A simple graph.

• tolerance (float, optional) – Defaults to 0.01.

• max_round (int, optional) – Defaults to 100.

• normalized (bool, optional) – Whether to normalize the result to 0-1. Defaults to True.

Returns:

A context with each vertex assigned with the HITS value, evaluated in eager mode.

Return type:

graphscope.framework.context.VertexPropertyContextDAGNode

Examples:

>>> import graphscope
>>> from graphscope.dataset import load_p2p_network
>>> sess = graphscope.session(cluster_type="hosts", mode="eager")
>>> g = load_p2p_network(sess)
>>> # project to a simple graph (if needed)
>>> pg = g.project(vertices={"host": ["id"]}, edges={"connect": ["dist"]})
>>> c = graphscope.hits(pg, tolerance=0.01, max_round=10, normalized=True)
>>> sess.close()

graphscope.is_simple_path(graph, nodes)

Returns True if and only if nodes form a simple path in G.

A simple path in a graph is a nonempty sequence of nodes in which no node appears more than once in the sequence, and each adjacent pair of nodes in the sequence is adjacent in the graph.

:param graph (graphscope.Graph): :type graph (graphscope.Graph): A simple graph. :param nodes: A list of one or more nodes in the graph G. :type nodes: list

Returns:

Whether the given list of nodes represents a simple path in G.

Return type:

bool

Notes

An empty list of nodes is not a path but a list of one node is a path. Here’s an explanation why.

This function operates on node paths. One could also consider edge paths. There is a bijection between node paths and edge paths.

The length of a path is the number of edges in the path, so a list of nodes of length n corresponds to a path of length n - 1. Thus the smallest edge path would be a list of zero edges, the empty path. This corresponds to a list of one node.

To convert between a node path and an edge path, you can use code like the following:

>>> from networkx.utils import pairwise
>>> nodes = [0, 1, 2, 3]
>>> edges = list(pairwise(nodes))
>>> edges
[(0, 1), (1, 2), (2, 3)]
>>> nodes = [edges[0][0]] + [v for u, v in edges]
>>> nodes
[0, 1, 2, 3]

Examples

>>> import graphscope
>>> from graphscope.dataset import load_p2p_network
>>> sess = graphscope.session(cluster_type="hosts", mode="eager")
>>> g = load_p2p_network(sess)
>>> # project to a simple graph (if needed)
>>> pg = g.project(vertices={"host": ["id"]}, edges={"connect": ["dist"]})
>>> c = graphscope.is_simple_path(pg, [2, 3, 8])
>>> print(c)
>>> sess.close()

graphscope.k_core(graph, k: int)

K-cores of the graph are connected components that are left after all vertices of degree less than k have been removed.

Parameters:

• graph (graphscope.Graph) – A simple graph.

• k (int) – The order of the core.

Returns:

A context with each vertex assigned with a boolean:

1 if the vertex satisfies k-core, otherwise 0.

Evaluated in eager mode.

Return type:

graphscope.framework.context.VertexDataContextDAGNode

Examples:

>>> import graphscope
>>> from graphscope.dataset import load_p2p_network
>>> sess = graphscope.session(cluster_type="hosts", mode="eager")
>>> g = load_p2p_network(sess)
>>> # project to a simple graph (if needed)
>>> pg = g.project(vertices={"host": ["id"]}, edges={"connect": ["dist"]})
>>> c = graphscope.k_core(pg, k=3)
>>> sess.close()

graphscope.k_shell(graph, k: int)

The k-shell is the subgraph induced by nodes with core number k. That is, nodes in the k-core that are not in the (k+1)-core.

Parameters:

• graph (graphscope.Graph) – A simple graph.

• k (int) – The order of the k_shell.

Returns:

A context with each vertex assigned with a boolean:

1 if the vertex satisfies k-shell, otherwise 0.

Evaluated in eager mode.

Return type:

graphscope.framework.context.VertexDataContextDAGNode

Examples:

>>> import graphscope
>>> from graphscope.dataset import load_p2p_network
>>> sess = graphscope.session(cluster_type="hosts", mode="eager")
>>> g = load_p2p_network(sess)
>>> # project to a simple graph (if needed)
>>> pg = g.project(vertices={"host": ["id"]}, edges={"connect": ["dist"]})
>>> c = graphscope.k_shell(pg, k=3)
>>> sess.close()

graphscope.katz_centrality(graph, alpha=0.1, beta=1.0, tolerance=1e-06, max_round=100, normalized=True, degree_threshold=1000000000.0)

Compute the Katz centrality.

See more details for Katz centrality here: https://networkx.org/documentation/stable/reference/algorithms/generated/networkx.algorithms.centrality.katz_centrality_numpy.html

Parameters:

• graph (graphscope.Graph) – A simple graph.

• alpha (float, optional) – Auttenuation factor. Defaults to 0.1.

• beta (float, optional) – Weight attributed to the immediate neighborhood. Defaults to 1.0.

• tolerance (float, optional) – Error tolerance. Defaults to 1e-06.

• max_round (int, optional) – Maximum number of rounds. Defaults to 100.

• normalized (bool, optional) – Whether to normalize result values. Defaults to True.

• degree_threshold (int, optional) – Filter super vertex which degree is greater than threshold. Default to 1e9.

Returns:

A context with each vertex assigned with the computed katz_centrality, evaluated in eager mode.

Return type:

graphscope.framework.context.VertexDataContextDAGNode

Examples:

>>> import graphscope
>>> from graphscope.dataset import load_p2p_network
>>> sess = graphscope.session(cluster_type="hosts", mode="eager")
>>> g = load_p2p_network(sess)
>>> # project to a simple graph (if needed)
>>> pg = g.project(vertices={"host": ["id"]}, edges={"connect": ["dist"]})
>>> c = graphscope.katz_centrality(pg)
>>> sess.close()

graphscope.louvain(graph, min_progress=1000, progress_tries=1)

Compute best partition on the graph by louvain.

Parameters:

• graph (graphscope.Graph) – A simple undirected graph.

• min_progress – The minimum delta X required to be considered progress, where X is the number of nodes that have changed their community on a particular pass. Delta X is then the difference in number of nodes that changed communities on the current pass compared to the previous pass.

• progress_tries – number of times the min_progress setting is not met before exiting form the current level and compressing the graph.

Returns:

A context with each vertex assigned with id of community it belongs to, evaluated in eager mode.

Return type:

graphscope.framework.context.VertexDataContextDAGNode

References

[1] Blondel, V.D. et al. Fast unfolding of communities in large networks. J. Stat. Mech 10008, 1-12(2008).

[2] https://github.com/Sotera/distributed-graph-analytics

[3] https://sotera.github.io/distributed-graph-analytics/louvain/

Notes

louvain now only support undirected graph. If input graph is directed graph, louvain would raise an InvalidArgumentError.

Examples:

>>> import graphscope
>>> from graphscope.dataset import load_p2p_network
>>> sess = graphscope.session(cluster_type="hosts", mode="eager")
>>> g = load_p2p_network(sess, directed=False)
>>> # project to a simple graph (if needed)
>>> pg = g.project(vertices={"host": ["id"]}, edges={"connect": ["dist"]})
>>> c = graphscope.louvain(pg, min_progress=1000, progress_tries=1)
>>> sess.close()

graphscope.cdlp(graph, max_round=10)

Evaluate Community Detection with Label Propagation.

Parameters:

• graph (graphscope.Graph) – A simple graph.

• max_round (int, optional) – Maximum rounds. Defaults to 10.

Returns:

A context with each vertex assigned with a community ID, will be evaluated in eager mode.

Return type:

graphscope.framework.context.VertexDataContextDAGNode

Examples:

>>> import graphscope
>>> from graphscope.dataset import load_p2p_network
>>> sess = graphscope.session(cluster_type="hosts", mode="eager")
>>> g = load_p2p_network(sess)
>>> # project to a simple graph (if needed)
>>> pg = g.project(vertices={"host": ["id"]}, edges={"connect": ["dist"]})
>>> c = graphscope.lpa(pg, max_round=10)
>>> sess.close()

graphscope.lpa(graph, max_round=10)

Evaluate Community Detection with Label Propagation.

Parameters:

• graph (graphscope.Graph) – A simple graph.

• max_round (int, optional) – Maximum rounds. Defaults to 10.

Returns:

A context with each vertex assigned with a community ID, will be evaluated in eager mode.

Return type:

graphscope.framework.context.VertexDataContextDAGNode

Examples:

>>> import graphscope
>>> from graphscope.dataset import load_p2p_network
>>> sess = graphscope.session(cluster_type="hosts", mode="eager")
>>> g = load_p2p_network(sess)
>>> # project to a simple graph (if needed)
>>> pg = g.project(vertices={"host": ["id"]}, edges={"connect": ["dist"]})
>>> c = graphscope.lpa(pg, max_round=10)
>>> sess.close()

graphscope.lpa_u2i(graph, max_round=10)

Evaluate (multi-) label propagation on a property graph.

Parameters:

• graph (graphscope.Graph) – A property graph.

• max_round (int, optional) – Maximum number of rounds. Defaults to 10.

Returns:

A context with each vertex, following an array of propagated labels, evaluated in eager mode.

Return type:

graphscope.framework.context.LabeledVertexPropertyContextDAGNode

Examples:

import graphscope as gs
g = gs.g()
# Load some data
r = gs.lpa(g)
s.close()

graphscope.pagerank(graph, delta=0.85, max_round=10)

Evaluate PageRank on a graph.

Parameters:

• graph (graphscope.Graph) – A simple graph.

• delta (float, optional) – Dumping factor. Defaults to 0.85.

• max_round (int, optional) – Maximum number of rounds. Defaults to 10.

Returns:

A context with each vertex assigned with the pagerank value, evaluated in eager mode.

Return type:

graphscope.framework.context.VertexDataContextDAGNode

Examples:

>>> import graphscope
>>> from graphscope.dataset import load_p2p_network
>>> sess = graphscope.session(cluster_type="hosts", mode="eager")
>>> g = load_p2p_network(sess)
>>> # project to a simple graph (if needed)
>>> pg = g.project(vertices={"host": ["id"]}, edges={"connect": ["dist"]})
>>> c = graphscope.pagerank(pg, delta=0.85, max_round=10)
>>> sess.close()

graphscope.pagerank_nx(graph, alpha=0.85, max_iter=100, tol=1e-06)

Evaluate pagerank on a graph using algorithm exactly follows the implemented in NetworkX library.

Parameters:

• graph (graphscope.Graph) – A simple graph.

• alpha (float, optional) – Dumping factor. Defaults to 0.85.

• max_iter (int, optional) – Maximum number of iteration. Defaults to 100.

• tol (float, optional) – Error tolerance used to check convergence in power method solver.

Returns:

A context with each vertex assigned with the pagerank value, evaluated in eager mode.

Return type:

graphscope.framework.context.VertexDataContextDAGNode

Examples:

>>> import graphscope
>>> from graphscope.dataset import load_p2p_network
>>> sess = graphscope.session(cluster_type="hosts", mode="eager")
>>> g = load_p2p_network(sess)
>>> # project to a simple graph (if needed)
>>> pg = g.project(vertices={"host": ["id"]}, edges={"connect": ["dist"]})
>>> c = graphscope.pagerank_nx(pg,  alpha=0.85, max_iter=10, tol=1e-06)
>>> sess.close()

graphscope.sssp(graph, src=0, weight=None)

Compute single source shortest path length on the graph.

Note that the sssp algorithm requires an numerical property on the edge.

Parameters:

• graph (graphscope.Graph) – A simple graph.

• src (optional) – The source vertex. The type should be consistent with the id type of the graph, that is, it’s int or str depending on the oid_type is int64_t or string of the graph. Defaults to 0.

• weight (str, optional) – The edge data key corresponding to the edge weight. Note that property under multiple labels should have the consistent index. Defaults to None.

Returns:

A context with each vertex assigned with the shortest distance from the src, evaluated in eager mode.

Return type:

graphscope.framework.context.VertexDataContextDAGNode

Examples:

>>> import graphscope
>>> from graphscope.dataset import load_p2p_network
>>> sess = graphscope.session(cluster_type="hosts", mode="eager")
>>> g = load_p2p_network(sess)
>>> # project to a simple graph (if needed)
>>> pg = g.project(vertices={"host": ["id"]}, edges={"connect": ["dist"]})
>>> c = graphscope.sssp(pg, src=6)
>>> sess.close()

graphscope.triangles(graph)

Evaluate triangle counting of the graph G.

Parameters:

graph (graphscope.Graph) – A simple graph.

Returns:

A context with each vertex assigned with the triangle counting result, evaluated in eager mode.

Return type:

graphscope.framework.context.VertexDataContextDAGNode

Examples:

>>> import graphscope
>>> from graphscope.dataset import load_p2p_network
>>> sess = graphscope.session(cluster_type="hosts", mode="eager")
>>> g = load_p2p_network(sess)
>>> # project to a simple graph (if needed)
>>> pg = g.project(vertices={"host": ["id"]}, edges={"connect": ["dist"]})
>>> c = graphscope.triangles(pg)
>>> sess.close()

graphscope.voterank(graph, num_of_nodes=0)

Evaluate VoteRank on a graph.

Parameters:

• graph (graphscope.Graph) – A simple graph.

• num_of_nodes (unsigned long int, optional) – Number of ranked nodes to extract. Default all nodes.

Returns:

A context with each vertex assigned with the voterank value, evaluated in eager mode.

Return type:

graphscope.framework.context.VertexDataContextDAGNode

Examples:

>>> import graphscope
>>> from graphscope.dataset import load_p2p_network
>>> sess = graphscope.session(cluster_type="hosts", mode="eager")
>>> g = load_p2p_network(sess)
>>> # project to a simple graph (if needed)
>>> pg = g.project(vertices={"host": ["id"]}, edges={"connect": ["dist"]})
>>> c = graphscope.voterank(pg, num_of_nodes=10)
>>> sess.close()

graphscope.wcc(graph)

Evaluate weakly connected components on the graph. This is an optimized version of WCC. Note this cannot be compiled against a property graph that has multiple labels.

Parameters:

graph (graphscope.Graph) – A simple graph.

Returns:

A context with each vertex assigned with the component ID, evaluated in eager mode.

Return type:

graphscope.framework.context.VertexDataContextDAGNode

Examples:

>>> import graphscope
>>> from graphscope.dataset import load_p2p_network
>>> sess = graphscope.session(cluster_type="hosts", mode="eager")
>>> g = load_p2p_network(sess)
>>> # project to a simple graph (if needed)
>>> pg = g.project(vertices={"host": ["id"]}, edges={"connect": ["dist"]})
>>> c = graphscope.wcc(pg)
>>> sess.close()