Hyperiso 1.0.3
Modular flavour-physics calculations, Wilson coefficients and statistical inference
Loading...
Searching...
No Matches
StatisticInterface.MLFitOptions Class Reference

Public Member Functions

"MLFitOptions" from_cpp (cls, cpp_obj)
 
 to_cpp (self)
 

Static Public Attributes

bool run_hesse = True
 
bool request_minos = False
 
bool verbose = False
 
int strategy = 0
 
int max_fcn = 0
 
float tolerance = 0.0
 
bool allow_profile_hessian_fallback = True
 
float profile_hessian_step_scale = 1.0
 
float profile_hessian_eig_floor_rel = 1e-8
 
bool trace_first_evals = False
 
int trace_max_evals = 25
 

Detailed Description

Low-level maximum-likelihood fitter options.

This mirrors the C++ ``MLFitOptions`` struct. In most user workflows these
settings are configured through :class:`StatisticConfig`; this class is kept
available for direct conversions and advanced integrations.

Attributes:
    run_hesse: Ask the minimizer to compute a covariance/HESSE estimate.
    request_minos: Request MINOS if the compiled backend supports it.
    verbose: Enable verbose minimizer output.
    strategy: Backend strategy; ``0`` means backend default.
    max_fcn: Maximum number of function calls; ``0`` means backend default.
    tolerance: Minimizer tolerance; ``0.0`` means backend default.
    allow_profile_hessian_fallback: Allow numerical profile-Hessian fallback.
    profile_hessian_step_scale: Step scale for the fallback Hessian.
    profile_hessian_eig_floor_rel: Relative eigenvalue floor for Hessian
        regularization.
    trace_first_evals: Print the first likelihood evaluations.
    trace_max_evals: Maximum number of traced evaluations.

Definition at line 187 of file StatisticInterface.py.

Member Function Documentation

◆ from_cpp()

"MLFitOptions" StatisticInterface.MLFitOptions.from_cpp (   cls,
  cpp_obj 
)
Create Python fitter options from C++ options.

Definition at line 222 of file StatisticInterface.py.

◆ to_cpp()

StatisticInterface.MLFitOptions.to_cpp (   self)
Convert this options object to C++.

Definition at line 238 of file StatisticInterface.py.

Member Data Documentation

◆ allow_profile_hessian_fallback

bool StatisticInterface.MLFitOptions.allow_profile_hessian_fallback = True
static

Definition at line 215 of file StatisticInterface.py.

◆ max_fcn

int StatisticInterface.MLFitOptions.max_fcn = 0
static

Definition at line 213 of file StatisticInterface.py.

◆ profile_hessian_eig_floor_rel

float StatisticInterface.MLFitOptions.profile_hessian_eig_floor_rel = 1e-8
static

Definition at line 217 of file StatisticInterface.py.

◆ profile_hessian_step_scale

float StatisticInterface.MLFitOptions.profile_hessian_step_scale = 1.0
static

Definition at line 216 of file StatisticInterface.py.

◆ request_minos

bool StatisticInterface.MLFitOptions.request_minos = False
static

Definition at line 210 of file StatisticInterface.py.

◆ run_hesse

bool StatisticInterface.MLFitOptions.run_hesse = True
static

Definition at line 209 of file StatisticInterface.py.

◆ strategy

int StatisticInterface.MLFitOptions.strategy = 0
static

Definition at line 212 of file StatisticInterface.py.

◆ tolerance

float StatisticInterface.MLFitOptions.tolerance = 0.0
static

Definition at line 214 of file StatisticInterface.py.

◆ trace_first_evals

bool StatisticInterface.MLFitOptions.trace_first_evals = False
static

Definition at line 218 of file StatisticInterface.py.

◆ trace_max_evals

int StatisticInterface.MLFitOptions.trace_max_evals = 25
static

Definition at line 219 of file StatisticInterface.py.

◆ verbose

bool StatisticInterface.MLFitOptions.verbose = False
static

Definition at line 211 of file StatisticInterface.py.


The documentation for this class was generated from the following file: