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.2.tar.gz (56.3 kB view details)

Uploaded Source

Built Distribution

gym_minigrid-1.2.2-py3-none-any.whl (70.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: gym_minigrid-1.2.2.tar.gz
  • Upload date:
  • Size: 56.3 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.2.tar.gz
Algorithm Hash digest
SHA256 99b74fc191cabd17f212cc34da23dda0e850456dbd335da462ed9369939dfcfe
MD5 cea10430fa0523d274fe866a13cef05e
BLAKE2b-256 6823501d0433991f580c8bf66fb15fb6ad57d87a152d1e8e0ebec8c383c0db38

See more details on using hashes here.

File details

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

File metadata

  • Download URL: gym_minigrid-1.2.2-py3-none-any.whl
  • Upload date:
  • Size: 70.5 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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 89363d7afb0aaa5fa1fd7bba0cdf7d8a5482233b0b963fa5ed91fa88559133ae
MD5 959d04776147f56fe38ffd21289dc777
BLAKE2b-256 3e4bb1b32a0bdd125ebe8869eb33dce64fbe63e1568bdcc677fe67ff21353d22

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