.. _manual-main:

================
River API Client
================

.. image:: https://img.shields.io/github/stars/vsoch/riverapi?style=social
    :alt: GitHub stars
    :target: https://github.com/vsoch/riverapi/stargazers


This is a small client to help you interact with an online machine learning server with River
such as `django-river-ml <https://github.com/vsoch/django-river-ml/>`_.

.. _main-getting-started:

------------------------------
Getting started with River API
------------------------------

This is an API intended to interact with a `river <https://riverml.xyz>`_ online machine learning server. 
The client uses the river API spec :ref:`spec` that is defined alongside the implementation here.

.. _main-support:

-------
Support
-------

* For **bugs and feature requests**, please use the `issue tracker <https://github.com/vsoch/riverapi/issues>`_.
* For **contributions**, visit us on `Github <https://github.com/vsoch/riverapi>`_.

---------
Resources
---------

`GitHub Repository <https://github.com/vsoch/django-river-ml>`_
    The code on GitHub.


.. toctree::
   :caption: Getting started
   :name: getting_started
   :hidden:
   :maxdepth: 3

   getting_started/index
   getting_started/user-guide
   getting_started/spec

.. toctree::
    :caption: API Reference
    :name: api-reference
    :hidden:
    :maxdepth: 1

    api_reference/riverapi
    api_reference/internal/modules