MLCompare Documentation
=======================

:mod:`MLCompare` is a Python package for running model comparison pipelines, with the aim of being both 
simple and flexible. It supports multiple popular ML libraries, retrieval from multiple online dataset 
repositories, common data processing steps, and results visualization. Additionally, it allows for using 
your own models and datasets within the pipelines.

.. grid:: 1 2 2 2
   :gutter: 4
   :padding: 2 2 0 0
   :class-container: sd-text-center

   .. grid-item-card::  User guide
      :img-top: assets/user-guide-icon.svg
      :class-card: intro-card
      :shadow: md

      The user guide provides information for getting started with MLCompare as well as important
      details for using the library.

      +++

      .. button-ref:: user_guide
         :ref-type: ref
         :click-parent:
         :color: secondary
         :expand:

         see the User Guide

   .. grid-item-card::  API reference
      :img-top: assets/api-reference-icon.svg
      :class-card: intro-card
      :shadow: md

      The API Reference contains a detailed description of the MLCompare API and source code. 
      It assumes familiarity with the library from the User Guide.

      +++

      .. button-ref:: api_reference
         :ref-type: ref
         :click-parent:
         :color: secondary
         :expand:

         see the API Reference

   .. grid-item-card::  Release Notes
      :img-top: assets/release-notes-icon.svg
      :class-card: intro-card
      :shadow: md

      The release notes provide a summary of changes between each version of MLCompare.

      +++

      .. button-ref:: release_notes
         :ref-type: ref
         :click-parent:
         :color: secondary
         :expand:

         see the Release Notes


.. toctree::
   :maxdepth: 3
   :hidden:
   :titlesonly:

   user_guide/index
   api_reference/index
   release_notes/index