Counterfactual Regret Minimization in Jax
Reason this release was yanked:
wrong python requirements
Project description
cfrx: Counterfactual Regret Minimization in Jax.
cfrx is an open-source library designed for efficient implementation of counterfactual regret minimization (CFR) algorithms using JAX. It focuses on computational speed and easy parallelization on hardware accelerators like GPUs and TPUs.
Key Features:
-
JIT Compilation for Speed: cfrx makes the most out of JAX's just-in-time (JIT) compilation to minimize runtime overhead and maximize computational speed.
-
Hardware Accelerator Support: It supports parallelization on GPUs and TPUs, enabling efficient scaling of computations for large-scale problems.
-
Python/JAX Ease of Use: cfrx provides a Pythonic interface built on JAX, offering simplicity and accessibility compared to traditional C++ implementations or prohibitively slow pure-Python code.
Installation
pip install cfrx
Getting started
An example notebook is available here.
Snippet for training a MCCFR-outcome sampling on the Kuhn Poker game.
import jax
from cfrx.envs.kuhn_poker.env import KuhnPoker
from cfrx.policy import TabularPolicy
from cfrx.trainers.mccfr import MCCFRTrainer
env = KuhnPoker()
policy = TabularPolicy(
n_actions=env.n_actions,
exploration_factor=0.6,
info_state_idx_fn=env.info_state_idx,
)
random_key = jax.random.PRNGKey(0)
trainer = MCCFRTrainer(env=env, policy=policy)
training_state = trainer.train(
random_key=random_key, n_iterations=100_000, metrics_period=5_000
)
Implemented features and upcoming features
Algorithms | |
---|---|
MCCFR (outcome-sampling) | :white_check_mark: |
MCCFR (other variants) | :x: |
Vanilla CFR | :x: |
Deep CFR | :x: |
Metrics | |
---|---|
Exploitability | :white_check_mark: |
Local Best Response | :x: |
Environments | |
---|---|
Kuhn Poker | :white_check_mark: |
Leduc Poker | :white_check_mark: |
Larger games | :x: |
Performance
Below is a small benchmark against open_spiel
for MCCFR-outcome-sampling on Kuhn Poker and Leduc Poker. Compared to the Python API of open_spiel
, cfrx
has faster runtime and demonstrates similar convergence.
See also
cfrx is heavily inspired by the amazing google-deepmind/open_spiel library as well as by many projects from the Jax ecosystem and especially sotetsuk/pgx and google-deepmind/mctx.
Contributing
Contributions are welcome, refer to the contributions guidelines.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file cfrx-0.0.1.tar.gz
.
File metadata
- Download URL: cfrx-0.0.1.tar.gz
- Upload date:
- Size: 29.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.0.0 CPython/3.10.13
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7e394d536029a9089cce3ad0a929ffdaa3cef0aeb3c83736821fbba90015e89a |
|
MD5 | 6a6c4f424e7e092dd88d5e2880fdf7a5 |
|
BLAKE2b-256 | 9c3608595054d1efb1e279f5c7f7d64f054b8c3284931b2ca968f769ff1bff5d |
File details
Details for the file cfrx-0.0.1-py3-none-any.whl
.
File metadata
- Download URL: cfrx-0.0.1-py3-none-any.whl
- Upload date:
- Size: 33.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.0.0 CPython/3.10.13
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9f80de8cf903d91683e464b4438d8796efe52c427cc5eab08813e35c8ee1f26f |
|
MD5 | 2aad799fa18e8a8c7cd23752d0a27d9b |
|
BLAKE2b-256 | c8103eefdb43972fe9cba68028ee2c291e50a44e4b10bafbd766688d2925d447 |