nthakur commited on
Commit
f06d6a7
·
verified ·
1 Parent(s): b4ff99e

Add generic BEIR data instance example

Browse files

Keep the high-level corpus/queries/qrels example in README as requested.

Files changed (1) hide show
  1. README.md +34 -0
README.md CHANGED
@@ -104,6 +104,40 @@ This dataset uses the standard BEIR retrieval layout and includes:
104
  - `title` (`string`): title (empty string when unavailable)
105
  - `text` (`string`): document/query text
106
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
107
  ### Data Splits
108
 
109
  | Subset | Split | Rows |
 
104
  - `title` (`string`): title (empty string when unavailable)
105
  - `text` (`string`): document/query text
106
 
107
+ ### Data Instances
108
+
109
+ A high level example of any BEIR dataset:
110
+
111
+ ```python
112
+ corpus = {
113
+ "doc1" : {
114
+ "title": "Albert Einstein",
115
+ "text": "Albert Einstein was a German-born theoretical physicist. who developed the theory of relativity, \
116
+ one of the two pillars of modern physics (alongside quantum mechanics). His work is also known for \
117
+ its influence on the philosophy of science. He is best known to the general public for his mass–energy \
118
+ equivalence formula E = mc2, which has been dubbed 'the world's most famous equation'. He received the 1921 \
119
+ Nobel Prize in Physics 'for his services to theoretical physics, and especially for his discovery of the law \
120
+ of the photoelectric effect', a pivotal step in the development of quantum theory."
121
+ },
122
+ "doc2" : {
123
+ "title": "", # Keep title an empty string if not present
124
+ "text": "Wheat beer is a top-fermented beer which is brewed with a large proportion of wheat relative to the amount of \
125
+ malted barley. The two main varieties are German Weißbier and Belgian witbier; other types include Lambic (made\
126
+ with wild yeast), Berliner Weisse (a cloudy, sour beer), and Gose (a sour, salty beer)."
127
+ },
128
+ }
129
+
130
+ queries = {
131
+ "q1" : "Who developed the mass-energy equivalence formula?",
132
+ "q2" : "Which beer is brewed with a large proportion of wheat?"
133
+ }
134
+
135
+ qrels = {
136
+ "q1" : {"doc1": 1},
137
+ "q2" : {"doc2": 1},
138
+ }
139
+ ```
140
+
141
  ### Data Splits
142
 
143
  | Subset | Split | Rows |