honeymoose
/
OpenSearch
mirror of https://github.com/honeymoose/OpenSearch.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Docs: clarify calculation of sigma and lambda in function_score (#20267) 

- Using log() to indicate natural log can add some confusion when trying to further adjust/tweak scores. Other parts of the API (field_value_factor on this same page) use 'ln' and 'log', so this change should be more consistent
- Fixes #20027
- I generated the images using http://latex2png.com/ at a resolution of 150 which seemed to be about the same size as before
This commit is contained in:
Greg Ichneumon Brown 2016-09-02 05:41:07 -07:00 committed by Clinton Gormley
parent cdc27b75b8
commit 639b7278d9
3 changed files with 2 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

BIN
docs/reference/images/lambda_calc.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 920 B

After

Width:  |  Height:  |  Size: 1.4 KiB

BIN
docs/reference/images/sigma_calc.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 1.2 KiB

After

Width:  |  Height:  |  Size: 1.7 KiB

2
docs/reference/query-dsl/function-score-query.asciidoc
View File

@ -359,6 +359,7 @@ image:images/Gaussian.png[]
where image:images/sigma.png[] is computed to assure that the score takes the value `decay` at distance `scale` from `origin`+-`offset` where image:images/sigma.png[] is computed to assure that the score takes the value `decay` at distance `scale` from `origin`+-`offset`
// \sigma^2 = -scale^2/(2 \cdot ln(decay))
image:images/sigma_calc.png[] image:images/sigma_calc.png[]
See <<gauss-decay>> for graphs demonstrating the curve generated by the `gauss` function. See <<gauss-decay>> for graphs demonstrating the curve generated by the `gauss` function.
@ -374,6 +375,7 @@ image:images/Exponential.png[]
where again the parameter image:images/lambda.png[] is computed to assure that the score takes the value `decay` at distance `scale` from `origin`+-`offset` where again the parameter image:images/lambda.png[] is computed to assure that the score takes the value `decay` at distance `scale` from `origin`+-`offset`
// \lambda = ln(decay)/scale
image:images/lambda_calc.png[] image:images/lambda_calc.png[]
See <<exp-decay>> for graphs demonstrating the curve generated by the `exp` function. See <<exp-decay>> for graphs demonstrating the curve generated by the `exp` function.