Delex (DAG multi-strategy blocking)
===================================

DAG-based multi-strategy blocking. ``madmatcher_pro.delex`` has an empty
``__init__``; import these symbols from their submodules, as shown below. You build
a ``BlockingProgram`` from rules and predicates and run it with ``PlanExecutor``.
The **advanced** base classes at the bottom are only needed to write a custom
predicate or rule.

Running a blocking program
--------------------------

.. autoclass:: madmatcher_pro.delex.execution.plan_executor.PlanExecutor
   :members: execute
   :show-inheritance:

Blocking programs and rules
---------------------------

.. autoclass:: madmatcher_pro.delex.lang.program.BlockingProgram
   :members:
   :show-inheritance:

.. autoclass:: madmatcher_pro.delex.lang.rule.KeepRule
   :members:
   :show-inheritance:

.. autoclass:: madmatcher_pro.delex.lang.rule.DropRule
   :members:
   :show-inheritance:

Predicates
----------

The concrete predicates a blocking rule is built from. Import them from
``madmatcher_pro.delex.lang.predicate``.

.. autoclass:: madmatcher_pro.delex.lang.predicate.BM25TopkPredicate
   :show-inheritance:

.. autoclass:: madmatcher_pro.delex.lang.predicate.ExactMatchPredicate
   :show-inheritance:

.. autoclass:: madmatcher_pro.delex.lang.predicate.JaccardPredicate
   :show-inheritance:

.. autoclass:: madmatcher_pro.delex.lang.predicate.CosinePredicate
   :show-inheritance:

.. autoclass:: madmatcher_pro.delex.lang.predicate.OverlapCoeffPredicate
   :show-inheritance:

.. autoclass:: madmatcher_pro.delex.lang.predicate.EditDistancePredicate
   :show-inheritance:

.. autoclass:: madmatcher_pro.delex.lang.predicate.JaroPredicate
   :show-inheritance:

.. autoclass:: madmatcher_pro.delex.lang.predicate.JaroWinklerPredicate
   :show-inheritance:

.. autoclass:: madmatcher_pro.delex.lang.predicate.SmithWatermanPredicate
   :show-inheritance:

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

.. autofunction:: madmatcher_pro.delex.utils.checks.check_tables

Advanced: extension base classes
--------------------------------

Subclass these only to write a custom predicate or rule. Most users compose the
concrete predicates above and do not need them.

.. autoclass:: madmatcher_pro.delex.lang.predicate.Predicate
   :members:
   :show-inheritance:

.. autoclass:: madmatcher_pro.delex.lang.predicate.ThresholdPredicate
   :show-inheritance:

.. autoclass:: madmatcher_pro.delex.lang.predicate.SetSimPredicate
   :show-inheritance:

.. autoclass:: madmatcher_pro.delex.lang.predicate.StringSimPredicate
   :show-inheritance:

.. autoclass:: madmatcher_pro.delex.lang.rule.Rule
   :members:
   :show-inheritance: