api.rst

Python API

Top-Level

pyhf

default_backend default_optimizer tensorlib optimizer get_backend set_backend readxml writexml compat

Probability Distribution Functions (PDFs)

pyhf.probability

Normal Poisson Independent Simultaneous

Making Models from PDFs

pyhf

~pdf.Model ~pdf._ModelConfig ~workspace.Workspace ~patchset.PatchSet ~patchset.Patch simplemodels.uncorrelated_background simplemodels.correlated_background simplemodels.hepdata_like

Backends

The computational backends that pyhf provides interfacing for the vector-based calculations.

pyhf.tensor

numpy_backend.numpy_backend pytorch_backend.pytorch_backend tensorflow_backend.tensorflow_backend jax_backend.jax_backend

Optimizers

pyhf.optimize

mixins.OptimizerMixin opt_scipy.scipy_optimizer opt_minuit.minuit_optimizer

Modifiers

pyhf.modifiers

histosys normfactor normsys shapefactor shapesys staterror

Interpolators

pyhf.interpolators

code0 code1 code2 code4 code4p

Inference

pyhf.infer

Test Statistics

test_statistics.q0 test_statistics.qmu test_statistics.qmu_tilde test_statistics.tmu test_statistics.tmu_tilde utils.get_test_stat

Calculators

calculators.generate_asimov_data calculators.AsymptoticTestStatDistribution calculators.EmpiricalDistribution calculators.AsymptoticCalculator calculators.ToyCalculator utils.create_calculator

Fits and Tests

mle.twice_nll mle.fit mle.fixed_poi_fit hypotest intervals.upperlimit utils.all_pois_floating

Exceptions

Various exceptions, apart from standard python exceptions, that are raised from using the pyhf API.

pyhf.exceptions

InvalidMeasurement InvalidNameReuse InvalidSpecification InvalidPatchSet InvalidPatchLookup PatchSetVerificationError InvalidWorkspaceOperation InvalidModel InvalidModifier InvalidInterpCode ImportBackendError InvalidBackend InvalidOptimizer InvalidPdfParameters InvalidPdfData

Utilities

pyhf.utils

load_schema validate options_from_eqdelimstring digest citation

Contrib

pyhf.contrib

viz.brazil utils.download