Skip to content

Commit

Permalink
updated homepage
Browse files Browse the repository at this point in the history
  • Loading branch information
BolunDai0216 committed Feb 14, 2023
1 parent a46662e commit 15d8adc
Showing 1 changed file with 10 additions and 2 deletions.
12 changes: 10 additions & 2 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,15 +31,23 @@ 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
```

MiniWorld is a minimalistic 3D interior environment simulator for reinforcement learning & robotics research that 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).
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:

Expand Down

0 comments on commit 15d8adc

Please sign in to comment.