Generic least-squares function

This tutorial shows how to write a basic generic least-squares cost function that works well with iminuit.

We have seen in the basic tutorial how to make a least-squares function with an explicit signature that iminuit could read to find the parameter names automatically. Part of the structure of a least-squares function is always the same. What changes is the model that predicts the y-values and its parameters. Here, we show how to make a generic weighted least-squares that extracts the parameters from the model which the user provides.

Note: Cost functions for common use-cases can be imported from ``iminuit.cost``, including a better version of a generic least-squares function that we build here. The built-in cost functions come with extra features and use some insights to make them work better than naive implementations, so prefer the built-in cost functions if you can.

Derive parameters from model

import numpy as np
from iminuit import Minuit
from iminuit.util import describe
from typing import Annotated

class LeastSquares:
    """
    Generic least-squares cost function with error.
    """

    errordef = Minuit.LEAST_SQUARES  # for Minuit to compute errors correctly

    def __init__(self, model, x, y, err):
        self.model = model  # model predicts y for given x
        self.x = np.asarray(x)
        self.y = np.asarray(y)
        self.err = np.asarray(err)

    def __call__(self, *par):  # we must accept a variable number of model parameters
        ym = self.model(self.x, *par)
        return np.sum((self.y - ym) ** 2 / self.err**2)

Let’s try it out with iminuit. We use a straight-line model which is only allowed to have positive slopes, and use an annotation with a slice to declare that, see iminuit.util.describe for details.

def line(x, a: float, b: Annotated[float, 0:]):
    return a + b * x


rng = np.random.default_rng(1)
x_data = np.arange(1, 6, dtype=float)
y_err = np.ones_like(x_data)
y_data = line(x_data, 1, 2) + rng.normal(0, y_err)

lsq = LeastSquares(line, x_data, y_data, y_err)

# this fails
try:
    m = Minuit(lsq, a=0, b=0)
    m.errordef = Minuit.LEAST_SQUARES
except RuntimeError:
    import traceback

    traceback.print_exc()

Traceback (most recent call last):
  File "/tmp/ipykernel_4604/1496415135.py", line 14, in <module>
    m = Minuit(lsq, a=0, b=0)
        ^^^^^^^^^^^^^^^^^^^^^
  File "/home/runner/work/iminuit/iminuit/src/iminuit/minuit.py", line 683, in __init__
    self._init_state = _make_init_state(self._pos2var, start, kwds)
                       ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/home/runner/work/iminuit/iminuit/src/iminuit/minuit.py", line 2611, in _make_init_state
    raise RuntimeError(
RuntimeError: a is not one of the parameters []

What happened? iminuit uses introspection to detect the parameter names and the number of parameters. It uses the describe utility for that, but it fails, since the generic method signature LeastSquares.__call__(self, *par), does not reveal the number and names of the parameters.

The information could be extracted from the model signature, but iminuit knows nothing about the signature of line(x, a, b) here. We can fix this by generating a function signature for the LeastSquares class from the signature of the model.

# get the args from line
describe(line, annotations=True)

{'x': None, 'a': None, 'b': (0, inf)}

# we inject that into the lsq object with the special attribute
# `_parameters` that iminuit recognizes
pars = describe(line, annotations=True)
model_args = iter(pars)
next(model_args)  # we skip the first argument which is not a model parameter
lsq._parameters = {k: pars[k] for k in model_args}

# now we get the right answer
describe(lsq, annotations=True)

{'a': None, 'b': (0, inf)}

We can put this code into the init function of our generic least-squares class to obtain a generic least-squares class which works with iminuit.

class BetterLeastSquares(LeastSquares):
    def __init__(self, model, x, y, err):
        super().__init__(model, x, y, err)
        pars = describe(model, annotations=True)
        model_args = iter(pars)
        next(model_args)
        self._parameters = {k: pars[k] for k in model_args}

lsq = BetterLeastSquares(line, x_data, y_data, y_err)

m = Minuit(lsq, a=0, b=1)
m.migrad()

Migrad
FCN = 3.079	Nfcn = 38
EDM = 9.86e-10 (Goal: 0.0002)
Valid Minimum	Below EDM threshold (goal x 10)
No parameters at limit	Below call limit
Hesse ok	Covariance accurate

	Name	Value	Hesse Error	Minos Error-	Minos Error+	Limit-	Limit+	Fixed
0	a	1.5	1.0
1	b	1.90	0.32			0

	a	b
a	1.1	-0.3 (-0.905)
b	-0.3 (-0.905)	0.1

Report number of data points

The minimum value of our least-squares function is asymptotically chi2-distributed. This is useful, because it allows us to judge the quality of the fit. iminuit automatically reports the reduced chi2 value \(\chi^2/n_\text{dof}\) if the cost function has errordef equal to Minuit.LEAST_SQUARES and reports the number of data points.

class EvenBetterLeastSquares(BetterLeastSquares):
    @property
    def ndata(self):
        return len(self.x)


lsq = EvenBetterLeastSquares(line, x_data, y_data, y_err)

m = Minuit(lsq, a=0, b=0)
m.migrad()

Migrad
FCN = 3.079 (χ²/ndof = 1.0)	Nfcn = 63
EDM = 3.17e-08 (Goal: 0.0002)
Valid Minimum	Below EDM threshold (goal x 10)
No parameters at limit	Below call limit
Hesse ok	Covariance accurate

	Name	Value	Hesse Error	Minos Error-	Minos Error+	Limit-	Limit+	Fixed
0	a	1.5	1.0
1	b	1.90	0.32			0

	a	b
a	1.1	-0.3 (-0.905)
b	-0.3 (-0.905)	0.1

As a developer of a cost function, you have to make sure that its minimum value is chi2-distributed if you add the property ndata to your cost function, Minuit has no way of knowing that.

For binned likelihoods, one can make the minimum value asymptotically chi2-distributed by applying transformations, see Baker and Cousins, Nucl.Instrum.Meth. 221 (1984) 437-442.