.. main-page:

CORELS: Certifiably Optimal RulE ListS
======================================

Welcome to the documentation of the Python binding of CORELS (Certifiably Optimal RulE ListS)!


Quick Start
-----------
.. literalinclude:: ../../examples/basic.py
    :language: python

All functionality is exposed via a class named 'CorelsClassifier'. In addition, a couple helper functions are provided.

Head over to the `examples page <examples.html>`_ for more code samples.

For installation instructions, visit the code repository at https://github.com/fingoldin/pycorels.

.. toctree::
    :maxdepth: 2

    CorelsClassifier
    helpers
    examples