.. _home:

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

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

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

   get_started
   users
   api_reference
   contribute
   about
   changelog

From here, you can navigate to:

.. panels::
    :card: + intro-card text-center

    ---

    Get Started
    ^^^^^^^^^^^

    Get started using ``skbase`` quickly.

    +++

    .. link-button:: get_started
            :type: ref
            :text: Get Started
            :classes: btn-block btn-secondary stretched-link

    ---

    User Documentation
    ^^^^^^^^^^^^^^^^^^

    Find user documentation.

    +++

    .. link-button:: users
            :type: ref
            :text: Users
            :classes: btn-block btn-secondary stretched-link

    ---

    API Reference
    ^^^^^^^^^^^^^

    Understand ``skbase``'s API.

    +++

    .. link-button:: api_reference
            :type: ref
            :text: API Reference
            :classes: btn-block btn-secondary stretched-link

    ---

    Get Involved
    ^^^^^^^^^^^^

    Find out how you can contribute.

    +++

    .. link-button:: contribute
            :type: ref
            :text: Get Involved
            :classes: btn-block btn-secondary stretched-link

    ---

    About
    ^^^^^

    Learn more about ``skbase``.

    +++

    .. link-button:: about
            :type: ref
            :text: Learn More
            :classes: btn-block btn-secondary stretched-link

    ---

    Changelog
    ^^^^^^^^^

    See how the package has changed.

    +++

    .. link-button:: changelog
            :type: ref
            :text: Changelog
            :classes: btn-block btn-secondary stretched-link