gittins
An opinionated, highly optimised contextual bandit engine.
- Online by nature. Learns one observation at a time, in O(1) work and fixed memory, as long as open decisions are regularly resolved.
- Non-stationarity is expected. The engine adapts as the relationship between context and feedback drifts, and never learns anything it cannot eventually unlearn.
- Dynamic actions and context. The candidate set can change on every call; you never declare the number of actions up front.
- Safe reward handling. Rewards may arrive late or never. Constructing invalid training data is made hard by design.
- Speed and determinism. Bit-identical results across platforms and language bindings, enforced by a golden test corpus.
- Bring your own model. Swap in your own scoring or exploration and inherit everything else.
Full documentation and user guide: docs.getgittins.dev
Install
pip install gittins
Usage
The state is an opaque handle updated in place — calls return only their
result, and every alias of the handle observes the current state. Persist it
with serialize, which returns one plain string.
import time
import gittins
state = gittins.create(bits=8, horizon=3600.0) # model size, seconds to resolve
candidates = [
("banner-sale", {"discount": 0.2}),
("banner-new", {"discount": 0.0}),
("banner-plain", {}),
]
context = {"device": "mobile", "hour": 14}
record = gittins.decide(state, context, candidates, time.time(), "web-1")
arm_id = candidates[record.chosen][0]
# ... your code: act on the choice, then report the outcome
gittins.learn(state, record.decision_id, 1.0, time.time())
gittins.expire(state, time.time()) # resolve anything past its horizon
open("bandit.txt", "w").write(gittins.serialize(state))
Feature values are typed by what you pass: strings are categorical, ints,
floats and bools numeric, None absent. Anything else raises ValueError
naming the feature.
Bringing your own model
decide takes optional score and explore callbacks, and learn/expire
take train. Each crosses the Python/Rust boundary once per call — with all
candidates, all estimates, or the one resolved record — never once per
candidate, so the one boundary crossing per decision is preserved.
Offline policy evaluation
log_line renders a decision record or resolution as one canonical
experience-log line. Append it verbatim; it is exactly what the gittins
CLI's verify / eval / sweep / replay consume.
with open("decisions.jsonl", "a") as log:
log.write(gittins.log_line(record) + "\n")
API
| Function | Purpose |
|---|---|
create(bits, horizon, default_reward=0.0, epsilon=..., forgetfulness=...) |
New state |
decide(state, context, candidates, t, salt, score=None, explore=None) |
Choose; returns a DecisionRecord |
learn(state, decision_id, reward, t, train=None) |
Resolve one decision; returns a Resolution or None |
expire(state, t, train=None) |
Resolve everything past its horizon |
serialize(state) / deserialize(text) |
State as one plain string |
model_bits(state) |
The model's size in bits |
log_line(record_or_resolution) |
One canonical experience-log line |
License
MIT. Named after John Gittins, whose index (1974) established that exploration has a precise, computable value.
Release files for gittins 1.0.4
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| gittins-1.0.4.tar.gz | 51.7 kB | Details |
Built distributions (wheels)
| File | Reset | |||
|---|---|---|---|---|
| gittins-1.0.4-cp310-abi3-win_amd64.whl | CPython 3.10 | abi3 | Windows x86-64 | Details |
| gittins-1.0.4-cp310-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl | CPython 3.10 | abi3 | Linux glibc 2.17+ x86-64 | Details |
| gittins-1.0.4-cp310-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl | CPython 3.10 | abi3 | Linux glibc 2.17+ ARM64 | Details |
| gittins-1.0.4-cp310-abi3-macosx_11_0_arm64.whl | CPython 3.10 | abi3 | macOS 11.0+ ARM64 | Details |
| gittins-1.0.4-cp310-abi3-macosx_10_12_x86_64.whl | CPython 3.10 | abi3 | macOS 10.12+ x86-64 | Details |
Total release size: 1.4 MB
Release files / gittins-1.0.4.tar.gz
| Download URL | gittins-1.0.4.tar.gz |
|---|---|
| Size | 51.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
1e7a65207a63da6680f14f9a9ac944ee530b836195aa656e1117c242b0c694c7
|
|
BLAKE2b-256 checksum How to use checksums |
585910c9858472ab0b50d784fa4493dcff125c67f054f02823aacdd0ef8b6845
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Aug 10, 2026.
Transparency logRelease files / gittins-1.0.4-cp310-abi3-win_amd64.whl
| Download URL | gittins-1.0.4-cp310-abi3-win_amd64.whl |
|---|---|
| Size | 177.3 kB |
| Tags | CPython 3.10 Windows x86-64 abi3 |
|
SHA-256 checksum How to use checksums |
efa19da08067344648b0947e5d990f8b3b51c9a801d2abcdea0256b8cc1bc04c
|
|
BLAKE2b-256 checksum How to use checksums |
a4459ad9b24d42220a9800d233aa89908e931794a5afac231e6f11e8574ce708
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Aug 10, 2026.
Transparency logRelease files / gittins-1.0.4-cp310-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
| Download URL | gittins-1.0.4-cp310-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl |
|---|---|
| Size | 322.3 kB |
| Tags | CPython 3.10 Linux glibc 2.17+ x86-64 abi3 |
|
SHA-256 checksum How to use checksums |
0a8af601a97dd00f8d68f9df4481fddbd0c8d7c41747ae383b52007df93bff3c
|
|
BLAKE2b-256 checksum How to use checksums |
c90cad0c48956694ba6a13f3d87fe9c6bbca7f55075565d5f63a998d054543c4
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Aug 10, 2026.
Transparency logRelease files / gittins-1.0.4-cp310-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl
| Download URL | gittins-1.0.4-cp310-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl |
|---|---|
| Size | 316.6 kB |
| Tags | CPython 3.10 Linux glibc 2.17+ ARM64 abi3 |
|
SHA-256 checksum How to use checksums |
70b95feac1bf2253fb7ae6d3231c543624978bd8ee4cb7b638fdd96c1780af7c
|
|
BLAKE2b-256 checksum How to use checksums |
4ee5eb7d60afbbecf0b5854e9c972f6a631b70173bf419d9d531ce31e663aa6a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Aug 10, 2026.
Transparency logRelease files / gittins-1.0.4-cp310-abi3-macosx_11_0_arm64.whl
| Download URL | gittins-1.0.4-cp310-abi3-macosx_11_0_arm64.whl |
|---|---|
| Size | 285.4 kB |
| Tags | CPython 3.10 abi3 macOS 11.0+ ARM64 |
|
SHA-256 checksum How to use checksums |
eab5938966f547262ed003a61b15d5ef88d7f042a0193ed8305d42259f75785d
|
|
BLAKE2b-256 checksum How to use checksums |
43fd03086dc2e7ba345cd28c0ef502b1107da1dcfedbb7ecdcd8e3f53f0759b2
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Aug 10, 2026.
Transparency logRelease files / gittins-1.0.4-cp310-abi3-macosx_10_12_x86_64.whl
| Download URL | gittins-1.0.4-cp310-abi3-macosx_10_12_x86_64.whl |
|---|---|
| Size | 285.0 kB |
| Tags | CPython 3.10 abi3 macOS 10.12+ x86-64 |
|
SHA-256 checksum How to use checksums |
4cc28112ac3ac11c82f9fcfd6da2666a419b69b8a600304d93963285b25f2387
|
|
BLAKE2b-256 checksum How to use checksums |
a1b2302f6f7a6b7a7292496ec9103178c980e4298a219bbd8563cfdb33368b2c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Aug 10, 2026.
Transparency log