Skip to content

Latest commit

 

History

History
163 lines (104 loc) · 4.05 KB

api.rst

File metadata and controls

163 lines (104 loc) · 4.05 KB
Raw

API Reference

:mod:`nondefaced_detector.models`: Model functions

.. autosummary:: nondefaced_detector.models
   :toctree: generated/
   :template: function.rst

   nondefaced_detector.models.model.ConvBNrelu
   nondefaced_detector.models.model.TruncatedSubmodel
   nondefaced_detector.models.model.ClassifierHead
   nondefaced_detector.models.model.Submodel
   nondefaced_detector.models.model.CombinedClassifier


.. currentmodule:: nondefaced_detector

:mod:`nondefaced_detector.dataloaders`: Dataset functions

.. automodule:: nondefaced_detector.dataloaders
   :no-members:
   :no-inherited-members:


.. autosummary:: nondefaced_detector.dataloaders
   :toctree: generated/

   nondefaced_detector.dataloaders.dataset.get_dataset


.. currentmodule:: nondefaced_detector

:mod:`nondefaced_detector.preprocess`: Preprocess input volumes

.. automodule:: nondefaced_detector.preprocess
   :no-members:
   :no-inherited-members:


.. autosummary:: nondefaced_detector.preprocess
   :toctree: generated/

   nondefaced_detector.preprocess.preprocess
   nondefaced_detector.preprocess.preprocess_parallel


.. currentmodule:: nondefaced_detector

:mod:`nondefaced_detector.preprocessing`: Helper functions for the preprocess module

.. automodule:: nondefaced_detector.preprocessing
   :no-members:
   :no-inherited-members:


.. autosummary:: nondefaced_detector.preprocessing
   :toctree: generated/

   nondefaced_detector.preprocessing.conform.conform_data
   nondefaced_detector.preprocessing.normalization.clip
   nondefaced_detector.preprocessing.normalization.standardize
   nondefaced_detector.preprocessing.normalization.normalize


.. currentmodule:: nondefaced_detector

:mod:`nondefaced_detector.training`: Training

.. automodule:: nondefaced_detector.training
   :no-members:
   :no-inherited-members:


.. autosummary:: nondefaced_detector.training
   :toctree: generated/

   nondefaced_detector.training.training.train


.. currentmodule:: nondefaced_detector

:mod:`nondefaced_detector.prediction`: Making predictions

.. automodule:: nondefaced_detector.prediction
   :no-members:
   :no-inherited-members:


.. autosummary:: nondefaced_detector.prediction
   :toctree: generated/

   nondefaced_detector.prediction.predict
   nondefaced_detector.prediction._structural_slice
   nondefaced_detector.prediction._get_model


.. currentmodule:: nondefaced_detector

:mod:`nondefaced_detector.inference`: Inference

.. automodule:: nondefaced_detector.inference
   :no-members:
   :no-inherited-members:


.. autosummary:: nondefaced_detector.inference
   :toctree: generated/

   nondefaced_detector.inference.inference


.. currentmodule:: nondefaced_detector

:mod:`nondefaced_detector.helpers`: Helper functions

.. automodule:: nondefaced_detector.helpers
   :no-members:
   :no-inherited-members:


.. autosummary:: nondefaced_detector.helpers
   :toctree: generated/

   nondefaced_detector.helpers.utils.is_gz_file
   nondefaced_detector.helpers.utils.save_vol
   nondefaced_detector.helpers.utils.load_vol
   nondefaced_detector.helpers.utils.imshow


.. currentmodule:: nondefaced_detector

:mod:`nondefaced_detector.utils`: Utility functions

.. automodule:: nondefaced_detector.utils
   :no-members:
   :no-inherited-members:


.. autosummary:: nondefaced_detector.utils
   :toctree: generated/

   nondefaced_detector.utils.get_datalad


.. currentmodule:: nondefaced_detector