Updated ReadMe

README.md

@@ -88,7 +88,31 @@ configs:
 
 ### Dataset Summary
 
-This dataset is a consolidation of SpaRTUN and StepGame datasets with an extension of additional spatial characterization and reasoning path generation. The methodology is explained in our ACL 2024 paper - [SpaRC and SpaRP: Spatial Reasoning Characterization and Path Generation for Understanding Spatial Reasoning Capability of Large Language Models]().
+This dataset is a consolidation of SpaRTUN and StepGame datasets with an extension of additional spatial characterization and reasoning path generation. The methodology is explained in our ACL 2024 paper - [SpaRC and SpaRP: Spatial Reasoning Characterization and Path Generation for Understanding Spatial Reasoning Capability of Large Language Models](). The dataset format and fields are normalized across the two upstream benchmark datasets -- SpaRTUN and StepGame. The datasets are primarily a Spatial Question Answering datasets, which are enriched with verbalized reasoning paths. The prominent fields of interests are:
+
+- *context*: Textual description of the spatial context.
+- *question*: A question about finding spatial relations between two entities in the context.
+- *targets*: Answer i.e. list of spatial relations between the entities in the question.
+- *target_choices*: List of all the spatial relations to choose from.
+- *target_scores*: Binarized Multi-label representation of targets over target_choices.
+- *reasoning*: Verbalized reasoning path as deductively-verified CoT for training or few-shot examples.
+
+Additionally, the fields with the metadata are:
+
+- *context_id*: An identifier from the source data corresponding to the context. `context_id` is unique. A single context can have multiple questions (e.g. SpaRTUN). Hence, (context_id, question_id) is a unique identifier for a dataset instance. 
+- *question_id*: An identifier from the source data corresponding to the question.
+- *num_hop*: Ground truth number of hop required for the question.
+- *symbolic_context*: A json string describing the symbolic context.
+- *symbolic_entity_map*: A json string that maps symbolic entities to their complete descriptive names used.
+- *symbolic_question*: A json string describing the symbolic question.
+- *num_context_entities*: Number of entities in the context.
+- *num_question_entities*: Number of entities in the question.
+- *question_type*: Type of the question. Only `FR` i.e. Find Relation type questions are currently present.
+- *canary*: A canary string present only in the `test`.
+- *reasoning_types*: The type of reasoning copied from the source data required for answering the question.
+- *spatial_types*: The type of spatial relations copied from the source data required for answering the question.
+- *source_data*: The upstream source of the data (either SpaRTUN or StepGame) for a given instance.
+- *comments*: Additional comments specific to the upstream data.
 
 ### Languages