Skip to main content
Ctrl+K
spey 0.2.7b2 documentation - Home

Spey v0.2.7b2

  • GitHub
  • arXiv
  • PyPI

Contents:

  • Quick Start
  • Exclusion limits
  • Plug-ins
    • Spey-pyhf plug-in documentation
    • Spey-strathisla
    • Spey-fastprof: TBA
  • Combining Statistical Models
  • Building a plugin
  • Kitchen Sink
    • Introduction to Spey: A Unified Statistical Inference Framework
    • Inference with parameter dependent signal yields
    • Statistical inference on Histogram
    • Reinterpretation of Cross-Section Limits with Spey
    • Gradient of a Statistical Model
    • Signal Uncertainties
    • Multi-Parameter Confidence Contours with Spey
    • Building a Plug-in
      • Neutrino Experiment (example)
      • Simple Poisson (example)
    • Introduction to Spey (PyHEP 2023)
  • Description of all functions and classes
    • Top-Level
      • spey.version
      • spey.about
      • spey.check_updates
      • spey.ExpectationType
      • spey.register_backend
      • spey.AvailableBackends
      • spey.set_optimiser
      • spey.get_backend
      • spey.get_backend_metadata
      • spey.get_backend_bibtex
      • spey.cite
      • spey.reset_backend_entries
      • spey.statistical_model_wrapper
      • spey.helper_functions.correlation_to_covariance
      • spey.helper_functions.covariance_to_correlation
      • spey.helper_functions.merge_correlated_bins
      • spey.optimizer.core.fit
      • spey.set_log_level
    • Statistical Model
      • spey.interface.statistical_model.statistical_model_wrapper
    • Base Classes
      • spey.base.backend_base.BackendBase
      • spey.base.backend_base.ConverterBase
      • spey.base.model_config.ModelConfig
      • spey.base.hypotest_base.HypothesisTestingBase
    • Statistical Model Combiner
    • Hypothesis testing
      • spey.hypothesis_testing.test_statistics.qmu
      • spey.hypothesis_testing.test_statistics.qmu_tilde
      • spey.hypothesis_testing.test_statistics.q0
      • spey.hypothesis_testing.test_statistics.get_test_statistic
      • spey.hypothesis_testing.test_statistics.compute_teststatistics
      • spey.hypothesis_testing.upper_limits.ComputerWrapper
      • spey.hypothesis_testing.upper_limits.find_poi_upper_limit
      • spey.hypothesis_testing.upper_limits.find_root_limits
      • spey.hypothesis_testing.utils.pvalues
      • spey.hypothesis_testing.utils.expected_pvalues
      • spey.hypothesis_testing.distributions.AsymptoticTestStatisticsDistribution
      • spey.hypothesis_testing.distributions.EmpricTestStatisticsDistribution
      • spey.hypothesis_testing.asymptotic_calculator.compute_asymptotic_confidence_level
      • spey.hypothesis_testing.toy_calculator.compute_toy_confidence_level
    • Default Backends
      • spey.backends.default_pdf.UncorrelatedBackground
      • spey.backends.default_pdf.CorrelatedBackground
      • spey.backends.default_pdf.ThirdMomentExpansion
      • spey.backends.default_pdf.EffectiveSigma
      • spey.backends.default_pdf.DefaultPDFBase
      • spey.backends.default_pdf.third_moment.third_moment_expansion
      • spey.backends.default_pdf.third_moment.compute_third_moments
      • spey.backends.default_pdf.uncertainty_synthesizer.signal_uncertainty_synthesizer
      • spey.backends.default_pdf.simple_pdf.Poisson
      • spey.backends.default_pdf.simple_pdf.Gaussian
      • spey.backends.default_pdf.simple_pdf.MultivariateNormal
      • spey.backends.default_pdf.simple_pdf.SimplePDFBase
      • spey.backends.distributions.Poisson
      • spey.backends.distributions.Normal
      • spey.backends.distributions.MultivariateNormal
      • spey.backends.distributions.MainModel
      • spey.backends.distributions.ConstraintModel
    • Multi-dimensional chi-squared confidence contour finder
      • spey.multiparameter.contour.find_contour
      • spey.multiparameter.contour.ContourResult
    • Gradient Tools
      • spey.math.value_and_grad
      • spey.math.hessian
    • Developer Tools
      • spey.system.exceptions.AnalysisQueryError
      • spey.system.exceptions.MethodNotAvailable
      • spey.system.exceptions.NegativeExpectedYields
      • spey.system.exceptions.PluginError
      • spey.system.exceptions.UnknownCrossSection
      • spey.system.exceptions.UnknownTestStatistics
      • spey.system.exceptions.CalculatorNotAvailable
      • spey.system.exceptions.CanNotFindRoots
      • spey.system.exceptions.UnknownComputer
      • spey.system.exceptions.CombinerNotAvailable
      • spey.system.logger.disable_logging
      • spey.system.logger.capture_logs
      • spey.system.cache.cache_results
      • spey.system.cache._PerInstanceCacheDescriptor
  • Use & Citations
  • Contributing to Spey
  • Known Issues
  • Outreach
  • Release Notes
    • Release notes v0.1
    • Release notes v0.2
    • Pre-release notes: v0.2.7-b2
  • Bibliography
  • Repository
  • Suggest edit
  • .rst

Building a Plug-in

Building a Plug-in#

  • Neutrino Experiment (example)
  • Simple Poisson (example)

previous

Multi-Parameter Confidence Contours with Spey

next

Description of all functions and classes

By Jack Y. Araz

© Copyright 2023 - 2026, Jack Y. Araz.