Skip to content

Latest commit

 

History

History
237 lines (176 loc) · 3.71 KB

api.rst

File metadata and controls

237 lines (176 loc) · 3.71 KB

Python API

Top-Level

pyhf

tensorlib optimizer get_backend set_backend readxml writexml compat schema

Probability Distribution Functions (PDFs)

pyhf.probability

Normal Poisson Independent Simultaneous

Making Models from PDFs

pyhf

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

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.HypoTestFitResults calculators.AsymptoticTestStatDistribution calculators.EmpiricalDistribution calculators.AsymptoticCalculator calculators.ToyCalculator utils.create_calculator

Fits and Tests

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

Confidence Intervals

intervals.upper_limits.upper_limit intervals.upper_limits.toms748_scan intervals.upper_limits.linear_grid_scan intervals.upperlimit

Schema

pyhf.schema

Schema load_schema validate

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

options_from_eqdelimstring digest citation

Contrib

pyhf.contrib

viz.brazil utils.download