Skip to main content

OpennHGNN: an open-source toolkit for Heterogeneous Graph Neural Network

Project description

# OpenHGNN This is an open-source toolkit for Heterogeneous Graph Neural Network(OpenHGNN) based on [DGL [Deep Graph Library]](https://github.com/dmlc/dgl). We integrate SOTA models of heterogeneous graph.

[Test Version]For now, we just release some models for some researchers to run the experiments.

## Keys

  • Easy-to-Use: OpenHGNN provides easy-to-use interfaces for running experiments with the given models and datasets. TODO: [Feature]AutoML & hyper-parameter search.

  • Extensibility: User can define customized task/model/dataset to apply new models to new scenarios.

  • Efficiency: The backend dgl provides efficient APIs.

## Why OpenHGNN

### Relation with [DGL](https://github.com/dmlc/dgl)

OpenHGNN is a high-level package built on top of DGL; it will not cover efficient implementation of low-level components in C++.

### Relation with [OpenHINE](https://github.com/BUPT-GAMMA/OpenHINE)

Package | Heterograph structure | Models | Efficiency | Others |
——– | ——————— | ——————————— | ———– | —————————————— |
OpenHINE | write by our own | Most embedding methods | Inefficient | — |
OpenHGNN | heterograph | Most graph neural network methods | Efficient | Better Extensibility, Better Encapsulation |

To avoid reinventing the wheel, we use the DGL as our backend. So we build the new toolkit OpenHGNN and more models will be integrated into it. OpenHINE will not be updated.

![image](./docs/source/image-001.jpg)

## Get Started

#### Requirements and Installation

#### Running an existing baseline model on an existing benchmark [dataset](./openhgnn/dataset/#Dataset)

`bash python main.py -m model_name -d dataset_name -t task_name -g 0 --use_best_config `

-g controls which gpu you will use. If you do not have gpu, set -g -1.

–use_best_config means you can use the best config in the dataset with the model. If you want to set the different hyper-parameter, modify the [openhgnn.config.ini](./openhgnn/config.ini) manually.

e.g.:

`bash python main.py -m GTN -d imdb4GTN -t node_classification -g 0 --use_best_config `

It is under development, and we release it in a nightly build version. For now, we just give some new models, such as HetGNN, NSHE, GTN, MAGNN, RSHN.

## [Models](./openhgnn/models/#Model)

### Supported Models

  • [HAN](./openhgnn/output/HAN)[WWW 2019] for node classification

  • [HetGNN](./openhgnn/output/HetGNN)[KDD 2019] for node classification and link prediction

  • [GTN](./openhgnn/output/GTN)[NeurIPS 2019] for node classification

  • [RSHN](./openhgnn/output/RSHN)[ICDM 2019] for entity classification

  • [MAGNN](./openhgnn/output/MAGNN)[WWW 2020] for node classification

  • [NSHE](./openhgnn/output/NSHE)[IJCAI 2020] for node classification

### To be supported models

  • Metapath2vec[KDD 2017]

  • [RGCN](./openhgnn/output/RGCN)[ESWC 2018] for node classification

  • CompGCN[ICLR 2020] for node classification

### Candidate models

## Contributors

[GAMMA LAB](https://github.com/BUPT-GAMMA) [BUPT]: [Tianyu Zhao](https://github.com/Theheavens), Cheng Yang, Xiao Wang, [Chuan Shi](http://shichuan.org/)

BUPT: Jiahang Li

DGL Team: Quan Gan, [Jian Zhang](https://github.com/zhjwy9343)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

testopenhgnn-1.1.tar.gz (86.2 kB view details)

Uploaded Source

File details

Details for the file testopenhgnn-1.1.tar.gz.

File metadata

  • Download URL: testopenhgnn-1.1.tar.gz
  • Upload date:
  • Size: 86.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: Python-urllib/3.8

File hashes

Hashes for testopenhgnn-1.1.tar.gz
Algorithm Hash digest
SHA256 f48e1b0b8f388b17c26bf889018eeda13d034ac69c54c584c1aa4f50771b81d2
MD5 dd676be9050ea8997da0619895cddd35
BLAKE2b-256 081ce8918566cf556ca8f9608db7e79cbb7a5764b9862fb9106827df05e01b00

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page