Skip to main content

Minimalistic gridworld reinforcement learning environments

Project description

MiniGrid (formerly gym-minigrid)

pre-commit Code style: black

There are other gridworld Gymnasium 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
  • Gymnasium 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{minigrid,
  author = {Chevalier-Boisvert, Maxime and Willems, Lucas and Pal, Suman},
  title = {Minimalistic Gridworld Environment for Gymnasium},
  year = {2018},
  publisher = {GitHub},
  journal = {GitHub repository},
  howpublished = {\url{https://github.com/Farama-Foundation/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:

pip 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/MiniGrid
cd MiniGrid
pip 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-2.0.0.tar.gz (59.5 kB view details)

Uploaded Source

Built Distribution

MiniGrid-2.0.0-py3-none-any.whl (78.8 kB view details)

Uploaded Python 3

File details

Details for the file MiniGrid-2.0.0.tar.gz.

File metadata

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

File hashes

Hashes for MiniGrid-2.0.0.tar.gz
Algorithm Hash digest
SHA256 a42495648eb6904e5bb70d566c2414f859866edb224c0d7f20ab9c090a110785
MD5 809d92603d902652b8ff27f0f819f5a1
BLAKE2b-256 9ed373e032da9b07bd81ef93f745f010c3165c855dc62fc2a763b3654590ed66

See more details on using hashes here.

File details

Details for the file MiniGrid-2.0.0-py3-none-any.whl.

File metadata

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

File hashes

Hashes for MiniGrid-2.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c10e10ffe4bb771960dc3b6ce623b2aa7bdf574e363bf58280dfa27268861e22
MD5 1168b31361b299ea18621dde86fbade7
BLAKE2b-256 9876612842099d5a5e1afbc653b4f778520437ada9cbdce82f048dc1a3d9f8ec

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