.. Brisk documentation master file, created by
   sphinx-quickstart on Sat Dec  7 09:00:06 2024.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

=============================
Brisk |release| Documentation
=============================

.. toctree::
   :maxdepth: 2
   :hidden:

   getting_started/index
   users/index
   api/index
   dev/releases/index
   dev/contribute

Brisk is a framework for training machine learning models using scikit-learn. It
is designed to streamline the process of training models, with built-in methods
for analysis and a structured approach to code organization.


Getting Started
===============
Learn the basics of Brisk, including installation. Create your first machine 
learning project with Brisk. Perfect for newcomers to get up and running quickly.

.. grid:: 2

   .. grid-item-card::
      :columns: 12 6 6 6
      :padding: 2
      :link: getting_started/index
      :link-type: doc

      Getting Started
      ^^^^^^^^^^^^^^^
      Information for first time users

   .. grid-item-card::
      :columns: 12 6 6 6
      :padding: 2
      :link: getting_started/quickstart/index
      :link-type: doc

      Quick Start Guide
      ^^^^^^^^^^^^^^^^^
      Create a Brisk project and train a model


Learn More
==========

.. grid:: 1 1 2 2

   .. grid-item-card::
      :columns: 12 6 6 6
      :padding: 2
      :link: users/index
      :link-type: doc

      User Guide
      ^^^^^^^^^^
      Provides in-depth information on the tools that Brisk provides.
      Browse through the guides

   .. grid-item-card:: 
      :columns: 12 6 6 6
      :padding: 2
      :link: api/index
      :link-type: doc

      API Reference
      ^^^^^^^^^^^^^^
      Detailed documentation of all Brisk classes, methods, and functions.

For Contributors
================

.. grid:: 1 1 2 2

   .. grid-item-card::
      :columns: 12 6 6 6
      :padding: 2
      :link: dev/releases/index
      :link-type: doc

      Release Notes
      ^^^^^^^^^^^^^^
      Changes made with each release

   .. grid-item-card::
      :columns: 12 6 6 6
      :padding: 2
      :link: dev/contribute
      :link-type: doc

      Contributing
      ^^^^^^^^^^^^^^
      Coding standards, pull request guidelines, and development setup.