api.rst

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

.. _mednet.classify.api:

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

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


Core Components
---------------

This part of mednet contains methods and scripts that can be reused by more
specialized libraries.

.. _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.classify.data.typing
   mednet.segment.data.typing


.. _mednet.api.engines:

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

Functions that operate on data.

.. autosummary::
   :toctree: api/engines

   mednet.engine.callbacks
   mednet.engine.device
   mednet.engine.loggers
   mednet.engine.trainer
   mednet.engine.uploader
   mednet.classify.engine.evaluator
   mednet.classify.engine.predictor
   mednet.classify.engine.saliency.completeness
   mednet.classify.engine.saliency.generator
   mednet.classify.engine.saliency.interpretability
   mednet.classify.engine.saliency.viewer
   mednet.classify.engine.saliency.utils
   mednet.segment.engine.dumper
   mednet.segment.engine.evaluator
   mednet.segment.engine.predictor
   mednet.segment.engine.viewer


.. _mednet.api.models.support:

Modelling Suppoort
^^^^^^^^^^^^^^^^^^

Model definitions and utilities.

.. autosummary::
   :toctree: api/models/support

   mednet.models.loss_weights
   mednet.models.transforms
   mednet.models.typing
   mednet.models.model


.. _mednet.api.utils:

Utils
^^^^^

Reusable auxiliary functions.

.. autosummary::
   :toctree: api/utils

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


.. _mednet.api.classify.models:

Classification models
---------------------

Library for training models on classification tasks.


.. _mednet.api.classify.models.support:

Modelling Support
^^^^^^^^^^^^^^^^^

Classification model definitions and utilities.

.. autosummary::
   :toctree: api/classify/models/support

   mednet.classify.models.classification_model
   mednet.classify.models.loss_weights
   mednet.classify.models.normalizer
   mednet.classify.models.typing


.. _mednet.api.classify.models.available:

Available Models
^^^^^^^^^^^^^^^^

Available classification models.

.. autosummary::
   :toctree: api/classify/models/available

   mednet.classify.models.alexnet
   mednet.classify.models.densenet
   mednet.classify.models.pasa
   mednet.classify.models.logistic_regression
   mednet.classify.models.mlp



.. _mednet.api.segment.models:

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

Library for training models on semantic segmentation tasks.


.. _mednet.api.segment.models.support:

Modelling Support
^^^^^^^^^^^^^^^^^

Semantic segmentation model definitions and utilities.

.. autosummary::
   :toctree: api/segment/models/support

   mednet.segment.models.segmentation_model
   mednet.segment.models.normalizer
   mednet.segment.models.make_layers
   mednet.segment.models.losses


.. _mednet.api.segment.models.available:

Available Models
^^^^^^^^^^^^^^^^

Available semantic segmentation models.

.. autosummary::
   :toctree: api/segment/models/available

   mednet.segment.models.driu_bn
   mednet.segment.models.driu_od
   mednet.segment.models.driu_pix
   mednet.segment.models.driu
   mednet.segment.models.hed
   mednet.segment.models.lwnet
   mednet.segment.models.m2unet
   mednet.segment.models.unet


.. include:: links.rst