RapidFuzz/docs/index.rst

42 lines
696 B
ReStructuredText
Raw Normal View History

Release v1.0.0 (#68) - all normalized string_metrics can now be used as scorer for process.extract/extractOne - Implementation of the C++ Wrapper completely refactored to make it easier to add more scorers, processors and string matching algorithms in the future. - increased test coverage, that already helped to fix some bugs and help to prevent regressions in the future - improved docstrings of functions - Added bitparallel implementation of the Levenshtein distance for the weights (1,1,1) and (1,1,2). - Added specialized implementation of the Levenshtein distance for cases with a small maximum edit distance, that is even faster, than the bitparallel implementation. - Improved performance of `fuzz.partial_ratio` -> Since `fuzz.ratio` and `fuzz.partial_ratio` are used in most scorers, this improves the overall performance. - Improved performance of `process.extract` and `process.extractOne` - the `rapidfuzz.levenshtein` module is now deprecated and will be removed in v2.0.0 These functions are now placed in `rapidfuzz.string_metric`. `distance`, `normalized_distance`, `weighted_distance` and `weighted_normalized_distance` are combined into `levenshtein` and `normalized_levenshtein`. - added normalized version of the hamming distance in `string_metric.normalized_hamming` - process.extract_iter as a generator, that yields the similarity of all elements, that have a similarity >= score_cutoff - multiple bugs in extractOne when used with a scorer, thats not from RapidFuzz - fixed bug in `token_ratio` - fixed bug in result normalisation causing zero division
2021-02-12 15:37:44 +00:00
.. RapidFuzz documentation master file, created by
sphinx-quickstart on Fri Jan 1 19:02:29 2021.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to RapidFuzz's documentation!
=====================================
.. toctree::
:maxdepth: 2
:caption: Installation:
installation
.. toctree::
:maxdepth: 2
:caption: Usage:
fuzz
string_metric
process
utils
.. toctree::
:maxdepth: 1
:caption: Contributing:
contributing
.. toctree::
:maxdepth: 2
:caption: License:
license
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`