From 00b1ea16d8cfc37a542f10b68a2dc5e06118f6d0 Mon Sep 17 00:00:00 2001 From: enerrio Date: Mon, 3 Jul 2023 12:29:45 -0700 Subject: [PATCH 1/3] add installation instructions --- docs/content/basic_usage.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/docs/content/basic_usage.md b/docs/content/basic_usage.md index 8a0ed0ff..6d5dc903 100644 --- a/docs/content/basic_usage.md +++ b/docs/content/basic_usage.md @@ -7,6 +7,18 @@ 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 . +``` + ## Create Minari Dataset ### Collecting Data From 4073912c12ac9f4b6b011d6ece390e483cd8914c Mon Sep 17 00:00:00 2001 From: enerrio Date: Mon, 3 Jul 2023 12:44:36 -0700 Subject: [PATCH 2/3] add instructions for building docs --- docs/README.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/docs/README.md b/docs/README.md index ca33fb83..e795b12a 100644 --- a/docs/README.md +++ b/docs/README.md @@ -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 +``` From 63f2fa4c487b81fc92a2877f7b0ca65393e760db Mon Sep 17 00:00:00 2001 From: enerrio Date: Mon, 3 Jul 2023 13:46:01 -0700 Subject: [PATCH 3/3] add supported python versions and OS --- docs/content/basic_usage.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/content/basic_usage.md b/docs/content/basic_usage.md index 6d5dc903..ade5360c 100644 --- a/docs/content/basic_usage.md +++ b/docs/content/basic_usage.md @@ -19,6 +19,8 @@ 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