=================
Altametris - unet
=================

Welcome to unet's documentation
===============================

.. note::
   For a complete documentation, please visit the repository `unet <https://dev.azure.com/altametris/DEV-IA/_git/unet>`_.

   Owner `altametris`_.


Project Description
-------------------

This python package is the implementation of the neural network `U-Net` used for semantic segmentation on images.
It is implemented in ``PyTorch`` and can easily be used in your experiments.


Steps
-----
1. Install the package following the :doc:`installation`
2. Learn how to use it following the :doc:`usage`


Contents
--------

.. toctree::
   :maxdepth: 1

   installation
   usage
   readme

Contributors
------------

* souheil.maatoug@altametris.com


.. include:: readme.rst


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

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

.. _altametris: https://www.altametris.com/en/