Compute.avg_clustering_coefficient() Preview #

relationalai.std.graphs
#Compute.avg_clustering_coefficient() -> Expression

Compute the average clustering coefficient of all nodes in an undirected graph. The average clustering coefficient is the average of the local clustering coefficients for each node in the graph. Values range from 0 to 1. Higher average clustering coefficients indicate nodes’ increased tendency to form triangles with neighbors. Must be called in a rule or query context.

Directed graphs are not supported.

Supported Graph Types#

Graph TypeSupportedNotes
DirectedNo
UndirectedYes
WeightedYesWeights are ignored.
UnweightedYes

Returns#

Returns an Expression object that produces the average clustering coefficient of all nodes in the graph as a floating-point value.

Example#

Use .avg_clustering_coefficient() to compute the average clustering coefficient of all nodes in an undirected graph. You access the .avg_clustering_coefficient() method from a Graph object’s .compute attribute:

#import relationalai as rai
from relationalai.std import alias
from relationalai.std.graphs import Graph

# Create a model named "socialNetwork" with a Person type.
model = rai.Model("socialNetwork")
Person = model.Type("Person")

# Add some people to the model and connect them with a multi-valued `friend` property.
with model.rule():
    alice = Person.add(name="Alice")
    bob = Person.add(name="Bob")
    carol = Person.add(name="Carol")
    daniel = Person.add(name="Daniel")
    alice.friends.extend([bob, carol])
    bob.friends.extend([alice, carol, daniel])

# Create an undirected graph with Person nodes and edges between friends.
# This graph has four edges: Alice, Bob, and Carol form a triangle, and Daniel is only connected to Bob.
graph = Graph(model, undirected=True)
graph.Node.extend(Person)
graph.Edge.extend(Person.friends)

# Compute the average clustering coefficient of the graph.
with model.query() as select:
    acc = graph.compute.avg_clustering_coefficient()
    response = select(alias(acc, "avg_clustering_coefficient"))

print(response.results)
# Output:
#    avg_clustering_coefficient
# 0                    0.583333

See Also#