Sparkly documentation
=====================

Sparkly performs distributed TF/IDF blocking: it builds a Lucene index over one
table and runs bulk top-k similarity search to produce candidate pairs for matching.
This is the API reference for the classes and functions you call, organized by module.

.. toctree::
   :maxdepth: 2
   :caption: API reference

   sparkly
   sparkly.index
   sparkly.index_optimizer
   sparkly.query_generator

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`