Package index • bayesim

Configuration

Functions for configuring simulation studies

simulation_config(): Create a Simulation Configuration
is_simulation_config(): Check if Object is a SimulationConfig
validate_config_completeness(): Validate SimulationConfig Completeness
get_total_tasks(): Get Total Number of Tasks in Configuration
compute_config_fingerprint(): Compute Configuration Fingerprint
as_config_spec(): Convert SimulationConfig to Plain List for Hashing

Running Simulations

Functions for executing simulation studies

run_simulation(): Run a Simulation Study
resume_simulation(): Resume a simulation from an existing result directory
can_resume(): Check if Resumable Run Exists

Fitters

Classes for fitting Bayesian models

Fitter(): Abstract Fitter Class
BrmsFitter(): Brms Fitter
MockFitter(): Mock Fitter for Testing (Internal)
fit(): Fit a Bayesian Model
extract_draws(): Extract Posterior Draws
predict_fit(): Generate Predictions
log_lik(): Compute Pointwise Log-Likelihood
loo(): Compute LOO-CV
diagnostics(): Extract Fit Diagnostics
validate_fitter(): Validate a Fitter Object

Metrics

Classes and built-in metrics for computing simulation results

Metric(): Metric Abstract Class
compute(): Compute Metric Values
RmseMetric() rmse_metric(): RMSE Metric
BiasMetric() bias_metric(): Bias Metric
CoverageMetric() coverage_metric(): Coverage Metric
PosteriorMeanMetric() posterior_mean_metric(): Posterior Mean Metric
validate_metric_output(): Validate Metric Output
flatten_metric_output(): Flatten Metric Output

Results

Functions for working with simulation results

is_bayesim_fit_result(): Check if object is a bayesim_fit_result
validate_bayesim_fit_result(): Validate a bayesim_fit_result object
new_fit_result(): Create a new bayesim_fit_result object
new_task_result(): Create a new bayesim_task_result object
new_simulation_result(): Create a new bayesim_simulation_result object

Checkpointing

Functions for checkpoint and resume functionality

init_checkpoint_dir(): Initialize checkpoint directory
write_checkpoint(): Write checkpoint
read_checkpoint(): Read checkpoint
get_resume_summary(): Get Resume Summary
load_for_resume(): Load Run for Resume

Retention

Control what artifacts are retained in results

resolve_retention(): Resolve retention specification
RETENTION_PROFILES: Retention profiles

Utilities

Helper functions and utilities

`%||%`: Null coalescing operator
format_task_id() deprecated: Format task ID from indices (deprecated)
make_task_id(): Create task ID from indices
resolve_retention(): Resolve retention specification