Skip to main content

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 .

Metadata

Release files for gym-minigrid 1.2.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for gym-minigrid 1.2.2
File Size Uploaded Provenance Actions
gym_minigrid-1.2.2.tar.gz 56.3 kB Without provenance Details for gym_minigrid-1.2.2.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for gym-minigrid 1.2.2
File Interpreter ABI Platform Actions
gym_minigrid-1.2.2-py3-none-any.whl Python 3 none any Details for gym_minigrid-1.2.2-py3-none-any.whl

Total release size: 126.8 kB

Release files / gym_minigrid-1.2.2.tar.gz

Download URL gym_minigrid-1.2.2.tar.gz
Size 56.3 kB
Tags Source
SHA-256 checksum
How to use checksums
99b74fc191cabd17f212cc34da23dda0e850456dbd335da462ed9369939dfcfe
BLAKE2b-256 checksum
How to use checksums
6823501d0433991f580c8bf66fb15fb6ad57d87a152d1e8e0ebec8c383c0db38
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.1 CPython/3.9.14

Release files / gym_minigrid-1.2.2-py3-none-any.whl

Download URL gym_minigrid-1.2.2-py3-none-any.whl
Size 70.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
89363d7afb0aaa5fa1fd7bba0cdf7d8a5482233b0b963fa5ed91fa88559133ae
BLAKE2b-256 checksum
How to use checksums
3e4bb1b32a0bdd125ebe8869eb33dce64fbe63e1568bdcc677fe67ff21353d22
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.1 CPython/3.9.14

Security for gym-minigrid 1.2.2

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page