Welcome to PlanetAlign's documentation!
======================================

**PlanetAlign** is a Python library for network alignment (NA) tasks built upon `PyTorch <https://pytorch.org>`_ and `PyTorch Geometric <https://pytorch-geometric.readthedocs.io/en/latest/>`_. **PlanetAlign** includes
18 built-in datasets for NA tasks across 6 different domains, as well as 14 existing NA algorithms.

..
    Check out the :doc:`usage` section for further information, including
    how to :ref:`installation` the project.

.. note::

   This project is under active development.

.. toctree::
    :maxdepth: 1
    :caption: Getting Started

    get_started/na_intro
    get_started/example

.. toctree::
    :maxdepth: 1
    :caption: Tutorials

    tutorials/datasets
    tutorials/algorithms
    tutorials/effectiveness
    tutorials/scalability
    tutorials/robustness

.. toctree::
   :maxdepth: 1
   :caption: Package Reference

   modules/data
   modules/datasets
   modules/algorithms
   modules/metrics
   modules/logger
   modules/utils