Improve dataset card: Add task category, paper, code, project page links, and refined sample usage
Browse filesThis PR significantly improves the dataset card for HouseLayout3D by:
- Adding the `task_categories: ['image-to-3d']` to the metadata, enhancing discoverability for relevant tasks.
- Including explicit links to the official paper (https://huggingface.co/papers/2512.02450), the main GitHub repository (https://github.com/HouseLayout3D/houselayout3d), and the project page (https://houselayout3d.github.io) at the top of the card.
- Reformatting and expanding the existing "Getting Started" section into a comprehensive "Sample Usage" guide. This new section incorporates detailed installation steps (including `git-lfs`), instructions for downloading the dataset, and steps to run the visualization, all derived from the project's GitHub README for accuracy.
|
@@ -1,20 +1,23 @@
|
|
| 1 |
---
|
|
|
|
|
|
|
|
|
|
| 2 |
configs:
|
| 3 |
- config_name: doors
|
| 4 |
-
data_files:
|
| 5 |
- config_name: stairs
|
| 6 |
-
data_files:
|
| 7 |
- config_name: windows
|
| 8 |
-
data_files:
|
| 9 |
- config_name: poses
|
| 10 |
-
data_files:
|
| 11 |
- config_name: structures
|
| 12 |
-
data_files:
|
| 13 |
-
license: mit
|
| 14 |
---
|
| 15 |
|
| 16 |
# HouseLayout3D: A Benchmark Dataset for 3D Layout Estimation in the Wild
|
| 17 |
|
|
|
|
| 18 |
|
| 19 |
**HouseLayout3D** is a challenging benchmark dataset for **3D layout estimation in large-scale, multi-floor buildings**. It is built upon real-world building scans from [Matterport3D](https://niessner.github.io/Matterport/), and provides detailed annotations of structural elements across up to five floors and forty rooms per building. The dataset is designed to support research in scene understanding, indoor mapping, and robotics applications that require vectorized, object-free representations of indoor spaces.
|
| 20 |
|
|
@@ -33,39 +36,47 @@ Most existing datasets and models for 3D layout estimation are tailored for smal
|
|
| 33 |
- Annotations of windows and doors (including opening direction) as 3D rectangles.
|
| 34 |
- Annotations of stairs as 3D polygons.
|
| 35 |
|
| 36 |
-
##
|
| 37 |
|
| 38 |
-
Follow these steps to set up the environment and visualize a scene
|
| 39 |
|
| 40 |
### 1. Installation
|
| 41 |
|
| 42 |
-
|
| 43 |
-
# Clone the evaluation repo
|
| 44 |
-
git clone https://github.com/valebi/house-layout-3d-eval.git
|
| 45 |
-
cd house-layout-3d-eval
|
| 46 |
|
| 47 |
-
|
| 48 |
-
conda create
|
| 49 |
-
conda activate
|
| 50 |
|
| 51 |
-
|
|
|
|
| 52 |
pip install -r requirements.txt
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 53 |
```
|
| 54 |
|
| 55 |
-
### 2.
|
| 56 |
|
| 57 |
-
|
| 58 |
|
| 59 |
```bash
|
| 60 |
-
git
|
|
|
|
| 61 |
```
|
| 62 |
|
| 63 |
-
|
|
|
|
|
|
|
| 64 |
|
| 65 |
```bash
|
| 66 |
-
python visualize.py
|
|
|
|
| 67 |
```
|
| 68 |
-
|
| 69 |
|
| 70 |
## Data Structure
|
| 71 |
```text
|
|
|
|
| 1 |
---
|
| 2 |
+
license: mit
|
| 3 |
+
task_categories:
|
| 4 |
+
- image-to-3d
|
| 5 |
configs:
|
| 6 |
- config_name: doors
|
| 7 |
+
data_files: doors/*.json
|
| 8 |
- config_name: stairs
|
| 9 |
+
data_files: stairs/*/*.ply
|
| 10 |
- config_name: windows
|
| 11 |
+
data_files: windows/*.json
|
| 12 |
- config_name: poses
|
| 13 |
+
data_files: poses/*.json
|
| 14 |
- config_name: structures
|
| 15 |
+
data_files: structures/*.obj
|
|
|
|
| 16 |
---
|
| 17 |
|
| 18 |
# HouseLayout3D: A Benchmark Dataset for 3D Layout Estimation in the Wild
|
| 19 |
|
| 20 |
+
[Paper](https://huggingface.co/papers/2512.02450) | [Project Page](https://houselayout3d.github.io) | [Code](https://github.com/HouseLayout3D/houselayout3d)
|
| 21 |
|
| 22 |
**HouseLayout3D** is a challenging benchmark dataset for **3D layout estimation in large-scale, multi-floor buildings**. It is built upon real-world building scans from [Matterport3D](https://niessner.github.io/Matterport/), and provides detailed annotations of structural elements across up to five floors and forty rooms per building. The dataset is designed to support research in scene understanding, indoor mapping, and robotics applications that require vectorized, object-free representations of indoor spaces.
|
| 23 |
|
|
|
|
| 36 |
- Annotations of windows and doors (including opening direction) as 3D rectangles.
|
| 37 |
- Annotations of stairs as 3D polygons.
|
| 38 |
|
| 39 |
+
## Sample Usage
|
| 40 |
|
| 41 |
+
Follow these steps to set up the environment, download the dataset, and visualize a scene.
|
| 42 |
|
| 43 |
### 1. Installation
|
| 44 |
|
| 45 |
+
First, clone the main repository and install dependencies:
|
|
|
|
|
|
|
|
|
|
| 46 |
|
| 47 |
+
```bash
|
| 48 |
+
conda create --name houselayout3d python=3.10 -y
|
| 49 |
+
conda activate houselayout3d
|
| 50 |
|
| 51 |
+
git clone https://github.com/HouseLayout3D/houselayout3d.git
|
| 52 |
+
cd houselayout3d
|
| 53 |
pip install -r requirements.txt
|
| 54 |
+
|
| 55 |
+
# Install Git LFS to download large files
|
| 56 |
+
# On Mac
|
| 57 |
+
brew install git-lfs
|
| 58 |
+
# On Linux
|
| 59 |
+
sudo apt-get install git-lfs
|
| 60 |
```
|
| 61 |
|
| 62 |
+
### 2. Download the Dataset
|
| 63 |
|
| 64 |
+
Download the HouseLayout3D dataset using `git lfs` from Hugging Face:
|
| 65 |
|
| 66 |
```bash
|
| 67 |
+
git lfs install # Ensure lfs is initialized
|
| 68 |
+
git clone https://huggingface.co/datasets/houselayout3d/HouseLayout3D data
|
| 69 |
```
|
| 70 |
|
| 71 |
+
### 3. Visualize a Scene
|
| 72 |
+
|
| 73 |
+
Navigate to the `houselayout3d` directory (where you cloned the code in step 1) and run the visualization script:
|
| 74 |
|
| 75 |
```bash
|
| 76 |
+
python visualize.py
|
| 77 |
+
python -m http.server 6008
|
| 78 |
```
|
| 79 |
+
Then open your browser and navigate to `http://localhost:6008` to view the visualizations.
|
| 80 |
|
| 81 |
## Data Structure
|
| 82 |
```text
|