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.1.tar.gz (77.9 kB view details)

Uploaded Source

Built Distribution

pydgn-1.5.1-py3-none-any.whl (92.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: pydgn-1.5.1.tar.gz
  • Upload date:
  • Size: 77.9 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.1.tar.gz
Algorithm Hash digest
SHA256 6762f20d3ba3f177c8fbeee1073ad3e0b1803ea03cb44b84192d0ba430fd5d7f
MD5 a4309656754af6788ee6bbcb8ebb489a
BLAKE2b-256 99f00e7c986e96b8785c556060c414006243ca537bfd605629dd731208e21668

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: pydgn-1.5.1-py3-none-any.whl
  • Upload date:
  • Size: 92.8 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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 225253053e3bd2e40abb8d06a40504e32ef13793d0e3328ec08e12e851d151a8
MD5 e0b311cea5fda92f45aac86d1a79c88b
BLAKE2b-256 cdcfcd11e2efc3bb156163a589bd5052891d740825db077631c3f8b99d246036

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