API Reference
=============

.. automodule:: graph_explain
   :members:
   :no-index:

Core
----

.. automodule:: graph_explain.core.explainer
   :members:
   :undoc-members:

.. automodule:: graph_explain.core.explanation
   :members:
   :undoc-members:

.. automodule:: graph_explain.core.registry
   :members:
   :undoc-members:

Metrics
-------

.. automodule:: graph_explain.core.evaluation
   :members:
   :undoc-members:

Comparative benchmark
---------------------

.. automodule:: graph_explain.core.benchmark
   :members:
   :undoc-members:

Backends
--------

.. automodule:: graph_explain.backends.base
   :members:
   :undoc-members:

Methods
-------

.. automodule:: graph_explain.methods.perturbation.gnn_explainer
   :members:

.. automodule:: graph_explain.methods.perturbation.pg_explainer
   :members:

.. automodule:: graph_explain.methods.perturbation.subgraphx
   :members:

.. automodule:: graph_explain.methods.perturbation.node_mask
   :members:

.. automodule:: graph_explain.methods.gradient.saliency
   :members:

.. automodule:: graph_explain.methods.gradient.integrated_gradients
   :members:

.. automodule:: graph_explain.methods.gradient.grad_x_input
   :members:

.. automodule:: graph_explain.methods.gradient.guided_backprop
   :members:

.. automodule:: graph_explain.methods.relevance.gnn_lrp
   :members:

.. automodule:: graph_explain.methods.relevance.deeplift
   :members:

.. automodule:: graph_explain.methods.attention.attention
   :members:

.. automodule:: graph_explain.methods.feature.graph_lime
   :members:

.. automodule:: graph_explain.methods.baseline.random_baseline
   :members:

Synthetic benchmarks
--------------------

.. automodule:: graph_explain.benchmarks.synthetic
   :members:
   :undoc-members:

Narration
---------

.. automodule:: graph_explain.narration
   :members:
   :undoc-members:

Visualization
-------------

.. automodule:: graph_explain.visualization
   :members:
   :undoc-members:

CLI
---

.. automodule:: graph_explain.cli
   :members:
   :undoc-members: