-
Notifications
You must be signed in to change notification settings - Fork 235
/
ir_eval.cpp
244 lines (208 loc) · 6.21 KB
/
ir_eval.cpp
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
/**
* @file ir_eval.cpp
* @author Sean Massung
*/
#include <algorithm>
#include <numeric>
#include <iomanip>
#include <fstream>
#include <sstream>
#include "cpptoml.h"
#include "meta/index/eval/ir_eval.h"
#include "meta/util/mapping.h"
#include "meta/util/printing.h"
#include "meta/util/shim.h"
namespace meta
{
namespace index
{
ir_eval::ir_eval(const cpptoml::table& config)
{
auto path = config.get_as<std::string>("query-judgements");
if (!path)
throw ir_eval_exception{"query judgement file was not specified"};
init_index(*path);
}
void ir_eval::init_index(const std::string& path)
{
std::ifstream in{path};
if (!in)
throw ir_eval_exception{"query judgements file unable to be opened!"};
std::string line;
// four (or three) fields per line
query_id q_id;
uint64_t unused; // TREC compatability, optional
doc_id d_id;
uint64_t relevance;
while (in.good())
{
std::getline(in, line);
bool trec = (std::count_if(line.begin(), line.end(),
[](char ch)
{
return ch == ' ';
})
== 3); // 3 spaces == 4 columns
std::istringstream iss{line};
iss >> q_id;
if (trec)
iss >> unused;
iss >> d_id;
iss >> relevance;
if (relevance > 0)
qrels_[q_id][d_id] = relevance;
}
}
double ir_eval::precision(const std::vector<search_result>& results,
query_id q_id, uint64_t num_docs) const
{
if (results.empty())
return 0.0;
const auto& ht = qrels_.find(q_id);
if (ht == qrels_.end())
return 0.0;
uint64_t denominator = std::min<uint64_t>(results.size(), num_docs);
return relevant_retrieved(results, q_id, num_docs) / denominator;
}
double ir_eval::recall(const std::vector<search_result>& results, query_id q_id,
uint64_t num_docs) const
{
if (results.empty())
return 0.0;
const auto& ht = qrels_.find(q_id);
if (ht == qrels_.end())
return 0.0;
return relevant_retrieved(results, q_id, num_docs) / ht->second.size();
}
double ir_eval::relevant_retrieved(const std::vector<search_result>& results,
query_id q_id, uint64_t num_docs) const
{
double rel = 0.0;
const auto& ht = qrels_.find(q_id);
uint64_t i = 1;
for (auto& result : results)
{
if (map::safe_at(ht->second, result.d_id) != 0)
++rel;
if (i++ == num_docs)
break;
}
return rel;
}
double ir_eval::f1(const std::vector<search_result>& results, query_id q_id,
uint64_t num_docs, double beta) const
{
double p = precision(results, q_id, num_docs);
double r = recall(results, q_id, num_docs);
double denominator = (beta * beta * p) + r;
if (denominator < 0.00000001)
return 0.0;
double numerator = (1.0 + beta * beta) * p * r;
return numerator / denominator;
}
double ir_eval::ndcg(const std::vector<search_result>& results, query_id q_id,
uint64_t num_docs) const
{
// find this query's judgements
const auto& ht = qrels_.find(q_id);
if (ht == qrels_.end() || results.empty())
return 0.0;
// calculate discounted cumulative gain
double dcg = 0.0;
uint64_t i = 1;
for (auto& result : results)
{
auto rel = map::safe_at(ht->second, result.d_id); // 0 if non-relevant
dcg += (std::pow(2.0, rel) - 1.0) / std::log2(i + 1.0);
if (i++ == num_docs)
break;
}
// calculate ideal DCG
std::vector<uint64_t> rels;
for (const auto& s : ht->second)
rels.push_back(s.second);
std::sort(rels.begin(), rels.end(), std::greater<uint64_t>{});
double idcg = 0.0;
i = 1;
for (auto& rel : rels)
{
idcg += (std::pow(2.0, rel) - 1.0) / std::log2(i + 1.0);
if (i++ == num_docs)
break;
}
return dcg / idcg;
}
double ir_eval::avg_p(const std::vector<search_result>& results, query_id q_id,
uint64_t num_docs)
{
const auto& ht = qrels_.find(q_id);
if (ht == qrels_.end() || results.empty())
{
scores_.push_back(0.0);
return 0.0;
}
// the total number of *possible* relevant documents given the num_docs
// cutoff point
auto total_relevant = std::min<uint64_t>(num_docs, ht->second.size());
uint64_t i = 1;
double avgp = 0.0;
double num_rel = 1;
for (auto& result : results)
{
if (map::safe_at(ht->second, result.d_id) != 0)
{
avgp += num_rel / i;
++num_rel;
}
if (num_rel - 1 == total_relevant)
break;
if (i++ == num_docs)
break;
}
scores_.push_back(avgp / total_relevant);
return avgp / total_relevant;
}
double ir_eval::map() const
{
if (scores_.empty())
return 0.0;
return std::accumulate(scores_.begin(), scores_.end(), 0.0)
/ scores_.size();
}
double ir_eval::gmap() const
{
if (scores_.empty())
return 0.0;
double sum = 0.0;
for (auto& s : scores_)
{
if (s <= 0.0)
return 0.0;
sum += std::log(s);
}
return std::exp(sum / scores_.size());
}
void ir_eval::print_stats(const std::vector<search_result>& results,
query_id q_id, std::ostream& out, uint64_t num_docs)
{
auto w1 = std::setw(8);
auto w2 = std::setw(6);
int p = 3;
out << w1 << printing::make_bold(" NDCG:") << w2 << std::setprecision(p)
<< ndcg(results, q_id, num_docs);
out << w1 << printing::make_bold(" Avg. P:") << w2 << std::setprecision(p)
<< avg_p(results, q_id, num_docs);
out << w1 << printing::make_bold(" F1 Score:") << w2
<< std::setprecision(p) << f1(results, q_id, num_docs);
out << w1 << printing::make_bold(" Precision:") << w2
<< std::setprecision(p) << precision(results, q_id, num_docs);
out << w1 << printing::make_bold(" Recall:") << w2 << std::setprecision(p)
<< recall(results, q_id, num_docs);
out << std::endl;
}
void ir_eval::reset_stats()
{
scores_.clear();
}
}
}