Update README.md

README.md

@@ -39,6 +39,7 @@ This is a variant of the [Statcan Dialogue Dataset](https://huggingface.co/datas
 ## Quickstart
 
 ```python
+
 from datasets import load_dataset
 
 repo = 'McGill-NLP/statcan-dialogue-dataset-retrieval'
@@ -58,9 +59,37 @@ corpus_fr = load_dataset(repo, 'corpus', split='french')
 #     features: ['doc_id', 'title', 'doc'],
 #     num_rows: 5907
 # })
+```
+
+The queries is given in list of dicts, with the following keys:
+ - role: either "user" or "operator". Operator is the expert in charge of helping the user.
+ - content: the utterance of the user or operator. 
 
+```python
+# ...continued
+q = queries_en[0]['query']
+doc_id = queries_en[0]['doc_id']
+print("Query:", q)
+
+# You can filter the corpus to find your table (english and french are the same docs)
+d = corpus_fr.filter(lambda r: r['doc_id'] == doc_id)[0]
+# 
+print("Title:", d['title'])
+print('-'*50)
+print(d['doc'])
 ```
 
+Note that `d['title']` only contains the title of the table, whereas `d['doc']` is the full document and contains:
+* title,
+* time period,
+* table dimensions,
+* subject (for taxonomy),
+* name of survey where it was sourced,
+* update frequency,
+* columns for each of the dimensions
+
+Warning: please do not do `d['title'] + d['doc']` as that would be redundant.
+
 ## License
 
 By using this dataset, you agree to the the following terms of use and restrictions: