Top-Level

Top-Level#

version()

Version of spey package

about()

Prints the information regarding spey installation

check_updates()

Check Spey Updates.

ExpectationType(value)

Expectation type has been used to determine the nature of the statistical model through out the package.

register_backend(model)

A local backend registry for statistical models.

AvailableBackends()

Returns a list of available backends.

set_optimiser(name)

Set optimiser for fitting interface.

get_backend(name)

Statistical model backend retreiver.

get_backend_metadata(name)

Retreive metadata about the backend.

get_backend_bibtex(name)

Retreive BibTex entry for backend plug-in if available.

cite()

Retreive BibTex information for Spey

reset_backend_entries()

Scan the system for backends and reset the entries

statistical_model_wrapper(func)

Decorator that promotes a BackendBase constructor into a StatisticalModel factory.

helper_functions.correlation_to_covariance(...)

Convert correlation matrix into covariance matrix.

helper_functions.covariance_to_correlation(...)

Convert covariance matrix into correlation matrix.

helper_functions.merge_correlated_bins(...)

Merge correlated bins in a histogram/cutflow.

optimizer.core.fit(func, model_configuration)

Dispatch a fit to either the scipy or minuit minimiser.

set_log_level(level)

Set log level for spey