.. ReliefE documentation master file, created by
   sphinx-quickstart on Mon Jan  4 08:30:27 2021.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to ReliefE's documentation
===================================

`ReliefE <https://github.com/SkBlaz/reliefe/>`_ is an extension of  ReliefF family of the algorithms to the realm of real-valued learnable embeddings. All examples assume you have the `ReliefE <https://github.com/SkBlaz/reliefe/>`_ repo downloaded (alongside the data).

.. image:: scheme.png
   :width: 600

.. toctree::
   :maxdepth: 3
   :caption: About:

   key_idea.rst
	   
.. toctree::
   :maxdepth: 3
   :caption: Tutorial and first steps:

   installation.rst
   core_idea.rst
   task_types.rst
   reliefe_types.rst
   custom_embeddings.rst

.. toctree::
   :maxdepth: 3
   :caption: Contents:

   reliefe.rst
   
..
   Method index
   ==================

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