Home

Awesome

Auto Graph Learning

Chinese Introduction

An autoML framework & toolkit for machine learning on graphs.

Actively under development by @THUMNLab

Feel free to open <a href="https://github.com/THUMNLab/AutoGL/issues">issues</a> or contact us at <a href="mailto:autogl@tsinghua.edu.cn">autogl@tsinghua.edu.cn</a> if you have any comments or suggestions!

<!-- [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black) % [![Documentation Status](http://mn.cs.tsinghua.edu.cn/autogl/documentation/?badge=latest)](http://mn.cs.tsinghua.edu.cn/autogl/documentation/?badge=latest)-->

News!

Introduction

AutoGL is developed for researchers and developers to conduct autoML on graph datasets and tasks easily and quickly. See our documentation for detailed information!

The workflow below shows the overall framework of AutoGL.

<img src="./resources/workflow.svg">

AutoGL uses datasets to maintain datasets for graph-based machine learning, which is based on Dataset in PyTorch Geometric or Deep Graph Library with some functions added to support the auto solver framework.

Different graph-based machine learning tasks are handled by different AutoGL solvers, which make use of five main modules to automatically solve given tasks, namely auto feature engineer, neural architecture search, auto model, hyperparameter optimization, and auto ensemble.

Currently, the following algorithms are supported in AutoGL:

<table> <tbody> <tr valign="top"> <td>Feature Engineer</td> <td>Model</td> <td>NAS</td> <td>HPO</td> <td>Ensemble</td> </tr> <tr valign="top"> <!--<td><b>Generators</b><br>graphlet <br> eigen <br> pagerank <br> PYGLocalDegreeProfile <br> PYGNormalizeFeatures <br> PYGOneHotDegree <br> onehot <br> <br><b>Selectors</b><br> SeFilterConstant<br> gbdt <br> <br><b>Subgraph</b><br> NxLargeCliqueSize<br> NxAverageClusteringApproximate<br> NxDegreeAssortativityCoefficient<br> NxDegreePearsonCorrelationCoefficient<br> NxHasBridge <br>NxGraphCliqueNumber<br> NxGraphNumberOfCliques<br> NxTransitivity<br> NxAverageClustering<br> NxIsConnected<br> NxNumberConnectedComponents<br> NxIsDistanceRegular<br> NxLocalEfficiency<br> NxGlobalEfficiency<br> NxIsEulerian </td>--> <td><b>Generators</b><br>Graphlets <br> EigenGNN <br> <a href="http://mn.cs.tsinghua.edu.cn/autogl/documentation/docfile/tutorial/t_fe.html">more ...</a><br><br><b>Selectors</b><br> SeFilterConstant<br> gbdt <br> <br><b>Graph</b><br> netlsd<br> NxAverageClustering<br> <a href="http://mn.cs.tsinghua.edu.cn/autogl/documentation/docfile/tutorial/t_fe.html">more ...</a></td> <td><b>Homo Encoders</b><br> GCNEncoder <br> GATEncoder <br> SAGEEncoder <br> GINEncoder <br> <br><b>Decoders</b><br>LogSoftmaxDecoder <br> DotProductDecoder <br> SumPoolMLPDecoder <br> JKSumPoolDecoder </td> <td> <b>Algorithms</b><br> Random<br> RL<br> Evolution<br> GASSO<br> <a href='http://mn.cs.tsinghua.edu.cn/autogl/documentation/docfile/documentation/nas.html'>more ...</a><br><br> <b>Spaces</b><br> SinglePath<br> GraphNas<br> AutoAttend<br> <a href='http://mn.cs.tsinghua.edu.cn/autogl/documentation/docfile/documentation/nas.html'>more ...</a><br><br> <b>Estimators</b><br> Oneshot<br> Scratch<br> </td> <td> Grid <br> Random <br> Anneal <br> Bayes <br> CAMES <br> MOCAMES <br> Quasi random <br> TPE <br> AutoNE </td> <td> Voting <br> Stacking </td> </tr> </tbody> </table>

This toolkit also serves as a framework for users to implement and test their own autoML or graph-based machine learning models.

Installation

Requirements

Please make sure you meet the following requirements before installing AutoGL.

  1. Python >= 3.6.0

  2. PyTorch (>=1.6.0)

    see https://pytorch.org/ for installation.

  3. Graph Library Backend

    You will need either PyTorch Geometric (PyG) or Deep Graph Library (DGL) as the backend. You can select a backend following here if you install both.

    3.1 PyTorch Geometric (>=1.7.0)

    See https://pytorch-geometric.readthedocs.io/en/latest/notes/installation.html/ for installation.

    3.2 Deep Graph Library (>=0.7.0)

    See https://dgl.ai/ for installation.

Installation

Install from pip

Run the following command to install this package through pip.

pip install autogl

Install from source

Run the following command to install this package from the source.

git clone https://github.com/THUMNLab/AutoGL.git
cd AutoGL
python setup.py install

Install for development

If you are a developer of the AutoGL project, please use the following command to create a soft link, then you can modify the local package without install them again.

pip install -e .

Documentation

Please refer to our <a href="http://mn.cs.tsinghua.edu.cn/autogl/documentation/">documentation</a> to see the detailed documentation.

You can also make the documentation locally. First, please install sphinx and sphinx-rtd-theme:

pip install -U Sphinx
pip install sphinx-rtd-theme

Then, make an html documentation by:

cd docs
make clean && make html

The documentation will be automatically generated under docs/_build/html

Cite

Please cite our paper as follows if you find our code useful:

@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}
}

You may also find our survey paper helpful:

@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}
}

License

We follow Apache license across the entire codebase from v0.2.