Getting started
===============

This guide illustrates the main functionalities that ``scikit-matter`` provides. It
assumes a very basic working knowledge of how ``scikit-learn`` works. Please refer to
our :ref:`installation` instructions for installing ``scikit-matter``.

For a detailed explaination of the functionalities, please look at the
:ref:`selection-api`

.. _getting_started-selection:

Features and Samples Selection
------------------------------

.. automodule:: skmatter._selection
   :noindex:

Notebook Examples
^^^^^^^^^^^^^^^^^

.. include:: examples/selection/index.rst
   :start-line: 4


.. _getting_started-reconstruction:

Metrics
-------

.. automodule:: skmatter.metrics
   :noindex:

Notebook Examples
^^^^^^^^^^^^^^^^^

.. include:: examples/reconstruction/index.rst
   :start-line: 4

.. _getting_started-hybrid:

Hybrid Mapping Techniques
-------------------------

.. automodule:: skmatter.decomposition
   :noindex:

Notebook Examples
^^^^^^^^^^^^^^^^^

.. include:: examples/pcovr/index.rst
   :start-line: 4
.. include:: examples/pcovc/index.rst
   :start-line: 4