Update README.md

README.md

@@ -1,3 +1,176 @@
 ---
 license: mit
+language:
+- en
+tags:
+- dialogue segmentation
+size_categories:
+- n<1K
 ---
+
+# Dataset Card for SuperDialseg
+
+## Table of Contents
+- [Table of Contents](#table-of-contents)
+- [Dataset Description](#dataset-description)
+  - [Dataset Summary](#dataset-summary)
+  - [Supported Tasks and Leaderboards](#supported-tasks-and-leaderboards)
+  - [Languages](#languages)
+- [Dataset Structure](#dataset-structure)
+  - [Data Instances](#data-instances)
+  - [Data Fields](#data-fields)
+  - [Data Splits](#data-splits)
+- [Dataset Creation](#dataset-creation)
+  - [Curation Rationale](#curation-rationale)
+  - [Source Data](#source-data)
+  - [Annotations](#annotations)
+  - [Personal and Sensitive Information](#personal-and-sensitive-information)
+- [Considerations for Using the Data](#considerations-for-using-the-data)
+  - [Social Impact of Dataset](#social-impact-of-dataset)
+  - [Discussion of Biases](#discussion-of-biases)
+  - [Other Known Limitations](#other-known-limitations)
+- [Additional Information](#additional-information)
+  - [Dataset Curators](#dataset-curators)
+  - [Licensing Information](#licensing-information)
+  - [Citation Information](#citation-information)
+  - [Contributions](#contributions)
+
+## Dataset Description
+
+- **Homepage:** [https://github.com/HuiyuanXie/tiage](https://github.com/HuiyuanXie/tiage)
+- **Repository:** [https://github.com/HuiyuanXie/tiage](https://github.com/HuiyuanXie/tiage)
+- **Paper:** TIAGE: A Benchmark for Topic-Shift Aware Dialog Modeling
+- **Leaderboard:** 
+- **Point of Contact:** 
+
+### Dataset Summary
+
+[More Information Needed]
+
+### Supported Tasks and Leaderboards
+
+[More Information Needed]
+
+### Languages: English
+
+## Dataset Structure
+
+### Data Instances
+
+```
+{
+  "dial_data": {
+    "tiage": [
+      {
+        "dial_id": "tiage_dial_001",
+        "turns": [
+          {
+            "da": "",
+            "role": "user",
+            "turn_id": 0,
+            "utterance": "hello , how are you doing tonight ?",
+            "topic_id": 0,
+            "segmentation_label": 0
+          },
+          ...
+          {
+            "da": "",
+            "role": "user",
+            "turn_id": 15,
+            "utterance": "i bet it is oh i could not",
+            "topic_id": 4,
+            "segmentation_label": 1
+          }
+        ],
+      ...
+      }
+    ]
+}
+```
+
+### Data Fields
+
+#### Dialogue-Level
++ `dial_id`: ID of a dialogue;
++ `turns`: All utterances of a dialogue.
+#### Utterance-Level
++ `da`: Dialogue Act annotation (here is Null);
++ `role`: Role annotation  (here is user/agent/user/agent... in default);
++ `turn_id`: ID of an utterance;
++ `utterance`: Text of the utterance;
++ `topic_id`: ID (order) of the current topic;
++ `segmentation_label`: 1: it is the end of a topic; 0: others.
+
+### Data Splits
+
+[More Information Needed]
+
+## Dataset Creation
+
+### Curation Rationale
+
+[More Information Needed]
+
+### Source Data
+
+#### Initial Data Collection and Normalization
+
+[More Information Needed]
+
+#### Who are the source language producers?
+
+[More Information Needed]
+
+### Annotations
+
+#### Annotation process
+
+[More Information Needed]
+
+#### Who are the annotators?
+
+[More Information Needed]
+
+### Personal and Sensitive Information
+
+[More Information Needed]
+
+## Considerations for Using the Data
+
+### Social Impact of Dataset
+
+[More Information Needed]
+
+### Discussion of Biases
+
+[More Information Needed]
+
+### Other Known Limitations
+
+[More Information Needed]
+
+## Additional Information
+
+### Dataset Curators
+
+[More Information Needed]
+
+### Licensing Information
+
+MIT
+
+### Citation Information
+
+```
+@article{xie2021tiage,
+  title={TIAGE: A Benchmark for Topic-Shift Aware Dialog Modeling},
+  author={Xie, Huiyuan and Liu, Zhenghao and Xiong, Chenyan and Liu, Zhiyuan and Copestake, Ann},
+  journal={arXiv preprint arXiv:2109.04562},
+  year={2021}
+ }
+```
+
+### Contributions
+
++ Thanks to [@HuiyuanXie](https://github.com/HuiyuanXie/) for collecting this dataset.
++ Thanks to [@Coldog2333](https://github.com/Coldog2333) for adding this dataset.