vishal-burman commited on
Commit
b206ad0
·
1 Parent(s): 09a9176

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +22 -6
README.md CHANGED
@@ -66,29 +66,45 @@ task_ids:
66
 
67
  ### Dataset Summary
68
 
69
- [More Information Needed]
 
 
 
 
 
 
70
 
71
  ### Supported Tasks and Leaderboards
72
 
73
- [More Information Needed]
74
 
75
  ### Languages
76
 
77
- [More Information Needed]
78
 
79
  ## Dataset Structure
80
 
81
  ### Data Instances
82
 
83
- [More Information Needed]
 
 
 
84
 
85
  ### Data Fields
86
 
87
- [More Information Needed]
 
 
 
 
 
88
 
89
  ### Data Splits
90
 
91
- [More Information Needed]
 
 
92
 
93
  ## Dataset Creation
94
 
 
66
 
67
  ### Dataset Summary
68
 
69
+ This dataset comprises of open-domain question-answer pairs obtained from extracting 100K FAQ URLs from C4 dataset. Please refer to the original [`paper`](https://arxiv.org/abs/1910.10683) and [`dataset card`](https://huggingface.co/datasets/c4) for more details.
70
+
71
+ You can load C4-FAQs as follows:
72
+ ```python
73
+ from datasets import load_dataset
74
+ c4_faqs_dataset = load_dataset("vishal-burman/c4-faqs")
75
+ ```
76
 
77
  ### Supported Tasks and Leaderboards
78
 
79
+ C4-FAQs is mainly intended for open-domain end-to-end question generation. It can also be used for open-domain question answering.
80
 
81
  ### Languages
82
 
83
+ C4-FAQs only supports English language.
84
 
85
  ## Dataset Structure
86
 
87
  ### Data Instances
88
 
89
+ An example of a single dataset point:
90
+ ```python
91
+ {'faq_pairs': [{'question': 'What should I bring for the tour?', 'answer': 'Nothing special, just be ready to walk for bit and potentially something to protect you from poltergeists and rain. Any kind of amulet or protection stone is also welcome.'}, {'question': 'Can kids join too ?', 'answer': 'Yes, we accept kids from 6 years old and on! We also have a family discount, if you book for 2 adults and 2 kids!'}, {'question': 'Where is the meeting point ?', 'answer': 'Brussels has many paved roads and those are hardly accessible with a wheelchair, for that reason we have to unfortunately label our tour as not wheelchair accessible.'}]}
92
+ ```
93
 
94
  ### Data Fields
95
 
96
+ The data have several fields:
97
+
98
+ - `url`: URL of the webpage containing the FAQs
99
+ - `faq_pairs`: A list of question-answer pairs extracted from the webpage
100
+ - `question`: A single question as a string
101
+ - `answer`: A single answer to the above question as a string
102
 
103
  ### Data Splits
104
 
105
+ | subset | total |
106
+ |:-------|:------|
107
+ | train | 100K |
108
 
109
  ## Dataset Creation
110