Skip to main content

A hackable graphnets library for tensorflow-keras.

Project description

Tensorflow versions and tf_gnns

tf Tests status
2.13 alt-img
2.14 alt-img
2.15 alt-img
2.17 alt-img
Further info There are some un-resolved bugs with the latest tensorflow versions, due to the on-going transition from keras 2 to keras 3 some of the problems are already resolved, but there are some flaky parts in the code currently. Since I develop this single-handedly, I will wait for the dust to settle with keras 3. At the moment it is recommended to use version `tensorflow==2.15` or earlier.

tf_gnns - A Hackable GraphNets library

alt-img A library for easy construction of message-passing networks in tensorflow keras. It is inspired largely by this DeepMind paper and the corresponding open-sourced library (original graph_nets library)

The tf_gnns library has no external dependencies except tensorflow 2.x (there is no support for tf 1.x graphs/sessions-based computation). It implements some alternative design constraints from graph_nets taking advantage of some facilities keras provides to make complex models easily and without large drops in performance.

tf_gnns is built to support arbitrary node/edge/global attributes and update functions. A set of utility functions providing MLP construction with keras are also provided (i.e., handling input/output sizes for valid networks) that replaces sonnet.

The main motivation for this library was the absense of a relatively short and efficient implementation of GNNs that was explicitly created to take advantage of keras's functionalities. GNN implementations which take advantage of tensorflow_probability functionality are to be released in the future (as the one used in [2]).

Installing tf_gnns


NOTE

Currently tensorflow==2.17 and tensorflow_probability==0.24 have one test failing. The failure is related to a validation that tests between two different computation modes - namely the GraphTuple (efficient) and Graph computation mode (not efficient - does not use unsorted_segment_sum and other sparse aggregations). I have not resolved the source of the issue yet, but it could be some benign deviation due to changes in the order of operations that happen for low-level kernels. All tests pass with tensorflow==2.15 and tensorflow_probability==0.22, and it is therefore recommended to use these.


Install with pip:

# optional - recommended:
# pip install tensorflow==2.15 
# pip install tensorflow_probability==0.22
pip install tf_gnns

Use through Docker

You can run build a dockerfile that uses tf_gnns with the following command, based on an Ubuntu22 OS:

docker build . -t tf_gnns_215 --network host  --build-arg TENSORFLOW_VERSION=2.15

The container implements some logic to sort out the necessary dependencies. Namely,

  • Numpy 1.x is required for tf <= 2.14
  • Keras 2 support needs to be enabled for tf >= 2.16
  • The tensorflow_probability version is selected through a mapping given the tensorflow version.

Examples

tf_gnns basics

You may inspect some basic functionality on the following colab notebook:

Open In Colab

list sorting example

(Example from the original deepmind/graph_nets library) If you are familiar with the original graph_nets library, this example will help you understand how you can transition to tf_gnns.

Sort a list of elements. This notebook and the accompanying code demonstrates how to use the Graph Nets library to learn to sort a list of elements.

A list of elements is treated as a fully connected graph between the elements. The network is trained to label the start node, and which (directed) edges correspond to the links to the next largest element, for each node.

After training, the prediction ability is tested by comparing its output to true sorted lists. Then the network's ability to generalise is tested, by using it to sort larger lists.

Open In Colab

Performance

From some initial tests the performance of the tf_gnns library seems to be at least as good as deepmind/graph_nets when using tensor dictionaries.

Publications using tf_gnns

The library has been used so far in the following publications:

[1] Bayesian graph neural networks for strain-based crack localization

[2] Remaining Useful Life Estimation Under Uncertainty with Causal GraphNets [3] Relational VAE: A Continuous Latent Variable Model for Graph Structured Data

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

tf_gnns-0.1.7.4.tar.gz (39.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

tf_gnns-0.1.7.4-py3-none-any.whl (40.1 kB view details)

Uploaded Python 3

File details

Details for the file tf_gnns-0.1.7.4.tar.gz.

File metadata

  • Download URL: tf_gnns-0.1.7.4.tar.gz
  • Upload date:
  • Size: 39.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.10.12

File hashes

Hashes for tf_gnns-0.1.7.4.tar.gz
Algorithm Hash digest
SHA256 dc95de43b749453d3381fff26986ec879a0f1a8b1f082bec3a28507740613d63
MD5 e5f3bb4b316af0647b9041c58da94f04
BLAKE2b-256 6970a920bdce79936a4c46bbbbc088578da318800551f0efec8601c3de80cf4e

See more details on using hashes here.

File details

Details for the file tf_gnns-0.1.7.4-py3-none-any.whl.

File metadata

  • Download URL: tf_gnns-0.1.7.4-py3-none-any.whl
  • Upload date:
  • Size: 40.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.10.12

File hashes

Hashes for tf_gnns-0.1.7.4-py3-none-any.whl
Algorithm Hash digest
SHA256 9f44e2ead47d7806c05071896f4bdf070edac09372d6d8f794f5d1c599ff6ba1
MD5 5ccacb0e90b32f5812d8b24c63c9f6ec
BLAKE2b-256 1aa3443b94bb064eb8e6c70c27773db53d5b17ded86ab9a440462cc43722886f

See more details on using hashes here.

Supported by

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