Skip to content
Snippets Groups Projects
api.rst 2.15 KiB
Newer Older
André Anjos's avatar
André Anjos committed
.. 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.sample
   ptbench.data.dataset
   ptbench.data.utils
   ptbench.data.loader
   ptbench.data.transforms
   ptbench.configs.datasets


.. _ptbench.api.data.raw:

Raw Dataset Access
------------------

Direct data-access through iterators.

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

   ptbench.data.hivtb_RS
   ptbench.data.tbpoc
   ptbench.data.montgomery_RS
   ptbench.data.padchest
   ptbench.data.hivtb
   ptbench.data.indian_RS
   ptbench.data.shenzhen_RS
   ptbench.data.tbpoc_RS
   ptbench.data.shenzhen
   ptbench.data.montgomery
   ptbench.data.indian
   ptbench.data.nih_cxr14_re
   ptbench.data.padchest_RS
   ptbench.data.tbx11k_simplified
   ptbench.data.tbx11k_simplified_RS
   ptbench.data.tbx11k_simplified_v2
   ptbench.data.tbx11k_simplified_v2_RS


.. _ptbench.api.models:

Models
------

CNN and other models implemented.

.. autosummary::
   :toctree: api/models

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


.. _ptbench.api.engines:

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

Functions to actuate on the data.

.. autosummary::
   :toctree: api/engine

   ptbench.engine.trainer
   ptbench.engine.predictor
   ptbench.engine.evaluator


.. _ptbench.api.utils:

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

Reusable auxiliary functions.

André Anjos's avatar
André Anjos committed
.. autosummary::
   :toctree: api/utils
André Anjos's avatar
André Anjos committed

   ptbench.utils.checkpointer
   ptbench.utils.download
   ptbench.utils.grad_cams
   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
André Anjos's avatar
André Anjos committed


.. include:: links.rst