Metadata-Version: 2.1
Name: room-env
Version: 3.0.1
Summary: The Room environment
Home-page: https://github.com/humemai/room-env
Author: Taewoon Kim
Author-email: info@humem.ai
Project-URL: Bug Tracker, https://github.com/humemai/room-env/issues
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: gymnasium<1,>=0.27.1
Requires-Dist: torch>=1.12.1
Requires-Dist: PyYAML>=6.0
Requires-Dist: networkx>=3.5
Requires-Dist: tqdm
Requires-Dist: matplotlib
Requires-Dist: Ipython
Requires-Dist: rdflib

# The Room environments (compatible with gymnasium)

[![DOI](https://zenodo.org/badge/614376641.svg)](https://zenodo.org/doi/10.5281/zenodo.10876436)
[![PyPI
version](https://badge.fury.io/py/room-env.svg)](https://badge.fury.io/py/room-env)

<img src="figures/room-layout-xl.png" alt="" style="width: 50%;"/><img src="figures/room-layout-kg-xl.png" alt="" style="width: 50%;"/>

![alt text](figures/dash-graph.png)
At the moment, there are three versions of the Room environments.

[Training agents for these environments are in a separate
repo](https://github.com/humemai/humemai).

## README for each version

- [RoomEnv-v0](./README-v0.md)
- [RoomEnv-v1](./README-v1.md)
- [RoomEnv-v2](./README-v2.md)

## List of academic papers that use the Rooms environments

- ["A Machine With Human-Like Memory Systems"](https://arxiv.org/abs/2204.01611)
- ["A Machine with Short-Term, Episodic, and Semantic Memory
  Systems"](https://arxiv.org/abs/2212.02098)
- ["Leveraging Knowledge Graph-Based Human-Like Memory Systems to Solve Partially Observable Markov Decision Processes"](https://arxiv.org/abs/2408.05861)

## pdoc documentation

Click on [this link](https://humemai.github.io/room-env) to see the HTML rendered
docstrings
