.. project-template 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:

#############################################
Project template for `scikit-learn` extension
#############################################

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

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

This is the documentation for the `project-template` to help at extending
`scikit-learn`. It provides some information on how to build your own custom
`scikit-learn` compatible estimators as well as a template to package them.

.. raw:: html

    <div class="container">
        <div class="row">
            <div class="col-lg-6 col-md-6 col-sm-6 col-xs-12 d-flex">
                <div class="intro-card text-center sd-intro-card shadow">
                <div class="sd-card-body flex-fill">
                    <i class="fas fa-download fa-7x"></i>
                    <h5 class="sd-card-title">Getting started</h5>
                    <p class="sd-card-text">Information regarding this template and how
                    to modify it for your own project.</p>

.. container:: custom-button

    :ref:`To the getting started guideline<quick_start>`

.. raw:: html

                </div>
                </div>
            </div>
            <div class="col-lg-6 col-md-6 col-sm-6 col-xs-12 d-flex">
                <div class="intro-card text-center sd-intro-card shadow">
                <div class="sd-card-body flex-fill">
                    <i class="fas fa-book fa-7x"></i>
                    <h5 class="sd-card-title">User guide</h5>
                    <p class="sd-card-text">An example of narrative documentation.
                    Here, we will explain how to create your own <em>scikit-learn</em>
                    estimator.</p>

.. container:: custom-button

    :ref:`To the user guide<user_guide>`

.. raw:: html

                </div>
                </div>
            </div>
            <div class="col-lg-6 col-md-6 col-sm-6 col-xs-12 d-flex">
                <div class="intro-card text-center sd-intro-card shadow">
                <div class="sd-card-body flex-fill">
                    <i class="fas fa-code fa-7x"></i>
                    <h5 class="sd-card-title">API reference</h5>
                    <p class="sd-card-text">An example of API documentation. This
                    is an example how to use <em>sphinx</em> to automatically generate
                    reference API page.</p>

.. container:: custom-button

    :ref:`To the reference guide<api>`

.. raw:: html

                </div>
                </div>
            </div>
            <div class="col-lg-6 col-md-6 col-sm-6 col-xs-12 d-flex">
                <div class="intro-card text-center sd-intro-card shadow">
                <div class="sd-card-body flex-fill">
                    <i class="fas fa-chart-bar fa-7x"></i>
                    <h5 class="sd-card-title">Examples</h5>
                    <p class="sd-card-text">A set of examples. It complements the User
                    Guide and it is the right place to show how to use your compatible
                    estimator.</p>

.. container:: custom-button

    :ref:`To the gallery of examples<general_examples>`

.. raw:: html

                </div>
                </div>
            </div>
        </div>
    </div>


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

    quick_start
    user_guide
    api
    auto_examples/index