lucene-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Grant Ingersoll (JIRA)" <j...@apache.org>
Subject [jira] Commented: (LUCENE-664) [PATCH] small fixes to the new scoring.html doc
Date Sat, 30 Sep 2006 03:14:23 GMT
    [ http://issues.apache.org/jira/browse/LUCENE-664?page=comments#action_12438837 ] 
            
Grant Ingersoll commented on LUCENE-664:
----------------------------------------

Hi Doron,

Thanks for the updates.  I like the content in scoring.xml, although I am inclined to place
it after boosts have been introduced in the Scoring Formula section (what do you think?  No
need to send a new patch if you agree, I can take care of it)

On the Similarity changes, I think I like them, but would like to hear from other people.
One of the problems I had with the old writing of the formula is it is a bit hard to  tell
whether the coord factor is inside the sum or not at first glance and I always have to think
about the theory a bit before being sure.  With your formula, it is much clearer.  You also
have some nice explanations, but I also feel it takes a bit longer to get an understanding
of the formula b/c you introduce some new factors (normalizer, searchBoost, indexBoost) that
require an extra layer of indirection (but maybe it is just b/c I am late and I'm tired and
need to take a fresh look this weekend).

I think the scoring.xml and Similarity.java formulas should be kept in sync.  Ideally we could
do some type of include and only have one file with the formula, but I am not sure how to
do this given the current documentation frameworks.

Also, I think you need a link on the indexBoost factor to the indexBoost anchor (but again,
I can take care of that if others are in favor of this part of the patch).

So, in summary, I am +1 on part 1 of this patch and am all for applying that, but after the
Scoring Formula section.  Part 1 can be applied separately from part 2 and I will do so this
weekend unless I hear objections otherwise.

The 2nd part, I am +0.5, if there is such a thing.  I really like the added explanation and
the organization of the formula, but am not sure on the searchBoost, indexBoost and normalizer
factors and would like to hear from others what they favor.

-Grant

> [PATCH] small fixes to the new scoring.html doc
> -----------------------------------------------
>
>                 Key: LUCENE-664
>                 URL: http://issues.apache.org/jira/browse/LUCENE-664
>             Project: Lucene - Java
>          Issue Type: Improvement
>          Components: Website
>    Affects Versions: 2.0.1
>            Reporter: Michael McCandless
>         Attachments: boosts_plus_scoring_formula.patch, lucene.uxf, scoring-small-fixes.patch,
scoring-small-fixes2.patch, scoring-small-fixes3.patch
>
>
> This is an awesome initiative.  We need more docs that cleanly explain the inner workings
of Lucene in general... thanks Grant & Steve & others!
> I have a few small initial proposed fixes, largely just adding some more description
around the components of the formula.  But also a couple typos, another link out to Wikipedia,
a missing closing ), etc.  I've only made it through the "Understanding the Scoring Formula"
section so far.

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

---------------------------------------------------------------------
To unsubscribe, e-mail: java-dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: java-dev-help@lucene.apache.org


Mime
View raw message