:orphan:

.. title:: Teacher documentation

.. module:: teacher


##################################
Teacher |release| documentation
##################################

Teacher is a Python library for explaining machine learning models.

************
Installation
************

.. grid:: 1 1 2 2

    .. grid-item::

        Install using `pip <https://pypi.org/project/teacher-xai/>`__:

        .. code-block:: bash

            pip install teacher-xai

    .. grid-item::

        Install using `conda <https://docs.continuum.io/anaconda/>`__:

        .. code-block:: bash

            conda install ...

Further details are available in the :doc:`Installation Guide <users/installing/index>`.


******************
Learning resources
******************

.. grid:: 1 1 2 2

    .. grid-item-card::
        :class-header: sd-bg-light
        :padding: 2

        Tutorials
        ^^^

        - `Introductory tutorials <../tutorials/index.html>`_

    .. grid-item-card::
        :class-header: sd-bg-light
        :padding: 2

        How-tos
        ^^^
        - :doc:`Teacher FAQ <users/faq/index>`

    .. grid-item-card::
        :class-header: sd-bg-light
        :padding: 2

        Understand how Teacher works
        ^^^

        - The explanation in the :doc:`Users guide
          <users/index>`

    .. grid-item-card::
        :class-header: sd-bg-light
        :padding: 2

        Reference
        ^^^

        - :doc:`API Reference <api/index>`


************
Contributing
************

Teacher is a community project maintained for and by its users.  There are many ways
you can help!

- Report a bug or request a feature `on GitHub <https://github.com/Kaysera/teacher/issues>`__
- or improve the :ref:`documentation and code <developers-guide-index>`


.. toctree::
   :maxdepth: 2
   :hidden:

   users/getting_started/index.rst
   users/installing/index.rst

.. toctree::
   :maxdepth: 1
   :hidden:

   tutorials/index.rst

.. toctree::
   :maxdepth: 2
   :hidden:

   api/index.rst
   devel/index.rst
   users/project/index.rst