Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update documentation #105

Merged
merged 3 commits into from
Jul 3, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,28 @@
This folder contains the documentation for Minari.

For more information about how to contribute to the documentation go to our [CONTRIBUTING.md](https://github.com/Farama-Foundation/Celshast/blob/main/CONTRIBUTING.md)

## Build the Documentation

Install the required packages and Minari:

```bash
git clone https://github.com/Farama-Foundation/Minari.git
cd Minari
pip install -e .
pip install -r docs/requirements.txt
```

To build the documentation once:

```bash
cd docs
make dirhtml
```

To rebuild the documentation automatically every time a change is made:

```bash
cd docs
sphinx-autobuild -b dirhtml . _build
```
14 changes: 14 additions & 0 deletions docs/content/basic_usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,20 @@ title: Basic Usage

Minari is a standard dataset hosting interface for Offline Reinforcement Learning applications. Minari is compatible with most of the RL environments that follow the Gymnasium API and facilitates Offline RL dataset handling by providing data collection, dataset hosting, and dataset sampling capabilities.

## Installation

To install the most recent version of the Minari library run this command: `pip install minari`

The beta release is currently under development. If you'd like to start testing or contribute to Minari then please install this project from source with:

```bash
git clone https://github.com/Farama-Foundation/Minari.git
cd Minari
pip install -e .
```

We support Python 3.7, 3.8, 3.9, 3.10 and 3.11 on Linux and macOS.

## Create Minari Dataset

### Collecting Data
Expand Down