diff --git a/README.md b/README.md index 1835a49..e14bd6c 100644 --- a/README.md +++ b/README.md @@ -1,32 +1,30 @@ # 智图 (AutoGL) -[English Introduction](https://www.gitlink.org.cn/THUMNLab/AutoGL/tree/main/README_en.md) +[English Introduction](../..) + 用于图数据的自动机器学习框架和工具包。 *由清华大学媒体与网络实验室进行开发与维护* -[Chinese Introduction](README_cn.md) - -An autoML framework & toolkit for machine learning on graphs. -若有任何意见或建议，欢迎通过issues 或邮件autogl@tsinghua.edu.cn与我们联系。 +若有任何意见或建议，欢迎通过issues 或邮件autogl@tsinghua.edu.cn与我们联系。 -## News! - -- 2022.12.29 New version! v0.4.0-pre is here! - - We have proposed __NAS-Bench-Graph__ ([paper](https://openreview.net/pdf?id=bBff294gqLp), [code](https://github.com/THUMNLab/NAS-Bench-Graph), [tutorial](http://mn.cs.tsinghua.edu.cn/autogl/documentation/docfile/tutorial/t_nas_bench_graph.html)), the first NAS-benchmark for graphs published in NeurIPS'22. By using AutoGL together with NAS-Bench-Graph, the performance estimation process of GraphNAS algorithms can be greatly speeded up. - - We have supported the graph __robustness__ algorithms in AutoGL, including graph structure engineering, robust GNNs and robust GraphNAS. See [robustness tutorial](http://mn.cs.tsinghua.edu.cn/autogl/documentation/docfile/tutorial/t_robust.html) for more details. - - We have supported graph __self-supervised learning__! See [self-supervised learning tutorial](http://mn.cs.tsinghua.edu.cn/autogl/documentation/docfile/tutorial/t_ssl_trainer.html) for more details. -- 2021.12.31 Version v0.3.0-pre is released - - Support [__Deep Graph Library (DGL)__](https://www.dgl.ai/) backend including homogeneous node classification, link prediction, and graph classification tasks. AutoGL is also compatible with PyG 2.0 now. - - Support __heterogeneous__ node classification! See [hetero tutorial](http://mn.cs.tsinghua.edu.cn/autogl/documentation/docfile/tutorial/t_hetero_node_clf.html) . - - The module `model` now supports __decoupled__ to two additional sub-modules named `encoder` and `decoder`. Under the __decoupled__ design, one `encoder` can be used to solve all kinds of tasks. - - Enrich [NAS algorithms](http://mn.cs.tsinghua.edu.cn/autogl/documentation/docfile/tutorial/t_nas.html) such as [AutoAttend](https://proceedings.mlr.press/v139/guan21a.html), [GASSO](https://proceedings.neurips.cc/paper/2021/hash/8c9f32e03aeb2e3000825c8c875c4edd-Abstract.html), [hardware-aware algorithm](http://mn.cs.tsinghua.edu.cn/autogl/documentation/docfile/documentation/nas.html#autogl.module.nas.estimator.OneShotEstimator_HardwareAware), etc. -- 2021.07.11 Version 0.2.0-pre is released, which supports [neural architecture search (NAS)](http://mn.cs.tsinghua.edu.cn/autogl/documentation/docfile/tutorial/t_nas.html) to customize architectures, [sampling (http://mn.cs.tsinghua.edu.cn/autogl/documentation/docfile/tutorial/t_trainer.html#node-classification-with-sampling) to perform tasks on large datasets, and link prediction. -- 2021.04.16 Our survey paper about automated machine learning on graphs is accepted by IJCAI! See more [here](http://arxiv.org/abs/2103.00742). -- 2021.04.10 Our paper [__AutoGL: A Library for Automated Graph Learning__](https://arxiv.org/abs/2104.04987) is accepted by _ICLR 2021 Workshop on Geometrical and Topological Representation Learning_! You can cite our paper following methods [here](#Cite). +## 最新消息 + +- 2021.12.31 新版本！智图v0.4.0-pre 版本发布! + - 提出了__NAS-Bench-Graph__ ([paper](https://openreview.net/pdf?id=bBff294gqLp),[code](https://github.com/THUMNLab/NAS-Bench-Graph), [tutorial](http://mn.cs.tsinghua.edu.cn/autogl/documentation/docfile/tutorial/t_nas_bench_graph.html))，并发表于NeurIPS'22上！其是首个针对图数据的神经架构搜索Benchmark。将AutoGL与NAS-Bench-Graph一起使用可以极大加快图神经架构搜索算法的性能评估过程 + - 支持图自动机器学习的__鲁棒性__算法!包括图结构特征工程、鲁棒图神经网络模型和鲁棒图神经架构搜索，详情参见[图鲁棒性教程](http://mn.cs.tsinghua.edu.cn/autogl/documentation/docfile/tutorial_cn/t_robustness.html) + - 支持图自动机器学习的__自监督__算法！详情参见[图自监督教程](http://mn.cs.tsinghua.edu.cn/autogl/documentation/docfile/tutorial_cn/t_ssl_trainer.html) +- 2021.12.31 智图发布v0.3.0-pre版本： + - 支持[__Deep Graph Library (DGL)__](https://www.dgl.ai/)作为后端，包括同构图的节点分类、链接预测以及图分类等任务。智图现在也可兼容PyG 2.0版本。 + - 支持__异构图__节点分类任务!详情请参考[异构图教程](http://mn.cs.tsinghua.edu.cn/autogl/documentation/docfile/tutorial/t_hetero_node_clf.html)。 + - `model`模块目前支持__解耦__为两个子模块，即编码器`encoder`和解码器`decoder`。在__解耦__设计中，一个`encoder`可以被用来处理不同任务。 + - 扩展了支持的[神经架构搜索算法](http://mn.cs.tsinghua.edu.cn/autogl/documentation/docfile/tutorial/t_nas.html)，例如[AutoAttend](https://proceedings.mlr.press/v139/guan21a.html)，[GASSO](https://proceedings.neurips.cc/paper/2021/hash/8c9f32e03aeb2e3000825c8c875c4edd-Abstract.html)， [硬件感知算法](http://mn.cs.tsinghua.edu.cn/autogl/documentation/docfile/documentation/nas.html#autogl.module.nas.estimator.OneShotEstimator_HardwareAware)等。 +- 2021.07.11 智图v0.2.0-pre版本发布，并支持了[神经架构搜索(NAS)](http://mn.cs.tsinghua.edu.cn/autogl/documentation/docfile/tutorial/t_nas.html)，可以对给定的数据集和架构定制化神经网络架构；[采样](http://mn.cs.tsinghua.edu.cn/autogl/documentation/docfile/tutorial/t_trainer.html#node-classification-with-sampling)以处理大规模图数据集；和链接预测任务。 +- 2021.04.16 我们在IJCAI 2021发表了关于图自动机器学习的首个综述文章! 详情见[这里](http://arxiv.org/abs/2103.00742)。 +- 2021.04.10 我们的论文[__AutoGL: A Library for Automated Graph Learning__](https://arxiv.org/abs/2104.04987)已经发表于 _ICLR 2021 Workshop on Geometrical and Topological Representation Learning_ ! ## 介绍 @@ -118,7 +116,7 @@ pip install autogl 运行以下命令以从源安装智图。 ``` -git clone https://gitlink.org.cn/THUMNLab/AutoGL.git +git clone https://github.com/THUMNLab/AutoGL.git cd AutoGL python setup.py install ``` @@ -174,3 +172,5 @@ make clean && make html ## 版权相关 从v0.2版本开始，智图的所有代码采用[Apache license](LICENSE)。 +## 用户交流微信群 +![weixin](https://user-images.githubusercontent.com/17705534/163801846-2aa1bdf8-919e-4636-b7d9-e5346f352c15.jpg) \ No newline at end of file diff --git a/README_cn.md b/README_cn.md deleted file mode 100644 index 879da68..0000000 --- a/README_cn.md +++ /dev/null @@ -1,180 +0,0 @@ -# 智图 (AutoGL) -[English Introduction](../..) - -用于图数据的自动机器学习框架和工具包。 - -*由清华大学媒体与网络实验室进行开发与维护* - -若有任何意见或建议，欢迎通过issues 或邮件autogl@tsinghua.edu.cn与我们联系。 - - - -## 最新消息 -- 2021.12.31 新版本！智图v0.4.0-pre 版本发布! - - 提出了__NAS-Bench-Graph__ ([paper](https://openreview.net/pdf?id=bBff294gqLp),[code](https://github.com/THUMNLab/NAS-Bench-Graph), [tutorial](http://mn.cs.tsinghua.edu.cn/autogl/documentation/docfile/tutorial/t_nas_bench_graph.html))，并发表于NeurIPS'22上！其是首个针对图数据的神经架构搜索Benchmark。将AutoGL与NAS-Bench-Graph一起使用可以极大加快图神经架构搜索算法的性能评估过程 - - 支持图自动机器学习的__鲁棒性__算法!包括图结构特征工程、鲁棒图神经网络模型和鲁棒图神经架构搜索，详情参见[图鲁棒性教程](http://mn.cs.tsinghua.edu.cn/autogl/documentation/docfile/tutorial_cn/t_robustness.html) - - 支持图自动机器学习的__自监督__算法！详情参见[图自监督教程](http://mn.cs.tsinghua.edu.cn/autogl/documentation/docfile/tutorial_cn/t_ssl_trainer.html) -- 2021.12.31 智图发布v0.3.0-pre版本： - - 支持[__Deep Graph Library (DGL)__](https://www.dgl.ai/)作为后端，包括同构图的节点分类、链接预测以及图分类等任务。智图现在也可兼容PyG 2.0版本。 - - 支持__异构图__节点分类任务!详情请参考[异构图教程](http://mn.cs.tsinghua.edu.cn/autogl/documentation/docfile/tutorial/t_hetero_node_clf.html)。 - - `model`模块目前支持__解耦__为两个子模块，即编码器`encoder`和解码器`decoder`。在__解耦__设计中，一个`encoder`可以被用来处理不同任务。 - - 扩展了支持的[神经架构搜索算法](http://mn.cs.tsinghua.edu.cn/autogl/documentation/docfile/tutorial/t_nas.html)，例如[AutoAttend](https://proceedings.mlr.press/v139/guan21a.html)，[GASSO](https://proceedings.neurips.cc/paper/2021/hash/8c9f32e03aeb2e3000825c8c875c4edd-Abstract.html)， [硬件感知算法](http://mn.cs.tsinghua.edu.cn/autogl/documentation/docfile/documentation/nas.html#autogl.module.nas.estimator.OneShotEstimator_HardwareAware)等。 -- 2021.07.11 智图v0.2.0-pre版本发布，并支持了[神经架构搜索(NAS)](http://mn.cs.tsinghua.edu.cn/autogl/documentation/docfile/tutorial/t_nas.html)，可以对给定的数据集和架构定制化神经网络架构；[采样](http://mn.cs.tsinghua.edu.cn/autogl/documentation/docfile/tutorial/t_trainer.html#node-classification-with-sampling)以处理大规模图数据集；和链接预测任务。 -- 2021.04.16 我们在IJCAI 2021发表了关于图自动机器学习的首个综述文章! 详情见[这里](http://arxiv.org/abs/2103.00742)。 -- 2021.04.10 我们的论文[__AutoGL: A Library for Automated Graph Learning__](https://arxiv.org/abs/2104.04987)已经发表于 _ICLR 2021 Workshop on Geometrical and Topological Representation Learning_ ! - -## 介绍 - -智图的设计目标是可以简单、快速地对图数据集和任务进行自动机器学习，可供研究者和开发者使用。更多详细信息，可以参阅我们的文档。 - -下图是智图的整体框架。 - - - -智图通过 `datasets` 类以支持图数据集，其基于 PyTorch Geometric 和 Deep Graph Library 的数据集，并添加了一些函数以支持自动机器学习框架。 - -智图通过 `AutoGL solvers` 以处理不同的图机器学习任务，利用五个主要模块自动解决给定的任务，即自动特征工程 `auto feature engineer`，神经架构搜索 `neural architecture search`，自动模型 `auto model`，超参数优化 `hyperparameter optimization`，和自动模型集成 `auto ensemble`。 - -目前，智图支持以下算法： - - - - - - - - - - - - - - - - - - -
特征工程图模型神经架构搜索超参数优化模型集成
生成器
Graphlets
EigenGNN
更多 ...

选择器
SeFilterConstant
gbdt

全图特征
Netlsd
NxAverageClustering
更多 ...		同构图编码器
GCNEncoder
GATEncoder
SAGEEncoder
GINEncoder

解码器
LogSoftmaxDecoder
DotProductDecoder
SumPoolMLPDecoder
JKSumPoolDecoder 		- 搜索算法
- Random
- RL
- Evolution
- GASSO
- 更多 ...

- 搜索空间
- SinglePath
- GraphNas
- AutoAttend
- 更多 ...

- 模型评估
- Oneshot
- Scratch
- 		Grid
Random
Anneal
Bayes
CAMES
MOCAMES
Quasi random
TPE
AutoNE 		Voting
Stacking
- -此工具包还可作为一个框架供用户实现和测试自己的自动机器学习或图机器学习模型。 - -## 安装 - -### 依赖 - -在安装智图之前，请首先安装以下依赖项。 - -1. Python >= 3.6.0 - -2. PyTorch (>=1.6.0) - - 详细信息请参考。 - -3. 图机器学习工具包 - - 智图需要 PyTorch Geometric（PyG）或 Deep Graph Library（DGL）作为后端。若两者均安装，可在运行时选择任一后端，参考[这里](http://mn.cs.tsinghua.edu.cn/autogl/documentation/docfile/tutorial/t_backend.html)。 - - 3.1 PyTorch Geometric (>=1.7.0) - - 详细信息请参考。 - - 3.2 Deep Graph Library (>=0.7.0) - - 详细信息请参考。 - - -### 安装 - -#### 通过pip进行安装 - -运行以下命令以通过`pip`安装智图。 - -``` -pip install autogl -``` - -#### 从源代码安装 - -运行以下命令以从源安装智图。 - -``` -git clone https://github.com/THUMNLab/AutoGL.git -cd AutoGL -python setup.py install -``` - -#### 开发者安装 - -如果您想以开发者方式安装智图，请运行以下命令以创建软链接，然后即可修改本地程序后而无需重复安装。 -``` -pip install -e . -``` - -## 文档 - -您可参考文档页面 以参阅我们的详细文档。 - -文档也可以进行本地编译。首先，请安装 sphinx 和 sphinx-rtd-theme: -``` -pip install -U Sphinx -pip install sphinx-rtd-theme -``` - -然后，通过以下方式创建 html 文档： -``` -cd docs -make clean && make html -``` -文档将在如下路径自动生成：`docs/_build/html` - -## 引用 - -如果您使用了智图代码，请按如下方式引用我们的[论文](https://openreview.net/forum?id=0yHwpLeInDn): -``` -@inproceedings{guan2021autogl, - title={Auto{GL}: A Library for Automated Graph Learning}, - author={Chaoyu Guan and Ziwei Zhang and Haoyang Li and Heng Chang and Zeyang Zhang and Yijian Qin and Jiyan Jiang and Xin Wang and Wenwu Zhu}, - booktitle={ICLR 2021 Workshop on Geometrical and Topological Representation Learning}, - year={2021}, - url={https://openreview.net/forum?id=0yHwpLeInDn} -} -``` - -或许您也会发现我们的[综述](http://arxiv.org/abs/2103.00742)有帮助: -``` -@article{zhang2021automated, - title={Automated Machine Learning on Graphs: A Survey}, - author={Zhang, Ziwei and Wang, Xin and Zhu, Wenwu}, - booktitle = {Proceedings of the Thirtieth International Joint Conference on Artificial Intelligence, {IJCAI-21}}, - year={2021}, - note={Survey track} -} -``` - -## 版权相关 -从v0.2版本开始，智图的所有代码采用[Apache license](LICENSE)。 - -## 用户交流微信群 -![weixin](https://user-images.githubusercontent.com/17705534/163801846-2aa1bdf8-919e-4636-b7d9-e5346f352c15.jpg) - - - - - diff --git a/README_en.md b/README_en.md index ee3d1e1..2d7cff3 100644 --- a/README_en.md +++ b/README_en.md @@ -1,10 +1,12 @@ # Auto Graph Learning +[Chinese Introduction](README_cn.md) + An autoML framework & toolkit for machine learning on graphs. *Actively under development by @THUMNLab* -Feel free to open issues or contact us at autogl@tsinghua.edu.cn if you have any comments or suggestions! +Feel free to open issues or contact us at autogl@tsinghua.edu.cn if you have any comments or suggestions!