模块化度量

此功能在 Aura 图分析无服务器版中不可用。

有向图

无向图

异构节点

异构关系

加权关系

术语表

有向图: 有向特性。该算法在有向图上定义良好。
有向图: 有向特性。该算法忽略图的方向。
有向图: 有向特性。该算法不在有向图上运行。
无向图: 无向特性。该算法在无向图上定义良好。
无向图: 无向特性。该算法忽略图的无向性。
异构节点: 完全支持异构节点。该算法能够区分不同类型的节点。
异构节点: 允许异构节点。该算法对待所有选定节点的方式相似，无论其标签如何。
异构关系: 完全支持异构关系。该算法能够区分不同类型的关系。
异构关系: 允许异构关系。该算法对待所有选定关系的方式相似，无论其类型如何。
加权关系: 加权特性。该算法支持将关系属性用作权重，通过 relationshipWeightProperty 配置参数指定。
加权关系: 加权特性。该算法将每个关系视为同等重要，忽略任何关系权重的值。

简介

模块化是一种用于评估社区检测质量的度量。社区 C 中节点的关系可以连接到 C 内部的节点或 C 外部的节点。高模块化图中的社区内部节点连接紧密，但不同社区之间的节点连接稀疏。

语法

本节介绍在每种执行模式下执行模块化度量算法所使用的语法。我们正在描述具名图语法的变体。要了解更多关于通用语法变体的信息，请参阅语法概述。

示例 1. 各模式下的模块化语法

在具名图上以流模式运行模块化算法。

CALL gds.modularity.stream(
  graphName: String,
  configuration: Map
) YIELD
  communityId: Integer,
  modularity: Float

表 1. 参数
名称	类型	默认值	可选	描述
graphName	字符串	`不适用`	否	目录中存储的图的名称。
configuration	映射	`{}`	是	算法特定配置和/或图过滤配置。

表 2. 配置
名称	类型	默认值	可选	描述
nodeLabels	字符串列表	`['*']`	是	使用给定节点标签过滤具名图。将包含具有任何给定标签的节点。
relationshipTypes	字符串列表	`['*']`	是	使用给定关系类型过滤具名图。将包含具有任何给定类型的关系。
concurrency	整数	`4 ^[1]`	是	运行算法所使用的并发线程数。
jobId	字符串	`内部生成`	是	可用于更轻松地跟踪算法进度的 ID。
logProgress	布尔值	`true`	是	如果禁用，则不会记录进度百分比。
relationshipWeightProperty	字符串	`null`	是	用作权重的关系属性名称。如果未指定，算法将以无权重模式运行。
communityProperty	字符串	`不适用`	否	保存每个节点社区 ID（整数类型）的节点属性。请注意，只有非负社区 ID 才被视为有效，并会计算其模块化分数。
1. 在 GDS 会话中，默认值为可用处理器数量。

表 3. 结果
名称	类型	描述
communityId	整数	社区 ID。
modularity	浮点数	社区的模块化。

在具名图上以统计模式运行模块化算法。

CALL gds.modularity.stats(
  graphName: String,
  configuration: Map
) YIELD
  nodeCount: Integer,
  relationshipCount: Integer,
  communityCount: Integer,
  modularity: Float,
  postProcessingMillis: Integer,
  preProcessingMillis: Integer,
  computeMillis: Integer,
  configuration: Map

表 4. 参数
名称	类型	默认值	可选	描述
graphName	字符串	`不适用`	否	目录中存储的图的名称。
configuration	映射	`{}`	是	算法特定配置和/或图过滤配置。

表 5. 配置
名称	类型	默认值	可选	描述
nodeLabels	字符串列表	`['*']`	是	使用给定节点标签过滤具名图。将包含具有任何给定标签的节点。
relationshipTypes	字符串列表	`['*']`	是	使用给定关系类型过滤具名图。将包含具有任何给定类型的关系。
concurrency	整数	`4 ^[2]`	是	运行算法所使用的并发线程数。
jobId	字符串	`内部生成`	是	可用于更轻松地跟踪算法进度的 ID。
logProgress	布尔值	`true`	是	如果禁用，则不会记录进度百分比。
relationshipWeightProperty	字符串	`null`	是	用作权重的关系属性名称。如果未指定，算法将以无权重模式运行。
communityProperty	字符串	`不适用`	否	保存每个节点社区 ID（整数类型）的节点属性。请注意，只有非负社区 ID 才被视为有效，并会计算其模块化分数。
2. 在 GDS 会话中，默认值为可用处理器数量。

表 6. 结果
名称	类型	描述
nodeCount	整数	图中的节点数量。
relationshipCount	整数	图中的关系数量。
communityCount	整数	社区数量。
modularity	浮点数	总模块化分数。
preProcessingMillis	整数	数据预处理的毫秒数。
computeMillis	整数	运行算法的毫秒数。
postProcessingMillis	整数	计算百分位数和社区计数的毫秒数。
configuration	映射	运行算法所使用的配置。

示例

以下所有示例都应在空数据库中运行。

示例均使用Cypher 投影作为标准。原生投影将在未来版本中弃用。

在本节中，我们将展示在具体图上运行模块化算法的示例。目的是说明结果如何，并提供在实际设置中如何使用该算法的指南。我们将在一个由少量节点以特定模式连接而成的小型社交网络图上进行此操作。示例图如下所示

以下 Cypher 语句将在 Neo4j 数据库中创建示例图

CREATE
  (nAlice:User {name: 'Alice', community: 3}),
  (nBridget:User {name: 'Bridget', community: 2}),
  (nCharles:User {name: 'Charles', community: 2}),
  (nDoug:User {name: 'Doug', community: 3}),
  (nMark:User {name: 'Mark', community: 5}),
  (nMichael:User {name: 'Michael', community: 5}),

  (nAlice)-[:LINK {weight: 1}]->(nBridget),
  (nAlice)-[:LINK {weight: 1}]->(nCharles),
  (nCharles)-[:LINK {weight: 1}]->(nBridget),

  (nAlice)-[:LINK {weight: 5}]->(nDoug),

  (nMark)-[:LINK {weight: 1}]->(nDoug),
  (nMark)-[:LINK {weight: 1}]->(nMichael),
  (nMichael)-[:LINK {weight: 1}]->(nMark);

此图包含三个预先计算好的用户社区，这些社区紧密相连。有关可用社区检测算法的更多详细信息，请参阅文档的社区算法部分。社区由每个节点上的 community 节点属性指示。连接每个组件中节点的关系具有一个 weight 属性，该属性决定了关系的强度。

我们现在可以将图投影并存储在图目录中。我们加载 LINK 关系，并将其方向设置为 UNDIRECTED（无向）。

以下语句将投影图并将其存储在图目录中。

MATCH (source:User)-[r:LINK]->(target:User)
RETURN gds.graph.project(
  'myGraph',
  source,
  target,
  {
    sourceNodeProperties: source { .community },
    targetNodeProperties: target { .community },
    relationshipProperties: r { .weight }
  },
  { undirectedRelationshipTypes: ['*'] }
)

内存估算

首先，我们将使用 estimate 过程估算运行算法的成本。这可以通过任何执行模式完成。在此示例中，我们将使用 stats 模式。估算算法有助于了解在图上运行算法对内存的影响。当您稍后实际以某种执行模式运行算法时，系统将执行一次估算。如果估算结果显示执行超出其内存限制的可能性非常高，则禁止执行。要了解更多信息，请参阅自动估算和执行阻塞。

有关 estimate 的更多详细信息，请参阅内存估算。

以下将估算在统计模式下运行算法所需的内存。

CALL gds.modularity.stats.estimate('myGraph', {
     communityProperty: 'community',
     relationshipWeightProperty: 'weight'
})
YIELD nodeCount, relationshipCount, bytesMin, bytesMax, requiredMemory

表 7. 结果
nodeCount	relationshipCount	bytesMin	bytesMax	requiredMemory
6	14	968	968	"968 字节"

流模式

由于每个节点上都有社区信息，我们可以根据模块化度量来评估其质量。请注意，在这种情况下，我们使用了关系由关系属性加权的特性。

模块化流过程返回每个社区的模块化。这使我们能够直接检查结果，或在 Cypher 中对其进行后处理而无任何副作用。

有关流模式的更多详细信息，请参阅流模式。

以下将在 stream 模式下运行模块化算法

CALL gds.modularity.stream('myGraph', {
     communityProperty: 'community',
     relationshipWeightProperty: 'weight'
})
YIELD communityId, modularity
RETURN communityId, modularity
ORDER BY communityId ASC

表 8. 结果
communityId	modularity
2	0.057851239669421
3	0.105371900826446
5	0.130165289256198

我们可以看到加权图中模块化最高的社区是社区 5。这意味着社区 5 是最“紧密相连”的社区，其大部分关系权重都在社区内部。

统计模式

有关统计模式的更多详细信息，请参阅统计模式。

以下将在 stats 模式下运行模块化算法

CALL gds.modularity.stats('myGraph', {
     communityProperty: 'community',
     relationshipWeightProperty: 'weight'
})
YIELD nodeCount, relationshipCount, communityCount, modularity

表 9. 结果
nodeCount	relationshipCount	communityCount	modularity
6	14	3	0.293388429752066