api.rst

Python API

Top-Level

.. currentmodule:: pyhf

.. autosummary::
   :toctree: _generated/
   :nosignatures:

   tensorlib
   optimizer
   get_backend
   set_backend
   readxml
   writexml
   compat
   schema

Probability Distribution Functions (PDFs)

.. currentmodule:: pyhf.probability

.. autosummary::
   :toctree: _generated/
   :nosignatures:

   Normal
   Poisson
   Independent
   Simultaneous

Making Models from PDFs

.. currentmodule:: pyhf

.. autosummary::
   :toctree: _generated/
   :nosignatures:

   ~pdf.Model
   ~pdf._ModelConfig
   ~pdf._MainModel
   ~pdf._ConstraintModel
   ~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.

.. currentmodule:: pyhf.tensor

.. autosummary::
   :toctree: _generated/
   :nosignatures:

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

Optimizers

.. currentmodule:: pyhf.optimize

.. autosummary::
   :toctree: _generated/
   :nosignatures:

   mixins.OptimizerMixin
   opt_scipy.scipy_optimizer
   opt_minuit.minuit_optimizer

Modifiers

.. currentmodule:: pyhf.modifiers

.. autosummary::
   :toctree: _generated/
   :nosignatures:

   histosys
   normfactor
   normsys
   shapefactor
   shapesys
   staterror

Interpolators

.. currentmodule:: pyhf.interpolators

.. autosummary::
   :toctree: _generated/
   :nosignatures:

   code0
   code1
   code2
   code4
   code4p

Inference

.. currentmodule:: pyhf.infer

Test Statistics

.. autosummary::
   :toctree: _generated/
   :nosignatures:

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

Calculators

.. autosummary::
   :toctree: _generated/
   :nosignatures:

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

Fits and Tests

.. autosummary::
   :toctree: _generated/
   :nosignatures:

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

Confidence Intervals

.. autosummary::
   :toctree: _generated/
   :nosignatures:

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

Schema

.. currentmodule:: pyhf.schema

.. autosummary::
   :toctree: _generated/
   :nosignatures:

   Schema
   load_schema
   validate

Exceptions

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

.. currentmodule:: pyhf.exceptions

.. autosummary::
   :toctree: _generated/
   :nosignatures:

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

Utilities

.. currentmodule:: pyhf.utils

.. autosummary::
   :toctree: _generated/
   :nosignatures:

   options_from_eqdelimstring
   digest
   citation

Contrib

.. currentmodule:: pyhf.contrib

.. autosummary::
   :toctree: _generated/
   :nosignatures:

   viz.brazil
   utils.download