api.rst

.. 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.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.mlp
   ptbench.models.typing


.. _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.rc
   ptbench.utils.resources
   ptbench.utils.summary
   ptbench.utils.tensorboard


.. include:: links.rst