This file is indexed.

/usr/share/doc/xapian-doc/bm25.html is in xapian-doc 1.2.19-1+deb8u1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below.

  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
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="Docutils 0.8.1: http://docutils.sourceforge.net/" />
<title>The BM25 Weighting Scheme</title>
<style type="text/css">

/*
:Author: David Goodger (goodger@python.org)
:Id: $Id: html4css1.css 7056 2011-06-17 10:50:48Z milde $
:Copyright: This stylesheet has been placed in the public domain.

Default cascading style sheet for the HTML output of Docutils.

See http://docutils.sf.net/docs/howto/html-stylesheets.html for how to
customize this style sheet.
*/

/* used to remove borders from tables and images */
.borderless, table.borderless td, table.borderless th {
  border: 0 }

table.borderless td, table.borderless th {
  /* Override padding for "table.docutils td" with "! important".
     The right padding separates the table cells. */
  padding: 0 0.5em 0 0 ! important }

.first {
  /* Override more specific margin styles with "! important". */
  margin-top: 0 ! important }

.last, .with-subtitle {
  margin-bottom: 0 ! important }

.hidden {
  display: none }

a.toc-backref {
  text-decoration: none ;
  color: black }

blockquote.epigraph {
  margin: 2em 5em ; }

dl.docutils dd {
  margin-bottom: 0.5em }

object[type="image/svg+xml"], object[type="application/x-shockwave-flash"] {
  overflow: hidden;
}

/* Uncomment (and remove this text!) to get bold-faced definition list terms
dl.docutils dt {
  font-weight: bold }
*/

div.abstract {
  margin: 2em 5em }

div.abstract p.topic-title {
  font-weight: bold ;
  text-align: center }

div.admonition, div.attention, div.caution, div.danger, div.error,
div.hint, div.important, div.note, div.tip, div.warning {
  margin: 2em ;
  border: medium outset ;
  padding: 1em }

div.admonition p.admonition-title, div.hint p.admonition-title,
div.important p.admonition-title, div.note p.admonition-title,
div.tip p.admonition-title {
  font-weight: bold ;
  font-family: sans-serif }

div.attention p.admonition-title, div.caution p.admonition-title,
div.danger p.admonition-title, div.error p.admonition-title,
div.warning p.admonition-title {
  color: red ;
  font-weight: bold ;
  font-family: sans-serif }

/* Uncomment (and remove this text!) to get reduced vertical space in
   compound paragraphs.
div.compound .compound-first, div.compound .compound-middle {
  margin-bottom: 0.5em }

div.compound .compound-last, div.compound .compound-middle {
  margin-top: 0.5em }
*/

div.dedication {
  margin: 2em 5em ;
  text-align: center ;
  font-style: italic }

div.dedication p.topic-title {
  font-weight: bold ;
  font-style: normal }

div.figure {
  margin-left: 2em ;
  margin-right: 2em }

div.footer, div.header {
  clear: both;
  font-size: smaller }

div.line-block {
  display: block ;
  margin-top: 1em ;
  margin-bottom: 1em }

div.line-block div.line-block {
  margin-top: 0 ;
  margin-bottom: 0 ;
  margin-left: 1.5em }

div.sidebar {
  margin: 0 0 0.5em 1em ;
  border: medium outset ;
  padding: 1em ;
  background-color: #ffffee ;
  width: 40% ;
  float: right ;
  clear: right }

div.sidebar p.rubric {
  font-family: sans-serif ;
  font-size: medium }

div.system-messages {
  margin: 5em }

div.system-messages h1 {
  color: red }

div.system-message {
  border: medium outset ;
  padding: 1em }

div.system-message p.system-message-title {
  color: red ;
  font-weight: bold }

div.topic {
  margin: 2em }

h1.section-subtitle, h2.section-subtitle, h3.section-subtitle,
h4.section-subtitle, h5.section-subtitle, h6.section-subtitle {
  margin-top: 0.4em }

h1.title {
  text-align: center }

h2.subtitle {
  text-align: center }

hr.docutils {
  width: 75% }

img.align-left, .figure.align-left, object.align-left {
  clear: left ;
  float: left ;
  margin-right: 1em }

img.align-right, .figure.align-right, object.align-right {
  clear: right ;
  float: right ;
  margin-left: 1em }

img.align-center, .figure.align-center, object.align-center {
  display: block;
  margin-left: auto;
  margin-right: auto;
}

.align-left {
  text-align: left }

.align-center {
  clear: both ;
  text-align: center }

.align-right {
  text-align: right }

/* reset inner alignment in figures */
div.align-right {
  text-align: inherit }

/* div.align-center * { */
/*   text-align: left } */

ol.simple, ul.simple {
  margin-bottom: 1em }

ol.arabic {
  list-style: decimal }

ol.loweralpha {
  list-style: lower-alpha }

ol.upperalpha {
  list-style: upper-alpha }

ol.lowerroman {
  list-style: lower-roman }

ol.upperroman {
  list-style: upper-roman }

p.attribution {
  text-align: right ;
  margin-left: 50% }

p.caption {
  font-style: italic }

p.credits {
  font-style: italic ;
  font-size: smaller }

p.label {
  white-space: nowrap }

p.rubric {
  font-weight: bold ;
  font-size: larger ;
  color: maroon ;
  text-align: center }

p.sidebar-title {
  font-family: sans-serif ;
  font-weight: bold ;
  font-size: larger }

p.sidebar-subtitle {
  font-family: sans-serif ;
  font-weight: bold }

p.topic-title {
  font-weight: bold }

pre.address {
  margin-bottom: 0 ;
  margin-top: 0 ;
  font: inherit }

pre.literal-block, pre.doctest-block, pre.math {
  margin-left: 2em ;
  margin-right: 2em }

span.classifier {
  font-family: sans-serif ;
  font-style: oblique }

span.classifier-delimiter {
  font-family: sans-serif ;
  font-weight: bold }

span.interpreted {
  font-family: sans-serif }

span.option {
  white-space: nowrap }

span.pre {
  white-space: pre }

span.problematic {
  color: red }

span.section-subtitle {
  /* font-size relative to parent (h1..h6 element) */
  font-size: 80% }

table.citation {
  border-left: solid 1px gray;
  margin-left: 1px }

table.docinfo {
  margin: 2em 4em }

table.docutils {
  margin-top: 0.5em ;
  margin-bottom: 0.5em }

table.footnote {
  border-left: solid 1px black;
  margin-left: 1px }

table.docutils td, table.docutils th,
table.docinfo td, table.docinfo th {
  padding-left: 0.5em ;
  padding-right: 0.5em ;
  vertical-align: top }

table.docutils th.field-name, table.docinfo th.docinfo-name {
  font-weight: bold ;
  text-align: left ;
  white-space: nowrap ;
  padding-left: 0 }

h1 tt.docutils, h2 tt.docutils, h3 tt.docutils,
h4 tt.docutils, h5 tt.docutils, h6 tt.docutils {
  font-size: 100% }

ul.auto-toc {
  list-style-type: none }

</style>
</head>
<body>
<div class="document" id="the-bm25-weighting-scheme">
<h1 class="title">The BM25 Weighting Scheme</h1>

<p>This is a technical note about the BM25 weighting scheme, which is the
default weighting scheme used by Xapian. Recent TREC tests have shown
BM25 to be the best of the known probabilistic weighting schemes. In
case you're wondering, the BM simply stands for &quot;Best Match&quot;.</p>
<p>We'll follow the evolution from the &quot;traditional&quot; probabilistic
weighting scheme (as described in the <a class="reference external" href="http://www.soi.city.ac.uk/~ser/papers/RSJ76.pdf">1976 Robertson/Sparck Jones
paper</a>) through to
BM25.</p>
<div class="section" id="the-traditional-probabilistic-weighting-scheme">
<h1>The Traditional Probabilistic Weighting Scheme</h1>
<p>In its most general form, the traditional probabilistic term weighting
function is:</p>
<table border=0><tr valign=center>
<td>
<tt><center>
<u>(k<sub>3</sub>+1)q</u><br>(k<sub>3</sub>+q)</center></tt>
</td>
<td><tt>&middot;</tt></td>
<td>
  <tt><center>
<u>(k<sub>1</sub>+1)f</u><br>(k<sub>1</sub>L+f)</center></tt>
</td>
<td><tt>&middot;log</tt></td>
<td><tt><center>
<u>(r+0.5)(N-n-R+r+0.5)</u><br>(n-r+0.5)(R-r+0.5)</center></tt>
</td>
<td>
<tt>
&nbsp;...(1)
</tt>
</td>
</tr></table><p>where</p>
<blockquote>
<ul class="simple">
<li><tt class="docutils literal">k</tt><sub>1</sub>, <tt class="docutils literal">k</tt><sub>3</sub> are constants,</li>
<li>q is the wqf, the within query frequency,</li>
<li>f is the wdf, the within document frequency,</li>
<li>n is the number of documents in the collection indexed by this term,</li>
<li>N is the total number of documents in the collection,</li>
<li>r is the number of relevant documents indexed by this term,</li>
<li>R is the total number of relevant documents,</li>
<li>L is the normalised document length (i.e. the length of this document
divided by the average length of documents in the collection).</li>
</ul>
</blockquote>
<p>The factors (<tt class="docutils literal">k</tt><sub>3</sub><tt class="docutils literal">+1</tt>) and (<tt class="docutils literal">k</tt><sub>1</sub><tt class="docutils literal">+1</tt>) are unnecessary here, but help
scale the weights, so the first component is 1 when <tt class="docutils literal">q=1</tt> etc. But
they are critical below when we add an extra item to the sum of term
weights.</p>
</div>
<div class="section" id="bm11">
<h1>BM11</h1>
<p>Stephen Robertson's BM11 uses formula <tt class="docutils literal">(1)</tt> for the term weights, but
adds an extra item to the sum of term weights to give the overall
document score:</p>
<table border=0><tr valign=center> <td><tt>k<sub>2</sub>
n<sub>q</sub></tt></td> <td> <tt><center>
<u>(1-L)</u><br>(1+L)</center></tt> </td> <td> <tt> &nbsp;...(2) </tt> </td>
</tr></table><p>where:</p>
<ul class="simple">
<li><tt class="docutils literal">n</tt><sub>q</sub> is the number of terms in the query (the query length),</li>
<li><tt class="docutils literal">k</tt><sub>2</sub> is yet another constant.</li>
</ul>
<p>Note that this extra item is zero when <tt class="docutils literal">L=1</tt>.</p>
</div>
<div class="section" id="bm15">
<h1>BM15</h1>
<p>BM15 is BM11 with the <tt class="docutils literal">k</tt><sub>1</sub><tt class="docutils literal">+f</tt> in place of <tt class="docutils literal">k</tt><sub>1</sub><tt class="docutils literal">L+f</tt> in <tt class="docutils literal">(1)</tt>.</p>
</div>
<div class="section" id="bm25">
<h1>BM25</h1>
<p>BM25 combines the B11 and B15 with a scaling factor, b, which turns BM15
into BM11 as it moves from 0 to 1:</p>
<table border=0><tr valign=center> <td> <tt><center>
<u>(k<sub>3</sub>+1)q</u><br>(k<sub>3</sub>+q)</center></tt> </td>
<td><tt>&middot;</tt></td> <td> <tt><center>
<u>(k<sub>1</sub>+1)f</u><br>(K+f)</center></tt> </td>
<td><tt>&middot;log</tt></td> <td><tt><center>
<u>(r+0.5)(N-n-R+r+0.5)</u><br>(n-r+0.5)(R-r+0.5)</center></tt> </td> <td>
<tt> &nbsp;...(3) </tt> </td> </tr></table><p>where:</p>
<p><tt class="docutils literal">K=</tt><tt class="docutils literal">k</tt><sub>1</sub><tt class="docutils literal"><span class="pre">(bL+(1-b))</span></tt></p>
<p>BM25 originally introduced another constant, as a power to which f and K
are raised. However, Stephen remarks that powers other than 1 were <em>'not
helpful'</em>, and other tests confirm this, so Xapian's implementation of
BM25 ignores this.</p>
<p><tt class="docutils literal">(2)</tt> and <tt class="docutils literal">(3)</tt> make up BM25, with which Stephen has had so much
recent success.</p>
<p>This does all seem somewhat ad-hoc, with so many unknown constants in
the formula. But note that with <tt class="docutils literal">k</tt><sub>2</sub><tt class="docutils literal">=0</tt> and <tt class="docutils literal">b=1</tt> we get the
traditional formula anyway.</p>
<p>The default parameter values Xapian uses are <tt class="docutils literal">k</tt><sub>1</sub><tt class="docutils literal">=1</tt>, <tt class="docutils literal">k</tt><sub>2</sub><tt class="docutils literal">=0</tt>,
<tt class="docutils literal">k</tt><sub>3</sub><tt class="docutils literal">=1</tt>, and <tt class="docutils literal">b=0.5</tt>. These are reasonable defaults, but the
optimum values will vary with both the documents being searched and the
type of queries, so you may be able to improve the effectiveness of your
search system by tuning the values of these parameters.</p>
<p>In Xapian, we also apply a floor to L (0.5 by default) which helps stop
tiny documents get ridiculously high weights. And the matcher wants the
extra item in the sum to be positive, so we add <tt class="docutils literal">k</tt><sub>2</sub><tt class="docutils literal">n</tt><sub>q</sub> (constant for a
given query) to <tt class="docutils literal">(2)</tt> to give:</p>
<table border=0><tr valign=center> <td> <tt><center> <u>2 k<sub>2</sub>
n<sub>q</sub></u><br>(1 + L)</center></tt> </td> <td> <tt> &nbsp;...(4)
</tt> </td> </tr></table></div>
</div>
</body>
</html>