Package index • bayesim

Design and run studies

Configure and execute simulation studies

simulation_config(): Create a Simulation Configuration
run_simulation(): Run a Simulation Study
resume_simulation(): Resume a simulation from an existing result directory
preflight(): Preflight check for a simulation configuration
n_replicates_for_target(): Required number of replicates for a target MCSE
config_fingerprint(): Stable simulation-design fingerprint

Classes and generics for fitting Bayesian models

Factory constructors for simulation data generators

fixed_truth_generator(): Construct a fixed-truth data generator
prior_predictive_generator(): Construct a prior-predictive data generator
ifs_generator(): Construct an inverse forward sampling (IFS) data generator
prior_draws_generator(): Construct a fitter-agnostic prior-draws data generator
forward_sim_generator(): Construct a fitter-agnostic forward-simulation (IFS) data generator

Classes and built-in metrics for computing simulation results

Metric(): Metric Abstract Class
compute_metric(): Compute Metric Values
PosteriorSummaryMetric() posterior_summary_metric(): Posterior Summary Metric
CoverageMetric() coverage_metric(): Coverage Metric
RankMetric() rank_metric(): SBC Rank Metric
PosProbMetric() pos_prob_metric(): Positivity Probability Metric
SamplerDiagnosticsMetric() sampler_diagnostics_metric(): Sampler Diagnostics Metric
RmseMetric() pred_rmse_metric(): RMSE Metric
BiasMetric() pred_bias_metric(): Bias Metric
MaeMetric() pred_mae_metric(): MAE Metric
MseMetric() pred_mse_metric(): MSE Metric
ElpdLooMetric() elpd_loo_metric(): ELPD-LOO Metric
RmseLooMetric() rmse_loo_metric(): RMSE-LOO Metric
R2LooMetric() r2_loo_metric(): R-squared LOO Metric
ElpdTestMetric() elpd_test_metric(): ELPD Test-Set Metric
R2TestMetric() r2_test_metric(): R-squared Test-Set Metric

Summaries, SBC diagnostics, and plotting functions for simulation results

summarize_simulation(): Aggregate simulation results per condition
metric_cols(): Select flattened metric columns
performance_measures(): Simulation-method performance measures with Monte-Carlo standard errors
failed_tasks(): Extract failed tasks from a simulation result
sbc_ranks(): Extract SBC ranks from a simulation result
plot_rank_hist(): Plot SBC rank histograms
plot_rank_ecdf(): Plot SBC rank ECDF with simultaneous confidence band
plot_recovery(): Plot parameter recovery (truth vs posterior estimate)
plot_coverage(): Plot coverage rates per condition/parameter
plot_metric(): Plot a metric across conditions
render_report(): Render a simulation-study report
read_summary(): Read a simulation summary file

Validators, error constructors, and classifiers for extending bayesim