Get started

This page discusses the prerequisites and outlines the installation procedure.

Requirements

This package is developed and tested on a Python 3.9.x version but any higher version should also work without any problems. The package requires installations of the following packages:

• (numpy)

• (networkx)

• pytorch

• pytorch_geometric

• plotly

Note

Both numpy and networkx are dependencies of pytorch and pytorch_geometric and will be automatically installed during the installation of these packages.

The packages should be installed in the order they are listed. Make sure to use a pytorch version that is supported by pytorch_geometric. You can check the supported versions here.

Tip

When installing pytorch and pytorch_geometric for GPU use, pay attention to the versions as some GPUs are only supported by specific versions.

Installation

Use pip to install the package directly from its GitHub repository

$ pip install git+https://github.com/hkneiding/HyDGL

which installs HyDGL as a library to your python installation or virtual environment.

Check that the installation was successful by running Python and importing the package:

>>> import HyDGL

Note

A way to pip install via PyPI will become available soon.