api.rst

.. SPDX-FileCopyrightText: Copyright © 2023 Idiap Research Institute <contact@idiap.ch>
..
.. SPDX-License-Identifier: GPL-3.0-or-later

.. _mednet.api:

============
 Python API
============

This section includes information for using the Python API of
``mednet``.


.. _mednet.api.data:

Data Methods
------------

Auxiliary classes and methods to define raw dataset iterators.

.. autosummary::
   :toctree: api/data

   mednet.data.augmentations
   mednet.data.datamodule
   mednet.data.image_utils
   mednet.data.split
   mednet.data.typing


.. _mednet.api.models:

Models
------

CNN and other models implemented.

.. autosummary::
   :toctree: api/models

   mednet.models.pasa
   mednet.models.alexnet
   mednet.models.densenet
   mednet.models.normalizer
   mednet.models.logistic_regression
   mednet.models.mlp
   mednet.models.typing


.. _mednet.api.engines:

Command engines
---------------

Functions to actuate on the data.

.. autosummary::
   :toctree: api/engine

   mednet.engine.device
   mednet.engine.callbacks
   mednet.engine.trainer
   mednet.engine.predictor
   mednet.engine.evaluator


.. _mednet.api.saliency:

Saliency Map Generation and Analysis
------------------------------------

Engines to generate and analyze saliency mapping techniques.

.. autosummary::
   :toctree: api/saliency

   mednet.engine.saliency.generator
   mednet.engine.saliency.completeness
   mednet.engine.saliency.interpretability


.. _mednet.api.utils:

Various utilities
-----------------

Reusable auxiliary functions.

.. autosummary::
   :toctree: api/utils

   mednet.utils.checkpointer
   mednet.utils.rc
   mednet.utils.resources
   mednet.utils.summary
   mednet.utils.tensorboard


.. include:: links.rst