Skip to main content

Minimalistic gridworld reinforcement learning environments

Project description

MiniGrid (formerly gym-minigrid)

pre-commit Code style: black

There are other gridworld Gym environments out there, but this one is designed to be particularly simple, lightweight and fast. The code has very few dependencies, making it less likely to break or fail to install. It loads no external sprites/textures, and it can run at up to 5000 FPS on a Core i7 laptop, which means you can run your experiments faster. A known-working RL implementation can be found in this repository.

Requirements:

  • Python 3.7 to 3.10
  • OpenAI Gym v0.26
  • NumPy 1.18+
  • Matplotlib (optional, only needed for display) - 3.0+

Please use this bibtex if you want to cite this repository in your publications:

@misc{gym_minigrid,
  author = {Chevalier-Boisvert, Maxime and Willems, Lucas and Pal, Suman},
  title = {Minimalistic Gridworld Environment for OpenAI Gym},
  year = {2018},
  publisher = {GitHub},
  journal = {GitHub repository},
  howpublished = {\url{https://github.com/maximecb/gym-minigrid}},
}

List of publications & submissions using MiniGrid or BabyAI (please open a pull request to add missing entries):

This environment has been built as part of work done at Mila. The Dynamic obstacles environment has been added as part of work done at IAS in TU Darmstadt and the University of Genoa for mobile robot navigation with dynamic obstacles.

Installation

There is now a pip package available, which is updated periodically:

pip3 install gym-minigrid

Alternatively, to get the latest version of MiniGrid, you can clone this repository and install the dependencies with pip3:

git clone https://github.com/maximecb/gym-minigrid.git
cd gym-minigrid
pip3 install -e .

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_minigrid-1.2.1.tar.gz (56.0 kB view details)

Uploaded Source

Built Distribution

gym_minigrid-1.2.1-py3-none-any.whl (70.3 kB view details)

Uploaded Python 3

File details

Details for the file gym_minigrid-1.2.1.tar.gz.

File metadata

  • Download URL: gym_minigrid-1.2.1.tar.gz
  • Upload date:
  • Size: 56.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.14

File hashes

Hashes for gym_minigrid-1.2.1.tar.gz
Algorithm Hash digest
SHA256 f713f8372e48a601383988102d06e99ad61e6f7c46bab41413d6c0ad259f37d8
MD5 df1faf87105ed947c512c4d2e66ce79c
BLAKE2b-256 53f36919948d435b08686f4c1e9dd341a16b44d0a9402c5df85d4ecb3256faa6

See more details on using hashes here.

File details

Details for the file gym_minigrid-1.2.1-py3-none-any.whl.

File metadata

  • Download URL: gym_minigrid-1.2.1-py3-none-any.whl
  • Upload date:
  • Size: 70.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.14

File hashes

Hashes for gym_minigrid-1.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 997fe46110c487e07687959cd2eb77dc46b4a2617213ec024aafab8cf50df147
MD5 3bf973b9a8b3654fcc67f99b7c54e4f6
BLAKE2b-256 81da25a7b39d690029ef33fe92933f7436c621ed24f1d1b62f364c49d5be6e7c

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