.. _home:

=================
Welcome to skbase
=================

``skbase`` provides base classes for creating scikit-learn-like and sktime-like
parametric objects, along with tools to make it easier to build your own packages
that reuse these design patterns.

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

   get_started
   users
   api_reference
   contribute
   about
   changelog

From here, you can navigate to:

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

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

        Get started using ``skbase`` quickly.

        +++

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

            Get Started

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

        Find user documentation.

        +++

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

            Users

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

        Understand ``skbase``'s API.

        +++

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

            API Reference

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

        Find out how you can contribute.

        +++

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

            Get Involved

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

        Learn more about ``skbase``.

        +++

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

            Learn More

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

        See how the package has changed.

        +++

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

            Changelog