.. RIME documentation master file, created by
   sphinx-quickstart on Tue Feb  9 10:18:49 2021.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to the RI Platform!
================================

The Robust Intelligence (RI) Platform enables comprehensive testing of data and model performance at the pre-development and post-development stages of the model life cycle. Users
already familiar with the RI Platform who want to know what's new in the most recent release can find details in the **Release Notes**.

.. toctree::
   :maxdepth: 1

   /changelogs.rst

The RI Platform documentation covers several broad topic areas. If you're new to the RI Platform or want to familiarize yourself with core concepts of 
machine learning, **Getting Started** provides an overview, as well as a comprehensive walkthrough of a local trial of the RI Platform.

.. toctree ::
   :maxdepth: 2
   :caption: Getting Started

   /getstarted/index.rst

The **Administering the RI Platform** section discusses tasks related to the maintenance and administration of an RI Platform instance, including user account management,
role assignments, authentication systems, and API access.

.. toctree::
   :maxdepth: 2
   :caption: Administering the RI Platform

   /for_admins/index.rst

RI Platform instances are available as cloud installations, either fully managed by Robust Intelligence or directly managed by you. The RI Platform can also be installed
as a stand-alone, self-hosted application. The installation process is discussed in **Installing the RI Platform**.

.. toctree::
   :maxdepth: 2
   :caption: Installing the RI Platform

   /installation/index.rst

The **Data science with the RI Platform** section discusses actively using the RI Platform to evaluate data sets and models. Configuring alerts, setting up integrations,
and running tests on uploaded models are all discussed here.

.. toctree::
   :maxdepth: 2
   :caption: Data science with the RI Platform

   /for_data_scientists/get_started.rst
   /for_data_scientists/how_to_guides.rst
   /for_data_scientists/reference.rst

.. TODO actually make the security section
   The **RIME Security** section discusses RIME's approach to authentication, authorization, encryption, and audit functionality.

   .. toctree::
      :maxdepth: 1
      :caption: Security

      /security/index.rst

The **Reference** section contains in-depth details about the Python SDK, including detailed JSON templates to configure 
stress testing for the RI Platform.

.. toctree::
   :maxdepth: 2
   :caption: Reference

   /reference/index.rst

.. TODO fold in rime API once it's not one giant page
   /reference/rimeapi.md