.. role:: hidden
    :class: hidden-section

.. automodule:: mlens.index
.. currentmodule:: mlens.index

mlens.index
===========

Indexers
--------

:hidden:`BaseIndex`
^^^^^^^^^^^^^^^^^^^

.. autoclass:: BaseIndex 
    :members:
    :show-inheritance:

:hidden:`FoldIndex`
^^^^^^^^^^^^^^^^^^^

.. autoclass:: FoldIndex 
    :members:
    :show-inheritance:

:hidden:`BlendIndex`
^^^^^^^^^^^^^^^^^^^^

.. autoclass:: BlendIndex 
    :members:
    :show-inheritance:

:hidden:`SubsetIndex`
^^^^^^^^^^^^^^^^^^^^^

.. autoclass:: SubsetIndex 
    :members:
    :show-inheritance:

:hidden:`ClusteredSubsetIndex`
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. autoclass:: ClusteredSubsetIndex 
    :members:
    :show-inheritance:

:hidden:`FullIndex`
^^^^^^^^^^^^^^^^^^^

.. autoclass:: FullIndex 
    :members:
    :show-inheritance:

Utilities
---------

:hidden:`prune_train`
^^^^^^^^^^^^^^^^^^^^^

.. autofunction:: prune_train 

:hidden:`partition`
^^^^^^^^^^^^^^^^^^^

.. autofunction:: partition 

:hidden:`make_tuple`
^^^^^^^^^^^^^^^^^^^^

.. autofunction:: make_tuple