Skip to content

Commit

Permalink
Merge pull request #84 from BolunDai0216/master
Browse files Browse the repository at this point in the history
added an introduction to miniworld in the homepage
  • Loading branch information
pseudo-rnd-thoughts authored Feb 14, 2023
2 parents f594b29 + 15d8adc commit bd2ffb5
Showing 1 changed file with 12 additions and 2 deletions.
14 changes: 12 additions & 2 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,15 +31,25 @@ Contribute to the Docs <https://github.com/Farama-Foundation/Miniworld/tree/mast
```

# Miniworld
# Miniworld is a minimalistic 3D interior environment simulator for reinforcement learning & robotics research


```{figure} _static/img/miniworld_homepage.gif
:width: 400px
:alt: Sequence of observations from Collect Health environment
```

**The Gymnasium interface allows to initialize and interact with the Miniworld default environments as follows:**
MiniWorld allows environments to be easily edited like Minigrid meets DM Lab. It can simulate environments with rooms, doors, hallways, and various objects (e.g., office and home environments, mazes).

## Installation

```python
pip install miniworld
```

## Usage

The Gymnasium interface allows to initialize and interact with the Miniworld default environments as follows:

```python
import gymnasium as gym
Expand Down

0 comments on commit bd2ffb5

Please sign in to comment.