.. _user_documentation:

Documentation
=============

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

   installation
   tutorials
   examples
   estimator_overview
   glossary
   changelog
   related_software

.. grid:: 1 2 2 2
    :gutter: 3

    .. grid-item-card::
        :text-align: center

        Installation

        ^^^

        Stable version, developer version, and build requirements.

        +++

        .. button-ref:: installation
            :color: primary
            :click-parent:
            :expand:

            Installation Guide

    .. grid-item-card::
        :text-align: center

        Video tutorials

        ^^^

        ``sktime`` video tutorials.

        +++

        .. button-ref:: tutorials
            :color: primary
            :click-parent:
            :expand:

            Tutorials

    .. grid-item-card::
        :text-align: center

        Notebook Examples

        ^^^

        Usage examples in jupyter notebooks.

        +++

        .. button-ref:: examples
            :color: primary
            :click-parent:
            :expand:

            Notebook Examples

    .. grid-item-card::
        :text-align: center

        Estimator Overview

        ^^^

        Overview of all estimators in ``sktime``.

        +++

        .. button-ref:: estimator_overview
            :color: primary
            :click-parent:
            :expand:

            Estimator Overview

    .. grid-item-card::
        :text-align: center

        Glossary

        ^^^

        Glossary of common terms and API elements in ``sktime``.

        +++

        .. button-ref:: glossary
            :color: primary
            :click-parent:
            :expand:

            Glossary

    .. grid-item-card::
        :text-align: center

        Change Logs

        ^^^

        Version change logs.

        +++

        .. button-ref:: changelog
            :color: primary
            :click-parent:
            :expand:

            Change Logs

    .. grid-item-card::
        :text-align: center

        Related Software

        ^^^

        Software related to ``sktime`` and time series.

        +++

        .. button-ref:: related_software
            :color: primary
            :click-parent:
            :expand:

            Related Software
