==================================
Sklearn Nature Inspired Algorithms
==================================

Nature-inspired algorithms for hyper-parameter tuning of `scikit-learn <https://github.com/scikit-learn/scikit-learn>`_ models. This library uses algorithm implementations from `NiaPy <https://github.com/NiaOrg/NiaPy>`_.

Getting started
---------------

The following pages will help you get started with the nature-inspired algorithms library.

:doc:`Basic Usage </introduction/usage>` |
:doc:`NatureInspiredSearchCV </introduction/nature-inspired-search-cv>` |
:doc:`Visualization of Optimization Results </introduction/visualisation>` |
:doc:`List of Supported Algorithms </introduction/algorithms>`

.. toctree::
   :maxdepth: 1
   :hidden:
   :caption: Getting started

   /introduction/usage.rst
   /introduction/nature-inspired-search-cv.rst
   /introduction/visualisation.rst
   /introduction/algorithms.rst

Advanced
--------

If you are already familiar with this library, these pages cover more advanced topics, such as using a custom NiaPy algorithm.

:doc:`Using a Custom NiaPy Algorithm </advanced/niapy>`

.. toctree::
   :maxdepth: 1
   :hidden:
   :caption: Advanced

   /advanced/niapy.rst