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.1.tar.gz (29.4 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.1-py3-none-any.whl (30.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: minari-0.3.1.tar.gz
  • Upload date:
  • Size: 29.4 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.1.tar.gz
Algorithm Hash digest
SHA256 b838dd96a2780abc87718cf798d950d36b851ed5591a705ff3d770d7d21c36db
MD5 054edcd5357dab921e5b0ea4d3c0bb2a
BLAKE2b-256 6a7a383bea19fe79731bca8b0b2445e42b599a20dc19f89b43903b3d3c5a7037

See more details on using hashes here.

File details

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

File metadata

  • Download URL: minari-0.3.1-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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 27f09cbfa24a7acd4b7d280317235f1ed43bd28fa0d55122a4d673d9a0b36c20
MD5 9f62ff84d4c15fdf962b43be82afea8a
BLAKE2b-256 0b5ef1c9f95eda38ef38371cf10299d68e186110e3108e986e5045767de024e9

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