.. _getting-started:

===============
Getting Started
===============


Django River ML provides a means to deploy `river <https://riverml.xyz>`_ online machine learning models.
It is a Django version of `chantilly <https://github.com/online-ml/chantilly>`_ that aims to use the
same overall design. We also include `example clients <https://github.com/vsoch/django-river-ml/tree/main/examples>`_ and a
test application in `tests <https://github.com/vsoch/django-river-ml/tree/main/tests>`_.

If you have any questions or issues, please `let us know <https://github.com/vsoch/django-river-ml/issues>`_

.. toctree::
   :maxdepth: 3

   installation
   user-guide