How-To Guides
================================

These walkthroughs illustrate how to test your ML models across different modalities: Tabular, Natural Language Processing (NLP), and Computer Vision (CV). Each walkthrough provides steps to run the examples using the bundled sample data in ``rime_trial/`` or your own models and data.

These guides will make use of the ``rime-engine`` CLI, which is accessible through the Python package.

Be sure to complete `Installation <get_started/installation.html>`__ before proceeding!

Tabular
---------------------------------------

For ML tasks like **Binary Classification**, **Multi-Class Classification**, **Regression**, and **Ranking**.

Follow these comprehensive guides for walkthroughs of core RI features:

.. toctree::
   :maxdepth: 1

   /local_trial/how_to_guides/rime_ai_stress_testing.md
   /local_trial/how_to_guides/rime_firewall_realtime.md
   /local_trial/how_to_guides/rime_ai_firewall_continuous_tests.md

Familiar with RI and know what you need? See the references below:

- `Input Data Format <../for_data_scientists/reference/tabular/task_data_format.html>`__
- `Specify a Model <../for_data_scientists/reference/tabular/specify_model.html>`__
- `Tabular Configuration <../for_data_scientists/reference/tabular.html>`__
- `Download AI Stress Test Results <how_to_guides/download_stress_test_results.html>`__

NLP
---------------------------------------

For ML tasks like **Text Classification** and **Named Entity Recognition**.

Follow these comprehensive guides for walkthroughs of core RI features:

.. toctree::
   :maxdepth: 1

   /local_trial/how_to_guides/rime_ai_stress_testing_nlp.md
   /local_trial/how_to_guides/rime_firewall_realtime_nlp.md
   /local_trial/how_to_guides/rime_ai_firewall_continuous_tests_nlp.md

Familiar with RI and know what you need? See the references below:

- `Input Data Format <../for_data_scientists/reference/nlp/task_data_format.html>`__
- `Specify a Model <../for_data_scientists/reference/nlp/specify_model_nlp.html>`__
- `NLP Configuration <../for_data_scientists/reference/nlp.html>`__
- `Download AI Stress Test Results <how_to_guides/download_stress_test_results.html>`__

CV
---------------------------------------

For ML tasks like **Image Classification** and **Object Detection**.

Follow these comprehensive guides for walkthroughs of core RI features:

.. toctree::
   :maxdepth: 1

   /local_trial/how_to_guides/rime_ai_stress_testing_cv.md
   /local_trial/how_to_guides/rime_firewall_realtime_cv.md
   /local_trial/how_to_guides/rime_ai_firewall_continuous_tests_cv.md

Familiar with RI and know what you need? See the references below:

- `Input Data Format <../for_data_scientists/reference/cv/task_data_format.html>`__
- `Specify a Model <../for_data_scientists/reference/cv/specify_model_cv.html>`__
- `Specify an Image Loading Function <../for_data_scientists/reference/cv/specify_image_loading.html>`__
- `CV Configuration <../for_data_scientists/reference/cv.html>`__
- `Download AI Stress Test Results <how_to_guides/download_stress_test_results.html>`__

Troubleshooting
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Stuck? Check out our troubleshooting guides below.

.. toctree::
   :maxdepth: 1

   /local_trial/how_to_guides/troubleshooting/installation.md
   /local_trial/how_to_guides/troubleshooting/python_package.md