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

Uploaded Source

Built Distribution

gym_minigrid-1.1.0-py3-none-any.whl (57.4 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for gym_minigrid-1.1.0.tar.gz
Algorithm Hash digest
SHA256 3971e1d8c306b8da5ef588707fea2e0eb16a7570a6089ec7b5c758dec4224ea9
MD5 4213fe140791006dafb1b1bb12cc1458
BLAKE2b-256 1201a9b735ca3b6ab12a9f899ea9c64cd88e06c095d1e1cef2af6879617455df

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for gym_minigrid-1.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d00d632eafd686d022c7c05ade57b1206eb2eef7592e3ae8d2f922deada27b0e
MD5 109ff379a41aa6ecb6eb133ce565ae50
BLAKE2b-256 ca23df0d18c24dc5758c34570918edeb8abdee1cecddf57451a599bc9da00055

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