Automated reports
InferenceReport is a Julia package to automatically generate a web page or PDF report from Pigeons' output, containing common plots and diagnostics.
We provide a brief summary on how to use InfereReport here, see the full InferenceReport documentation for details.
Install InferenceReport
using Pkg; Pkg.add("InferenceReport")Basic usage
using InferenceReport
using Pigeons
pt = pigeons(
target = toy_mvn_target(2),
n_rounds = 4,
record = [traces; round_trip; record_default()])
report(pt)───────────────────────────────────────────────────────────────────────────────────────
scans restarts Λ time(s) allc(B) log(Z₁/Z₀) min(α) mean(α)
────────── ────────── ────────── ────────── ────────── ────────── ────────── ──────────
2 0 0.609 3.75e-05 1.16e+04 -1.68 0.705 0.932
4 0 1.28 4.9e-05 1.84e+04 -1.86 0.527 0.858
8 0 1.39 5.25e-05 3.34e+04 -2.29 0.458 0.845
16 1 1.55 6.3e-05 5.82e+04 -2.27 0.646 0.828
───────────────────────────────────────────────────────────────────────────────────────
target_description...[skipped: no description provided]
pair_plot... ✓
trace_plot... ✓
moments... ✓
trace_plot_cumulative... ✓
mpi_standard_out...[skipped: no MPI std out files found]
lcb... ✓
gcb_progress... ✓
logz_progress... ✓
round_trip_progress... ✓
swaps_plot... ✓
pigeons_summary... ✓
pigeons_inputs... ✓
reproducibility_info...[skipped: missing reproducibility_command]
Report generated at: /home/runner/work/Pigeons.jl/Pigeons.jl/docs/build/results/all/2024-11-14-21-28-48-eqThweGyThis will generate an HTML report with various useful diagnostic plots and open it in your default browser.