Skip to main content

MCMC visualisations package developed at the University of Warwick and supported by The Alan Turing Institute.

Project description

Release build Develop build Project Status: WIP – Initial development is in progress, but there has not yet been a stable, usable release suitable for the public. License: MIT

New View of MCMC

Backfillz-py provides new visual diagnostics for understanding MCMC (Markov Chain Monte Carlo) analyses and outputs. MCMC chains can defy a simple line graph. Unless the chain is very short (which isn’t often the case), plotting tens or hundreds of thousands of data points reveals very little other than a ‘trace plot’ where we only see the outermost points. Common plotting methods may only reveal when an MCMC really hasn’t worked, but not when it has. BackFillz-py slices and dices MCMC chains so increasingly parameter rich, complex analyses can be visualised meaningfully. What does ‘good mixing’ look like? Is a ‘hair caterpillar’ test verifiable? What does a density plot show and what does it hide?

Quick Start

Install from PyPI using pip install backfillz.

from backfillz import Backfillz

# Let's have an example Stan model.
from backfillz.example.eight_schools import generate_fit

backfillz = Backfillz(generate_fit().fit)

# Plot some of the available plot types.
backfillz.plot_slice_histogram('mu')
backfillz.plot_trace_dial('theta')
backfillz.plot_spiral_stream('mu', [2, 8, 15, 65, 250, 600])

See the example notebook for running in JupyterLab.

Current supported plot types

Pretzel Plot – plot_trace_dial()

This plot shows the chain and summary histograms in a format that can be easily arranged as a grid. The trace plot is stretched, clearly indicating ‘burn-in’, with density plots showing the burn-in and remainder of the chain in context.

Slice plot - plot_slice_histogram()

By partitioning chain slices, in a faceted view, users can assess chain convergence. The slices are currently specified by the user and display density plots for each slice. Have my chains converged? The slice plot offers a clear view of when and how convergence is achieved. Further statistical diagnostics can be embedded in these plots as colour encodings or additional layers and annotations.

Splash plot - plot_spiral_stream()

Based on a Theodorus spiral, we turn MCMC chains into glyphs and extract properties to answer – What does ‘good mixing’ look like? In these plots variance windows are calculated across chains and parameters. The glyphs have clear diagnostic features and will allow gridded plots to investigate large numbers of parameters.

Emojis on commit messages

Recent commits use the following git aliases (add to [alias] section of your .gitconfig):

doc      = "!f() { git commit -a -m \"📚 : $1\"; }; f"
lint     = "!f() { git commit -a -m \"✨ : $1\"; }; f"
modify   = "!f() { git commit -a -m \"❗ : $1\"; }; f"
refactor = "!f() { git commit -a -m \"♻️ : $1\"; }; f"

Acknowledgements

We are grateful for funding from the Alan Turing Institute within the Tools, Practices and Systems theme. Initial user research was carried out by GJM on the 2020 Science programme funded by the EPSRC Cross-Discipline Interface Programme (grant number EP/I017909/1).

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

backfillz-0.2.4.tar.gz (16.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

backfillz-0.2.4-py3-none-any.whl (19.4 kB view details)

Uploaded Python 3

File details

Details for the file backfillz-0.2.4.tar.gz.

File metadata

  • Download URL: backfillz-0.2.4.tar.gz
  • Upload date:
  • Size: 16.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.8 CPython/3.9.6 Darwin/19.6.0

File hashes

Hashes for backfillz-0.2.4.tar.gz
Algorithm Hash digest
SHA256 45474cbf77ebb0a305258b326e5f28888b229e8347cd322dd6c0ce46b959ead3
MD5 2b70d660b019484385fe7c65fbf8f73c
BLAKE2b-256 8e0e3a1e0f1f3b00966aa684a2889d8d312e3d1b31e8e8dca05c9b08b1ec82bf

See more details on using hashes here.

File details

Details for the file backfillz-0.2.4-py3-none-any.whl.

File metadata

  • Download URL: backfillz-0.2.4-py3-none-any.whl
  • Upload date:
  • Size: 19.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.8 CPython/3.9.6 Darwin/19.6.0

File hashes

Hashes for backfillz-0.2.4-py3-none-any.whl
Algorithm Hash digest
SHA256 5e2c9d326a97f4db33b135aa2b09a26a4cac24d0ddaa9afe6b2316557164fd4c
MD5 1fc10342249b4fc35825f12b79a4019f
BLAKE2b-256 cae8570c4e64d5919ef818de008cd9b5c265170d6d95af32799bcf12cf066ced

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page