Sparkly (lexical blocking)
==========================

TF/IDF (Lucene) blocking. ``madmatcher_pro.sparkly`` has an empty ``__init__``;
import these symbols from their submodules, as shown below. The ``:members:`` on
each class is scoped to its user-facing methods (the classes also carry internal
plumbing that is not part of the supported API).

Search
------

.. autoclass:: madmatcher_pro.sparkly.search.Searcher
   :members: search, get_full_query_spec
   :show-inheritance:

Index
-----

.. autoclass:: madmatcher_pro.sparkly.index.lucene_index.LuceneIndex
   :members: upsert_docs, get_full_query_spec
   :show-inheritance:

.. autoclass:: madmatcher_pro.sparkly.index_config.IndexConfig
   :members: add_field, add_concat_field, remove_field
   :show-inheritance:

Query spec
----------

.. autoclass:: madmatcher_pro.sparkly.query_generator.QuerySpec
   :members: boost_map, filter, size, union, is_subset, to_dict
   :show-inheritance:

Index optimization and config generation (Sparkly Auto)
-------------------------------------------------------

.. autoclass:: madmatcher_pro.sparkly.index_optimizer.index_optimizer.IndexOptimizer
   :members: optimize, make_index_config
   :show-inheritance:

Table validation
----------------

.. autofunction:: madmatcher_pro.sparkly.utils.check_tables_manual

.. autofunction:: madmatcher_pro.sparkly.utils.check_tables_auto