.. Contextual Bandits documentation master file, created by
   sphinx-quickstart on Wed Mar 28 00:01:31 2018.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Contextual Bandits
=================================

This is the documentation page for the python package *contextualbandits*. For 
more details, see the project's home page:

`<https://www.github.comdavid-cortes/contextualbandits/>`_

Installation
=================================
Package is available on PyPI, can be installed with
::

    pip install contextualbandits


Getting started
=================================

You can find user guides with detailed examples in the following links:

`Online Contextual Bandits 
<http://nbviewer.jupyter.org/github/david-cortes/contextualbandits/blob/master/
example/online_contextual_bandits.ipynb>`_

`Off policy Learning in Contextual Bandits 
<http://nbviewer.jupyter.org/github/david-cortes/contextualbandits/blob/master/
example/offpolicy_learning.ipynb>`_

`Policy Evaluation in Contextual Bandits 
<http://nbviewer.jupyter.org/github/david-cortes/contextualbandits/blob/master/
example/policy_evaluation.ipynb>`_


Online Contextual Bandits
=================================

.. automodule:: contextualbandits.online
    :members:
    :undoc-members:
    :show-inheritance:
    :inherited-members:

Off-policy learning
=================================

.. automodule:: contextualbandits.offpolicy
    :members:
    :undoc-members:
    :show-inheritance:
    :inherited-members:

Policy Evaluation
=================================

.. automodule:: contextualbandits.evaluation
    :members:
    :undoc-members:
    :show-inheritance:
    :inherited-members:


Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
