.. _f-completionsimple:

module ``nlp.completion_simple``
================================





.. inheritance-diagram:: mlstatpy.nlp.completion_simple


Short summary
+++++++++++++

module ``mlstatpy.nlp.completion_simple``

About completion, simple algorithm


:githublink:`%|py|5`




Classes
+++++++

+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+
| class                                                                         | truncated documentation                                                             |
+===============================================================================+=====================================================================================+
| :class:`CompletionElement <mlstatpy.nlp.completion_simple.CompletionElement>` | Definition of an element in a completion system, it contains the following members: |
+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+
| :class:`CompletionSystem <mlstatpy.nlp.completion_simple.CompletionSystem>`   | define a completion system                                                          |
+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+








Static Methods
++++++++++++++

+--------------------------------------------------------------------------------------+------------------------------------------------+
| staticmethod                                                                         | truncated documentation                        |
+======================================================================================+================================================+
| :meth:`empty_prefix <mlstatpy.nlp.completion_simple.CompletionElement.empty_prefix>` | return an instance filled with an empty prefix |
+--------------------------------------------------------------------------------------+------------------------------------------------+




Methods
+++++++

+-------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+
| method                                                                                                | truncated documentation                                                                                             |
+=======================================================================================================+=====================================================================================================================+
| :py:meth:`__getitem__ <mlstatpy.nlp.completion_simple.CompletionSystem.__getitem__>`                  | Returns ``elements[i]``.                                                                                            |
+-------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+
| :py:meth:`__init__ <mlstatpy.nlp.completion_simple.CompletionElement.__init__>`                       | constructor                                                                                                         |
+-------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+
| :py:meth:`__init__ <mlstatpy.nlp.completion_simple.CompletionSystem.__init__>`                        | fill the completion system                                                                                          |
+-------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+
| :py:meth:`__iter__ <mlstatpy.nlp.completion_simple.CompletionSystem.__iter__>`                        | Iterates over elements.                                                                                             |
+-------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+
| :py:meth:`__len__ <mlstatpy.nlp.completion_simple.CompletionSystem.__len__>`                          | Number of elements.                                                                                                 |
+-------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+
| :py:meth:`__repr__ <mlstatpy.nlp.completion_simple.CompletionElement.__repr__>`                       | usual                                                                                                               |
+-------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+
| :meth:`compare_with_trie <mlstatpy.nlp.completion_simple.CompletionSystem.compare_with_trie>`         | Compares the results with the other implementation.                                                                 |
+-------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+
| :meth:`compute_metrics <mlstatpy.nlp.completion_simple.CompletionSystem.compute_metrics>`             | Computes the metric for the completion itself.                                                                      |
+-------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+
| :meth:`enumerate_test_metric <mlstatpy.nlp.completion_simple.CompletionSystem.enumerate_test_metric>` | Evaluates the completion set on a set of queries, the function returns a list of :class:`CompletionElement` ...     |
+-------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+
| :meth:`find <mlstatpy.nlp.completion_simple.CompletionSystem.find>`                                   | Not very efficient, finds an item in a the list.                                                                    |
+-------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+
| :meth:`init_metrics <mlstatpy.nlp.completion_simple.CompletionElement.init_metrics>`                  | initiate the metrics                                                                                                |
+-------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+
| :meth:`items <mlstatpy.nlp.completion_simple.CompletionSystem.items>`                                 | Iterates on ``(e.value, e)``.                                                                                       |
+-------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+
| :meth:`sort_values <mlstatpy.nlp.completion_simple.CompletionSystem.sort_values>`                     | sort the elements by value                                                                                          |
+-------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+
| :meth:`sort_weight <mlstatpy.nlp.completion_simple.CompletionSystem.sort_weight>`                     | Sorts the elements by value.                                                                                        |
+-------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+
| :meth:`str_all_completions <mlstatpy.nlp.completion_simple.CompletionElement.str_all_completions>`    | builds a string with all completions for all prefixes along the paths, this is only available if parameter ...      |
+-------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+
| :meth:`str_mks <mlstatpy.nlp.completion_simple.CompletionElement.str_mks>`                            | return a string with metric information                                                                             |
+-------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+
| :meth:`str_mks0 <mlstatpy.nlp.completion_simple.CompletionElement.str_mks0>`                          | return a string with metric information                                                                             |
+-------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+
| :meth:`test_metric <mlstatpy.nlp.completion_simple.CompletionSystem.test_metric>`                     | Evaluates the completion set on a set of queries, the function returns a dictionary with the aggregated metrics ... |
+-------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+
| :meth:`to_dict <mlstatpy.nlp.completion_simple.CompletionSystem.to_dict>`                             | Returns a dictionary.                                                                                               |
+-------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+
| :meth:`tuples <mlstatpy.nlp.completion_simple.CompletionSystem.tuples>`                               | Iterates on ``(e.weight, e.value)``.                                                                                |
+-------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+
| :meth:`update_metrics <mlstatpy.nlp.completion_simple.CompletionElement.update_metrics>`              | update the metrics                                                                                                  |
+-------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+


Documentation
+++++++++++++

.. automodule:: mlstatpy.nlp.completion_simple
    :members:
    :special-members: __init__
    :show-inheritance: