Skip to main content

Minimalistic 3D interior environment simulator for reinforcement learning & robotics research.

Project description

Miniworld (formerly gym-miniworld) is currently under development to be made compliant with the standards of the Farama Foundation (https://farama.org/project_standards), and when complete this will be maintained long term.

Build Status

Contents:

Introduction

MiniWorld is a minimalistic 3D interior environment simulator for reinforcement learning & robotics research. It can be used to simulate environments with rooms, doors, hallways and various objects (eg: office and home environments, mazes). MiniWorld can be seen as a simpler alternative to VizDoom or DMLab. It is written 100% in Python and designed to be easily modified or extended by students.

Figure of Maze environment from top view Figure of Sidewalk environment Figure of Collect Health environment

Features:

  • Few dependencies, less likely to break, easy to install
  • Easy to create your own levels, or modify existing ones
  • Good performance, high frame rate, support for multiple processes
  • Lightweight, small download, low memory requirements
  • Provided under a permissive MIT license
  • Comes with a variety of free 3D models and textures
  • Fully observable top-down/overhead view available
  • Domain randomization support, for sim-to-real transfer
  • Ability to display alphanumeric strings on walls
  • Ability to produce depth maps matching camera images (RGB-D)

Limitations:

  • Graphics are basic, nowhere near photorealism
  • Physics are very basic, not sufficient for robot arms or manipulation

Please use this bibtex if you want to cite this repository in your publications:

@misc{gym_miniworld,
  author = {Chevalier-Boisvert, Maxime},
  title = {MiniWorld: Minimalistic 3D Environment for RL & Robotics Research},
  year = {2018},
  publisher = {GitHub},
  journal = {GitHub repository},
  howpublished = {\url{https://github.com/maximecb/gym-miniworld}},
}

List of publications & submissions using MiniWorld (please open a pull request to add missing entries):

This simulator was created as part of work done at Mila.

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

miniworld-2.0.0.tar.gz (38.7 MB view details)

Uploaded Source

Built Distribution

miniworld-2.0.0-py3-none-any.whl (39.4 MB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: miniworld-2.0.0.tar.gz
  • Upload date:
  • Size: 38.7 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.11.2

File hashes

Hashes for miniworld-2.0.0.tar.gz
Algorithm Hash digest
SHA256 4cf8e7bec00db9936808c4b35453d6ec0dcfed25e0283e1edbbf6012111c61f5
MD5 21e9ec7fbf08e942a83d82cc28ef066d
BLAKE2b-256 947bf5ade6af01328701a82cd4dd1039090739d23b3d80b05a0a54eb25516e21

See more details on using hashes here.

File details

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

File metadata

  • Download URL: miniworld-2.0.0-py3-none-any.whl
  • Upload date:
  • Size: 39.4 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.11.2

File hashes

Hashes for miniworld-2.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d2d0a8722b4495f9de75846651668751ba17e5f15169d93ee78fd14dea66c38d
MD5 767c421a3fc78e2454b9275c00f7e333
BLAKE2b-256 5f442b5aab45aa377e3dfdbfa37ac334a1aefe00fa0202a6fae0cc1d5de10854

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