rroonga 7.0.2-x64-mingw32 → 7.1.1-x64-mingw32

data/vendor/local/share/doc/groonga/en/html/_sources/reference/scorers/scorer_tf_at_most.txt

@@ -1,136 +0,0 @@
-.. -*- rst -*-
-
-.. highlightlang:: none
-
-.. groonga-command
-.. database: scorer_tf_at_most
-
-``scorer_tf_at_most``
-=====================
-
-.. note::
-
-   This scorer is an experimental feature.
-
-.. versionadded:: 5.0.1
-
-Summary
--------
-
-``scorer_tf_at_most`` is a scorer based on TF (term frequency).
-
-TF based scorer includes TF-IDF based scorer has a problem for the
-following case:
-
-If document contains many same keywords such as "They are keyword,
-keyword, keyword ... and keyword", the document has high score. It's
-not expected. Search engine spammer may use the technique.
-
-``scorer_tf_at_most`` is a TF based scorer but it can solve the case.
-
-``scorer_tf_at_most`` limits the maximum score value. It means that
-``scorer_tf_at_most`` limits effect of a match.
-
-If document contains many same keywords such as "They are keyword,
-keyword, keyword ... and keyword", ``scorer_tf_at_most(column, 2.0)``
-returns at most ``2`` as score.
-
-.. include:: ../scoring_note.rst
-
-Syntax
-------
-
-This scorer has two parameters::
-
-  scorer_tf_at_most(column, max)
-  scorer_tf_at_most(index, max)
-
-Usage
------
-
-This section describes how to use this scorer.
-
-Here are a schema definition and sample data to show usage.
-
-Sample schema:
-
-.. groonga-command
-.. include:: ../../example/reference/scorers/scorer_tf_at_most/usage_setup_schema.log
-.. table_create Logs TABLE_NO_KEY
-.. column_create Logs message COLUMN_SCALAR Text
-..
-.. table_create Terms TABLE_PAT_KEY ShortText \
-..   --default_tokenizer TokenBigram \
-..   --normalizer NormalizerAuto
-.. column_create Terms message_index COLUMN_INDEX|WITH_POSITION Logs message
-
-Sample data:
-
-.. groonga-command
-.. include:: ../../example/reference/scorers/scorer_tf_at_most/usage_setup_data.log
-.. load --table Logs
-.. [
-.. {"message": "Notice"},
-.. {"message": "Notice Notice"},
-.. {"message": "Notice Notice Notice"},
-.. {"message": "Notice Notice Notice Notice"},
-.. {"message": "Notice Notice Notice Notice Notice"}
-.. ]
-
-You specify ``scorer_tf_at_most`` in :ref:`select-match-columns` like
-the following:
-
-.. groonga-command
-.. include:: ../../example/reference/scorers/scorer_tf_at_most/usage_no_weight.log
-.. select Logs \
-..   --match_columns "scorer_tf_at_most(message, 3.0)" \
-..   --query "Notice" \
-..   --output_columns "message, _score" \
-..   --sortby "-_score"
-
-If a document has three or more ``Notice`` terms, its score is ``3``.
-Because the ``select`` specify ``3.0`` as the max score.
-
-If a document has one or two ``Notice`` terms, its score is ``1`` or
-``2``. Because the score is less than ``3.0`` specified as the max score.
-
-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 parameter.
-
-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 with limitation.
-
-See also
---------
-
-* :doc:`../scorer`

data/vendor/local/share/doc/groonga/en/html/_sources/reference/scorers/scorer_tf_idf.txt

@@ -1,157 +0,0 @@
-.. -*- rst -*-
-
-.. highlightlang:: none
-
-.. groonga-command
-.. database: scorer_tf_idf
-
-``scorer_tf_idf``
-=================
-
-.. note::
-
-   This scorer is an experimental feature.
-
-.. versionadded:: 5.0.1
-
-Summary
--------
-
-``scorer_tf_idf`` is a scorer based of `TF-IDF
-<https://en.wikipedia.org/wiki/Tf%E2%80%93idf>`_ (term
-frequency-inverse document frequency) score function.
-
-To put it simply, TF (term frequency) divided by DF (document
-frequency) is TF-IDF. "TF" means that "the number of occurrences is
-more important". "TF divided by DF" means that "the number of
-occurrences of important term is more important".
-
-The default score function in Groonga is TF (term frequency). It
-doesn't care about term importance but is fast.
-
-TF-IDF cares about term importance but is slower than TF.
-
-TF-IDF will compute more suitable score rather than TF for many cases.
-But it's not perfect.
-
-If document contains many same keywords such as "They are keyword,
-keyword, keyword ... and keyword", it increases score by TF and
-TF-IDF. Search engine spammer may use the technique. But TF-IDF
-doesn't guard from the technique.
-
-`Okapi BM25 <https://en.wikipedia.org/wiki/Okapi_BM25>`_ can solve the
-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
------
-
-This section describes how to use this scorer.
-
-Here are a schema definition and sample data to show usage.
-
-Sample schema:
-
-.. groonga-command
-.. include:: ../../example/reference/scorers/scorer_tf_idf/usage_setup_schema.log
-.. table_create Logs TABLE_NO_KEY
-.. column_create Logs message COLUMN_SCALAR Text
-..
-.. table_create Terms TABLE_PAT_KEY ShortText \
-..   --default_tokenizer TokenBigram \
-..   --normalizer NormalizerAuto
-.. column_create Terms message_index COLUMN_INDEX|WITH_POSITION Logs message
-
-Sample data:
-
-.. groonga-command
-.. include:: ../../example/reference/scorers/scorer_tf_idf/usage_setup_data.log
-.. load --table Logs
-.. [
-.. {"message": "Error"},
-.. {"message": "Warning"},
-.. {"message": "Warning Warning"},
-.. {"message": "Warning Warning Warning"},
-.. {"message": "Info"},
-.. {"message": "Info Info"},
-.. {"message": "Info Info Info"},
-.. {"message": "Info Info Info Info"},
-.. {"message": "Notice"},
-.. {"message": "Notice Notice"},
-.. {"message": "Notice Notice Notice"},
-.. {"message": "Notice Notice Notice Notice"},
-.. {"message": "Notice Notice Notice Notice Notice"}
-.. ]
-
-You specify ``scorer_tf_idf`` in :ref:`select-match-columns` like the
-following:
-
-.. groonga-command
-.. include:: ../../example/reference/scorers/scorer_tf_idf/usage_no_weight.log
-.. select Logs \
-..   --match_columns "scorer_tf_idf(message)" \
-..   --query "Error OR Info" \
-..   --output_columns "message, _score" \
-..   --sortby "-_score"
-
-Both the score of ``Info Info Info`` and the score of ``Error`` are
-``2`` even ``Info Info Info`` includes three ``Info`` terms. Because
-``Error`` is more important term rather than ``Info``. The number of
-documents that include ``Info`` is ``4``. The number of documents that
-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 parameter.
-
-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
---------
-
-* :doc:`../scorer`

data/vendor/local/share/doc/groonga/en/html/_sources/reference/sharding.txt

@@ -1,104 +0,0 @@
-.. -*- rst -*-
-
-.. highlightlang:: none
-
-Sharding
-========
-
-.. versionadded:: 5.0.0
-
-Groonga has :doc:`/limitations` against table size. You can't add
-268,435,455 more records in one table.
-
-Groonga supports time based sharding to resolve the limitation.
-
-It works in the same database. It doesn't work with multiple
-databases. It means that this sharding feature isn't for distributing
-large data to multiple hosts.
-
-If you want distributed sharding feature, use `Mroonga
-<http://mroonga.org/>`_ or `PGroonga
-<http://pgroonga.github.io/>`_. You can use sharding feature by MySQL
-or PostgreSQL. You'll be able to use `Droonga <http://droonga.org/>`_
-for distributed sharding feature soon.
-
-Summary
--------
-
-Sharding is implemented in ``sharding`` plugin. The plugin is written
-in mruby. You need to enable mruby when you build Groonga.
-
-You can confirm whether your Groonga supports mruby or not by
-``--version`` command line argument of
-:doc:`/reference/executables/groonga`::
-
-  % groonga --version
-  groonga 5.0.5 [...,mruby,...]
-
-  configure options: <...>
-
-If you find ``mruby``, your Groonga supports mruby.
-
-``sharding`` plugin provides only search commands. They have
-``logical_`` prefix in their command names such as
-:doc:`/reference/commands/logical_select` and
-:doc:`/reference/commands/logical_range_filter`.
-
-``sharding`` plugin doesn't provide schema define commands and data
-load commands yet. You need to use existing commands such as
-:doc:`/reference/commands/table_create`,
-:doc:`/reference/commands/column_create` and
-:doc:`/reference/commands/load`.
-
-``sharding`` plugin requires some rules against table and column. You
-need to follow these rules. They are described later.
-
-.. _sharding-glossary:
-
-Glossary
---------
-
-.. list-table::
-   :header-rows: 1
-
-   * - Name
-     - Description
-   * - Logical table
-     - It's a table that consists of shards. It doesn't exist in
-       Groonga database. It just exists in our minds.
-   * - Logical table name
-     - The name of logical table. It's prefix of shard names. For
-       example, ``Logs`` is a logical table name and ``Logs_20150814``
-       and ``Logs_20150815`` are shard names.
-   * - Shard
-     - It's a table that has records in a day or month.  One shard has
-       only partial records.
-
-       Shard name (= table name) must follow
-       ``${LOGICAL_TABLE_NAME}_${YYYYMMDD}`` format or
-       ``${LOGICAL_TABLE_NAME}_${YYYYMM}``
-       format. ``${LOGICAL_TABLE_NAME}`` is expanded to logical table
-       name. ``${YYYYMMDD}`` is expanded to day. ``${YYYYMM}`` is
-       expanded to month.
-
-       For example, ``Logs_20150814`` is consists of ``Logs`` logical
-       name and ``20150814`` day.
-
-
-.. _sharding-rules:
-
-Rules
------
-
-TODO
-
-.. _sharding-commands:
-
-Commands
---------
-
-.. toctree::
-   :maxdepth: 1
-   :glob:
-
-   commands/logical_*

data/vendor/local/share/doc/groonga/en/html/_sources/reference/suggest.txt

@@ -1,17 +0,0 @@
-.. -*- rst -*-
-.. Groonga Project
-
-.. highlightlang:: none
-
-Suggest
-=======
-
-Groonga has the suggest feature. This section describes how to use it and how it works.
-
-.. toctree::
-   :maxdepth: 2
-
-   suggest/introduction
-   suggest/completion
-   suggest/correction
-   suggest/suggestion

data/vendor/local/share/doc/groonga/en/html/_sources/reference/suggest/completion.txt

@@ -1,271 +0,0 @@
-.. -*- rst -*-
-
-.. highlightlang:: none
-
-.. groonga-command
-.. % groonga-suggest-create-dataset /tmp/groonga-databases/completion query
-.. database: completion
-
-Completion
-==========
-
-This section describes about the following completion
-features:
-
-* How it works
-* How to use
-* How to learn
-
-How it works
-------------
-
-The completion feature uses three searches to compute
-completed words:
-
-  1. Prefix RK search against registered words.
-  2. Cooccurrence search against learned data.
-  3. Prefix search against registered words. (optional)
-
-Prefix RK search
-^^^^^^^^^^^^^^^^
-
-See :doc:`/reference/operations/prefix_rk_search` for prefix RK
-search.
-
-If you create dataset which is named as ``query`` by
-:doc:`/reference/executables/groonga-suggest-create-dataset`
-executable file, you can update pairs of registered word and its
-reading by loading data to ``_key`` and ``kana`` column of
-``item_query`` table explicitly for prefix RK search.
-
-Cooccurrence search
-^^^^^^^^^^^^^^^^^^^
-
-Cooccurrence search can find registered words from user's
-partial input. It uses user input sequences that will be
-learned from query logs, access logs and so on.
-
-For example, there is the following user input sequence:
-
-+----------+----------+
-|  input   |  submit  |
-+==========+==========+
-|s         |no        |
-+----------+----------+
-|se        |no        |
-+----------+----------+
-|sea       |no        |
-+----------+----------+
-|sear      |no        |
-+----------+----------+
-|searc     |no        |
-+----------+----------+
-|search    |yes       |
-+----------+----------+
-|e         |no        |
-+----------+----------+
-|en        |no        |
-+----------+----------+
-|eng       |no        |
-+----------+----------+
-|engi      |no        |
-+----------+----------+
-|engin     |no        |
-+----------+----------+
-|engine    |no        |
-+----------+----------+
-|enginen   |no (typo!)|
-+----------+----------+
-|engine    |yes       |
-+----------+----------+
-
-Groonga creates the following completion pairs:
-
-+----------+--------------------+
-|  input   |   completed word   |
-+==========+====================+
-|s         |search              |
-+----------+--------------------+
-|se        |search              |
-+----------+--------------------+
-|sea       |search              |
-+----------+--------------------+
-|sear      |search              |
-+----------+--------------------+
-|searc     |search              |
-+----------+--------------------+
-|e         |engine              |
-+----------+--------------------+
-|en        |engine              |
-+----------+--------------------+
-|eng       |engine              |
-+----------+--------------------+
-|engi      |engine              |
-+----------+--------------------+
-|engin     |engine              |
-+----------+--------------------+
-|engine    |engine              |
-+----------+--------------------+
-|enginen   |engine              |
-+----------+--------------------+
-
-All user not-submitted inputs (e.g. "s", "se" and so on)
-before each an user submission maps to the submitted input
-(e.g. "search").
-
-To be precise, this description isn't correct because it
-omits about time stamp. Groonga doesn't case about "all user
-not-submitted inputs before each an user
-submission". Groonga just case about "all user not-submitted
-inputs within a minute from an user submission before each
-an user submission". Groonga doesn't treat user inputs
-before a minute ago.
-
-If an user inputs "sea" and cooccurrence search returns
-"search" because "sea" is in input column and corresponding
-completed word column value is "search".
-
-Prefix search
-^^^^^^^^^^^^^
-
-Prefix search can find registered word that start with
-user's input. This search doesn't care about romaji,
-katakana and hiragana not like prefix RK search.
-
-This search isn't always ran. It's just ran when it's
-requested explicitly or both prefix RK search and
-cooccurrence search return nothing.
-
-For example, there is a registered word "search". An user
-can find "search" by "s", "se", "sea", "sear", "searc" and
-"search".
-
-How to use
-----------
-
-.. groonga-command
-.. load --table event_query --each 'suggest_preparer(_id, type, item, sequence, time, pair_query)'
-.. [
-.. {"sequence": "1", "time": 1312950803.86057, "item": "e"},
-.. {"sequence": "1", "time": 1312950803.96857, "item": "en"},
-.. {"sequence": "1", "time": 1312950804.26057, "item": "eng"},
-.. {"sequence": "1", "time": 1312950804.56057, "item": "engi"},
-.. {"sequence": "1", "time": 1312950804.76057, "item": "engin"},
-.. {"sequence": "1", "time": 1312950805.86057, "item": "engine", "type": "submit"}
-.. ]
-
-Groonga provides :doc:`/reference/commands/suggest` command to use
-completion. ``--type complete`` option requests completion.
-
-For example, here is an command to get completion results by
-"en":
-
-.. groonga-command
-.. include:: ../../example/reference/suggest/complete/select.log
-.. suggest --table item_query --column kana --types complete --frequency_threshold 1 --query en
-
-How it learns
--------------
-
-Cooccurrence search uses learned data. They are based on
-query logs, access logs and so on. To create learned data,
-Groonga needs user input sequence with time stamp and user
-submit input with time stamp.
-
-For example, an user wants to search by "engine". The user
-inputs the query with the following sequence:
-
-  1. 2011-08-10T13:33:23+09:00: e
-  2. 2011-08-10T13:33:23+09:00: en
-  3. 2011-08-10T13:33:24+09:00: eng
-  4. 2011-08-10T13:33:24+09:00: engi
-  5. 2011-08-10T13:33:24+09:00: engin
-  6. 2011-08-10T13:33:25+09:00: engine (submit!)
-
-Groonga can be learned from the input sequence by the
-following command::
-
-  load --table event_query --each 'suggest_preparer(_id, type, item, sequence, time, pair_query)'
-  [
-  {"sequence": "1", "time": 1312950803.86057, "item": "e"},
-  {"sequence": "1", "time": 1312950803.96857, "item": "en"},
-  {"sequence": "1", "time": 1312950804.26057, "item": "eng"},
-  {"sequence": "1", "time": 1312950804.56057, "item": "engi"},
-  {"sequence": "1", "time": 1312950804.76057, "item": "engin"},
-  {"sequence": "1", "time": 1312950805.86057, "item": "engine", "type": "submit"}
-  ]
-
-How to update reading data
---------------------------
-
-Groonga requires registered word and its reading for prefix RK
-search. This section describes how to register a word and its reading.
-
-Here is an example to register "日本" which means Japan in English:
-
-.. groonga-command
-.. include:: ../../example/reference/suggest/complete/registered-word-japan.log
-.. load --table event_query --each 'suggest_preparer(_id, type, item, sequence, time, pair_query)'
-.. [
-.. {"sequence": "1", "time": 1312950805.86058, "item": "日本", "type": "submit"}
-.. ]
-
-
-Here is an example to update reading data to complete "日本":
-
-.. groonga-command
-.. include:: ../../example/reference/suggest/complete/update-rk-data.log
-.. load --table item_query
-.. [
-.. {"_key":"日本", "kana":["ニホン", "ニッポン"]}
-.. ]
-
-Then you can complete registered word "日本" by Romaji input -
-"nihon".
-
-.. groonga-command
-.. include:: ../../example/reference/suggest/complete/rk-search-nihon.log
-.. suggest --table item_query --column kana --types complete --frequency_threshold 1 --query nihon
-
-Without loading above reading data, you can't complete registered word
-"日本" by query - "nihon".
-
-You can register multiple readings for a registered word because
-``kana`` column in ``item_query`` table is defined as a
-:doc:`/reference/columns/vector`.
-
-This is the reason that you can also complete the registered word "日本"
-by query - "nippon".
-
-.. groonga-command
-.. include:: ../../example/reference/suggest/complete/rk-search-nippon.log
-.. suggest --table item_query --column kana --types complete --frequency_threshold 1 --query nippon
-
-This feature is very convenient because you can search registered word
-even though Japanese input method is disabled.
-
-If there are multiple candidates as completed result, you can
-customize priority to set the value of ``boost`` column in
-``item_query`` table.
-
-Here is an example to customize priority for prefix RK search:
-
-.. groonga-command
-.. include:: ../../example/reference/suggest/complete/registered-word-japanese.log
-.. load --table event_query --each 'suggest_preparer(_id, type, item, sequence, time, pair_query)'
-.. [
-.. {"sequence": "1", "time": 1312950805.86059, "item": "日本語", "type": "submit"}
-.. {"sequence": "1", "time": 1312950805.86060, "item": "日本人", "type": "submit"}
-.. ]
-.. load --table item_query
-.. [
-.. {"_key":"日本語", "kana":"ニホンゴ"}
-.. {"_key":"日本人", "kana":"ニホンジン"}
-.. ]
-.. suggest --table item_query --column kana --types complete --frequency_threshold 1 --query nihon
-.. load --table item_query
-.. [
-.. {"_key":"日本人", "boost": 100},
-.. ]
-.. suggest --table item_query --column kana --types complete --frequency_threshold 1 --query nihon
-