Skip to content

Public API

The top-level unibm namespace is intentionally small. It keeps only the two headline EVI entrypoints together with the grouped unibm.evi and unibm.ei namespaces.

Use:

  • unibm for estimate_evi_quantile and estimate_design_life_level
  • unibm.evi for the grouped severity-side namespace
  • unibm.ei for the grouped persistence-side namespace
  • unibm.cdf for the standalone public empirical CDF helper

unibm

Public UniBM package facade.

The package exposes grouped public namespaces under unibm.evi and unibm.ei together with the standalone helper module unibm.cdf. Repo-local benchmark, application, and notebook orchestration code lives outside the package under scripts/.

__version__ = '0.1.0' module-attribute

__all__ = ['__version__', 'ei', 'evi', 'estimate_design_life_level', 'estimate_evi_quantile'] module-attribute

estimate_design_life_level(fit, years, *, observations_per_year=365.25, tau=None)

Map a fitted quantile-scaling law to design-life levels.

estimate_evi_quantile(vec, *, quantile=0.5, sliding=True, block_sizes=None, num_step=None, min_block_size=None, max_block_size=None, bootstrap_reps=200, super_block_size=None, random_state=0, plateau_points=5, trim_fraction=0.15, curvature_penalty=DEFAULT_CURVATURE_PENALTY, covariance_shrinkage=DEFAULT_COVARIANCE_SHRINKAGE, curve=None, plateau=None, bootstrap_result=None)

Estimate the extreme value index from a block-quantile scaling law.

__getattr__(name)

Lazily expose the canonical grouped subpackages.