Hyperiso 1.0.3
Modular flavour-physics calculations, Wilson coefficients and statistical inference
Loading...
Searching...
No Matches
Public Member Functions | Static Public Attributes | List of all members
StatisticConfig.StatisticConfig Class Reference
Collaboration diagram for StatisticConfig.StatisticConfig:
Collaboration graph
[legend]

Public Member Functions

 to_cpp (self)
 

Static Public Attributes

int MC_draws = 100
 
int MC_threads = 1
 
int MC_seed = 123456
 
float skew_abs_threshold = 0.2
 
bool print_mc_progress = False
 
bool print_chi2_pipeline_progress = False
 
bool print_mc_config = False
 
bool print_fit_summary = False
 
bool print_scan_summary = False
 
bool print_cache_summary = False
 
bool print_debug = False
 
bool write_mc_samples_csv = False
 
str mc_samples_csv_path = "obs_samples.csv"
 
int mc_progress_probe_draws = 5
 
int mc_progress_update_every = 1
 
Optional progress_monitor = None
 
Dict fit_parameter_bounds = field(default_factory=dict)
 
Dict fit_parameter_offsets = field(default_factory=dict)
 
AdvancedStatisticConfig advanced = field(default_factory=AdvancedStatisticConfig)
 

Detailed Description

Basic configuration of the statistic pipeline.

This is the small, common config used by examples and scripts.  Advanced
minimization, nuisance-pruning and covariance options are grouped in
:class:`AdvancedStatisticConfig` under ``advanced``.

Args:
    MC_draws: Number of accepted MC predictions used in uncertainty
        propagation or chi-square covariance estimation.
    MC_threads: Number of worker threads used by MC propagation.
    MC_seed: RNG seed used for reproducible MC nuisance and experimental-data sampling.
    skew_abs_threshold: Skewness threshold for symmetric vs split-Gaussian
        summaries.
    print_mc_progress: Print a compact progress bar with live ETA during MC
        sampling.
    print_chi2_pipeline_progress: In chi-square MC-covariance mode, print
        the post-MC workflow stages so the MC ETA is not mistaken for the
        full runtime.
    print_mc_config: Print nuisance candidates and retained MC marginal
        configuration.
    print_fit_summary: Print high-level fit diagnostics.
    print_scan_summary: Print likelihood-scan diagnostics.
    print_cache_summary: Enable ``StatisticManager::print_cache`` output.
    print_debug: Master debug flag enabling extra diagnostic output.
    write_mc_samples_csv: Persist accepted MC observable samples.
    mc_samples_csv_path: Output CSV path when sample writing is enabled.
    advanced: Expert configuration object.

Definition at line 302 of file StatisticConfig.py.

Member Function Documentation

◆ to_cpp()

StatisticConfig.StatisticConfig.to_cpp (   self) 
Convert this Python config to the bound C++ ``StatisticConfig``.

Definition at line 355 of file StatisticConfig.py.

Member Data Documentation

◆ advanced

AdvancedStatisticConfig StatisticConfig.StatisticConfig.advanced = field(default_factory=AdvancedStatisticConfig)
static

Definition at line 353 of file StatisticConfig.py.

◆ fit_parameter_bounds

Dict StatisticConfig.StatisticConfig.fit_parameter_bounds = field(default_factory=dict)
static

Definition at line 351 of file StatisticConfig.py.

◆ fit_parameter_offsets

Dict StatisticConfig.StatisticConfig.fit_parameter_offsets = field(default_factory=dict)
static

Definition at line 352 of file StatisticConfig.py.

◆ MC_draws

int StatisticConfig.StatisticConfig.MC_draws = 100
static

Definition at line 332 of file StatisticConfig.py.

◆ mc_progress_probe_draws

int StatisticConfig.StatisticConfig.mc_progress_probe_draws = 5
static

Definition at line 347 of file StatisticConfig.py.

◆ mc_progress_update_every

int StatisticConfig.StatisticConfig.mc_progress_update_every = 1
static

Definition at line 348 of file StatisticConfig.py.

◆ mc_samples_csv_path

str StatisticConfig.StatisticConfig.mc_samples_csv_path = "obs_samples.csv"
static

Definition at line 346 of file StatisticConfig.py.

◆ MC_seed

int StatisticConfig.StatisticConfig.MC_seed = 123456
static

Definition at line 334 of file StatisticConfig.py.

◆ MC_threads

int StatisticConfig.StatisticConfig.MC_threads = 1
static

Definition at line 333 of file StatisticConfig.py.

◆ print_cache_summary

bool StatisticConfig.StatisticConfig.print_cache_summary = False
static

Definition at line 342 of file StatisticConfig.py.

◆ print_chi2_pipeline_progress

bool StatisticConfig.StatisticConfig.print_chi2_pipeline_progress = False
static

Definition at line 338 of file StatisticConfig.py.

◆ print_debug

bool StatisticConfig.StatisticConfig.print_debug = False
static

Definition at line 343 of file StatisticConfig.py.

◆ print_fit_summary

bool StatisticConfig.StatisticConfig.print_fit_summary = False
static

Definition at line 340 of file StatisticConfig.py.

◆ print_mc_config

bool StatisticConfig.StatisticConfig.print_mc_config = False
static

Definition at line 339 of file StatisticConfig.py.

◆ print_mc_progress

bool StatisticConfig.StatisticConfig.print_mc_progress = False
static

Definition at line 337 of file StatisticConfig.py.

◆ print_scan_summary

bool StatisticConfig.StatisticConfig.print_scan_summary = False
static

Definition at line 341 of file StatisticConfig.py.

◆ progress_monitor

Optional StatisticConfig.StatisticConfig.progress_monitor = None
static

Definition at line 350 of file StatisticConfig.py.

◆ skew_abs_threshold

float StatisticConfig.StatisticConfig.skew_abs_threshold = 0.2
static

Definition at line 335 of file StatisticConfig.py.

◆ write_mc_samples_csv

bool StatisticConfig.StatisticConfig.write_mc_samples_csv = False
static

Definition at line 345 of file StatisticConfig.py.

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