Skip to main content

Official Python SDK for BanditDB

Project description

BanditDB Python SDK

The official Python client and Model Context Protocol (MCP) server for BanditDB — the ultra-fast, lock-free Contextual Bandit database written in Rust.

BanditDB abstracts away the complex linear algebra of Reinforcement Learning (LinUCB, Thompson Sampling) behind a dead-simple API. Build real-time personalizers, dynamic A/B tests, and give LLM agents mathematically rigorous persistent memory.

Installation

pip install banditdb-python

Requires the BanditDB Rust server running (default: http://localhost:8080).


1. Standard SDK Usage

The client features automatic connection pooling, exponential backoff retries, and strict timeouts.

from banditdb import Client, BanditDBError

# Connect to the BanditDB server.
# Pass api_key if BANDITDB_API_KEY is set on the server.
db = Client(
    url="http://localhost:8080",
    timeout=2.0,
    api_key="your-secret-key",   # omit if server runs without auth
)

try:
    # 1. Create a campaign (run once at startup)
    db.create_campaign(
        campaign_id="checkout_upsell",
        arms=["offer_discount", "offer_free_shipping"],
        feature_dim=3,
    )

    # 2. A user arrives — ask the database what to show them
    # Context: [is_mobile, cart_value_normalized, is_returning_user]
    arm_id, interaction_id = db.predict("checkout_upsell", [1.0, 0.8, 0.0])
    print(f"Showing: {arm_id}")  # e.g., "offer_free_shipping"

    # 3. The user clicked — send the reward
    db.reward(interaction_id, reward=1.0)

except BanditDBError as e:
    print(f"Database error: {e}")

All Client methods

Method Description
health() Returns True if the server is reachable and healthy.
list_campaigns() Returns a list of all live campaigns with their alpha and arm_count.
campaign_info(campaign_id) Returns the full diagnostic state for one campaign: per-arm theta, theta_norm, prediction_count, reward_count, and totals. Raises APIError (404) if not found.
create_campaign(campaign_id, arms, feature_dim, alpha=1.0) Register a new campaign. alpha controls exploration (higher = more exploration).
delete_campaign(campaign_id) Delete a campaign. Returns False if not found.
predict(campaign_id, context) Returns (arm_id, interaction_id).
reward(interaction_id, reward) Close the feedback loop. Reward must be in [0, 1].
checkpoint() Flush the WAL, snapshot models, write Parquet files, rotate the WAL. Returns a summary string.
export() List per-campaign Parquet files created by checkpoint(). Returns a formatted string.

2. The AI "Hive Mind" (Model Context Protocol)

Standard LLM agents are stateless — if they route a task to the wrong model and fail, they repeat the same mistake tomorrow. BanditDB's built-in MCP server gives the entire agent swarm shared persistent memory.

Starting the MCP server

# Set environment variables before starting
export BANDITDB_URL=http://localhost:8080
export BANDITDB_API_KEY=your-secret-key   # omit if server runs without auth

banditdb-mcp

Connecting to Claude Desktop

Add to your Claude configuration file:

  • Mac: ~/Library/Application Support/Claude/claude_desktop_config.json
  • Windows: %APPDATA%\Claude\claude_desktop_config.json
{
  "mcpServers": {
    "banditdb": {
      "command": "banditdb-mcp",
      "args": [],
      "env": {
        "BANDITDB_URL": "http://localhost:8080",
        "BANDITDB_API_KEY": "your-secret-key"
      }
    }
  }
}

The agent swarm now has five tools:

Tool What it does
create_campaign Create a new decision campaign with a list of arms and a context dimension.
list_campaigns List all active campaigns — useful to check what exists before calling get_intuition.
campaign_diagnostics Inspect per-arm learning state: theta_norm, prediction counts, reward rates. Use this when a campaign doesn't seem to be learning.
get_intuition Ask BanditDB which arm to pick for a given context. Returns the arm and an interaction_id to save.
record_outcome Report whether the chosen action succeeded (1.0) or failed (0.0). Updates the shared model.

Every decision made by any agent in the network improves the routing for all future agents.


3. Data Science & Offline Evaluation

BanditDB event-sources every prediction and reward to a Write-Ahead Log (WAL). Calling checkpoint() compiles completed prediction→reward pairs into Snappy-compressed Parquet files — one per campaign — for offline analysis with Polars or Pandas.

Every prediction is guaranteed to appear in the Parquet file even if its reward arrives hours later: BanditDB re-emits in-flight interactions at each checkpoint so delayed rewards are always captured in a future cycle.

# Checkpoint: snapshot models, write Parquet, rotate the WAL.
# Call this on a schedule or after significant traffic.
summary = db.checkpoint()
print(summary)
# "Checkpoint written and WAL rotated: 2 campaigns, offset 4821 bytes,
#  150 interactions exported, 3 in-flight re-emitted"

# List which Parquet files are available
print(db.export())
# 'Parquet files in /data/exports: ["llm_routing.parquet"]'

# Load directly from the mounted volume into Polars for Offline Policy Evaluation.
# Flat schema: interaction_id | arm_id | reward | predicted_at | rewarded_at | feature_0 | ...
import polars as pl
df = pl.read_parquet("/data/exports/llm_routing.parquet")
print(df.head())
print(df.columns)

Error Handling

Exception When raised
BanditDBError Base exception — catch this to handle all SDK errors.
ConnectionError Server is offline or unreachable.
TimeoutError Request exceeded the configured timeout.
APIError Server returned an error (e.g., campaign not found, unauthorized).

License

AGPL-3.0 — Copyright (C) 2026 Simeon Lukov. See the main repository for details.

Project details


Download files

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

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

banditdb_python-0.1.1-py3-none-any.whl (21.4 kB view details)

Uploaded Python 3

File details

Details for the file banditdb_python-0.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for banditdb_python-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 e2e4657a9e0f073e85ceed981318c884eff674afaea10cc5b709e80fc07d8f03
MD5 4b60970d1d5629477ab26e4af4a3364c
BLAKE2b-256 b8409cea5b18ffa23f1da414a6e112c8e1432b0fc42e2147b7048066a08081c8

See more details on using hashes here.

Supported by

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