.. error-parity documentation master file, created by
   sphinx-quickstart on Thu Nov 23 16:53:42 2023.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to :code:`hyperparameter-tuning`'s documentation!
=========================================================

The :code:`hyperparameter-tuning` package is a minimal and easy-to-use 
hyperparameter tuning framework to help you train hundreds of models.
It's essentially a set of helpful wrappers over `optuna`_.

Full code available on the `GitHub repository`_.

Check out the following sub-pages:

.. toctree::
   :maxdepth: 1

   Example usage<examples/example-usage>
   Readme file <readme>
   API reference <api_ref/modules>


Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`


.. _GitHub repository: https://github.com/AndreFCruz/hpt
.. _optuna: https://github.com/optuna/optuna