Skip to main content

A Python Package for Deep Graph Networks

Project description

PyDGN: a research library for Deep Graph Networks

License Documentation Status Python Package Downloads Code style: black Interrogate Coverage DOI

Documentation

This is a Python library to easily experiment with Deep Graph Networks (DGNs). It provides automatic management of data splitting, loading and common experimental settings. It also handles both model selection and risk assessment procedures, by trying many different configurations in parallel (CPU or GPU).

Citing this work

If you used this library for your project, please consider citing us:

@article{pydgn,
  author = {Errica, Federico and Bacciu, Davide and Micheli, Alessio},
  doi = {10.21105/joss.05713},
  journal = {Journal of Open Source Software},
  month = oct,
  number = {90},
  pages = {5713},
  title = {{PyDGN: a Python Library for Flexible and Reproducible Research on Deep Learning for Graphs}},
  url = {https://joss.theoj.org/papers/10.21105/joss.05713},
  volume = {8},
  year = {2023}
}

Installation:

Automated tests passing on Windows, Linux, and MacOS. Requires at least Python 3.8. Simply run

pip install pydgn

Quickstart:

Build dataset and data splits

pydgn-dataset --config-file examples/DATA_CONFIGS/config_NCI1.yml

Train

pydgn-train  --config-file examples/MODEL_CONFIGS/config_SupToyDGN.yml 

And we are up and running!

To debug your code you can add --debug to the command above, but the "GUI" will be disabled.

To stop the computation, use CTRL-C to send a SIGINT signal, and consider using the command ray stop to stop all Ray processes. Warning: ray stop stops all ray processes you have launched, including those of other experiments in progress, if any.

Projects using PyDGN

Data Splits

We provide the data splits taken from

Errica Federico, Podda Marco, Bacciu Davide, Micheli Alessio: A Fair Comparison of Graph Neural Networks for Graph Classification. 8th International Conference on Learning Representations (ICLR 2020). Code

in the examples/DATA_SPLITS folder.

License:

PyDGN >= 1.0.0 is BSD 3-Clause licensed, as written in the LICENSE file.

Project details


Release history Release notifications | RSS feed

Download files

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

Source Distribution

pydgn-1.5.3.tar.gz (78.4 kB view details)

Uploaded Source

Built Distribution

pydgn-1.5.3-py3-none-any.whl (93.3 kB view details)

Uploaded Python 3

File details

Details for the file pydgn-1.5.3.tar.gz.

File metadata

  • Download URL: pydgn-1.5.3.tar.gz
  • Upload date:
  • Size: 78.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.18

File hashes

Hashes for pydgn-1.5.3.tar.gz
Algorithm Hash digest
SHA256 db63a95844462fd9fb2df1b1d9e480dce8e444d3879d6e283bf8d556e387e22b
MD5 2298b0bafeab4b30b8739284a98af010
BLAKE2b-256 0901388aec7b553e20f83668f5f88686b05c076d4ddc9ebbea684ae1b1fdf35e

See more details on using hashes here.

Provenance

File details

Details for the file pydgn-1.5.3-py3-none-any.whl.

File metadata

  • Download URL: pydgn-1.5.3-py3-none-any.whl
  • Upload date:
  • Size: 93.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.18

File hashes

Hashes for pydgn-1.5.3-py3-none-any.whl
Algorithm Hash digest
SHA256 05b24171382bc7549e13ef7e0377868c21dfef245e7e1c59d402bfff37fda7a9
MD5 37bf796ccf5d7e02b96cfb5d91aa61ff
BLAKE2b-256 b6cd2ac460f06b91e891347b4a4c8f2cc45c43c0c7e6b3bae7b26fd84ec6c75a

See more details on using hashes here.

Provenance

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