.. _api_documentation:

=================
API Documentation
=================

.. currentmodule:: posthoc

Main classes that implement the post-hoc adaptation framework
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~


.. autosummary::
   :template: class.rst

    Workbench
    WorkbenchOptimizer
    Beamformer

Ways of estimating the covariance matrix
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. currentmodule:: posthoc.cov_estimators
.. autosummary::
   :template: class.rst

    Empirical
    L2
    L2Kernel
    Shrinkage
    ShrinkageKernel
    KroneckerKernel

Utilities for efficient leave-one-out crossvalidation
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. currentmodule:: posthoc.loo_utils
.. autosummary::
   :template: function.rst

   loo
   loo_kern_inv
   loo_mean_norm
   loo_ols_regression
   loo_ols_values
   loo_patterns_from_model

Scoring functions
~~~~~~~~~~~~~~~~~
.. currentmodule:: posthoc.scoring
.. autosummary::
   :template: function.rst

   correlation_score
   logistic_loss_score