---

Karate Club 是一个面向 NetworkX 的无监督机器学习扩展库。

请访问 文档、相关 论文、宣传视频，以及 外部资源。

Karate Club 汇集了用于在图结构数据上进行无监督学习的前沿方法。简单来说，它就像一把瑞士军刀，专为小规模图挖掘研究而设计。首先，它提供了节点级和图级的网络嵌入技术；其次，它还包含多种重叠与非重叠的社区检测方法。所实现的方法覆盖了广泛的网络科学领域（如 NetSci、Complenet）、数据挖掘（如 ICDM、CIKM、KDD）、人工智能（如 AAAI、IJCAI）以及机器学习（如 NeurIPS、ICML、ICLR）等领域的会议、研讨会和知名期刊中的相关研究成果。

新近推出的图分类数据集已上线至 SNAP、TUD 图像核数据集 和 GraphLearning.io。

---

引用

如果您在研究中发现 Karate Club 及其新数据集非常有用，请考虑引用以下论文：

@inproceedings{karateclub,
       title = {{Karate Club: 一个以 API 为导向的开源 Python 框架，用于图上的无监督学习}},
       author = {Benedek Rozemberczki、Oliver Kiss、Rik Sarkar},
       year = {2020},
       pages = {3125–3132},
       booktitle = {29th ACM International Conference on Information and Knowledge Management (CIKM '20) 的会议论文集},
       organization = {ACM},
}

---

一个简单的示例

Karate Club 让现代社区检测技术的使用变得极为便捷（详见 此处 的配套教程）。例如，只需几行代码，您就可以在 Watts-Strogatz 图上使用该库 Ego 分裂：

import networkx as nx
from karateclub import EgoNetSplitter

g = nx.newman_watts_strogatz_graph(1000, 20, 0.05)

splitter = EgoNetSplitter(1.0)

splitter.fit(g)

print(splitter.get_memberships())

---

包含的模型

具体而言，我们实现了以下社区检测与嵌入方法：

重叠社区检测

• DANMF 来自 Ye 等人：基于深度自动编码器的非负矩阵分解法用于社区检测（CIKM 2018）

• M-NMF 来自 Wang 等人：社区保持的网络嵌入（AAAI 2017）

• Ego 分裂 来自 Epasto 等人：Ego 分裂框架：从非重叠到重叠聚类（KDD 2017）

• NNSED 来自 Sun 等人：一种非负对称编码器-解码器方法用于社区检测（CIKM 2017）

• BigClam 来自 Yang 和 Leskovec：大规模的重叠社区检测：一种非负矩阵分解方法（WSDM 2013）

• SymmNMF 来自 Kuang 等人：用于图聚类的对称非负矩阵分解（SDM 2012）

非重叠社区检测

• GEMSEC 来自 Rozemberczki 等人：GEMSEC：带有自聚类的图嵌入（ASONAM 2019）

• EdMot 来自 Li 等人：EdMot：一种针对模式感知社区检测的边缘增强方法（KDD 2019）

• SCD 来自 Prat-Perez 等人：高质量、可扩展且并行的大型真实图社区检测（WWW 2014）

• 标签传播——出自 Raghavan 等人：《用于大规模网络社区结构检测的近线性时间算法》（ArXiv 2007）

保持邻近度的节点嵌入

• GraRep——出自 Cao 等人：《GraRep：利用全局结构信息学习图表示》（CIKM 2015）
• DeepWalk——出自 Perozzi 等人：《DeepWalk：在线学习社交表示》（ArXiv 2014）
• Node2Vec——出自 Grover 等人：《node2vec：面向网络的可扩展特征学习》（CS.斯坦福大学，Jietang，2016）
• SocioDim——出自 Tang 等人：《基于潜在社会维度的关系学习》（KDD 2009）
• GLEE——出自 Torres 等人：《GLEE：几何拉普拉斯特征映射嵌入》（Journal of Complex Networks 2020）
• BoostNE——出自 Li 等人：《基于提升的低秩矩阵近似实现的多级网络嵌入》（ASONAM 2019）
• NodeSketch——出自 Yang 等人：《NodeSketch：通过递归抽样实现高效图嵌入》（Exascale 信息，2019）
• Diff2Vec——出自 Rozemberczki 和 Sarkar：《基于扩散图的快速序列嵌入》（CompleNet 2018）
• NetMF——出自 Qiu 等人：《将网络嵌入视为矩阵分解：统一 DeepWalk、LINE、PTE 与 Node2Vec》（WSDM 2018）
• RandNE——出自 Zhang 等人：《基于迭代随机投影的数十亿规模网络嵌入》（ArXiv 2018）
• Walklets——出自 Perozzi 等人：《别走路，跳过！在线学习多尺度网络嵌入》（ArXiv 2016）
• HOPE——出自 Ou 等人：《非对称传递性保持的图嵌入》（DLACM 2016）
• NMF-ADMM——出自 Sun 和 Févotte：《用于非负矩阵分解的交替方向乘法器方法：结合贝塔散度》（ICASSP 2014）
• 拉普拉斯特征映射——出自 Belkin 和 Niyogi：《拉普拉斯特征映射与谱技术：用于嵌入与聚类》（NIPS 2001）

结构化节点层级嵌入

• GraphWave——出自 Donnat 等人：《通过扩散小波学习结构化节点嵌入》（KDD 2018）
• Role2Vec——出自 Ahmed 等人：《学习基于角色的图嵌入》（ArXiv 2018）

带属性的节点层级嵌入

• FEATHER-N——出自 Rozemberczki 等人：《图上的特征函数：从统计描述符到参数化模型——如“鸟群”一般》（ArXiv 2020）

• TADW——出自 Yang 等人：《利用丰富文本信息进行网络表示学习》（IJCAI StarAI 2015）

• MUSAE——出自 Rozemberczki 等人：《多尺度带属性节点嵌入》（ArXiv 2019）

• AE——出自 Rozemberczki 等人：《多尺度带属性节点嵌入》（ArXiv 2019）

• FSCNMF——出自 Bandyopadhyay 等人：《通过非负矩阵分解融合结构与内容，实现信息网络的嵌入》（ArXiV 2018）

• SINE——出自 Zhang 等人：《SINE：可扩展的不完整网络嵌入》（ArXiv 2018）

• BANE——出自 Yang 等人：《二值化带属性网络嵌入》（IEEExplore.ieee.org，8626170）（ICDM 2018）

• TENE 由杨等人提出：利用文本信息增强网络嵌入（ICPR 2018）

• ASNE 由廖等人提出：带属性的社会网络嵌入（TKDE 2018）

元节点嵌入

• NEU 由杨等人提出：通过高阶邻近度近似实现的快速网络嵌入增强（IJCAI 2017）

图级嵌入

• FEATHER-G 由罗赞伯奇基等人提出：图上的特征函数：从统计描述符到参数化模型——“鸟群”式特征（CIKM 2020）

• Graph2Vec 由纳拉亚南等人提出：Graph2Vec：学习图的分布式表示（MLG Workshop 2017）

• NetLSD 由齐楚林等人提出：NetLSD：倾听图的形状（KDD 2018）

• WaveletCharacteristic 由王等人提出：基于扩散-小波的图节点特征分布表征的图嵌入（CIKM 2021）

• IGE 由加兰德等人提出：用于图分类的不变性嵌入（ICML 2019 LRGSD 工作坊）

• LDP 由蔡等人提出：一种简单而有效的非属性图分类基准（ICLR 2019）

• GeoScattering 由高等人提出：用于图数据分析的几何散射方法（ICML 2019）

• GL2Vec 由陈和古贺提出：GL2Vec：通过带有边特征的线性图丰富图嵌入（ICONIP 2019）

• SF 由德拉拉和皮诺提出：一种用于图分类的简单基准算法（NeurIPS RRL 工作坊 2018）

• FGSD 由维尔玛和张提出：在图上进行独特、稳定、稀疏且快速的特征学习的猎手（NeurIPS 2017）

前往我们的文档，了解有关安装与数据处理的更多详情，以及已实现的方法和数据集的完整列表。如需快速入门，请查看我们的示例。

若发现任何意外情况，请随时打开问题并告知我们。如果您缺少某项特定方法，欢迎随时提交功能请求。 我们始终致力于让 Karate Club 不断臻于完善。

---

安装

Karate Club 可以通过以下 pip 命令进行安装。

$ pip install karateclub

由于我们经常发布新版本，因此适时升级软件包可能会带来诸多益处。

$ pip install karateclub --upgrade

---

运行示例

作为文档的一部分，我们提供了多种用例，展示如何将聚类结果与嵌入向量应用于下游学习任务。这些用例可在此查阅，并附有详细的逐行说明。

除了案例研究之外，我们还为每种模型提供了合成示例。您只需运行示例脚本即可尝试这些示例。要运行其中某个示例，您可以使用 Graph2Vec 的代码片段：

$ cd examples/whole_graph_embedding/
$ python graph2vec_example.py

---

运行测试

在项目根目录下：

$ pytest

---

许可证

• GNU 通用公共许可证 v3.0

Karate Club 快速上手指南

环境准备

• 系统要求：Python 3.6+，支持 Linux / macOS / Windows
• 前置依赖：
  • NetworkX ≥ 2.3
  • NumPy ≥ 1.17
  • SciPy ≥ 1.3
  • scikit-learn ≥ 0.22

安装步骤

# 1. 创建并激活虚拟环境（可选）
python -m venv karate_env
source karate_env/bin/activate  # Windows 用 karate_env\Scripts\activate

# 2. 使用国内镜像加速安装
pip install -i https://pypi.tuna.tsinghua.edu.cn/simple karateclub

基本使用

import networkx as nx
from karateclub import EgoNetSplitter

# 1. 构造或加载图
g = nx.newman_watts_strogatz_graph(1000, 20, 0.05)

# 2. 初始化模型
splitter = EgoNetSplitter(1.0)

# 3. 训练并获取结果
splitter.fit(g)
memberships = splitter.get_memberships()
print(memberships)

完成！如需更多示例，参考 官方文档。