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.1.tar.gz (187.2 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.1-py3-none-any.whl (216.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: cogrid-0.3.1.tar.gz
  • Upload date:
  • Size: 187.2 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.1.tar.gz
Algorithm Hash digest
SHA256 1ad0da85160bd960d88546c295b4f372221dfef6ec0489b32a61f07ea1f74dcf
MD5 8d20e65de13344ddf89a73a486ed2691
BLAKE2b-256 1abf49718a0eefa4ab70d8309641558f0789f2d1eae2d7ab4a21aa4d6c49ef9c

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cogrid-0.3.1-py3-none-any.whl
  • Upload date:
  • Size: 216.2 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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 2bfebf537ba033d116a8213c68c3712efc6c48938b81d31eb98d278b7e601385
MD5 0b054f941b8f1327f1f8889e05d08186
BLAKE2b-256 26edd7c788bb3c6a706854cfbfa1533c90c3620a40483b74d1ae3cf51728f83b

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