API Reference
=============

Here, you can find documentation pages for the individual transformations.

| All preprocessing and augmentation transformations are implemented in the `Augmentation Module`.
| The `Conversion Module` implements transformations that ensure data format checks and conversion and are internally used within the :class:`Compose` class.
| The :class:`Compose` class itself and all base abstract transformations are implemented in the `Core Module`.

.. toctree::
   :maxdepth: 2

   src.bio_volumentations.augmentations

.. toctree::
   :maxdepth: 2

   src.bio_volumentations.conversion

.. toctree::
   :maxdepth: 3

   src.bio_volumentations.core


Runtime
*******

The execution times of individual transformations from our library
and their comparison to other libraries capable of processing volumetric image data
are available `at the project's GitLab page <https://gitlab.fi.muni.cz/cbia/bio-volumentations/-/blob/1.3.3/README.md?ref_type=tags#runtime>`_.