Skip to main content

A standard format for offline reinforcement learning datasets, with popular reference datasets and related utilities.

Project description

Minari is a Python library for conducting research in offline reinforcement learning, akin to an offline version of Gymnasium or an offline RL version of HuggingFace's datasets library. This library is currently in beta.

The documentation website is at minari.farama.org. We also have a public discord server (which we use for Q&A and to coordinate development work) that you can join here: https://discord.gg/bnJ6kubTg6.

Note: Minari was previously developed under the name Kabuki.

Installation

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

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

Getting Started

For an introduction to Minari, see Basic Usage. To create new datasets using Minari, see our Pointmaze D4RL Dataset tutorial, which re-creates the Maze2D datasets from D4RL.

API

To check available remote datasets:

import minari

minari.list_remote_datasets()

To check available local datasets:

import minari

minari.list_local_datasets()

To download a dataset:

import minari

dataset = minari.download_dataset("LunarLander_v2_remote-test-dataset")

Project Maintainers

Main Contributors: Rodrigo Perez-Vicente, Omar Younis

Maintenance for this project is also contributed by the broader Farama team: farama.org/team.


Minari is a shortening of Minarai, the Japanese word for "learning by observation".

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

minari-0.3.0.tar.gz (29.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

minari-0.3.0-py3-none-any.whl (30.6 kB view details)

Uploaded Python 3

File details

Details for the file minari-0.3.0.tar.gz.

File metadata

  • Download URL: minari-0.3.0.tar.gz
  • Upload date:
  • Size: 29.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.11.3

File hashes

Hashes for minari-0.3.0.tar.gz
Algorithm Hash digest
SHA256 117d465f44f4e1c135b59c9063d1ac9a740d99f3ac30ac744befae1b551e35e8
MD5 f0239451dffbf9f5242a0270efc82b61
BLAKE2b-256 fdb1d7f259848a56279dabe1150a9aeb8b0ad9ce92a5905e437308d977c45887

See more details on using hashes here.

File details

Details for the file minari-0.3.0-py3-none-any.whl.

File metadata

  • Download URL: minari-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 30.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.11.3

File hashes

Hashes for minari-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 9de5657e86a63d860d625dc85a3f83423f5bb003a38a42ba105c2ff1d28e262c
MD5 cee13833c13c6022784332bdb988ae44
BLAKE2b-256 1230503198d2e0d6a57e660db8214762ccad8bb210c77267208ddd14ea6cbc2c

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page