Class TFIDFSimilarity

Implementation of Similarity with the Vector Space Model.

Expert: Scoring API.

TFIDFSimilarity defines the components of Lucene scoring. Overriding computation of these components is a convenient way to alter Lucene scoring.

Suggested reading: Introduction To Information Retrieval, Chapter 6.

The following describes how Lucene scoring evolves from underlying information retrieval models to (efficient) implementation. We first brief on VSM Score, then derive from it Lucene's Conceptual Scoring Formula, from which, finally, evolves Lucene's Practical Scoring Function (the latter is connected directly with Lucene classes and methods).

Lucene combines Boolean model (BM) of Information Retrieval with Vector Space Model (VSM) of Information Retrieval - documents "approved" by BM are scored by VSM.

In VSM, documents and queries are represented as weighted vectors in a multi-dimensional space, where each distinct index term is a dimension, and weights are Tf-idf values.

VSM does not require weights to be Tf-idf values, but Tf-idf values are believed to produce search results of high quality, and so Lucene is using Tf-idf. Tf and Idf are described in more detail below, but for now, for completion, let's just say that for given term t and document (or query) x, Tf(t,x) varies with the number of occurrences of term t in x (when one increases so does the other) and idf(t) similarly varies with the inverse of the number of index documents containing term t.

VSM score of document d for query q is the Cosine Similarity of the weighted query vectors V(q) and V(d):

cosine-similarity(q,d)   =   V(q) · V(d)–––––––––|V(q)| |V(d)|

VSM Score

Where V(q) · V(d) is the dot product of the weighted vectors, and |V(q)| and |V(d)| are their Euclidean norms.

Note: the above equation can be viewed as the dot product of the normalized weighted vectors, in the sense that dividing V(q) by its euclidean norm is normalizing it to a unit vector.

Lucene refines VSM score for both search quality and usability:

• Normalizing V(d) to the unit vector is known to be problematic in that it removes all document length information. For some documents removing this info is probably ok, e.g. a document made by duplicating a certain paragraph 10 times, especially if that paragraph is made of distinct terms. But for a document which contains no duplicated paragraphs, this might be wrong. To avoid this problem, a different document length normalization factor is used, which normalizes to a vector equal to or larger than the unit vector: doc-len-norm(d).
• At indexing, users can specify that certain documents are more important than others, by assigning a document boost. For this, the score of each document is also multiplied by its boost value doc-boost(d).
• Lucene is field based, hence each query term applies to a single field, document length normalization is by the length of the certain field, and in addition to document boost there are also document fields boosts.
• The same field can be added to a document during indexing several times, and so the boost of that field is the multiplication of the boosts of the separate additions (or parts) of that field within the document.
• At search time users can specify boosts to each query, sub-query, and each query term, hence the contribution of a query term to the score of a document is multiplied by the boost of that query term query-boost(q).
• A document may match a multi term query without containing all the terms of that query (this is correct for some of the queries), and users can further reward documents matching more query terms through a coordination factor, which is usually larger when more terms are matched: coord-factor(q,d).

Under the simplifying assumption of a single field in the index, we get Lucene's Conceptual scoring formula:

score(q,d)   =   coord-factor(q,d) ·   query-boost(q) ·   V(q) · V(d) ––––––––– |V(q)|   ·   doc-len-norm(d)   ·   doc-boost(d)

Lucene Conceptual Scoring Formula

The conceptual formula is a simplification in the sense that (1) terms and documents are fielded and (2) boosts are usually per query term rather than per query.

We now describe how Lucene implements this conceptual scoring formula, and derive from it Lucene's Practical Scoring Function.

For efficient score computation some scoring components are computed and aggregated in advance:

• Query-boost for the query (actually for each query term) is known when search starts.
• Query Euclidean norm |V(q)| can be computed when search starts, as it is independent of the document being scored. From search optimization perspective, it is a valid question why bother to normalize the query at all, because all scored documents will be multiplied by the same |V(q)|, and hence documents ranks (their order by score) will not be affected by this normalization. There are two good reasons to keep this normalization:
  • Recall that Cosine Similarity can be used find how similar two documents are. One can use Lucene for e.g. clustering, and use a document as a query to compute its similarity to other documents. In this use case it is important that the score of document d3 for query d1 is comparable to the score of document d3 for query d2. In other words, scores of a document for two distinct queries should be comparable. There are other applications that may require this. And this is exactly what normalizing the query vector V(q) provides: comparability (to a certain extent) of two or more queries.
  • Applying query normalization on the scores helps to keep the scores around the unit vector, hence preventing loss of score data because of floating point precision limitations.
• Document length norm doc-len-norm(d) and document boost doc-boost(d) are known at indexing time. They are computed in advance and their multiplication is saved as a single value in the index: norm(d). (In the equations below, norm(t in d) means norm(field(t) in doc d) where field(t) is the field associated with term t.)

Lucene's Practical Scoring Function is derived from the above. The color codes demonstrate how it relates to those of the conceptual formula:

score(q,d)   =   coord(q,d)   ·   queryNorm(q)   ·   ∑ (tf(t in d)   ·   idf(t)2   ·   t.Boost   ·   norm(t,d)) t in q

Lucene Practical Scoring Function

where

1. tf(t in d) correlates to the term's frequency, defined as the number of times term t appears in the currently scored document d. Documents that have more occurrences of a given term receive a higher score. Note that tf(t in q) is assumed to be 1 and therefore it does not appear in this equation, However if a query contains twice the same term, there will be two term-queries with that same term and hence the computation would still be correct (although not very efficient). The default computation for tf(t in d) in DefaultSimilarity (Tf(float)) is:

   tf(t in d)   =

   frequency½

2. idf(t) stands for Inverse Document Frequency. this value correlates to the inverse of DocFreq (the number of documents in which the term t appears). this means rarer terms give higher contribution to the total score. idf(t) appears for t in both the query and the document, hence it is squared in the equation. The default computation for idf(t) in DefaultSimilarity (Idf(long, long)) is:

   idf(t)   =

   1 + log (

   NumDocs ––––––––– DocFreq+1

   )

3. coord(q,d) is a score factor based on how many of the query terms are found in the specified document. Typically, a document that contains more of the query's terms will receive a higher score than another document with fewer query terms. this is a search time factor computed in coord(q,d) (Coord(int, int)) by the Similarity in effect at search time.

4. queryNorm(q) is a normalizing factor used to make scores between queries comparable. this factor does not affect document ranking (since all ranked documents are multiplied by the same factor), but rather just attempts to make scores from different queries (or even different indexes) comparable. this is a search time factor computed by the Similarity in effect at search time.

   The default computation in DefaultSimilarity (QueryNorm(float)) produces a Euclidean norm:

   queryNorm(q)   =   queryNorm(sumOfSquaredWeights)   =

   1 –––––––––––––– sumOfSquaredWeights½

   The sum of squared weights (of the query terms) is computed by the query Weight object. For example, a BooleanQuery computes this value as:

   sumOfSquaredWeights   =   q.Boost 2  ·	∑	(idf(t)  ·  t.Boost) 2
   	t in q

   where sumOfSquaredWeights is GetValueForNormalization() and q.Boost is Boost

5. t.Boost is a search time boost of term t in the query q as specified in the query text (see query syntax), or as set by application calls to Boost. Notice that there is really no direct API for accessing a boost of one term in a multi term query, but rather multi terms are represented in a query as multi TermQuery objects, and so the boost of a term in the query is accessible by calling the sub-query Boost.

6. norm(t,d) encapsulates a few (indexing time) boost and length factors:
   • Field boost - set Boost before adding the field to a document.
   • lengthNorm - computed when the document is added to the index in accordance with the number of tokens of this field in the document, so that shorter fields contribute more to the score. LengthNorm is computed by the Similarity class in effect at indexing.
   The ComputeNorm(FieldInvertState) method is responsible for combining all of these factors into a single float.
   When a document is added to the index, all the above factors are multiplied. If the document has multiple fields with the same name, all their boosts are multiplied together:

   norm(t,d)   =   lengthNorm  ·	∏	Boost
   	field f in d named as t

   Note that search time is too late to modify this norm part of scoring, e.g. by using a different Similarity for search.

Inheritance

object

Similarity

TFIDFSimilarity

DefaultSimilarity

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Lucene.Net.Search.Similarities

Assembly: Lucene.Net.dll

Syntax

public abstract class TFIDFSimilarity : Similarity

Constructors

TFIDFSimilarity()

Sole constructor. (For invocation by subclass constructors, typically implicit.)

Declaration

protected TFIDFSimilarity()

See Also

Similarity

Similarity

Methods

ComputeNorm(FieldInvertState)

Computes the normalization value for a field, given the accumulated state of term processing for this field (see FieldInvertState).

Matches in longer fields are less precise, so implementations of this method usually set smaller values when state.Length is large, and larger values when

state.Length

is small.

Note

This API is experimental and might change in incompatible ways in the next release.

Declaration

public override sealed long ComputeNorm(FieldInvertState state)

Parameters

Type	Name	Description
FieldInvertState	state	current processing state for this field

Returns

Type	Description
long	computed norm value

Overrides

Similarity.ComputeNorm(FieldInvertState)

See Also

Similarity

Similarity

ComputeWeight(float, CollectionStatistics, params TermStatistics[])

Compute any collection-level weight (e.g. IDF, average document length, etc) needed for scoring a query.

Declaration

public override sealed Similarity.SimWeight ComputeWeight(float queryBoost, CollectionStatistics collectionStats, params TermStatistics[] termStats)

Parameters

Type	Name	Description
float	queryBoost	the query-time boost.
CollectionStatistics	collectionStats	collection-level statistics, such as the number of tokens in the collection.
TermStatistics[]	termStats	term-level statistics, such as the document frequency of a term across the collection.

Returns

Type	Description
Similarity.SimWeight	Similarity.SimWeight object with the information this Similarity needs to score a query.

Overrides

Similarity.ComputeWeight(float, CollectionStatistics, params TermStatistics[])

See Also

Similarity

Similarity

Coord(int, int)

Computes a score factor based on the fraction of all query terms that a document contains. this value is multiplied into scores.

The presence of a large portion of the query terms indicates a better match with the query, so implementations of this method usually return larger values when the ratio between these parameters is large and smaller values when the ratio between them is small.

Declaration

public override abstract float Coord(int overlap, int maxOverlap)

Parameters

Type	Name	Description
int	overlap	The number of query terms matched in the document
int	maxOverlap	The total number of terms in the query

Returns

Type	Description
float	A score factor based on term overlap with the query

Overrides

Similarity.Coord(int, int)

See Also

Similarity

Similarity

DecodeNormValue(long)

Decodes a normalization factor stored in an index.

Declaration

public abstract float DecodeNormValue(long norm)

Parameters

Type	Name	Description
long	norm

Returns

Type	Description
float

See Also

Similarity

Similarity

EncodeNormValue(float)

Encodes a normalization factor for storage in an index.

Declaration

public abstract long EncodeNormValue(float f)

Parameters

Type	Name	Description
float	f

Returns

Type	Description
long

See Also

Similarity

Similarity

GetSimScorer(SimWeight, AtomicReaderContext)

Creates a new Similarity.SimScorer to score matching documents from a segment of the inverted index.

Declaration

public override sealed Similarity.SimScorer GetSimScorer(Similarity.SimWeight stats, AtomicReaderContext context)

Parameters

Type	Name	Description
Similarity.SimWeight	stats
AtomicReaderContext	context	segment of the inverted index to be scored.

Returns

Type	Description
Similarity.SimScorer	Sloppy Similarity.SimScorer for scoring documents across context

Overrides

Similarity.GetSimScorer(Similarity.SimWeight, AtomicReaderContext)

Exceptions

Type	Condition
IOException	if there is a low-level I/O error

See Also

Similarity

Similarity

Idf(long, long)

Computes a score factor based on a term's document frequency (the number of documents which contain the term). This value is multiplied by the Tf(float) factor for each term in the query and these products are then summed to form the initial score for a document.

Terms that occur in fewer documents are better indicators of topic, so implementations of this method usually return larger values for rare terms, and smaller values for common terms.

Declaration

public abstract float Idf(long docFreq, long numDocs)

Parameters

Type	Name	Description
long	docFreq	The number of documents which contain the term
long	numDocs	The total number of documents in the collection

Returns

Type	Description
float	A score factor based on the term's document frequency

See Also

Similarity

Similarity

IdfExplain(CollectionStatistics, TermStatistics)

Computes a score factor for a simple term and returns an explanation for that score factor.

The default implementation uses:

Idf(docFreq, searcher.MaxDoc);

Note that MaxDoc is used instead of NumDocs because also DocFreq is used, and when the latter is inaccurate, so is MaxDoc, and in the same direction. In addition, MaxDoc is more efficient to compute

Declaration

public virtual Explanation IdfExplain(CollectionStatistics collectionStats, TermStatistics termStats)

Parameters

Type	Name	Description
CollectionStatistics	collectionStats	Collection-level statistics
TermStatistics	termStats	Term-level statistics for the term

Returns

Type	Description
Explanation	An Explain object that includes both an idf score factor and an explanation for the term.

See Also

Similarity

Similarity

IdfExplain(CollectionStatistics, TermStatistics[])

Computes a score factor for a phrase.

The default implementation sums the idf factor for each term in the phrase.

Declaration

public virtual Explanation IdfExplain(CollectionStatistics collectionStats, TermStatistics[] termStats)

Parameters

Type	Name	Description
CollectionStatistics	collectionStats	Collection-level statistics
TermStatistics[]	termStats	Term-level statistics for the terms in the phrase

Returns

Type	Description
Explanation	An Explain object that includes both an idf score factor for the phrase and an explanation for each term.

See Also

Similarity

Similarity

LengthNorm(FieldInvertState)

Compute an index-time normalization value for this field instance.

This value will be stored in a single byte lossy representation by EncodeNormValue(float).

Declaration

public abstract float LengthNorm(FieldInvertState state)

Parameters

Type	Name	Description
FieldInvertState	state	Statistics of the current field (such as length, boost, etc)

Returns

Type	Description
float	An index-time normalization value

See Also

Similarity

Similarity

QueryNorm(float)

Computes the normalization value for a query given the sum of the squared weights of each of the query terms. this value is multiplied into the weight of each query term. While the classic query normalization factor is computed as 1/sqrt(sumOfSquaredWeights), other implementations might completely ignore sumOfSquaredWeights (ie return 1).

This does not affect ranking, but the default implementation does make scores from different queries more comparable than they would be by eliminating the magnitude of the Query vector as a factor in the score.

Declaration

public override abstract float QueryNorm(float sumOfSquaredWeights)

Parameters

Type	Name	Description
float	sumOfSquaredWeights	The sum of the squares of query term weights

Returns

Type	Description
float	A normalization factor for query weights

Overrides

Similarity.QueryNorm(float)

See Also

Similarity

Similarity

ScorePayload(int, int, int, BytesRef)

Calculate a scoring factor based on the data in the payload. Implementations are responsible for interpreting what is in the payload. Lucene makes no assumptions about what is in the byte array.

Declaration

public abstract float ScorePayload(int doc, int start, int end, BytesRef payload)

Parameters

Type	Name	Description
int	doc	The docId currently being scored.
int	start	The start position of the payload
int	end	The end position of the payload
BytesRef	payload	The payload byte array to be scored

Returns

Type	Description
float	An implementation dependent float to be used as a scoring factor

See Also

Similarity

Similarity

SloppyFreq(int)

Computes the amount of a sloppy phrase match, based on an edit distance. this value is summed for each sloppy phrase match in a document to form the frequency to be used in scoring instead of the exact term count.

A phrase match with a small edit distance to a document passage more closely matches the document, so implementations of this method usually return larger values when the edit distance is small and smaller values when it is large.

Declaration

public abstract float SloppyFreq(int distance)

Parameters

Type	Name	Description
int	distance	The edit distance of this sloppy phrase match

Returns

Type	Description
float	The frequency increment for this match

See Also

Slop

Tf(float)

Computes a score factor based on a term or phrase's frequency in a document. This value is multiplied by the Idf(long, long) factor for each term in the query and these products are then summed to form the initial score for a document.

Terms and phrases repeated in a document indicate the topic of the document, so implementations of this method usually return larger values when freq is large, and smaller values when freq is small.

Declaration

public abstract float Tf(float freq)

Parameters

Type	Name	Description
float	freq	The frequency of a term within a document

Returns

Type	Description
float	A score factor based on a term's within-document frequency

See Also

Similarity

Similarity

See Also

Similarity

Similarity