RoomSpace / README.md
Fangjun's picture
Update README.md
a06096c verified
---
dataset_info:
config_name: n5_m4_d144
features:
- name: id
dtype: int64
- name: image_top_down
dtype: image
- name: image_north_facing
dtype: image
- name: question_image
dtype: string
- name: options_td
sequence: string
- name: options_sd
sequence: string
- name: answer_image_td
dtype: string
- name: answer_image_sd
dtype: string
- name: question_td_layout_yn
dtype: string
- name: answer_td_layout_yn
dtype: string
- name: question_td_layout_fr
dtype: string
- name: answer_td_layout_fr
sequence: string
- name: question_td_tpp_yn
dtype: string
- name: answer_td_tpp_yn
dtype: string
- name: question_td_tpp_fr
dtype: string
- name: answer_td_tpp_fr
sequence: string
- name: question_td_o2_yn
dtype: string
- name: answer_td_o2_yn
dtype: string
- name: question_td_o2_fr
dtype: string
- name: answer_td_o2_fr
sequence: string
- name: question_td_o2_d2_yn
dtype: string
- name: answer_td_o2_d2_yn
dtype: string
- name: question_td_o2_d2_fr
dtype: string
- name: answer_td_o2_d2_fr
sequence: string
- name: question_td_o2_d3_yn
dtype: string
- name: answer_td_o2_d3_yn
dtype: string
- name: question_td_o2_d3_fr
dtype: string
- name: answer_td_o2_d3_fr
sequence: string
- name: question_td_o2_layout_yn
dtype: string
- name: answer_td_o2_layout_yn
dtype: string
- name: question_td_o2_layout_fr
dtype: string
- name: answer_td_o2_layout_fr
sequence: string
- name: question_td_o2_d2_layout_yn
dtype: string
- name: answer_td_o2_d2_layout_yn
dtype: string
- name: question_td_o2_d2_layout_fr
dtype: string
- name: answer_td_o2_d2_layout_fr
sequence: string
- name: question_td_o2_d3_layout_yn
dtype: string
- name: answer_td_o2_d3_layout_yn
dtype: string
- name: question_td_o2_d3_layout_fr
dtype: string
- name: answer_td_o2_d3_layout_fr
sequence: string
- name: question_sd_layout_yn
dtype: string
- name: answer_sd_layout_yn
dtype: string
- name: question_sd_tpp_yn
dtype: string
- name: answer_sd_tpp_yn
dtype: string
- name: question_sd_o2_yn
dtype: string
- name: answer_sd_o2_yn
dtype: string
- name: question_sd_o2_fr
dtype: string
- name: answer_sd_o2_fr
sequence: string
- name: question_sd_o2_d2_yn
dtype: string
- name: answer_sd_o2_d2_yn
dtype: string
- name: question_sd_o2_d2_fr
dtype: string
- name: answer_sd_o2_d2_fr
sequence: string
- name: question_sd_o2_d3_yn
dtype: string
- name: answer_sd_o2_d3_yn
dtype: string
- name: question_sd_o2_d3_fr
dtype: string
- name: answer_sd_o2_d3_fr
sequence: string
- name: question_sd_o2_layout_yn
dtype: string
- name: answer_sd_o2_layout_yn
dtype: string
- name: question_sd_o2_layout_fr
dtype: string
- name: answer_sd_o2_layout_fr
sequence: string
- name: question_sd_o2_d2_layout_yn
dtype: string
- name: answer_sd_o2_d2_layout_yn
dtype: string
- name: question_sd_o2_d2_layout_fr
dtype: string
- name: answer_sd_o2_d2_layout_fr
sequence: string
- name: question_sd_o2_d3_layout_yn
dtype: string
- name: answer_sd_o2_d3_layout_yn
dtype: string
- name: question_sd_o2_d3_layout_fr
dtype: string
- name: answer_sd_o2_d3_layout_fr
sequence: string
splits:
- name: test
num_bytes: 67434227.0
num_examples: 100
download_size: 65991028
dataset_size: 67434227.0
configs:
- config_name: n5_m4_d144
data_files:
- split: test
path: n5_m4_d144/test-*
---
<div align="left">
<h1 style="font-size: 2em;">🏠 RoomSpace Benchmark</h1>
πŸ”— <a href="https://github.com/Fangjun-Li/RoomSpace">GitHub</a> β€’
πŸ“ <a href="https://archive.researchdata.leeds.ac.uk/1293/">Dataset</a> β€’
πŸ“– <a href="https://arxiv.org/abs/2405.15064">Paper</a>
πŸ•ΉοΈ <a href="https://colab.research.google.com/drive/1fAK8J1UHAjMm-mNVsuzIbEZd-SZG6bX-?usp=sharing">Colab</a>
</div>
<br/>
## Branch Structure
This repository contains various branches, each representing different versions and sizes of the RoomSpace dataset. For example, the `SD-100_v1.0` branch includes 100 test examples under version 1.0.
```
Data/
β”œβ”€β”€ main/
β”œβ”€β”€ SD-100_v1.0/
β”œβ”€β”€ SD-1K_v1.0/
└── SD-10K_v1.0/
```
- `main`: for the Dataset Viewer, contains the `n5_m4_d144` directory for SD-1K_v1.0.
- `SD-100_v1.0`: Contains data for 100 room samples.
- `SD-1K_v1.0`: Contains data for 1,000 room samples, with the first 100 rooms identical to those in `SD-100_v1.0`.
- `SD-10K_v1.0`: Contains data for 10,000 room samples, with the first 1,000 rooms identical to those in `SD-1K_v1.0`.
## Directory Structure
The repository is organized as follows:
```
Revision/
β”œβ”€β”€ n3_m2_d144/
β”œβ”€β”€ n4_m3_d144/
```
Each `n*_m*_d*` subdirectory includes a test parquet file containing stories, questions, and answers derived from the images and a Constraint Satisfaction Problem (CSP) reasoner. The parameters `n`, `m`, and `d` represent the object number, constraint density, and domain size, respectively.
### Images
Each example includes two images showing different views of the rooms:
- `image_top_down`: Top-down images of the rooms.
- `image_north_facing`: North-facing rectangular images, assuming a robot stands at the south door, facing north.
### Questions & Answers
There are a total of 26 QA pairs, categorized as follows:
- **Visual QA**: (image_top_down + question_image) -- answer_image_td, (image_north_facing + question_image) -- answer_image_sd
- **Layout Setting**: (question_td_layout_yn -- answer_td_layout_yn), (question_td_layout_fr -- answer_td_layout_fr)
- **TPP Setting**: (question_td_tpp_yn -- answer_td_tpp_yn), (question_td_tpp_fr -- answer_td_tpp_fr)
- **O2 Setting**: (question_td_o2_yn -- answer_td_o2_yn), (question_td_o2_fr -- answer_td_o2_fr), (question_sd_o2_yn -- answer_sd_o2_yn), (question_sd_o2_fr -- answer_sd_o2_fr)
- **O2+D2 Setting**: (question_td_o2_d2_yn -- answer_td_o2_d2_yn), (question_td_o2_d2_fr -- answer_td_o2_d2_fr), (question_sd_o2_d2_yn -- answer_sd_o2_d2_yn), (question_sd_o2_d2_fr -- answer_sd_o2_d2_fr)
- **O2+D3 Setting**: (question_td_o2_d3_yn -- answer_td_o2_d3_yn), (question_td_o2_d3_fr -- answer_td_o2_d3_fr), (question_sd_o2_d3_yn -- answer_sd_o2_d3_yn), (question_sd_o2_d3_fr -- answer_sd_o2_d3_fr)
- **Layout + O2 + D2 Setting**: (question_td_o2_d2_layout_yn -- answer_td_o2_d2_layout_yn), (question_td_o2_d2_layout_fr -- answer_td_o2_d2_layout_fr), (question_sd_o2_d2_layout_yn -- answer_sd_o2_d2_layout_yn), (question_sd_o2_d2_layout_fr -- answer_sd_o2_d2_layout_fr)
- **Layout + O2 + D3 Setting**: (question_td_o2_d3_layout_yn -- answer_td_o2_d3_layout_yn), (question_td_o2_d3_layout_fr -- answer_td_o2_d3_layout_fr), (question_sd_o2_d3_layout_yn -- answer_sd_o2_d3_layout_yn), (question_sd_o2_d3_layout_fr -- answer_sd_o2_d3_layout_fr)
### Question Types
- **'fr'**: Find Relation
- **'yn'**: Yes/No
### Points of View
- **'td'**: Top-Down View
- **'sd'**: North Facing View (from the south door)
---
## Relevant Paper
[Fangjun Li, David Hogg, and Anthony Cohn. "Reframing Spatial Reasoning Evaluation in Language Models: A Real-World Simulation Benchmark for Qualitative Reasoning." IJCAI, 2024](https://arxiv.org/abs/2405.15064).