.. mdinclude:: ../README.md

Contents of Official Documentation
------------------------------------

.. toctree::
   :maxdepth: 2
   :caption: User Guide

   guide/introduction
   guide/installation
   guide/experiment
   guide/models

.. toctree::
   :maxdepth: 2
   :caption: API Reference

   api/_autosummary/src.backbone
   api/_autosummary/src.build_graphs
   api/_autosummary/src.factorize_graph_matching
   api/_autosummary/src.displacement_layer
   api/_autosummary/src.evaluation_metric
   api/_autosummary/src.gconv
   api/_autosummary/src.loss_func
   api/_autosummary/src.spectral_clustering
   api/_autosummary/src.lap_solvers