Awesome

DGLD is an open-source library for Deep Graph Anomaly Detection based on pytorch and DGL. It provides unified interface of popular graph anomaly detection methods, including the data loader, data augmentation, model training and evaluation. Also, the widely used modules are well organized so that developers and researchers can quickly implement their own designed models.

News

• [Aug 2022] We have released an easy-to-use graphical command line tool for users to run experiments with different models, datasets and customized parameters. Users can select all the settings in the page, click 'Submit' and copy the shell scripts to the terminal.
• [July 2022] For PyG users, we recommend the PyGOD, which is another comprehensive package that also supports many graph anomaly detection methods.
• [June 2022] Recently we receive feedback that the reported results are slightly different from the original paper. This is due to the anomaly injection setting, the graph augmentation and sampling. We will provide more details on the settings.

Installation

Basic environment installation:

conda create -n dgld python=3.8.0
conda activate dgld
conda install cudatoolkit==11.3.1
pip install dgl-cu113==0.8.1 dglgo==0.0.1 -f https://data.dgl.ai/wheels/repo.html
pip install torch==1.11.0+cu113  -f https://download.pytorch.org/whl/torch_stable.html

Install from source code

Then clone the DGLD project, enter the directory and run:

git clone git@github.com:EagleLab-ZJU/DGLD.git
pip install -r requirements.txt

To check whether you have successfully installed the package and environment, you can simply run

python example.py

Install from pypi

pip install DGLD

Now you can enjoy DGLD!

Quick Start

We support an example.py showing how it works. Here, we introduce how to simply run DGLD, following 4 steps.

Dataloader

DGLD support multiple data import methods, including PyTorch Geometric, DGL and custom data. DGLD combines the process of data load and anomaly injection. Except for some basic datasets(including "Cora", "Citeseer", "Pubmed", "BlogCatalog", "Flickr", "ogbn-arxiv" and "ACM"), DGLD also accept custom data.

Anomaly Injection

In anomaly detection, DGLD inject the abnormal node in two methods, structural and contextual, by two parameters - p and k. gnd_dataset is an instance of GraphNodeAnomalyDectionDataset. g is an instance of DGL.Graph. label is an instnace of torch.Tensor, presenting the anomaly class. Following is an example showing that a few lines of codes are sufficient to load and inject.

from DGLD.utils.dataset import GraphNodeAnomalyDectionDataset

gnd_dataset = GraphNodeAnomalyDectionDataset("Cora", p = 15, k = 50)
g = gnd_dataset[0]
label = gnd_dataset.anomaly_label

Model

DGLD supports some basic methods. It's easy to construct and train model.

from DGLD.models import CoLA

model = CoLA(in_feats = g.ndata['feat'].shape[1])

Train and Evaluation

Function fit need parameters to specify number of epoch and device. For gpu, device should be a int, while a string 'cpu' for cpu.

from DGLD.utils.evaluation import split_auc

model.fit(g, num_epoch=5, device=0)
result = model.predict(g, auc_test_rounds=2)
print(split_auc(label, result))

Native Datasets

The DGLD provides native graph anomaly detection datasets that widely used by existing methods.

Implemented Results (Sorted Results)

Upcoming Features

• More Graph Anomaly Detection Methods
• Edge/Community/Graph Level Anomaly Detection Tasks
• Graphical Operation Interface