Update README.md

README.md

@@ -1,3 +1,98 @@
----
-license: apache-2.0
----
+---
+license: apache-2.0
+pretty_name: Spatial Reasoning Tasks
+dataset_info:
+- config_name: 1.0.0
+  features:
+  - name: task_id
+    dtype: string
+  - name: task_query
+    dtype: string
+  - name: task_label
+    dtype: bool
+  - name: task_constraint
+    dtype: list
+  - name: objects
+    dtype: list
+  - name: related_task_id
+    dtype: string
+  - name: image_url
+    dtype: string
+  - name: scene_id
+    dtype: string
+  splits:
+  - name: qa
+    num_bytes: <number_of_bytes>
+    num_examples: <number_of_examples>
+  download_size: <download_size>
+  dataset_size: <dataset_size>
+configs:
+- config_name: 1.0.0
+  data_files:
+  - split: qa
+    path: data/all.json
+train-eval-index:
+- config: 1.0.0
+  splits:
+    eval_split: qa
+  col_mapping:
+    task_query: text
+    task_label: label
+language:
+- en
+task_categories:
+- visual-question-answering
+tags:
+- spatial reasoning
+- embodied AI
+size_categories:
+- 1K<n<10K
+---
+
+# Embodied Spatial Reasoning Tasks
+
+## Dataset Description
+
+This dataset is part of the embodied-spatial-reasoning project, where the agent has to actively explore the environment to determine if certain spatial relationships hold true. The tasks involve spatial reasoning with various objects and scenes. Each task includes a query about the spatial relationships between objects within a scene, which the agent must verify through exploration.
+
+## Dataset Structure
+
+The dataset is organized so that each entry represents a single task associated with a specific scene.
+
+### Features
+
+- **task_id**: (string) Unique identifier for each task.
+- **task_query**: (string) A query describing the spatial relationship to be verified (e.g., "The object sofa is to the left of wardrobe.").
+- **task_label**: (bool) Indicates whether the spatial relationship described in the query is correct (True) or not (False).
+- **task_constraint**: (list) A list of constraints associated with the task, specifying the objects and their spatial relationship.
+  - **object_list**: (list of strings) List of objects involved in the constraint.
+  - **constraint_name**: (string) Name of the spatial relationship (e.g., "left").
+- **objects**: (list) List of objects involved in the scene.
+- **related_task_id**: (string) Identifier of a related task, if any.
+- **image_url**: (string) URL of the image associated with the task.
+- **scene_id**: (string) Identifier for the scene where the task occurs.
+
+### Example Entry
+
+```json
+{
+    "scene_id": "8cff7aca-1324-48fa-bf7d-ca913bdd6d2d",
+    "task_id": "579c553b-21dd-4a44-bcef-1da9e5fada9f",
+    "task_query": "The object sofa is to the left of wardrobe.",
+    "task_label": true,
+    "task_constraint": [
+        {
+            "object_list": [
+                "wardrobe",
+                "sofa"
+            ],
+            "constraint_name": "left"
+        }
+    ],
+    "objects": [
+        "wardrobe",
+        "sofa"
+    ],
+    "related_task_id": "718c876a-a8d1-4297-b552-24ce1f136ed4",
+    "image_url": "https://embodied-spatial-reasoning.storage.googleapis.com/images/left/True/579c553b-21dd-4a44-bcef-1da9e5fada9f.png"
+}