.. image:: https://user-images.githubusercontent.com/1223300/41346080-c2c910a0-6f05-11e8-89e9-71a72bb9543f.png
   :width: 300px
   :alt: sklearn-pmml-model

Documentation
=============

A library to effortlessly import models trained on different platforms and with programming languages into scikit-learn in Python. First export your model to PMML (widely supported). Next, load the exported PMML file with this library, and use the class as any other scikit-learn estimator.

.. raw:: html

    <div class="row mb-5">
      <div class="col-md-6 col-xs-12 d-flex p-1">
        <div class="flex-fill tile">
          <a class="tile-link" href="install.html">
            <h3 class="tile-title">Install
            <i class="fas fa-download tile-icon"></i>
            </h3>
          </a>
          <div class="tile-desc">
            <p>The easiest way to install <code>sklearn-pmml-model</code> is to use <a class="reference external" href="https://packaging.python.org/tutorials/installing-packages/#use-pip-for-installing">pip</a> by running:</p>
              <div class="highlight-default notranslate">
                <div class="highlight">
                  <pre>$ pip install sklearn-pmml-model</pre>
                </div>
              </div>

            <p>Alternatively, you can install from source using the details described on <a class="reference external" href="https://github.com/iamDecode/sklearn-pmml-model">GitHub</a>.</p>
          </div>
        </div>
      </div>
      <div class="col-lg-6 col-md-6 col-sm-6 col-xs-12 d-flex p-1">
        <div class="flex-fill tile">
          <a class="tile-link" href="autoapi/index.html">
            <h3 class="tile-title">API Reference
            <i class="fas fa-cogs tile-icon"></i>
            </h3>
            <div class="tile-desc">
              <p>The reference guide contains a detailed description of the <code>sklearn-pmml-model</code> API. It describes which classes and functions are available along with their arguments.</p>
            </div>
          </a>
        </div>
      </div>
    </div>

.. toctree::
    :maxdepth: 4
    :caption: Contents:

    Install <install>
    Contribute <contributing>
    Release notes <release_notes>