OptimizerMixin¶
-
class
pyhf.optimize.mixins.
OptimizerMixin
(**kwargs)[source]¶ Bases:
object
Mixin Class to build optimizers.
Attributes
-
maxiter
¶
-
verbose
¶
Methods
-
minimize
(objective, data, pdf, init_pars, par_bounds, fixed_vals=None, return_fitted_val=False, return_result_obj=False, do_grad=None, do_stitch=False, **kwargs)[source]¶ Find parameters that minimize the objective.
- Parameters
objective (
func
) – objective functiondata (
list
) – observed datapdf (Model) – The statistical model adhering to the schema model.json
init_pars (
list
) – initial parameterspar_bounds (
list
) – parameter boundariesfixed_vals (
list
) – fixed parameter valuesreturn_fitted_val (
bool
) – return bestfit value of the objectivereturn_result_obj (
bool
) – returnscipy.optimize.OptimizeResult
do_grad (
bool
) – enable autodifferentiation mode. Default depends on backend (pyhf.tensorlib.default_do_grad
).do_stitch (
bool
) – enable splicing/stitching fixed parameter.kwargs – other options to pass through to underlying minimizer
- Returns
parameters (
tensor
): fitted parametersminimum (
float
): ifreturn_fitted_val
flagged, return minimized objective valueresult (
scipy.optimize.OptimizeResult
): ifreturn_result_obj
flagged
- Return type
Fitted parameters or tuple of results
-