Skip to content

Update docs for the DFR similarity #40579

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 29, 2019
Merged

Update docs for the DFR similarity #40579

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 5 additions & 13 deletions docs/reference/index-modules/similarity.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,22 +92,14 @@ from randomness] framework. This similarity has the following options:

[horizontal]
`basic_model`::
Possible values: {lucene-core-javadoc}/org/apache/lucene/search/similarities/BasicModelG.html[`be`],
{lucene-core-javadoc}/org/apache/lucene/search/similarities/BasicModelD.html[`d`],
{lucene-core-javadoc}/org/apache/lucene/search/similarities/BasicModelG.html[`g`],
Possible values: {lucene-core-javadoc}/org/apache/lucene/search/similarities/BasicModelG.html[`g`],
{lucene-core-javadoc}/org/apache/lucene/search/similarities/BasicModelIF.html[`if`],
{lucene-core-javadoc}/org/apache/lucene/search/similarities/BasicModelIn.html[`in`],
{lucene-core-javadoc}/org/apache/lucene/search/similarities/BasicModelIne.html[`ine`] and
{lucene-core-javadoc}/org/apache/lucene/search/similarities/BasicModelP.html[`p`].

`be`, `d` and `p` should be avoided in practice as they might return scores that
are equal to 0 or infinite with terms that do not meet the expected random
distribution.
{lucene-core-javadoc}/org/apache/lucene/search/similarities/BasicModelIn.html[`in`] and
{lucene-core-javadoc}/org/apache/lucene/search/similarities/BasicModelIne.html[`ine`].

`after_effect`::
Possible values: {lucene-core-javadoc}/org/apache/lucene/search/similarities/AfterEffect.NoAfterEffect.html[`no`],
{lucene-core-javadoc}/org/apache/lucene/search/similarities/AfterEffectB.html[`b`] and
{lucene-core-javadoc}/org/apache/lucene/search/similarities/AfterEffectL.html[`l`].
Possible values: {lucene-core-javadoc}/org/apache/lucene/search/similarities/AfterEffectB.html[`b`] and
{lucene-core-javadoc}/org/apache/lucene/search/similarities/AfterEffectB.html[`l`].

`normalization`::
Possible values: {lucene-core-javadoc}/org/apache/lucene/search/similarities/Normalization.NoNormalization.html[`no`],
Expand Down