Skip to content

Repository files navigation

Documentation  •  Paper

PyPI CI License

GraKeL is a library that provides implementations of several well-established graph kernels. The library unifies these kernels into a common framework. Furthermore, it provides implementations of some frameworks that work on top of graph kernels. Specifically, GraKeL contains 16 kernels and 2 frameworks. The library is compatible with the scikit-learn pipeline allowing easy and fast integration inside machine learning algorithms.


In detail, the following kernels and frameworks are currently implemented:


To learn how to install and use GraKeL, and to find out more about the implemented kernels and frameworks, please read our documentation. To learn about the functionality of the library and about example applications, check out our examples in the examples/ directory and our tutorials in the tutorials/ directory.

In case you find a bug, please open an issue. To propose a new kernel, you can open a feature request.

Installation

The GraKeL library requires the following packages to be installed:

  • Python (>=3.9, <3.13)
  • NumPy (>=1.19.0)
  • SciPy (>=1.12.0)
  • scikit-learn (>=0.24.0)
  • Cython (>=0.29.21)
  • cvxopt (>=1.2.0) [optional]

To install the package, run:

$ pip install grakel

Development

To work on the source, first install uv and then sync the project (this installs the package and all its development dependencies in a .venv):

$ uv sync --all-extras

Running tests

To test the package, execute:

$ uv run pytest

Running examples

$ cd examples
$ python shortest_path.py

Cite

If you use GraKeL in a scientific publication, please cite our paper (http://jmlr.org/papers/volume21/18-370/18-370.pdf):

@article{JMLR:v21:18-370,
  author  = {Giannis Siglidis and Giannis Nikolentzos and Stratis Limnios and Christos Giatsidis and Konstantinos Skianis and Michalis Vazirgiannis},
  title   = {GraKeL: A Graph Kernel Library in Python},
  journal = {Journal of Machine Learning Research},
  year    = {2020},
  volume  = {21},
  number  = {54},
  pages   = {1-5}
}

License

GraKeL is distributed under the BSD 3-clause license. The library makes use of the C++ source code of BLISS (a tool for computing automorphism groups and canonical labelings of graphs) which is LGPL licensed. Futhermore, the cvxopt package (a software package for convex optimization) which is an optional dependency of GraKeL is GPL licensed.

Acknowledgements

We would like to thank @SneachChea for a round of tooling, CI, and docs modernization.

We would like to thank @eddiebergman for modernizing our CI and extending our python support.


Note

GraKeL needs your support! Keeping a graph kernel library working takes ongoing maintenance — updates for newer Python/numpy, CI upkeep, etc. Feel free to help out by opening a pull request or raising an issue, or reach out via the contact info on ysig.github.io if you'd like to help maintain GraKeL more closely — happy to gradually bring you on board. Thank you! 💕

Releases

Packages

Used by

Contributors

Languages