.. _api:

==============
Documentation
==============

Welcome to the twinLab python documentation! 

Please see the exposed capabilities for creating models:


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

   .. grid-item-card:: Dataset
      :class-card: intro-card
      :shadow: md

      Explore how to import and manipulate your data

      +++

      .. button-ref:: api.dataset
         :ref-type: ref
         :click-parent:
         :color: secondary
         :expand:

         Explore →


   .. grid-item-card:: Emulators
      :class-card: intro-card
      :shadow: md

      Learn how to use twinLab to build probabalistic emulators

      +++

      .. button-ref:: api.emulator
         :ref-type: ref
         :click-parent:
         :color: secondary
         :expand:

         Explore →

   .. grid-item-card:: Parameters
      :class-card: intro-card
      :shadow: md

      See our parameter classes which enable hyper-users to fine tune their models.

      +++

      .. button-ref:: api.parameters
         :ref-type: ref
         :click-parent:
         :color: secondary
         :expand:

         Explore →


   .. grid-item-card:: Utilities
      :class-card: intro-card
      :shadow: md

      See the twinLab core and utility functions

      +++

      .. button-ref:: api.utilities
         :ref-type: ref
         :click-parent:
         :color: secondary
         :expand:

         Explore →

.. toctree::
   :maxdepth: 1
   :hidden: 

   dataset
   emulator
   parameters
   distributions
   utilities

.. seealso:: 

   To explore how twinLab is used in the wide explore our notebook :ref:`examples`

..  deprecated:: V2.0.0

   A previous version of twinLab (pre December 2023) is still available as :ref:`v1-docs`