.. _api:

API documentation
=================

This section documents the public API of Congrads.

Callbacks
---------

.. automodule:: congrads.callbacks.base
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: congrads.callbacks.registry
   :members:
   :undoc-members:
   :show-inheritance:

Checkpoints
-----------

.. automodule:: congrads.checkpoints
   :members:
   :undoc-members:
   :show-inheritance:

Constraints
-----------

.. automodule:: congrads.constraints.registry
   :members:
   :undoc-members:
   :show-inheritance:

Core
----

.. automodule:: congrads.core.batch_runner
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: congrads.core.congradscore
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: congrads.core.constraint_engine
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: congrads.core.epoch_runner
   :members:
   :undoc-members:
   :show-inheritance:

Datasets
--------

.. automodule:: congrads.datasets.registry
   :members:
   :undoc-members:
   :show-inheritance:

Descriptor
----------

.. automodule:: congrads.descriptor
   :members:
   :undoc-members:
   :show-inheritance:

Metrics
-------

.. automodule:: congrads.metrics
   :members:
   :undoc-members:
   :show-inheritance:

Networks
--------

.. automodule:: congrads.networks.registry
   :members:
   :undoc-members:
   :show-inheritance:

Transformations
---------------

.. automodule:: congrads.transformations.base
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: congrads.transformations.registry
   :members:
   :undoc-members:
   :show-inheritance:

Utils
---------------

.. automodule:: congrads.utils.preprocessors
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: congrads.utils.utility
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: congrads.utils.validation
   :members:
   :undoc-members:
   :show-inheritance: