.. Open-ReID documentation master file, created by
   sphinx-quickstart on Sun Mar 19 15:49:51 2017.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Open-ReID documentation
=======================

Open-ReID is a deep learning library for person re-identification based on PyTorch.

.. toctree::
   :glob:
   :maxdepth: 1
   :caption: Notes

   notes/overview
   notes/data_modules
   notes/evaluation_metrics

.. toctree::
   :glob:
   :maxdepth: 1
   :caption: Examples

   examples/training_id
   examples/benchmarks

.. toctree::
   :maxdepth: 1
   :caption: SDK Level Reference

   trainers
   evaluators
   dist_metric

.. toctree::
   :maxdepth: 1
   :caption: API Level Reference

   datasets
   models

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

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