Skip to main content

A library for creating multi-agent grid-world environments for reinforcement learning.

Project description

PyPI version Python License Coverage

CoGrid Logo

CoGrid is a library for creating multi-agent grid-world environments for reinforcement learning research. It features a functional array-based simulation core, pluggable components (rewards, features, objects), and dual NumPy/JAX backend support.

CoGrid utilizes the parallel PettingZoo API to standardize the multi-agent environment interface. The JAX API is similar to that of JaxMARL.

CoGrid is designed to offer an approachable API for environment customization, compatibility with standard tooling, and pre-build benchmark environments. Full documentation is available at cogrid.readthedocs.io.

OvercookedV2 Layouts

Installation

Install from PyPI:

pip install cogrid

To install with JAX backend support:

pip install cogrid[jax]

For development (includes test, lint, and docs tools):

pip install cogrid[dev]

[!IMPORTANT] CoGrid has gone through a major overhaul and the API has changed significantly. If you need the previous version, you can install it with pip install cogrid==0.0.16.

Citation

If you use CoGrid in your research, please cite the following paper:

@article{mcdonald2026cogrid,
  title={CoGrid \& the Multi-User Gymnasium: A Framework for Multi-Agent Experimentation},
  author={McDonald, Chase and Gonzalez, Cleotilde},
  journal={arXiv preprint arXiv:2604.15044},
  year={2026}
}

Acknowledgements

This work builds on the invaluable efforts of many others:

@article{carroll2019utility,
  title={On the utility of learning about humans for human-ai coordination},
  author={Carroll, Micah and Shah, Rohin and Ho, Mark K and Griffiths, Tom and Seshia, Sanjit and Abbeel, Pieter and Dragan, Anca},
  journal={Advances in neural information processing systems},
  volume={32},
  year={2019}
}

@article{rutherford2024jaxmarl,
  title={Jaxmarl: Multi-agent rl environments and algorithms in jax},
  author={Rutherford, Alexander and Ellis, Benjamin and Gallici, Matteo and Cook, Jonathan and Lupu, Andrei and Ingvarsson, Gar{\dh}ar and Willi, Timon and Hammond, Ravi and Khan, Akbir and de Witt, Christian S and others},
  journal={Advances in Neural Information Processing Systems},
  volume={37},
  pages={50925--50951},
  year={2024}
}


@article{gessler2025overcookedv2,
  title={Overcookedv2: Rethinking overcooked for zero-shot coordination},
  author={Gessler, Tobias and Dizdarevic, Tin and Calinescu, Ani and Ellis, Benjamin and Lupu, Andrei and Foerster, Jakob Nicolaus},
  journal={arXiv preprint arXiv:2503.17821},
  year={2025}
}

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

cogrid-0.3.0.tar.gz (186.0 kB view details)

Uploaded Source

Built Distribution

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

cogrid-0.3.0-py3-none-any.whl (214.6 kB view details)

Uploaded Python 3

File details

Details for the file cogrid-0.3.0.tar.gz.

File metadata

  • Download URL: cogrid-0.3.0.tar.gz
  • Upload date:
  • Size: 186.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.14

File hashes

Hashes for cogrid-0.3.0.tar.gz
Algorithm Hash digest
SHA256 4cd06d0e20cdde5143398dfc66477adc169975555eee73a8027c0aa5cffa10b5
MD5 cd7e0a98565982534a52eddf493f0273
BLAKE2b-256 60b849898bd2383d92d5dbd3e4dcad68f74246ffc970836f0769fa628ccd60e1

See more details on using hashes here.

File details

Details for the file cogrid-0.3.0-py3-none-any.whl.

File metadata

  • Download URL: cogrid-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 214.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.14

File hashes

Hashes for cogrid-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 037bf38b62ac74cc3ad44d9cfb0ffdfd0c4523f0f81e19cba0fac738bc833252
MD5 0fc89d1c8e80244c3c9efd56137ba294
BLAKE2b-256 18514aacaa25a402bbb8fd13b28e2f54f3a48a669de6c202f1af4ca33f1ad3d0

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