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

.. _mednet.libs.classification.api:

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

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


Common library
--------------

This common library contains methods and scripts that can be reused by more specialized libraries.

.. _mednet.libs.common.api.data:

Data Methods
^^^^^^^^^^^^

Auxiliary classes and methods to define raw dataset iterators.

.. autosummary::
   :toctree: api/data

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


.. _mednet.libs.common.api.engines:

Command engines
^^^^^^^^^^^^^^^

Functions to actuate on the data.

.. autosummary::
   :toctree: api/engine

   mednet.libs.common.engine.callbacks
   mednet.libs.common.engine.device
   mednet.libs.common.engine.loggers
   mednet.libs.common.engine.trainer


.. _mednet.libs.common.api.models:

Models
^^^^^^

Common model utilities.

.. autosummary::
   :toctree: api/models

   mednet.libs.common.models.loss_weights
   mednet.libs.common.models.model
   mednet.libs.common.models.transforms
   mednet.libs.common.models.typing


.. _mednet.libs.common.api.utils:

Utils
^^^^^

Reusable auxiliary functions.

.. autosummary::
   :toctree: api/utils

   mednet.libs.common.utils.checkpointer
   mednet.libs.common.utils.gitlab
   mednet.libs.common.utils.rc
   mednet.libs.common.utils.resources
   mednet.libs.common.utils.summary
   mednet.libs.common.utils.tensorboard


Classification library
----------------------

Library for training models on classification tasks


.. _mednet.libs.classification.api.data:

Data
^^^^

Classification-specific data methods

.. autosummary::
   :toctree: api/data

   mednet.libs.classification.data.typing


.. _mednet.libs.classification.api.engines:

Command engines
^^^^^^^^^^^^^^^

Functions to actuate on the data.

.. autosummary::
   :toctree: api/engine

   mednet.libs.classification.engine.evaluator
   mednet.libs.classification.engine.predictor


.. _mednet.libs.classification.api.models:

Models
^^^^^^

CNN and other models implemented.

.. autosummary::
   :toctree: api/models

   mednet.libs.classification.models.pasa
   mednet.libs.classification.models.alexnet
   mednet.libs.classification.models.classification_model
   mednet.libs.classification.models.densenet
   mednet.libs.classification.models.loss_weights
   mednet.libs.classification.models.logistic_regression
   mednet.libs.classification.models.mlp
   mednet.libs.classification.models.normalizer
   mednet.libs.classification.models.typing


.. _mednet.libs.classification.api.saliency:

Saliency Map Generation and Analysis
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Engines to generate and analyze saliency mapping techniques.

.. autosummary::
   :toctree: api/saliency

   mednet.libs.classification.engine.saliency.completeness
   mednet.libs.classification.engine.saliency.evaluator
   mednet.libs.classification.engine.saliency.generator
   mednet.libs.classification.engine.saliency.interpretability
   mednet.libs.classification.engine.saliency.viewer


.. _mednet.libs.classification.api.utils:

Utils
^^^^^

Classification-specific utilities.

.. autosummary::
   :toctree: api/utils

   mednet.libs.common.utils.rc


Segmentation library
--------------------

Library for training models on segmentation tasks


.. _mednet.libs.segmentation.api.data:

Data
^^^^

Segmentation-specific data methods

.. autosummary::
   :toctree: api/data

   mednet.libs.segmentation.data.typing


.. _mednet.libs.segmentation.api.engines:

Command engines
^^^^^^^^^^^^^^^

Functions to actuate on the data.

.. autosummary::
   :toctree: api/engine

   mednet.libs.segmentation.engine.evaluator


.. _mednet.libs.segmentation.api.models:

Models
^^^^^^

CNN and other models implemented.

.. autosummary::
   :toctree: api/models

   mednet.libs.segmentation.models.driu_bn
   mednet.libs.segmentation.models.driu_od
   mednet.libs.segmentation.models.driu_pix
   mednet.libs.segmentation.models.driu
   mednet.libs.segmentation.models.hed
   mednet.libs.segmentation.models.losses
   mednet.libs.segmentation.models.lwnet
   mednet.libs.segmentation.models.m2unet
   mednet.libs.segmentation.models.normalizer
   mednet.libs.segmentation.models.segmentation_model
   mednet.libs.segmentation.models.unet


.. include:: links.rst