Upload README.md with huggingface_hub

README.md

@@ -1,3 +1,17 @@
+---
+language:
+- zh
+license:
+- apache-2.0
+multilinguality:
+- monolingual
+pretty_name: CrossWOZ
+size_categories:
+- 1K<n<10K
+task_categories:
+- conversational
+---
+
 # Dataset Card for CrossWOZ
 
 - **Repository:** https://github.com/thu-coai/CrossWOZ
@@ -5,6 +19,16 @@
 - **Leaderboard:** None
 - **Who transforms the dataset:** Qi Zhu(zhuq96 at gmail dot com)
 
+To use this dataset, you need to install [ConvLab-3](https://github.com/ConvLab/ConvLab-3) platform first. Then you can load the dataset via:
+```
+from convlab.util import load_dataset, load_ontology, load_database
+
+dataset = load_dataset('crosswoz')
+ontology = load_ontology('crosswoz')
+database = load_database('crosswoz')
+```
+For more usage please refer to [here](https://github.com/ConvLab/ConvLab-3/tree/master/data/unified_datasets).
+
 ### Dataset Summary
 
 CrossWOZ is the first large-scale Chinese Cross-Domain Wizard-of-Oz task-oriented dataset. It contains 6K dialogue sessions and 102K utterances for 5 domains, including hotel, restaurant, attraction, metro, and taxi. Moreover, the corpus contains rich annotation of dialogue states and dialogue acts at both user and system sides. We also provide a user simulator and several benchmark models for pipelined taskoriented dialogue systems, which will facilitate researchers to compare and evaluate their models on this corpus.