Python API

Top-Level

Workspace	Workspace for managing HS3 model specifications.
Model	Probabilistic model with compiled tensor operations.

Modules

distributions	HS3 Distribution implementations.
functions	HS3 Functions implementation.
domains	HS3 Domain implementations.
parameter_points	HS3 Parameter Point implementations.
data	HS3 Data implementations.
likelihoods	HS3 Likelihood implementations.
analyses	HS3 Analysis implementations.
generic_parse
exceptions	Exception classes for pyhs3.

Base Classes

Evaluable

Base class for HS3 distributions and functions with automatic parameter preprocessing.

Functions

Functions	Collection of HS3 functions for parameter computation.
Function	Base class for functions in HS3.
ProductFunction	Product function that multiplies factors together.
SumFunction	Sum function that adds summands together.
GenericFunction	Generic function with custom mathematical expression.
InterpolationFunction	Piecewise interpolation function implementation.
ProcessNormalizationFunction	Process normalization function with systematic variations.

Distributions

Distributions	Collection of distributions for a probabilistic model.
Distribution	Base class for probability distributions in HS3.
GaussianDist	Gaussian (normal) probability distribution.
UniformDist	Uniform (rectangular) probability distribution.
PoissonDist	Poisson probability distribution.
ExponentialDist	Exponential probability distribution.
LogNormalDist	Log-normal probability distribution.
LandauDist	Landau probability distribution.
MixtureDist	Mixture of probability distributions.
ProductDist	Product distribution implementation.
HistogramDist	Histogram probability distribution.
GenericDist	Generic distribution implementation.
PolynomialDist	Polynomial probability distribution.
BernsteinPolyDist	Bernstein polynomial probability distribution.
CrystalBallDist	Single-sided Crystal Ball distribution implementation.
AsymmetricCrystalBallDist	Crystal Ball distribution implementation.
ArgusDist	ARGUS probability distribution.
FastVerticalInterpHistPdf2Dist	CMS Fast Vertical Interpolation Histogram PDF (2D version).
GGZZBackgroundDist	CMS ggZZ background distribution.
QQZZBackgroundDist	CMS qqZZ background distribution.
FastVerticalInterpHistPdf2D2Dist	CMS Fast Vertical Interpolation Histogram PDF (2D version 2).

Domains

Domains	Collection of HS3 domains for parameter space definitions.
Domain	Base class for HS3 domain specifications.
ProductDomain	Product domain specification for multi-dimensional parameter spaces.
Axis	Axis specification for parameter domains.

Parameter Points

ParameterPoints	Collection of HS3 parameter sets for model configuration.
ParameterSet	Named collection of parameter specifications (matches HS3Spec structure).
ParameterPoint	Individual parameter specification with name and value.

Data

Data	Collection of HS3 data specifications.
Datum	Base class for HS3 data specifications.
PointData	Point data specification for single measurements.
UnbinnedData	Unbinned data specification for multiple data points.
BinnedData	Binned data specification for histogram data.
Axis	Axis specification for data coordinates.
GaussianUncertainty	Gaussian uncertainty specification for data.

Parsing

parse_expression	Parse a mathematical expression string into a SymPy expression.
sympy_to_pytensor	Converts a SymPy expression into a PyTensor computational graph using lambdify.
analyze_sympy_expr	Analyzes a SymPy expression and logs its independent variables, dependent variables, and structure for debugging.

Likelihoods

Likelihoods	Collection of HS3 likelihood specifications.
Likelihood	Likelihood specification mapping distributions to observations.

Analyses

Analyses	Collection of HS3 analysis specifications.
Analysis	Analysis specification defining automated analysis parameters.

Exceptions

HS3Exception	Base exception class for all pyhs3-related errors.
ExpressionParseError	Exception raised when a mathematical expression cannot be parsed.
ExpressionEvaluationError	Exception raised when a parsed expression cannot be evaluated.