Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
pypomp
pypomp

Getting Started

  • Tutorials
  • Model Mechanics
  • Best Practices and Performance Guidelines

Reference

  • API Reference
    • Pomp Class
      • pypomp.Pomp.simulate
      • pypomp.Pomp.pfilter
      • pypomp.Pomp.mif
      • pypomp.Pomp.train
      • pypomp.Pomp.dpop_train
      • pypomp.Pomp.pmcmc
      • pypomp.Pomp.abc
      • pypomp.Pomp.results
      • pypomp.Pomp.traces
      • pypomp.Pomp.CLL
      • pypomp.Pomp.ESS
      • pypomp.Pomp.sample_params
      • pypomp.Pomp.to_struct
      • pypomp.Pomp.prune
      • pypomp.Pomp.time
      • pypomp.Pomp.arma
      • pypomp.Pomp.negbin
      • pypomp.Pomp.probe
      • pypomp.Pomp.print_summary
      • pypomp.Pomp.print_metadata
      • pypomp.Pomp.merge
      • pypomp.Pomp.plot_traces
      • pypomp.Pomp.plot_simulations
    • PanelPomp Class
      • pypomp.PanelPomp.simulate
      • pypomp.PanelPomp.pfilter
      • pypomp.PanelPomp.mif
      • pypomp.PanelPomp.train
      • pypomp.PanelPomp.dpop_train
      • pypomp.PanelPomp.results
      • pypomp.PanelPomp.CLL
      • pypomp.PanelPomp.ESS
      • pypomp.PanelPomp.traces
      • pypomp.PanelPomp.get_unit_names
      • pypomp.PanelPomp.get_unit_parameters
      • pypomp.PanelPomp.sample_params
      • pypomp.PanelPomp.to_struct
      • pypomp.PanelPomp.prune
      • pypomp.PanelPomp.mix_and_match
      • pypomp.PanelPomp.time
      • pypomp.PanelPomp.probe
      • pypomp.PanelPomp.arma
      • pypomp.PanelPomp.negbin
      • pypomp.PanelPomp.print_metadata
      • pypomp.PanelPomp.print_summary
      • pypomp.PanelPomp.merge
      • pypomp.PanelPomp.plot_traces
      • pypomp.PanelPomp.plot_simulations
    • Parameters
      • pypomp.PompParameters.logLik
      • pypomp.PompParameters.to_jax_array
      • pypomp.PompParameters.num_replicates
      • pypomp.PompParameters.num_params
      • pypomp.PompParameters.subset
      • pypomp.PompParameters.get_param_names
      • pypomp.PompParameters.params
      • pypomp.PompParameters.set_params
      • pypomp.PompParameters.transformed
      • pypomp.PompParameters.pruned
      • pypomp.PompParameters.merge
      • pypomp.PanelParameters.logLik
      • pypomp.PanelParameters.logLik_unit
      • pypomp.PanelParameters.params
      • pypomp.PanelParameters.set_params
      • pypomp.PanelParameters.num_replicates
      • pypomp.PanelParameters.get_param_names
      • pypomp.PanelParameters.get_shared_param_names
      • pypomp.PanelParameters.get_unit_param_names
      • pypomp.PanelParameters.get_unit_names
      • pypomp.PanelParameters.subset
      • pypomp.PanelParameters.to_jax_array
      • pypomp.PanelParameters.transformed
      • pypomp.PanelParameters.pruned
      • pypomp.PanelParameters.mixed_and_matched
      • pypomp.PanelParameters.merge
    • Results
      • pypomp.core.results.Result
        • pypomp.core.results.Result.CLL
        • pypomp.core.results.Result.ESS
        • pypomp.core.results.Result.merge
        • pypomp.core.results.Result.print_summary
        • pypomp.core.results.Result.to_dataframe
        • pypomp.core.results.Result.traces
      • pypomp.core.results.ResultsHistory
        • pypomp.core.results.ResultsHistory.CLL
        • pypomp.core.results.ResultsHistory.ESS
        • pypomp.core.results.ResultsHistory.add
        • pypomp.core.results.ResultsHistory.append
        • pypomp.core.results.ResultsHistory.clear
        • pypomp.core.results.ResultsHistory.last
        • pypomp.core.results.ResultsHistory.merge
        • pypomp.core.results.ResultsHistory.print_summary
        • pypomp.core.results.ResultsHistory.results
        • pypomp.core.results.ResultsHistory.time
        • pypomp.core.results.ResultsHistory.traces
    • Functional API
      • pypomp.functional.PompStruct
        • pypomp.functional.PompStruct.count
        • pypomp.functional.PompStruct.index
      • pypomp.functional.PanelPompStruct
        • pypomp.functional.PanelPompStruct.count
        • pypomp.functional.PanelPompStruct.index
      • pypomp.functional.pfilter
      • pypomp.functional.panel_pfilter
      • pypomp.functional.mif
      • pypomp.functional.panel_mif
      • pypomp.functional.simulate
      • pypomp.functional.pmcmc
      • pypomp.functional.abc
      • pypomp.functional.train
      • pypomp.functional.panel_train
      • pypomp.functional.mop
      • pypomp.functional.dpop
      • pypomp.functional.align_params
    • Parameter Transformations
    • Random Walk Standard Deviation
      • pypomp.RWSigma.geometric_cooling
      • pypomp.RWSigma.cosine_cooling
      • pypomp.RWSigma.hyperbolic_cooling
      • pypomp.RWSigma.custom_cooling
      • pypomp.RWSigma.copy
      • pypomp.RWSigma.cooled
      • pypomp.RWSigma.keys
      • pypomp.RWSigma.values
      • pypomp.RWSigma.items
      • pypomp.RWSigma.get
    • Learning Rate
      • pypomp.LearningRate.to_array
      • pypomp.LearningRate.cosine_decay
      • pypomp.LearningRate.geometric_decay
      • pypomp.LearningRate.linear_decay
    • Optimizers
      • pypomp.core.optimizer.Optimizer
      • pypomp.SGD
      • pypomp.Adam
      • pypomp.FullMatrixAdam
      • pypomp.BFGS
      • pypomp.Newton
      • pypomp.WeightedNewton
    • Mathematical Utilities
      • pypomp.maths.logmeanexp
      • pypomp.maths.logmeanexp_se
      • pypomp.maths.expit
      • pypomp.maths.logit
    • Fast Random Number Generation on GPUs
      • pypomp.random.fast_poisson
      • pypomp.random.fast_binomial
      • pypomp.random.fast_multinomial
      • pypomp.random.fast_gamma
      • pypomp.random.fast_nbinomial
      • pypomp.random.poissoninv
      • pypomp.random.binominv
      • pypomp.random.gammainv
    • Proposal Distributions
      • pypomp.proposals.mvn_diag_rw
      • pypomp.proposals.mvn_rw
      • pypomp.proposals.mvn_rw_adaptive
      • pypomp.proposals.MVNDiagRW
        • pypomp.proposals.MVNDiagRW.init_state
        • pypomp.proposals.MVNDiagRW.step
      • pypomp.proposals.MVNRWFull
        • pypomp.proposals.MVNRWFull.init_state
        • pypomp.proposals.MVNRWFull.step
      • pypomp.proposals.MVNRWAdaptive
        • pypomp.proposals.MVNRWAdaptive.init_state
        • pypomp.proposals.MVNRWAdaptive.step
    • Monte Carlo Adjusted Profile
    • Type Aliases
    • Example Models
      • pypomp.models.dhaka
      • pypomp.models.LG
      • pypomp.models.sir
      • pypomp.models.spx
      • pypomp.models.UKMeasles
        • pypomp.models.UKMeasles.AK_mles
        • pypomp.models.UKMeasles.PanelPomp
        • pypomp.models.UKMeasles.Pomp
        • pypomp.models.UKMeasles.subset
        • pypomp.models.UKMeasles.units

Resources

  • Quantitative Tests
  • GitHub
Back to top
View this page
Edit this page

pypomp.core.results.Result.ESS¶

Result.ESS(average: bool = False) → DataFrame[source]¶

Return effective sample sizes as a pandas.DataFrame.

Next
pypomp.core.results.Result.merge
Previous
pypomp.core.results.Result.CLL
Copyright © 2026, pypomp team
Made with Sphinx and @pradyunsg's Furo
On this page
  • pypomp.core.results.Result.ESS
    • ESS()