.. _regressors:

Regressors
==========

Overview
--------

The models listed in this section map to C++ classes **and** the exact
keywords you use in a configuration or task file.  The match is
literal but case-insensitive:

.. code-block:: ini

   MODEL  M_KRR  Kern_RBF     # pick Kernel Ridge Regression
   MODEL  M_BLR  BF_Polynomial2   # pick Bayesian Linear Regression

Quick syntax guide
------------------

.. code-block:: ini

   MODEL  <Regressor>  [<Kernel> | <BasisF>]

* ``<Regressor>`` – one of the names under **Regressors** below  
  (``M_KRR``, ``M_BLR`` …).
* ``<Kernel>`` – required for kernel methods (choose from the *Kernels*
  subsection).  
* ``<BasisF>`` – required for linear / basis-function methods (choose from
  the *Basis Functions* subsection).  
* Follow-up keys such as ``MPARAMS``, ``SBASIS`` configure the
  model and are listed in each class’s table.

Examples
........

Kernel ridge regression with an RBF kernel:

.. code-block:: ini

   MODEL     M_KRR  Kern_RBF
   MPARAMS   0.5        # γ for RBF

Bayesian linear regression with the second order polynomial basis function:

.. code-block:: ini

   MODEL     M_BLR  BF_Polynomial2

Reading the autogenerated tables
--------------------------------

Each class entry provides:

* A concise description & mathematical form.
* The expected template parameter (kernel or basis).
* Required context keys (*bold* in the “Required key” lines).

Select the class name you need, supply exactly the keys it expects (see
*Value Limits*), and Tadah!MLIP will construct the corresponding regressor at
run-time.

The remainder of this page lists every available regressor, followed by
supported kernels and basis functions.

.. rubric:: Regressors

M_KRR
-----

.. doxygenclass:: tadah::mlip::M_KRR

Kernels
.......

Kern_Linear
~~~~~~~~~~~

.. doxygenclass:: tadah::models::Kern_Linear

Kern_LQ
~~~~~~~

.. doxygenclass:: tadah::models::Kern_LQ

Kern_Polynomial
~~~~~~~~~~~~~~~

.. doxygenclass:: tadah::models::Kern_Polynomial

Kern_Quadratic
~~~~~~~~~~~~~~

.. doxygenclass:: tadah::models::Kern_Quadratic

Kern_RBF
~~~~~~~~

.. doxygenclass:: tadah::models::Kern_RBF

Kern_Sigmoid
~~~~~~~~~~~~

.. doxygenclass:: tadah::models::Kern_Sigmoid

M_BLR
-----

.. doxygenclass:: tadah::mlip::M_BLR

Basis Functions
...............

BF_Linear
~~~~~~~~~

.. doxygenstruct:: tadah::models::BF_Linear

BF_Polynomial2
~~~~~~~~~~~~~~

.. doxygenstruct:: tadah::models::BF_Polynomial2