Python API¶

Top-Level¶

`Workspace`	Workspace for managing HS3 model specifications.
`Model`	Probabilistic model with compiled tensor operations.
`jaxify`	Convert a PyTensor expression into a JAX-callable `JaxifiedGraph`.
`JaxifiedGraph`	A JAX-callable wrapper around a compiled PyTensor expression.

`distributions`	HS3 Distribution implementations.
`functions`	HS3 Functions implementation.
`axes`	HS3 Axis implementations.
`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.
`normalization`	Normalization utilities for HS3 distributions.
`transpile`	JAX transpilation helpers for pyhs3.

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

`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`	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.
`HistFactoryDistChannel`	HistFactory probability distribution for a single channel/region.
`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).

`samples.Sample`	HistFactory sample specification.
`samples.Samples`	Collection of samples for a HistFactory distribution.
`data.SampleData`	Sample data containing bin contents and optional per-bin uncertainties.
`modifiers.Modifier`	Base class for modifier effects (multiplicative or additive).
`modifiers.ModifierData`	Base class for modifier data.
`modifiers.HasConstraint`	Base class for modifiers that can have constraint terms.
`modifiers.ParameterModifier`	Base for modifiers that use a single parameter name.
`modifiers.ParametersModifier`	Base for modifiers that use multiple parameter names (one per bin).
`modifiers.NormFactorModifier`	Normalization factor modifier (simple scaling by parameter value).
`modifiers.NormSysModifier`	Normalization systematic modifier (with hi/lo interpolation).
`modifiers.HistoSysModifier`	Additive correlated shape systematic modifier.
`modifiers.ShapeFactorModifier`	Uncorrelated multiplicative bin-by-bin scaling modifier.
`modifiers.ShapeSysModifier`	Uncorrelated shape systematic with Poisson constraints.
`modifiers.StatErrorModifier`	Statistical uncertainty modifier (Barlow-Beeston method).
`modifiers.NormSysData`	Data for normsys modifier.
`modifiers.HistoSysData`	Data for histosys modifier.
`modifiers.HistoSysDataContents`	Contents data for histosys modifier.
`modifiers.ShapeSysData`	Data for shapesys modifier.
`modifiers.StatErrorData`	Data for staterror modifier.
`modifiers.Modifiers`	Collection of modifiers for a HistFactory sample.

`Axis`	Base axis specification for data coordinates.
`BoundedAxis`	Axis with required finite min/max bounds.
`UnbinnedAxis`	Axis for unbinned data with required finite bounds.
`ConstantAxis`	Axis for constant data.
`RegularAxis`
`IrregularAxis`
`DomainCoordinateAxis`	Axis for domain coordinates with optional bounds.
`BinnedAxis`	Runtime representation of an annotated type.
`BinnedAxes`	Collection of binned axis.
`UnbinnedAxes`	Collection of UnbinnedAxis.
`Axes`	Collection of BinnedAxis \| UnbinnedAxis.
`DomainAxes`	Collection of BinnedAxis \| UnbinnedAxis.
`DomainAxis`	Represent a union type

`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.

`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`	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.
`GaussianUncertainty`	Gaussian uncertainty specification for data.

`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`	Collection of HS3 likelihood specifications.
`Likelihood`	Likelihood specification mapping distributions to observations.

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

`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.
`WorkspaceValidationError`	Raised when a workspace fails to validate.

Compute a definite integral symbolically via Gauss-Legendre quadrature.