.. 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 RIME!
================================

The Robust Intelligence Model Engine (RIME) enables comprehensive testing of data and 
model performance at the pre-development and post-development stages of the model life 
cycle.

RIME documentation covers several broad topic areas. If you're new to RIME or
want to familiarize yourself with core concepts of machine learning, **RIME at a Glance**
provides an overview.

The most recent version of this documentation is always available `here <https://docs.rime.dev/en/latest/>`_.

.. toctree::
   :maxdepth: 1
   :caption: RIME at a Glance

   /getstarted/product-overview.md
   /getstarted/workspace-overview.md
   /getstarted/modeltesting.rst

To find information on how to achieve day-to-day data science tasks with RIME, look in 
the **Testing and monitoring models with RIME** section, which discusses actively using RIME to evaluate
datasets and models. Configuring alerts, setting up integrations, and running tests on
uploaded models are all discussed here.

.. toctree::
   :maxdepth: 2
   :caption: Testing and monitoring models with RIME

   /for_data_scientists/get_started.rst
   /for_data_scientists/basic_tasks.rst
   /for_data_scientists/adv_tasks.rst
   /for_data_scientists/reference.rst

.. Material here: Python SDK, working with models, st, ct, integrations, alerts, monitors

.. 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

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

.. toctree::
   :maxdepth: 2
   :caption: Administering RIME

   /for_admins/userauthnz.rst
   /for_admins/naviconf.rst
   /for_admins/fixtrouble.rst

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

.. toctree::
   :maxdepth: 2
   :caption: Installing RIME

   /installation/index.rst
   /installation/cloudinst.rst
   /installation/mcloudinst.rst
   /installation/shostedinst.rst

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

.. toctree::
   :maxdepth: 2
   :caption: SDK reference

   /python_library/python-sdk.rst