Skip to main content

Minimalistic gridworld reinforcement learning environments

Project description

Minimalistic Gridworld Environment (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.22 to v0.25
  • 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 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/farama-foundation/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

minigrid-1.1.1.tar.gz (51.2 kB view details)

Uploaded Source

Built Distribution

minigrid-1.1.1-py3-none-any.whl (57.0 kB view details)

Uploaded Python 3

File details

Details for the file minigrid-1.1.1.tar.gz.

File metadata

  • Download URL: minigrid-1.1.1.tar.gz
  • Upload date:
  • Size: 51.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.12

File hashes

Hashes for minigrid-1.1.1.tar.gz
Algorithm Hash digest
SHA256 91295a8b4a3dc688e4a0370d767b62dc3a75568e5ed311a41eac63dd2c6998f3
MD5 14e1a868c3443faabacfe5496c28fe91
BLAKE2b-256 15b83cc4021cca119d722105c100ab978ba8b5909e2f884ce8e38d8abe1d0582

See more details on using hashes here.

File details

Details for the file minigrid-1.1.1-py3-none-any.whl.

File metadata

  • Download URL: minigrid-1.1.1-py3-none-any.whl
  • Upload date:
  • Size: 57.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.12

File hashes

Hashes for minigrid-1.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 09979c85a0187f880ffbea04d814d378769d644099f899aa548cbe0281f1afab
MD5 cc34cd761da6e6c94089ba3a18221d70
BLAKE2b-256 760cb757d060c03a828df27c7eeb72893c6a6c83df85ead44ce62cb62cb51ed1

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