Skip to main content

Python Multi-Armed Bandit Library

Project description

PyBandits

GitHub Actions Workflow Status PyPI - Version PyPI - Python Version MIT License Ask DeepWiki Coverage

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

MIT License

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pybandits-4.0.11.tar.gz (73.6 kB view details)

Uploaded Source

Built Distribution

pybandits-4.0.11-py3-none-any.whl (88.5 kB view details)

Uploaded Python 3

File details

Details for the file pybandits-4.0.11.tar.gz.

File metadata

  • Download URL: pybandits-4.0.11.tar.gz
  • Upload date:
  • Size: 73.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.3 CPython/3.10.18 Linux/6.11.0-1018-azure

File hashes

Hashes for pybandits-4.0.11.tar.gz
Algorithm Hash digest
SHA256 9c7fdc7166091f8e361d5ff9636fcd1b26e72c75a1fa58c02388f1cec31f1d66
MD5 dc980dbdf988688201d2c9f75cba21f3
BLAKE2b-256 0ed41b731b61318c6eed1037824f291b7aa9242e98e96292c0ca7f290b884cbd

See more details on using hashes here.

File details

Details for the file pybandits-4.0.11-py3-none-any.whl.

File metadata

  • Download URL: pybandits-4.0.11-py3-none-any.whl
  • Upload date:
  • Size: 88.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.3 CPython/3.10.18 Linux/6.11.0-1018-azure

File hashes

Hashes for pybandits-4.0.11-py3-none-any.whl
Algorithm Hash digest
SHA256 e2fa6ef76d12e080d03b256fe4e24b4b0666d3b792a6fd1d3aaa1286aae275af
MD5 b0f5758b08acfd5f8379f4262f066805
BLAKE2b-256 dc95727bbee5e061c8d24b446ef27ebfd3c1623be858b93910817d5c72a7150a

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page