Update README.md

README.md

@@ -2,4 +2,94 @@
 license: bsd-3-clause
 task_categories:
 - question-answering
----
+---
+
+# UniEQA Dataset
+## UniEQA Dataset Directory Structure
+
+```text
+|- Part
+  |- capability dimension (eg.,object_type)
+     |- core
+        |- images
+        |- data.json
+  | - ...
+|- ...
+```
+The UniEQA dataset includes questions, images, and answers, and the question-images-answer pairs are in [data.json](https://huggingface.co/datasets/TJURL-Lab/UniEQA/blob/main/object_type/core/data.json).
+
+## Download Dataset
+
+**Step 1:** Download dataset [UniEQA](https://drive.google.com/drive/folders/1az4jSfFvKU2_SMWksUICBeU1P-tAwWpo?usp=drive_link).
+
+**Step 2:** Download HM3D. The RGB frames for the HM3D episode histories are available in this [third party location](https://www.dropbox.com/scl/fi/t79gsjqlan8dneg7o63sw/open-eqa-hm3d-frames-v0.tgz?rlkey=1iuukwy2g3f5t06q4a3mxqobm) (12 Gb). You can use the following commands to download and extract the data:
+
+```bash
+wget -O open-eqa-hm3d-frames-v0.tgz <link above>
+md5sum open-eqa-hm3d-frames-v0.tgz  # 286aa5d2fda99f4ed1567ae212998370
+tar -xzf open-eqa-hm3d-frames-v0.tgz -C Part1/images
+rm open-eqa-hm3d-frames-v0.tgz
+```
+
+Afterwards, your directory should look like this:
+
+```text
+|- Part1
+   |- images
+      |- hm3d
+         |- 000-hm3d-BFRyYbPCCPE
+         |- ...
+| - ...
+```
+**Step 3:** Download [ScanNet](http://www.scan-net.org) by following the instructions [here](https://github.com/ScanNet/ScanNet#scannet-data).
+
+Place the data in `data/raw/scannet`. Afterwards, your directory should look like this:
+
+```text
+|- data
+   |- raw
+      |- scannet
+         |- scans
+            |- <scanId>
+               |- <scanId>.sens
+               |- ...
+         |- scans_test
+            |- <scanId>
+               |- <scanId>.sens
+               |- ...
+|- ...
+```
+
+**Step 4:** Extract episode histories $H$ from ScanNet scenes.
+
+You can either only extract RGB frames or extract RGB, depth, camera intrinsics, and camera pose information.
+
+| Format | Size | Extraction Time |
+| --- | --- | --- |
+| RGB-only | 62 Gb | ~8 hrs|
+| RGB-D + Intrinsics + Pose | 70 Gb | ~10 hrs|
+
+To extract only the RGB frames, run:
+
+```bash
+python data/raw/scannet/extract-frames.py --rgb-only
+```
+
+To extract the RGB, depth, camera intrinsics, and camera pose information, run:
+
+```bash
+python data/raw/scannet/extract-frames.py
+```
+
+Place the RGB frames in `Part1/images/scannet`. Afterwards, your directory structure should look like this:
+
+```text
+|- Part1
+   |- images
+      |- scannet
+         |- 002-scannet-scene0709_00
+         |- ...
+      |- hm3d
+| - ...
+```
+