Skip to main content

The Python implementation of the μG language for programming graph neural networks

Project description

libmg

Tests

libmg is a Python library for compiling μG expressions into TensorFlow model. It allows the parsing, unparsing, normalization, compilation of μG expressions. It also provides functionalities to visualize graphs and model outputs.

Pre-requisites

  • A Linux operating system (preferably Ubuntu 16.04 or later as per the TensorFlow recommendation).
  • Python 3.11 environment.

The library can run both on the CPU or the GPU. To enable the GPU, the specific dependencies needed are those of TensorFlow 2.12, that is:

  • GCC 9.3.1
  • Bazel 5.3.0
  • NVIDIA GPU drivers version 450.80.02 or higher
  • CUDA 11.8
  • cuDNN 8.6
  • (Optional) TensorRT 7

Installation

libmg can be installed via pip or from source.

Pip installation

libmg can be installed from the Python Package Index PyPI, by simply running the following command in your shell or virtual environment:

$ pip install libmg

Source installation

You can install libmg from source using git. You can start by downloading the repo archive or by cloning the repo:

git clone https://github.com/quasylab/mG.git

Then proceed by opening a shell into the mG directory you have just downloaded. To build the library you will need to use [Poetry](https://python-poetry. org/). Run the following command:

poetry install

and Poetry will install libmg in your Python environment. To install the development dependencies as well, install with:

poetry install --with tests --with docs

This will add the testing dependencies (pytest, mypy, and flake8) as well as the documentation dependencies (mkdocs and plugins).

Usage

  • Create a Dataset object with the Graph instances to process.
  • Define dictionaries of Psi, Phi, Sigma objects as needed by your application.
  • Define a CompilerConfig that is adequate for the graphs in your Dataset
  • Create a MGCompiler using the dictionaries and the CompilerConfig
  • Create an adequate Loader for your Dataset: use the SingleGraphLoader if your dataset contains a single graph and use the MultipleGraphLoader otherwise.
  • Build a model from your μG formulas using the compiler's compile(expr) method.
  • Train your model as you would in Tensorflow
  • Use output = model.predict(loader.load(), steps=loader.steps_per_epoch) or a loop like
    for x in loader.load():
        output = model(x)
    
    to run your model on the dataset.
  • Visualize the outputs on the browser using print_layer(model, inputs, layer_idx=-1)

Documentation

You can find the official documentation here.

Research articles

Matteo Belenchia, Flavio Corradini, Michela Quadrini, and Michele Loreti. 2023. Implementing a CTL Model Checker with μG, a Language for Programming Graph Neural Networks. In Formal Techniques for Distributed Objects, Components, and Systems: 43rd IFIP WG 6.1 International Conference, FORTE 2023, Held as Part of the 18th International Federated Conference on Distributed Computing Techniques, DisCoTec 2023, Lisbon, Portugal, June 19–23, 2023, Proceedings. Springer-Verlag, Berlin, Heidelberg, 37–54. https://doi.org/10.1007/978-3-031-35355-0_4. Preprint: https://www.researchgate.net/publication/371467699_Implementing_a_CTL_Model_Checker_with_mu_mathcal_G_a_Language_for_Programming_Graph_Neural_Networks

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

libmg-1.0.9.tar.gz (875.9 kB view details)

Uploaded Source

Built Distribution

libmg-1.0.9-py3-none-any.whl (890.5 kB view details)

Uploaded Python 3

File details

Details for the file libmg-1.0.9.tar.gz.

File metadata

  • Download URL: libmg-1.0.9.tar.gz
  • Upload date:
  • Size: 875.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/4.0.2 CPython/3.11.7

File hashes

Hashes for libmg-1.0.9.tar.gz
Algorithm Hash digest
SHA256 aef83982a10c8e1765dd775385eb7a8e629a0fbb8a563e4423952e565137f1c0
MD5 e656451b54cd7d292db145ffedefe9c3
BLAKE2b-256 4c40a25a595d93ea0b94a0cd4bc243b68740637ea9c5cc4630a0f6f0237e0ed3

See more details on using hashes here.

File details

Details for the file libmg-1.0.9-py3-none-any.whl.

File metadata

  • Download URL: libmg-1.0.9-py3-none-any.whl
  • Upload date:
  • Size: 890.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/4.0.2 CPython/3.11.7

File hashes

Hashes for libmg-1.0.9-py3-none-any.whl
Algorithm Hash digest
SHA256 69612e724e02ff64c9114f46874340c132b11dd193a49c5d42eed285474a9cb2
MD5 4988f3bfc180a752567a46770647eda7
BLAKE2b-256 365b139a284d1877f8f0fe1eb293eaf372cd1ebfe7225a83eb897e8c3de1a526

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