.. microDL documentation master file, created by
   sphinx-quickstart on Tue Dec 13 10:33:59 2022.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to microDL's documentation!
===================================

.. toctree::
   :maxdepth: 2
   :caption: Introduction:

microDL is a deep learning framework for processing microscopy data.
The framework consists of:

* Preprocessing: Flatfield correction, mask creation and normalization.
* Training: Building and training 2.5D or 2D U-Net models for regression or segmentation.
* Inference: Use your trained model to predict full size images.

These pages offers in depth descriptions of the functions and classes of microDL and is mainly
intended for developers,
and users who would like to understand the details.
If you're a user and are mainly interested in understanding how to run microDL,
please see the `GitHub repository <https://github.com/mehta-lab/microDL>`_ and the readme markdown files within it.


.. toctree::
   :maxdepth: 2
   :caption: Contents:

   modules


Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`