Datasets › RoomEnv-v1
RoomEnv-v1 (The Room environment - v1)
The Room environment - v1
We have released a challenging Gymnasium compatible environment. The best strategy for this environment is to have both episodic and semantic memory systems. See the paper for more information.
Prerequisites
- A unix or unix-like x86 machine
- python 3.10 or higher.
- Running in a virtual environment (e.g., conda, virtualenv, etc.) is highly recommended so that you don't mess up with the system python.
- This env is added to the PyPI server. Just run:
pip install room-env
RoomEnv-v1
import gymnasium as gym
env = gym.make("room_env:RoomEnv-v1")
(observation, question), info = env.reset()
rewards = 0
while True:
# There is one different thing in the RoomEnv from the original AAAI-2023 paper:
# The reward is either +1 or -1, instead of +1 or 0.
(observation, question), reward, done, truncated, info = env.step("This is my answer!")
rewards += reward
if done:
break
{
"des_size": "l",
"seed": 42,
"question_prob": 1.0,
"allow_random_human": False,
"allow_random_question": False,
"total_maximum_episode_rewards": 128,
"check_resources": True,
}
If you want to create an env with a different set of parameters, you can do so. For example:
env_params = {"seed": 0,
"allow_random_human": True,
"pretrain_semantic": True}
env = gym.make("room_env:RoomEnv-v1", **env_params)
Take a look at this repo for an actual interaction with this environment to learn a policy.
Data collection
Data is collected from querying ConceptNet APIs. For simplicity, we only collect triples
whose format is (head, atlocation, tail). Here head is one of the 80 MS COCO
dataset categories. This was kept in mind so that later on we can use images as well.
If you want to collect the data manually, then run below:
python collect_data.py
The RoomDes
The DES is part of RoomEnv. You don't have to care about how it works. If you are still curious, you can read below.
You can run the RoomDes by
from room_env.des import RoomDes
des = RoomDes()
des.run(debug=True)
with debug=True it'll print events (i.e., state changes) to the console.
{'resource_changes': {'desk': -1, 'lap': 1},
'state_changes': {'Vincent': {'current_time': 1,
'object_location': {'current': 'desk',
'previous': 'lap'}}}}
{'resource_changes': {}, 'state_changes': {}}
{'resource_changes': {}, 'state_changes': {}}
{'resource_changes': {},
'state_changes': {'Michael': {'current_time': 4,
'object_location': {'current': 'lap',
'previous': 'desk'}},
'Tae': {'current_time': 4,
'object_location': {'current': 'desk',
'previous': 'lap'}}}}
Contributing
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Run
make test && make style && make qualityin the root repo directory, to ensure code quality. - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
Cite our paper
@article{Kim_Cochez_Francois-Lavet_Neerincx_Vossen_2023,
title={A Machine with Short-Term, Episodic, and Semantic Memory Systems}, volume={37},
url={https://ojs.aaai.org/index.php/AAAI/article/view/25075},
DOI={10.1609/aaai.v37i1.25075},
abstractNote={Inspired by the cognitive science theory of the explicit human memory systems, we have modeled an agent with short-term, episodic, and semantic memory systems, each of which is modeled with a knowledge graph. To evaluate this system and analyze the behavior of this agent, we designed and released our own reinforcement learning agent environment, “the Room”, where an agent has to learn how to encode, store, and retrieve memories to maximize its return by answering questions. We show that our deep Q-learning based agent successfully learns whether a short-term memory should be forgotten, or rather be stored in the episodic or semantic memory systems. Our experiments indicate that an agent with human-like memory systems can outperform an agent without this memory structure in the environment.},
number={1},
journal={Proceedings of the AAAI Conference on Artificial Intelligence}, author={Kim, Taewoon and Cochez, Michael and Francois-Lavet, Vincent and Neerincx, Mark and Vossen, Piek},
year={2023},
month={Jun.},
pages={48-56}
}
Authors
License
Benchmarks archive 2025-07-28
All 1 leaderboard whose dataset resolves to this page shown (sort by any header). "First row" is the archive's own first row at snapshot, in the archive's row order; nothing here re-ranks and metric direction is not asserted.
| First row (archive order) | Paper | Code | ||||
|---|---|---|---|---|---|---|
| RoomEnv-v1 | RoomEnv-v1 | HumemAI-v0-capacity=32-semantic-pretrained final agent reward 116.5 | A Machine with Short-Term, Episodic, and Semantic Memory Systems | humemai/agent-room-env-v1 | 2 | Compare |
Papers archive 2025-07-28
papers with a benchmark row: 1 · with a code link: 1 · where Syntology ran a sample: 1 (1 with a run with no instrument failure, 0 where every run was a failure of Syntology's instrument) Syntology
Show: all papers with a benchmark rowonly where code ran (1 of 1 with a benchmark row: 1 with a run with no instrument failure, 0 where every run was a failure of Syntology's instrument)
Page 1 of 1: paper 1 of 1 with a leaderboard row on this dataset's benchmarks, newest first by the archive's date (ties by slug; undated papers last).
The archive's own "papers using this dataset" list was never published, so this is the benchmark-backed subset, not that list; the archive's count for this dataset is 1. The Syntology column is from Syntology's graph, stated per sample; it is not part of any archive number. A line reads “N ran (of which C constructed an object rather than computing a result; K with no instrument failure: H honoured, V violated, P with no contract checked; I where Syntology's instrument failed) · U unverified” (C is a part of N, never taken away from it); the figure “where Syntology's instrument failed” counts failures of Syntology's instrument, not of the code. “Ran” means the sample executed on a synthesized fixture, not that the paper's result was reproduced. When the archive marks a repository official for the paper, the cell starts with that repository's state (the archive's flag, not a verdict on who wrote the code; “community repositories only” when every sample that ran came from a community repository, “official: no sample here; runs from other or unrecorded repositories” when some came from a repository the paper names or has in its text, or from none recorded); hover it for the repositories the samples that ran came from. Syntology's record for this page last changed ; when this build read Syntology's graph is in the build record.
| Paper | Code | Results | Date | Samples run Syntology |
|---|---|---|---|---|
| A Machine with Short-Term, Episodic, and Semantic Memory Systems | 1 | 2 | 5 Dec 2022 | official (archive's flag): 6 ran · 6 ran (of which 0 constructed an object rather than computing a result; 6 with no instrument failure: 0 honoured, 0 violated, 6 with no contract checked; 0 where Syntology's instrument failed) · 4 unverified |
Dataset loaders archive 2025-07-28
No loader listed in the archive.
Tasks archive 2025-07-28
License archive 2025-07-28
https://github.com/humemai/room-env
Modalities archive 2025-07-28
Languages archive 2025-07-28
Variants archive 2025-07-28
- RoomEnv-v1
1 variant name, as the archive lists them.
Report a problem or propose a change · a person checks every report against the paper or source before anything changes; decisions are listed on /corrections