API reference#

This is the API reference for the zfit fitting package. Most classes and functions are documented with docstrings, but don’t hesitate to contact us if this documentation is insufficient!

Dimension
- Space
  - Space
- combine_spaces
  - combine_spaces()
Binned
- RegularBinning
  - RegularBinning
- VariableBinning
  - VariableBinning
Data
- Data
  - Data
- BinnedData
  - BinnedData
- RegularBinning
  - RegularBinning
- VariableBinning
  - VariableBinning
- SamplerData
  - SamplerData
- BinnedSamplerData
  - BinnedSamplerData
Param
- Parameter
  - Parameter
- ConstantParameter
  - ConstantParameter
- ComposedParameter
  - ComposedParameter
- ComplexParameter
  - ComplexParameter
- convert_to_parameter
  - convert_to_parameter()
- set_values
  - set_values()
Func
- BaseFuncV1
  - BaseFuncV1
- SimpleFuncV1
  - SimpleFuncV1
- ProdFunc
  - ProdFunc
- SumFunc
  - SumFunc
PDF
- Basic PDFs
- Binned PDFs
- Polynomials
- Kernel Density Estimations
- Composed PDFs
- Custom base class
- Physics PDFs
- Special PDFs
  - CachedPDF
Sample
- poisson
  - poisson()
Loss
- UnbinnedNLL
  - UnbinnedNLL
- ExtendedUnbinnedNLL
  - ExtendedUnbinnedNLL
- BinnedNLL
  - BinnedNLL
- ExtendedBinnedNLL
  - ExtendedBinnedNLL
- BinnedChi2
  - BinnedChi2
- ExtendedBinnedChi2
  - ExtendedBinnedChi2
- BaseLoss
  - BaseLoss
- SimpleLoss
  - SimpleLoss
Constraint
- GaussianConstraint
  - GaussianConstraint
- PoissonConstraint
  - PoissonConstraint
- LogNormalConstraint
  - LogNormalConstraint
- SimpleConstraint
  - SimpleConstraint
Minimize
- Minimizers
  - Minuit
  - Levenberg-Marquardt
  - Ipyopt
  - Scipy
  - NLopt
  - All minimizers
- Strategy
- Criterion
  - EDM
Result
- FitResult
  - FitResult
- compute_errors
  - compute_errors()
Prior distributions
- Base classes
- Parametric priors
  - Normal
  - Uniform
  - HalfNormal
  - Gamma
  - Beta
  - LogNormal
  - Cauchy
  - StudentT
  - Exponential
  - Poisson
- Non-parametric priors
  - KDE
MCMC sampling
- Samplers
  - EmceeSampler
- Result
  - PosteriorSamples
Settings
- set_seed()
HS3 serialization
- dumps
  - dumps()
- loads
  - loads()
- dump
  - dump()
- load
  - load()
dill
- dump
  - dump()
- dumps
  - dumps()
Exception
- AnalyticIntegralNotImplemented
  - AnalyticIntegralNotImplemented.add_note()
  - AnalyticIntegralNotImplemented.with_traceback()
- AnalyticNotImplemented
  - AnalyticNotImplemented.add_note()
  - AnalyticNotImplemented.with_traceback()
- AnalyticSamplingNotImplemented
  - AnalyticSamplingNotImplemented.add_note()
  - AnalyticSamplingNotImplemented.with_traceback()
- FunctionNotImplemented
  - FunctionNotImplemented.add_note()
  - FunctionNotImplemented.with_traceback()
- InitNotImplemented
  - InitNotImplemented.add_note()
  - InitNotImplemented.with_traceback()
- InvalidNameError
  - InvalidNameError.add_note()
  - InvalidNameError.with_traceback()
- MultipleLimitsNotImplemented
  - MultipleLimitsNotImplemented.add_note()
  - MultipleLimitsNotImplemented.with_traceback()
- NormRangeNotImplemented
- SpecificFunctionNotImplemented
  - SpecificFunctionNotImplemented.add_note()
  - SpecificFunctionNotImplemented.with_traceback()
- VectorizedLimitsNotImplemented
  - VectorizedLimitsNotImplemented.add_note()
  - VectorizedLimitsNotImplemented.with_traceback()
Config
- zfit.run.set_graph_mode
  - run.set_graph_mode()
- zfit.run.set_autograd_mode
  - run.set_autograd_mode()
- zfit.run.clear_graph_cache
  - run.clear_graph_cache()
- zfit.run.executing_eagerly
  - run.executing_eagerly()
- zfit.run.assert_executing_eagerly
  - run.assert_executing_eagerly()
- zfit.run.set_n_cpu
  - run.set_n_cpu()
- zfit.run.set_cpus_explicit
  - run.set_cpus_explicit()
Settings
Plot
- Quick Start
- Examples
- Available Functions
  - plot_model_pdf
  - plot_sumpdf_components_pdfV1