update README for release

README.md

@@ -1,22 +1,79 @@
-## data-intermediate
+# data-intermediate
 
-Because some json files are huge, we use tar.zst to package the data.
+If you are looking for our test ready version, please refer to [mango-ttic/data](https://huggingface.co/datasets/mango-ttic/data)
 
-1. to compress the data
+## Folder Structure
+
+Each folder inside `data-intermediate` contains
+all intermediate files we used during data annotation and generation. Here is the tree structure from game `data-intermediate/night` .
+
+```bash
+data-intermediate/night/
+├── night.all2all.json      # all simple paths between any 2 nodes
+├── night.all_pairs.json    # all connectivity between any 2 nodes 
+├── night.anno2code.json    # annotation to codename mapping
+├── night.code2anno.json    # codename to annotation mapping
+├── night.edges.json        # list of all edges
+├── night.map.human         # human map derived from human annotation
+├── night.map.machine       # machine map derived from exported action sequences
+├── night.map.reversed      # reverse map derived from human annotation map
+├── night.moves             # list of mentioned actions
+├── night.nodes.json        # list of all nodes
+├── night.valid_moves.csv   # human annotation
+├── night.walkthrough       # enriched walkthrough exported from Jericho simulator
+└── night.walkthrough_acts  # action sequences exported from Jericho simulator
+```
+
+## Variations
+
+<!-- ### 70-step vs all-step version
+
+In our paper, we benchmark using the first 70 steps of the walkthrough from each game. We also provide all-step versions of both `data` and `data-intermediate` collection. -->
+
+### Word-only & Word+ID
+
+* **Word-only** `data[-intermediate].tar.zst`: Nodes are annotated by additional descriptive text to distinguish different locations with similar names.
+
+* **Word + Object ID** `data[-intermediate]-objid.tar.zst`:  variation of the word-only version, where nodes are labeled using minimaly fixed names with object id from Jericho simulator.
+
+* **Word + Random ID** `data[-intermediate]-randid.tar.zst`: variation of the Jericho ID version, where the Jericho object id replaced with randomly generated integer.
+
+We primarily rely on the **word-only** version as benchmark, yet providing word+ID version for diverse benchmark settings.
+
+## How to use
+
+We use `data-intermediate.tar.zst` as an example here.
+
+### 1. download from Huggingface
+
+#### by directly download
+
+![](direct_download_data-intermediate.png)
+
+#### by git
+
+Make sure you have [git-lfs](https://git-lfs.com) installed
 
 ```bash
-tar -I 'zstd' -cvf data-intermediate.tar.zst --exclude='*.md' data-intermediate/ # exclude README.md and challenging_parsing.md
+git lfs install
+git clone https://huggingface.co/datasets/mango-ttic/data-intermediate
+
+# or, use hf-mirror if your connection to huggingface.co is slow
+# git clone https://hf-mirror.com/datasets/mango-ttic/data-intermediate
 ```
 
-2. to decompress the data to `your_folder/`
+### 2. decompress
+
+Because some json files are huge, we use tar.zst to package the data efficiently.
 
-first you should make sure `your_folder/` exist. If not, create it.
+silently decompress
 
-silently
 ```bash
-tar -I 'zstd -d' -xf data-intermediate.tar.zst -C your_folder/
+tar -I 'zstd -d' -xf data-intermediate.tar.zst
 ```
-or, with progress verbose
+
+or, verbosely decompress
+
 ```bash
-zstd -d -c data-intermediate.tar.zst | tar -xvf - -C your_folder/
-```
+zstd -d -c data-intermediate.tar.zst | tar -xvf -
+```