.. skutil documentation master file, created by
   sphinx-quickstart on Sun Oct  9 00:16:56 2016.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

scikit-util : Sklearn meets H2O
===================================================================

.. image:: ./images/h2o-sklearn.png
   :width: 80%
   :align: center

Why?
====

What began as a succinct set of extension classes and utilities (as well as implementations of preprocessors from R
packages like `caret <https://github.com/topepo/caret>`_ ) grew to bridge functionality between sklearn and H2O.
Now, `scikit-util (skutil)` brings the best of both worlds to H2O and sklearn, delivering an easy transition into the
world of distributed computing that H2O offers, while providing the same, familiar interface that sklearn users have
come to know and love.


Travis CI Build Status
======================

.. image:: https://travis-ci.org/tgsmith61591/skutil.svg?branch=master
   :target: https://travis-ci.org/tgsmith61591/skutil

.. image:: https://coveralls.io/repos/github/tgsmith61591/skutil/badge.svg?branch=master
   :target: https://coveralls.io/github/tgsmith61591/skutil?branch=master

.. image:: https://img.shields.io/badge/python-2.7-blue.svg
   :target: https://img.shields.io/badge/python-2.7-blue

Helpful Links
=============

- `H2O's Python Documentation <http://docs.h2o.ai/h2o/latest-stable/h2o-py/docs/index.html>`_
- `Sklearn's Python Documentation <http://scikit-learn.org>`_
- `Skutil's Source Code <https://github.com/tgsmith61591/skutil>`_


Table of Contents
=================

.. toctree::
   :maxdepth: 1

   Setup <./rsts/setup/index.rst>
   Codebase <./rsts/codebase/index.rst>
   Examples <./rsts/examples/index.rst>