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

.. _ptbench.api:

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

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


.. _ptbench.api.data:

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

Auxiliary classes and methods to define raw dataset iterators.

.. autosummary::
   :toctree: api/data

   ptbench.data.augmentations
   ptbench.data.datamodule
   ptbench.data.image_utils
   ptbench.data.split
   ptbench.data.typing

.. _ptbench.api.rawdata:

Basic Datamodules
-----------------

Pytorch_ :py:class:`torch.utils.data.DataLoader` access through lightning_
:py:class:`lightning.pytorch.core.LightningDataModule`.

.. autosummary::
   :toctree: api/data/raw

   ptbench.data.hivtb.datamodule
   ptbench.data.indian.datamodule
   ptbench.data.montgomery.datamodule
   ptbench.data.nih_cxr14.datamodule
   ptbench.data.padchest.datamodule
   ptbench.data.shenzhen.datamodule
   ptbench.data.tbpoc.datamodule
   ptbench.data.tbx11k.datamodule


.. _ptbench.api.remixdata:

Remixed Datamodules
-------------------

Pytorch_ :py:class:`torch.utils.data.DataLoader` access through lightning_
:py:class:`lightning.pytorch.core.LightningDataModule`.

.. autosummary::
   :toctree: api/data/raw

   ptbench.data.montgomery_shenzhen.datamodule
   ptbench.data.montgomery_shenzhen_indian.datamodule
   ptbench.data.montgomery_shenzhen_indian_tbx11k.datamodule
   ptbench.data.montgomery_shenzhen_indian_padchest.datamodule
   ptbench.data.nih_cxr14_padchest.datamodule


.. _ptbench.api.models:

Models
------

CNN and other models implemented.

.. autosummary::
   :toctree: api/models

   ptbench.models.pasa
   ptbench.models.alexnet
   ptbench.models.densenet
   ptbench.models.normalizer
   ptbench.models.logistic_regression
   ptbench.models.signs_to_tb


.. _ptbench.api.engines:

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

Functions to actuate on the data.

.. autosummary::
   :toctree: api/engine

   ptbench.engine.device
   ptbench.engine.callbacks
   ptbench.engine.trainer
   ptbench.engine.predictor
   ptbench.engine.evaluator



.. _ptbench.api.utils:

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

Reusable auxiliary functions.

.. autosummary::
   :toctree: api/utils

   ptbench.utils.checkpointer
   ptbench.utils.download
   ptbench.utils.grad_cams
   ptbench.utils.image
   ptbench.utils.measure
   ptbench.utils.model_serialization
   ptbench.utils.model_zoo
   ptbench.utils.plot
   ptbench.utils.rc
   ptbench.utils.resources
   ptbench.utils.summary
   ptbench.utils.table
   ptbench.utils.tensorboard


.. include:: links.rst