Skip to main content

Muti-agent gymnasium gridworld environments

Project description

gym-multigrid

This repo is intended to be a lightweight, multi-agent, gridworld environment. It was originally based on this multigrid environment, but has since been heavily modified and developed beyond the scope of the original environment. Please cite this respository as well as the original repository if you use this environment in any of your projects:

@misc{multigrid,
  title = {Tran Research Group Gridworld Environment},
  year = {2023},
  publisher = {GitHub},
  journal = {GitHub repository},
  howpublished = {\url{https://github.com/Tran-Research-Group/trg-multigrid}},
}

Getting started

To modify or contribute to this project, install gym-multigrid from source. This repo uses poetry library dependency management. To install the dependencies for this project run:

git clone https://github.com/Tran-Research-Group/gym-multigrid.git
cd gym-multigrid
poetry install

Included environments

Capture-the-Flag (CtF)

Collect Game

Collect Game Respawn

Attribute Description
Action Space Discrete(4)
Observation Space np.array of shape grid.width x grid.height
Observation Encoding (OBJECT_IDX, COLOR_IDX, STATE)
Reward (0, 1)
Number of Agents 2
Termination Condition None
Truncation Steps 50
Creation gymnasium.make("multigrid-collect-respawn-clustered-v0")

Agents move around the grid to collect objects. The object respawns in a random location after being collected.

Maze

Wildfire

Extending multigrid

Please see this guide for creating a custom multigrid environment. See CONTRIBUTING.md for our code guidelines if you are interested in adding your environment to this repo.

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

gym_multigrid-1.0.0.tar.gz (32.8 kB view details)

Uploaded Source

Built Distribution

gym_multigrid-1.0.0-py3-none-any.whl (40.8 kB view details)

Uploaded Python 3

File details

Details for the file gym_multigrid-1.0.0.tar.gz.

File metadata

  • Download URL: gym_multigrid-1.0.0.tar.gz
  • Upload date:
  • Size: 32.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.8.18 Darwin/22.6.0

File hashes

Hashes for gym_multigrid-1.0.0.tar.gz
Algorithm Hash digest
SHA256 dcd0e5889f362e23d53646024d264d0526f5f4da2151839c36f8542656ad4784
MD5 0cc92bc969f0d8922375669e78579ebf
BLAKE2b-256 2159ea0d6c2d1f15776d5837ba7411cab0ce6ae6c72f45a237f8c36f838917a3

See more details on using hashes here.

File details

Details for the file gym_multigrid-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: gym_multigrid-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 40.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.8.18 Darwin/22.6.0

File hashes

Hashes for gym_multigrid-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f2b6d7371edd65460db7fd76efd872f0656c8fe0b4422d4663ff0ece22557f5f
MD5 9bca675cc79120243c6a1707cdedb690
BLAKE2b-256 fee3c99c89521c918d647911d83303e3ad5d21db59db9807265621288e28010d

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page