PyBandits
PyBandits is a Python library for Multi-Armed Bandit. It provides an implementation of stochastic Multi-Armed Bandit (sMAB) and contextual Multi-Armed Bandit (cMAB) based on Thompson Sampling.
For the sMAB, we implemented a Bernoulli multi-armed bandit based on Thompson Sampling algorithm Agrawal and Goyal, 2012. If context information is available we provide a generalisation of Thompson Sampling for cMAB Agrawal and Goyal, 2014 implemented with PyMC, an open source probabilistic programming framework for automatic Bayesian inference on user-defined probabilistic models.
Installation
This library is distributed on PyPI and can be installed with pip.
pip install pybandits
Based on the guidelines of pymc authors, it is highly recommended to install the library in a conda environment via the following.
conda install -c conda-forge pymc
pip install pybandits
The command above will automatically install all the dependencies listed in pyproject.toml. Please visit the
installation
page for more details.
Getting started
A short example, illustrating it use. Use the sMAB model to predict actions and update the model based on rewards from the environment.
import numpy as np
from pybandits.model import Beta
from pybandits.smab import SmabBernoulli
n_samples=100
# define action model
actions = {
"a1": Beta(),
"a2": Beta(),
}
# init stochastic Multi-Armed Bandit model
smab = SmabBernoulli(actions=actions)
# predict actions
pred_actions, _ = smab.predict(n_samples=n_samples)
simulated_rewards = np.random.randint(2, size=n_samples)
# update model
smab.update(actions=pred_actions, rewards=simulated_rewards)
Documentation
For more information please read the full documentation and tutorials.
You can also observe on DeepWiki.
Info for developers
The source code of the project is available on GitHub.
git clone https://github.com/playtikaoss/pybandits.git
You can install the library and the dependencies from the source code with one of the following commands:
poetry install # install library + dependencies
poetry install --without dev # install library + dependencies, excluding developer-dependencies
To create the HTML documentation run the following commands:
cd docs/src
make html
Run tests
Tests can be executed with pytest running the following commands. Make sure to have the library installed before to
run any tests.
cd tests
pytest -vv # run all tests
pytest -vv test_testmodule.py # run all tests within a module
pytest -vv test_testmodule.py -k test_testname # run only 1 test
pytest -vv -k 'not time' # run all tests but not exec time
License
3 maintainers
Metadata
3 maintainers
Release files for pybandits 8.4.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| pybandits-8.4.0.tar.gz | 170.2 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| pybandits-8.4.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 384.2 kB
Release files / pybandits-8.4.0.tar.gz
| Download URL | pybandits-8.4.0.tar.gz |
|---|---|
| Size | 170.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
e4f9a0b4895bf5b3f926465fd04b820a42343f6e219c1930e404e94be676547b
|
|
BLAKE2b-256 checksum How to use checksums |
adff26f64a70f161ad51a03d718a0e06398e52e8fa22072361260cf41c4f48b6
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/2.2.1 CPython/3.10.22 Linux/6.17.0-1022-azure
|
Release files / pybandits-8.4.0-py3-none-any.whl
| Download URL | pybandits-8.4.0-py3-none-any.whl |
|---|---|
| Size | 214.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
74f4dd80b7cd95d7c2e329b2be88675ae5c6e7c3494d70fb5a44ad605c8d4007
|
|
BLAKE2b-256 checksum How to use checksums |
f35bb639f7c2e23a4582e6dbf79e937263189904cc2e275de63fa5049452ebb2
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/2.2.1 CPython/3.10.22 Linux/6.17.0-1022-azure
|
