Metadata-Version: 2.4
Name: ilovebandits
Version: 0.1.1
Summary: Advanced features for bandits with or without context.
Project-URL: Homepage, https://github.com/Abel-24pal/ilovebandits
Project-URL: Repository, https://github.com/Abel-24pal/ilovebandits
Author-email: Abel Sancarlos Gonzalez <abel.ingelectrico@gmail.com>
License: Apache-2.0
License-File: LICENSE
Keywords: contextual bandits,data-driven decision engines,mab,machine learning,python
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: Unix
Classifier: Programming Language :: Python
Classifier: Topic :: Scientific/Engineering
Requires-Python: >=3.10
Requires-Dist: pandas<2.4,>=2.2
Requires-Dist: scikit-learn>=1.5
Requires-Dist: unlzw3<1.0
Provides-Extra: dev
Requires-Dist: pytest-cov>=5.0.0; extra == 'dev'
Requires-Dist: pytest>=8.3.2; extra == 'dev'
Requires-Dist: ruff>=0.5.7; extra == 'dev'
Description-Content-Type: text/markdown

# ilovebandits

ilovebandits is a high-level Python package to work with contextual and multiarmed bandits with
new released algorithms. In essence, this package adds novel ensemble of trees techniques
for contextual bandits that the industry demands and that are not currently available in other places.

This package was born due to the need of having more advanced bandit algorithms and features for the finance industry.

Next version will also add the concept of composed rewards where you can feed the bandit with different type rewards in time as this was a requirement that a lot of problems face.

The implementation has been developed in Python 3.
We are currently in the first version focusing on adding more core features and collecting feedback from the community.

# Installation

**Installation/Usage**: [Installation/Usage details in official docs](https://ilovebandits.readthedocs.io/en/latest/examples.html)

# Documentation

**Documentation**: [Official documentation of the project in readthedocs](https://ilovebandits.readthedocs.io)

# Tutorial

**Tutorial contextual bandits**: [Tutorial and examples contextual bandits](https://ilovebandits.readthedocs.io/en/latest/examples_cban.html)

**Tutorial multi-armed bandits**: [Tutorial and exmaples multi-armed bandits](https://ilovebandits.readthedocs.io/en/latest/examples_mab.html)

## Motivation

There are a lot of potential business problems that can be solved with bandits, but current implementations lack some features that can be very useful to apply bandits in new scenarios. The main goal of this package is to provide a simple and easy-to-use interface to work with bandits, while also providing some advanced features that are not available in other packages.

Main industry limitations that this package addresses:

1. **Advanced contextual bandits with ensembles of trees**
   There are not many implementations of advanced contextual bandits that allow the use of ensemble-of-trees methods. This is a limitation because ensemble methods are very powerful for tabular data. They need less data than neural networks and can capture richer patterns than the common linear methods employed in bandits.

2. **Ability to define composed rewards**
   In many real-world scenarios, the reward is not a single value but a combination of different sub-rewards that can be observed at different times.
   For example, in a recommendation system, the final reward can be a combination of immediate clicks, time spent on the platform, and long-term user retention.
   Being able to define and use these sub-rewards can significantly improve the performance of the bandit algorithm, and we can also update the bandit more often for each subpart as soon as it comes.

---

## This package concentrates on

1. The use of ensemble-of-trees methods for contextual bandits.
2. The use of composed rewards where the bandit can be fed with different types of sub-rewards in time. Here, we define a long-term global reward, which we break down into smaller, shorter-term rewards that allow us to update the bandit much earlier than if we waited for the global reward.

These small updates also change the global reward estimate employed by the bandit to take the final decision.

---

This package is intended to provide a quick, as well as (hopefully) easy-to-understand, way of running bandit simulations and core functions to create ready-to-use solutions for the industry.
