Kouhei Sutou
null+****@clear*****
Tue Sep 15 14:15:45 JST 2015
Kouhei Sutou 2015-09-15 14:15:45 +0900 (Tue, 15 Sep 2015) New Revision: 266f8f5cb2c785e3286cf51147846e1055a2ed73 https://github.com/groonga/groonga/commit/266f8f5cb2c785e3286cf51147846e1055a2ed73 Message: doc scorer_tf_idf: add more description Modified files: doc/source/reference/scorers/scorer_tf_idf.rst Modified: doc/source/reference/scorers/scorer_tf_idf.rst (+47 -0) =================================================================== --- doc/source/reference/scorers/scorer_tf_idf.rst 2015-09-15 14:06:52 +0900 (3b89ca3a) +++ doc/source/reference/scorers/scorer_tf_idf.rst 2015-09-15 14:15:45 +0900 (1573d31) @@ -43,8 +43,19 @@ doesn't guard from the technique. case. But it's more slower than TF-IDF and not implemented yet in Groonga. +Groonga provides :doc:`scorer_tf_at_most` scorer that can also solve +the case. + .. include:: ../scoring_note.rst +Syntax +------ + +This scorer has only one parameter:: + + scorer_tf_idf(column) + scorer_tf_idf(index) + Usage ----- @@ -104,6 +115,42 @@ include ``Error`` is ``1``. Term that is included in less documents means that the term is more characteristic term. Characteristic term is important term. +Parameters +---------- + +This section describes all parameters. + +Required parameters +^^^^^^^^^^^^^^^^^^^ + +There is only one required parameters. + +``column`` +"""""""""" + +The data column that is match target. The data column must be indexed. + +``index`` +""""""""" + +The index column to be used for search. + +Optional parameters +^^^^^^^^^^^^^^^^^^^ + +There is no optional parameters. + +Return value +------------ + +This scorer returns score as :ref:`builtin-type-float`. + +:doc:`/reference/commands/select` returns ``_score`` as ``Int32`` not +``Float``. Because it casts to ``Int32`` from ``Float`` for keeping +backward compatibility. + +Score is computed as TF-IDF based algorithm. + See also -------- -------------- next part -------------- HTML����������������������������...Download