Update README.md

README.md

@@ -58,4 +58,155 @@ size_categories:
 task_categories:
 - text-generation
 pretty_name: AgentBoard
----
+---
+
+
+[Logo of AgentBoard]()
+
+# Dataset Card for AgentBoard
+This is the official dataset repository of [AgentBoard](). 
+
+## 1. Data Overview
+AgentBoard is composed of 9 diverse tasks which can be divided into 4 types, including **Embodied AI**, **Game**, **Web**, and **Tool**:
+
+
+<table align="center">
+  <tbody>
+    <tr align="center" valign="bottom">
+      <td>
+        <b>Embodied AI</b>
+      </td>
+      <td>
+        <b>Game</b>
+      </td>
+      <td>
+        <b>Web</b>
+      </td>
+      <td>
+        <b>Tool</b>
+      </td>
+    </tr>
+    <tr valign="top">
+<td>
+
+- AlfWorld
+- ScienceWorld
+- BabyAI
+
+</td>
+
+<td>
+
+- Jericho
+- PDDL
+
+</td>
+
+<td>
+
+- WebShop
+- WebArena
+
+</td>
+
+<td>
+
+- Tool-Query
+- Tool-Operation
+
+</td>
+
+  </tr>
+  </tbody>
+</table>
+
+
+And statistics of the evaluation data of 9 task are as follows:
+
+| | AlfWorld | ScienceWorld | BabyAI | Jericho | PDDL | WebShop | WebArena | Tool-Query | Tool-Operation |
+|-------|----------|--------------|--------|---------|------|---------|----------|------------|----------------|
+| **Metric** | PR/SR | PR/SR | PR/SR | PR/SR | PR/SR | Matching | Matching | PR/SR | PR/SR/Matching |
+| **\#Avg. Turn** | 6 | 15 | 10 | 20 | 20 | 3 | 25 | 5 | 6 |
+| **\#Avg. Action Space** | 13 | 21 | 8 | 150 | 8 | 2 | 12 | 15 | 16 |
+| **\#Avg. Context Length** | 900 | 2800 | 1800 | 1500 | 2700 | 1200 | 15000 | 2100 | 4300 |
+| **\#Avg. Sub-goals** | 3 | 5 | 4 | 6 | 6 | 4 | 6 | 5 | 5 |
+| **\#Environment** | 134 | 90 | 112 | 20 | 60 | 251 | 245 | 60 | 40 |
+
+
+To help researchers quickly understand evaluation data of each task, we provide **Dataset Viewer** at Huggingface Dataset: [🤗 AgentBoard](https://huggingface.co/datasets/YANG-Cheng/alpaca).
+
+> Note: Please download the dataset from the link provided below for the reason that the data in Dataset Viewer is not complete.
+
+## 2. Download Link
+You can download the whole evaluation data by running the following command:
+```shell
+wget https://huggingface.co/datasets/YANG-Cheng/alpaca/resolve/main/data.tar.gz
+```
+Please uncommpress the file and move the data to `agent-board/data`.
+```shell
+cd agentboard
+mkdir data
+tar -zxvf data.tar.gz -C ./data
+```
+
+The file structure of evaluation data is as follows:
+<details>
+<summary>
+Click to expand the file structure
+</summary>
+
+```
+data
+├── alfworld
+│   ├── alfred.pddl # additional data for alfworld
+│   ├── alfred.twl2 # additional data for alfworld
+│   ├── json_2.1.1  # additional data for alfworld
+│   └── test.jsonl
+├── babyai
+│   └── test.jsonl
+├── jericho
+│   ├── test.jsonl
+│   └── z-machine-games-master  # additional data for jericho
+├── pddl
+│   └── test.jsonl
+├── scienceworld
+│   └── test.jsonl
+├── tool-operation
+│   └── test.jsonl
+├── tool-query
+│   ├── academia  # additional data for academia tool
+│   └── test.jsonl
+├── webarena
+│   └── test.jsonl
+└── webshop
+    └── test.jsonl
+```
+
+</details>
+
+## 3. Data Fields
+We take an instance from the `ScienceWorld` task as an example to illustrate the data fields of evaluation data.
+```json
+{
+  "task": "scienceworld",
+  "id": 0,
+  "goal": "Your task is to find the animal with the longest life span.  The animals are in the 'outside' location.  Focus on the animal with the longest life span.",
+  "subgoals": ["You move to the outside.", "You focus on the crocodile egg."],
+  "difficulty": "easy",
+  "additional_info": {"var": 5, "env_name": "lifespan-longest-lived"}
+}
+```
+Details of the data fields are as follows:
+| Field Name | Description |
+|------------|-------------|
+| `task` | The task name of the example, e.g. `alfworld`, `babyai`, `jericho`, `pddl`, `scienceworld`, `tool-operation`, `tool-query`, `webarena`, `webshop`. |
+| `id` | The id of the example. |
+| `goal` | The goal of the example. |
+| `subgoals` | The subgoals of the example. |
+| `difficulty` | The difficulty of the example, e.g. `easy`, `hard`. |
+| `additional_info` | The additional information of the example, each example has its own additional information. |
+
+
+## 4. Citation
+```bibtex
+```