ABM package in JAX.
Project description
Abmax is a general-purpose agent-based modeling(ABM) framework in Jax It provides:
- Two algorithms to apply unique updates to a dynamic number of agents selected during run-time. Both are JIT friendly and can be vectorized across different number of models
- Rank-Match (RM)
- Sort-Count-Iterate (SCI)
- JAX-transformation-friendly data structures and functions that can be used to define sets of agents and their manipulations.
- Selecting agents based on a run-time determined key.
- Searching and sorting agents based on their attributes.
- Updating an arbitrary number of agents to a specific state.
- Stepping agents in a vectorized way.
- Running multiple such simulations in parallel.
- Implementation of common algorithms used in ABM implemented in vmap and jit friendly way.
Installation
pip install abmax
Dependencies:
Benchmark
A comparison of the performance of Abmax with other ABM frameworks: Agents.jl and Mesa based on the Wolf-Sheep (Grid space) and Bird-Flock (Continuous space) models. These simulations are run for 100 steps and the median time taken for 10 runs is logged in ms. The benchmark is run on a gcn GPU node(Intel Xeon Platinum 8360Y + Nvidia A100) of the Snelius cluster The number of initial agents for these simulations are as follows:
- Wolf-Sheep small: 600 sheep, 400 wolves on a 100 x 100 grid
- Wolf-Sheep large: 6000 sheep, 4000 wolves on a 1000 x 1000 grid
| Model | Agents.jl | Abmax RM | Abmax SCI | Mesa |
|---|---|---|---|---|
| Wolf-Sheep small | 14.93 | 50.26 | 726.78 | 1333.047 |
| Wolf-Sheep large | 685.03 | 3315.88 | 5455.01 | 170070.95 |
In Abmax, we can run multiple simulations in parallel because of automatic batching and vectorization. Here is a trend in running different numbers of wolf-sheep small models in parallel.
| Number of models | 10 | 20 | 50 | 100 | 200 | 500 |
|---|---|---|---|---|---|---|
| time taken (s) | 5.75 | 6.81 | 7.32 | 8.52 | 8.617 | 14.32 |
Note: All times that are reported, are excluding the model setup time.
Tutorial
A basic tutorial on how to use Abmax is available here[Outdated]
Citation
If you use Abmax in your work, please consider citing it as follows:
@misc{chaturvedi2025abmax,
title={Abmax: A JAX-based Agent-based Modeling Framework},
author={Siddharth Chaturvedi and Ahmed El-Gazzar and Marcel van Gerven},
year={2025},
eprint={2508.16508},
archivePrefix={arXiv},
primaryClass={cs.MA}
}
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
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file abmax-0.0.3.tar.gz.
File metadata
- Download URL: abmax-0.0.3.tar.gz
- Upload date:
- Size: 17.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.0.1 CPython/3.10.10
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
8a9305f647c123115b685d148c885e5e3d92ea5b0995427179dec31e423b1771
|
|
| MD5 |
2e952c35d0c022fb4eb05e14674cff5d
|
|
| BLAKE2b-256 |
8f26f5834a68b630277239dfef4305ab85c639cea1490b9504dd2b2203d30084
|
File details
Details for the file abmax-0.0.3-py3-none-any.whl.
File metadata
- Download URL: abmax-0.0.3-py3-none-any.whl
- Upload date:
- Size: 25.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.0.1 CPython/3.10.10
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
95d99d3b48d534b65dc63e088d21c26efcd98a63dd473d95a2ab3555814be82f
|
|
| MD5 |
e0c54384b333891712525661892c3082
|
|
| BLAKE2b-256 |
8c82e248739c35011a864653ca7a19edd8186c37174493bf08a7095bc69b7c22
|