prototorch_models/docs/source/index.rst
Alexander Engelsberger 7b4f7d84e0 Update Documentation
Clean up project
2021-05-21 15:42:45 +02:00

40 lines
1017 B
ReStructuredText

.. ProtoTorch Models documentation master file
ProtoTorch Models Plugins
========================================
.. toctree::
:hidden:
:maxdepth: 3
self
tutorial.ipynb
.. toctree::
:hidden:
:maxdepth: 3
:caption: Library
library
.. toctree::
:hidden:
:maxdepth: 3
:caption: Customize
custom
About
-----------------------------------------
`Prototorch Models <https://github.com/si-cim/prototorch_models>`_ is a Plugin
for `Prototorch <https://github.com/si-cim/prototorch>`_. It implements common
prototype-based Machine Learning algorithms using `PyTorch-Lightning
<https://www.pytorchlightning.ai/>`_.
Library
-----------------------------------------
Prototorch Models delivers many application ready models.
These models have been published in the past and have been adapted to the Prototorch library.
Customizable
-----------------------------------------
Prototorch Models also contains the building blocks to build own models with PyTorch-Lightning and Prototorch.