Adam#

class zfit.minimize.Adam(tol=None, learning_rate=0.2, beta1=0.9, beta2=0.999, epsilon=1e-08, name='Adam', **kwargs)[source]#

Bases: zfit.minimizers.base_tf.WrapOptimizer

create_criterion(loss=None, params=None)#

Create a criterion instance for the given loss and parameters.

Parameters
  • loss (ZfitLoss | None) – Loss that is used for the criterion. Can be None if called inside _minimize

  • params (ztyping.ParametersType | None) – Parameters that will be associated with the loss in this order. Can be None if called within _minimize.

Return type

ConvergenceCriterion

Returns

ConvergenceCriterion to check if the function converged.

create_evaluator(loss=None, params=None, strategy=None)#

Make a loss evaluator using the strategy and more from the minimizer.

Convenience factory for the loss evaluator. This wraps the loss to return a numpy array, to catch NaNs, stop on maxiter and evaluate the gradient and hessian without the need to specify the order every time.

Parameters
  • loss (ZfitLoss | None) – Loss to be wrapped. Can be None if called inside _minimize

  • params (ztyping.ParametersType | None) – Parameters that will be associated with the loss in this order. Can be None if called within _minimize.

  • strategy (ZfitStrategy | None) – Instance of a Strategy that will be used during the evaluation.

Returns

The evaluator that wraps the Loss ant Strategy with the current parameters.

Return type

LossEval

minimize(loss, params=None, init=None)#

Fully minimize the loss with respect to params, optionally using information from init.

The minimizer changes the parameter values in order to minimize the loss function until the convergence criterion value is less than the tolerance. This is a stateless function that can take a FitResult in order to initialize the minimization.

Parameters
  • loss (ZfitLoss | Callable) – Loss to be minimized until convergence is reached. Usually a ZfitLoss.

  • attribute (- If this is a simple callable that takes an array as argument and an attribute errordef. The) –

    can be set to any arbitrary function like

    def loss(x):
        return - x ** 2
    
    loss.errordef = 0.5  # as an example
    minimizer.minimize(loss, [2, 5])
    

    If not TensorFlow is used inside the function, make sure to set zfit.run.set_graph_mode(False) and zfit.run.set_autograd_mode(False).

  • method (- A FitResult can be provided as the only argument to the) – parameters to be minimized are taken from it. This allows to easily chain minimization algorithms.

  • the (in which case the loss as well as) – parameters to be minimized are taken from it. This allows to easily chain minimization algorithms.

  • params (ztyping.ParamsTypeOpt | None) –

    The parameters with respect to which to minimize the loss. If None, the parameters will be taken from the loss.

    In order to fix the parameter values to a specific value (and thereby make them indepented of their current value), a dictionary mapping a parameter to a value can be given.

    If loss is a callable, params can also be (instead of Parameters):

    • an array of initial values

    • for more control, a dict with the keys:

      • value (required): array-like initial values.

      • name: list of unique names of the parameters.

      • lower: array-like lower limits of the parameters,

      • upper: array-like upper limits of the parameters,

      • step_size: array-like initial step size of the parameters (approximately the expected uncertainty)

    This will create internally a single parameter for each value that can be accessed in the FitResult via params. Repeated calls can therefore (in the current implement) cause a memory increase. The recommended way is to re-use parameters (just taken from the FitResult attribute params).

  • init (ZfitResult | None) –

    A result of a previous minimization that provides auxiliary information such as the starting point for the parameters, the approximation of the covariance and more. Which information is used can depend on the specific minimizer implementation.

    In general, the assumption is that the loss provided is similar enough to the one provided in init.

    What is assumed to be close:

    • the parameters at the minimum of loss will be close to the parameter values at the minimum of init.

    • Covariance matrix, or in general the shape, of init to the loss at its minimum.

    What is explicitly _not_ assumed to be the same:

    • absolute value of the loss function. If init has a function value at minimum x of fmin, it is not assumed that loss will have the same/similar value at x.

    • parameters that are used in the minimization may differ in order or which are fixed.

Return type

FitResult

Returns

The fit result containing all information about the minimization.

Examples

Using the ability to restart a minimization with a previous result allows to use a more global search algorithm with a high tolerance and an additional local minimization to polish the found minimum.

result_approx = minimizer_global.minimize(loss, params)
result = minimizer_local.minimize(result_approx)

For a simple usage with a callable only, the parameters can be given as an array of initial values.

def func(x):
    return np.log(np.sum(x ** 2))

func.errordef = 0.5
params = [1.1, 3.5, 8.35]  # initial values
result = minimizer.minimize(func, param)
step(loss, params=None, init=None)#

Perform a single step in the minimization (if implemented).

Parameters

params (Union[Iterable[zfit.core.interfaces.ZfitParameter], None, Iterable[str]]) –

Returns:

Raises

MinimizeStepNotImplementedError – if the step method is not implemented in the minimizer.