MatchFlow (ML matching + active learning)
=========================================

ML-based matching with active learning. You call the pipeline functions
(``create_features`` → ``featurize`` → ``create_seeds`` / ``label_data`` →
``train_matcher`` → ``apply_matcher``), construct a model wrapper and a labeler and
pass them in, and optionally validate your tables. The **advanced** base classes at
the bottom are only for building custom pieces.

Pipeline functions
------------------

.. automodule:: madmatcher_pro.matchflow
   :members:
   :imported-members:
   :exclude-members: Tokenizer, Vectorizer, Feature, MLModel, SKLearnModel, SparkMLModel, Labeler, CustomLabeler, CLILabeler, GoldLabeler, WebUILabeler, HybridCosineLabeler
   :show-inheritance:

Model wrappers
--------------

Wrap your estimator and pass it to ``train_matcher`` (then ``apply_matcher``); you do
not call the wrapper's own methods. Use ``SKLearnModel`` for an sklearn / xgboost
estimator or ``SparkMLModel`` for a Spark ML estimator.

.. autoclass:: madmatcher_pro.matchflow.SKLearnModel
   :show-inheritance:

.. autoclass:: madmatcher_pro.matchflow.SparkMLModel
   :show-inheritance:

Labelers
--------

Construct one and pass it to ``label_data`` (or ``create_seeds``) to label pairs
during active learning.

.. autoclass:: madmatcher_pro.matchflow.GoldLabeler
   :show-inheritance:

.. autoclass:: madmatcher_pro.matchflow.CLILabeler
   :show-inheritance:

.. autoclass:: madmatcher_pro.matchflow.WebUILabeler
   :show-inheritance:

.. autoclass:: madmatcher_pro.matchflow.HybridCosineLabeler
   :show-inheritance:

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

Subclass these only to build a custom piece (a custom feature, tokenizer,
vectorizer, model wrapper, or labeler). Most users use the built-ins above.

.. autoclass:: madmatcher_pro.matchflow.Feature
   :members:
   :show-inheritance:

.. autoclass:: madmatcher_pro.matchflow.Tokenizer
   :members:
   :show-inheritance:

.. autoclass:: madmatcher_pro.matchflow.Vectorizer
   :members:
   :show-inheritance:

.. autoclass:: madmatcher_pro.matchflow.MLModel
   :members:
   :show-inheritance:

.. autoclass:: madmatcher_pro.matchflow.Labeler
   :members:
   :show-inheritance:

.. autoclass:: madmatcher_pro.matchflow.CustomLabeler
   :members:
   :show-inheritance: