.. bde documentation master file, created by
   sphinx-quickstart on Mon Jan 18 14:44:12 2016.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

:notoc:

#############################################################################################
Bayesian Deep Ensembles via MILE: easy to use, scikit-learn compatible and fast (JAX powered)
#############################################################################################

**Date**: |today| **Version**: |version|

**Useful links**:
`Source Repository <https://github.com/scikit-learn-contrib/bde.git>`__ |
`Issues & Ideas <https://github.com/scikit-learn-contrib/bde/issues>`__ 

This is the documentation for the `bde` package.



.. grid:: 1 2 2 2
    :gutter: 4
    :padding: 2 2 0 0
    :class-container: sd-text-center

    .. grid-item-card:: Getting started
        :img-top: _static/img/index_getting_started.svg
        :class-card: intro-card
        :shadow: md

        Information on how to install the package, manage dependencies and JAX device count

        +++

        .. button-ref:: quick_start
            :ref-type: ref
            :click-parent:
            :color: secondary
            :expand:

            To the getting started guideline

    .. grid-item-card::  User guide
        :img-top: _static/img/index_user_guide.svg
        :class-card: intro-card
        :shadow: md

        Overview of the package, estimators and most important hyperparameters

        +++

        .. button-ref:: user_guide
            :ref-type: ref
            :click-parent:
            :color: secondary
            :expand:

            To the user guide

    .. grid-item-card::  API reference
        :img-top: _static/img/index_api.svg
        :class-card: intro-card
        :shadow: md

        The API reference of the `bde` package.

        +++

        .. button-ref:: api
            :ref-type: ref
            :click-parent:
            :color: secondary
            :expand:

            To the reference guide

    .. grid-item-card::  Examples
        :img-top: _static/img/index_examples.svg
        :class-card: intro-card
        :shadow: md

        A set of examples. It complements the User Guide and shows how to use the available `bde` estimators.

        +++

        .. button-ref:: auto_examples/index
            :ref-type: doc
            :click-parent:
            :color: secondary
            :expand:

            To the gallery of examples


.. toctree::
    :maxdepth: 3
    :hidden:
    :titlesonly:

    quick_start
    user_guide
    api
    auto_examples/index